carvel-dev / carvel-dev/ytt

Create example: Templating in a multiline string

Open
#651 1 comment 4 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Go
Stars
1.9k
Forks
167
PR merge metrics
No merged PRs in 30d

Description

## Why
A common use case for Kubernetes ConfigMaps and Secrets are to put values in a multiline string, which may need to be templated. Templating that multiline string isn’t obvious (it requires `yaml.encode()`).
## What
[There exists](https://github.com/vmware-tanzu/carvel-ytt/blob/develop/examples/k8s-config-map-files/config.yml) an example of this. Put this or another example into the official docs.
## How
Either in the playground or in the carvel.dev/ytt docs.

[Here](https://kubernetes.slack.com/archives/CH8KCCKA5/p1647979081840839) is a request for this

Contributor guide

Open the contributing guide

Research direction

Start with the existing examples/k8s-config-map-files/config.yml example linked in the issue and review the official carvel.dev/ytt documentation or playground entry points. Add this example, or an equivalent one, so users can see how to template a multiline ConfigMap or Secret value; completion is the example appearing in the official docs or playground.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, yaml
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.