How to set dynamic values with Kubernetes yaml file

Question

For example, a deployment yaml file:

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
      spec:
        container:
          - name: guestbook
            image: {{Here want to read value from config file outside}}

There is a ConfigMap feature with Kubernetes, but that's also write the key/value to the yaml file. Is there a way to set the key to environment variables?

**See also:** https://stackoverflow.com/questions/41620674/use-placeholders-in-yaml — dreftymac, Dec 26 '19 at 16:58

score 110 · Answer 1 · edited Oct 25 '22 at 19:25

110

You can also use envsubst when deploying.

e.g.

cat app/deployment.yaml | envsubst | kubectl apply ...

It will replace all variables in the file with their values. We are successfully using this approach on our CI when deploying to multiple environments, also to inject the CI_TAG etc into the deployments.

edited Oct 25 '22 at 19:25

MikeSchinkel

4,947
4
38
46

answered May 21 '19 at 14:38

Marek Urbanowicz

12,659
16
62
87

58

Also possible without cat: `envsubst < deployment.yaml | kubectl apply -f -` – Noam Manos Nov 12 '19 at 15:34
1

Do you have an example of `envsubset` and `deployment ` so we can see syntax of the variables declarations and anchros? – Adam Hughes Nov 10 '21 at 15:40
4

You just put $YOUR_ENV_NAME in the file, that's it. – Marek Urbanowicz Nov 11 '21 at 14:13
I put in a quick post to supplement this. Thanks. Ya - online I see all sorts of syntax $FOO ${FOO} {{FOO}} etc.. so it wasn't clear. envsubst < k8s/pls-invoice-rest-dep.yaml | kubectl apply -f - – Adam Hughes Nov 12 '21 at 21:12
1

Edit queue is full, so I added here. `cat app/deployment.yaml`, there is no $. – ychz Jul 29 '22 at 00:28
I agree with @NoamManos cat is so uncivilized !! :D – sashok_bg Mar 29 '23 at 12:21

score 78 · Answer 2 · edited Apr 15 '19 at 13:43

78

You can't do it automatically, you need to use an external script to "compile" your template, or use helm as suggested by @Jakub.

You may want to use a custom bash script, maybe integrated with your CI pipeline.

Given a template yml file called deploy.yml.template very similar to the one you provided, you can use something like this:

#!/bin/bash

# sample value for your variables
MYVARVALUE="nginx:latest"

# read the yml template from a file and substitute the string 
# {{MYVARNAME}} with the value of the MYVARVALUE variable
template=`cat "deploy.yml.template" | sed "s/{{MYVARNAME}}/$MYVARVALUE/g"`

# apply the yml with the substituted value
echo "$template" | kubectl apply -f -

edited Apr 15 '19 at 13:43

Derek Hill

5,965
5
55
74

answered Jan 17 '18 at 09:07

whites11

12,008
3
36
53

1

Thank you for your clear answer! I have read `helm` document. It's a great tool. Your script is a right way to deploy an application with CI. – online Jan 17 '18 at 11:05
This was solution for me to template Kubernetes Job manifest. Thank you! – bartgras Oct 28 '20 at 03:33
If I need to replace 2 variables how do I do that ? – yasin mohammed May 30 '23 at 11:56

score 40 · Accepted Answer · answered Jan 17 '18 at 08:12

40

I don't think it is possible to set image through variable or Config Map in Kubernetes. But you can use for example Helm to make your deployments much more flexible and configurable.

answered Jan 17 '18 at 08:12

Jakub

3,506
12
20

score 36 · Answer 4 · answered Jan 13 '19 at 11:55

36

One line:

cat app-deployment.yaml | sed "s/{{BITBUCKET_COMMIT}}/$BITBUCKET_COMMIT/g" | kubectl apply -f -

In yaml:

  ...
  containers:
  - name: ulisses
    image: niceuser/niceimage:{{BITBUCKET_COMMIT}}
  ...

answered Jan 13 '19 at 11:55

CelinHC

1,857
2
27
36

or with the default value - `cat app-deployment.yaml | sed "s/{{BITBUCKET_COMMIT}}/${BITBUCKET_COMMIT:=1}/g" | kubectl apply -f -` – Dimaf Jan 16 '19 at 14:13
16

You all deserve the [Useless Use of Cat Award](http://porkmail.org/era/unix/award.html)! `sed` can read files perfectly fine on its own, all remaining arguments are parsed as input file paths. – gertvdijk May 20 '19 at 09:46
Thanks a lot, @CelinHC this is exactly what I was looking for. – dhayanand baskar Nov 06 '20 at 18:38
Is BITBUCKET_COMMIT an env variable? Where is the value actually set so that it can be substittuded? – Adam Hughes Nov 10 '21 at 15:49
Hi... what if I need to replace 2 or 3 variable in the file – yasin mohammed May 30 '23 at 11:51
1

@yasinmohammed just add another `sed` entry in the command like `cat ...| sed ...| sed ... | kubectl apply` – whites11 May 30 '23 at 12:22
I added the sed and its working the kubectl apply part am not able to get `cat filename | sed ... | sed ... | kubectl apply -f -n logs` – yasin mohammed May 30 '23 at 16:45
I added the kubectl as a separate command after outputting to /tmp – yasin mohammed May 30 '23 at 17:17

score 10 · Answer 5 · answered Jul 25 '20 at 05:26

10

This kind of thing is painfully easy with ytt:

deployment.yml

#@ load("@ytt:data", "data")
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
      spec:
        container:
          - name: guestbook
            image: #@ data.values.image

values.yml

#@data/values
image: nginx@sha256:fe2fa7bb1ceb86c6d9c935bc25c3dd8cbd64f2e95ed5b894f93ae7ffbd1e92bb

Then...

$ ytt -f deployment.yml -f values.yml | kubectl apply -f -

or even better, use ytt's cousin, kapp for a high-control deployment experience:

$ ytt -f deployment.yml -f values.yml | kapp deploy -a guestbook -f -

answered Jul 25 '20 at 05:26

JTigger

394
2
10

is `ytt` standard on linux or something we need to install ahead of deploy? – Adam Hughes Nov 10 '21 at 15:38
You install it: https://carvel.dev/ytt/docs/latest/install/ – JTigger Dec 23 '21 at 17:22
Why are more people not talking about this, looks really great! – Nicholas Petersen Sep 27 '22 at 18:43
1

@NicholasPetersen Yeah, it's unfortunate that we haven't been able to spread "the word" better about the Carvel tools like `ytt`. Glad you see value in it. Don't be shy in sharing with others you think would benefit. – JTigger Oct 02 '22 at 16:36

jonashackt · Answer 6 · 2022-04-01T16:19:28.870

After trying sed and envsubst I found Kustomize the most elegant and Kubernetes-native way. As an alternative also yq comes in handy sometimes.

Use Kustomize to change image name

Install the kustomize CLI (e.g. on a Mac this is brew install kustomize) and create a new file called kustomization.yaml in the same directory as your deployment.yaml:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
  - deployment.yaml

Now use the kustomize edit set image command to change the image name

# optionally define image name
IMAGE_NAME=ghcr.io/yourrepo/guestbook:c25a74c8f919a72e3f00928917dc4ab2944ab061

# replace image tag
kustomize edit set image $IMAGE_NAME

Finally apply your kustomized deployment.yml to your cluster using kubectl apply -k directory/where/your/kustomization/file/is like this:

kubectl apply -k .

For debugging you can see the resulting deployment.yml if you run kustomize build . :

$ kustomize build .
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
    spec:
      containers:
        - image: ghcr.io/yourrepo/guestbook:c25a74c8f919a72e3f00928917dc4ab2944ab061
          name: guestbook

Alternative: Use yq to change image name

Install the YAML processor yq (e.g. via homebrew brew install yq), define your variables and let yq do the replacement:

# define image name
IMAGE_NAME=ghcr.io/yourrepo/guestbook:c25a74c8f919a72e3f00928917dc4ab2944ab061

# replace image tag
yq e ".spec.template.spec.containers[0].image = \"$IMAGE_NAME\"" -i deployment.yaml

Now your deployment.yaml get's the new image version and then looks like this:

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
    spec:
      containers:
        - image: ghcr.io/yourrepo/guestbook:c25a74c8f919a72e3f00928917dc4ab2944ab061
          name: guestbook

FYI: Your deployment.yaml isn't really valid Kubernetes configuration - the template.spec.container should not reside under the metadata tag - and also it is spelled containers.

in kustomize, there is such concept called overlays, you can set different values for different environment; and i assume `kustomize edit set ` does the same effect — soMuchToLearnAndShare, Dec 30 '22 at 13:25

score 9 · Answer 7 · answered Apr 11 '19 at 23:21

I create a script called kubectl_create and use it to run the create command. It will substitute any value in the template that is referenced in an environment variable.

#!/bin/bash
set -e
eval "cat <<EOF
$(<$1)
EOF
" | kubectl create -f -

For example, if the template file has:

apiVersion: v1
kind: Service

metadata:
  name: nginx-external
  labels:
    app: nginx

spec:
  loadBalancerIP: ${PUBLIC_IP}
  type: LoadBalancer
  ports:
  - name: http
    port: 80
    targetPort: 80
  - name: https
    port: 443
    targetPort: 443

  selector:
    app: nginx

Run kubectl_create nginx-service.yaml and then the environment variable PUBLIC_IP will be substituted before running the actual kubectl create command.

why not out="$(cat $1)" and kubectl apply -f out ... maybe I am missing something — , Jun 26 '20 at 19:55

score 7 · Answer 8 · answered Jan 20 '20 at 07:06

7

yaml does not read values from another yaml file. As an alternative approach you could try this.

kind: Pod
metadata:
  creationTimestamp: null
  annotations:
    namespace: &namespaceId dev
    imageId: &imgageId nginx
    podName: &podName nginx-pod
    containerName: &containerName nginx-container
  name: *podName
  namespace: *namespaceId
spec:
  containers:
  - image: *imgageId
    name: *containerName
    resources: {}
  dnsPolicy: ClusterFirst
  restartPolicy: Always
status: {}

answered Jan 20 '20 at 07:06

Isuru Amarathunga

2,127
1
20
20

1

How is this any better than just hardcoding these values? If they are in the same file... – Adam Hughes Nov 10 '21 at 15:39
2

@AdamHughes it's better because there's a single source of truth for the values with this approach. This is important because say for example you forget to replace all, or there's a typo in one value. Instead of checking them all there's just this reference. Imagine a very long connection string, it would be tedious to maintain in more than one place in the file. – Daniel May 13 '22 at 18:45

nyet · Answer 9 · 2019-04-14T03:04:52.497

My approach:

tools/jinja2-cli.py:

#!/usr/bin/env python3
import os
import sys
from jinja2 import Environment, FileSystemLoader

sys.stdout.write(Environment(loader=FileSystemLoader('templates/')).from_string(sys.stdin.read()).render(env=os.environ) + "\n")

Make rule:

_GENFILES = $(basename $(TEMPLATES))
GENFILES = $(_GENFILES:templates/%=%)

$(GENFILES): %: templates/%.j2 $(MKFILES) tools/jinja2-cli.py .env
        env $$(cat .env | xargs) tools/jinja2-cli.py < $< > $@ || (rm -f $@; false)

Inside the .j2 template file you can use any jinja syntax construct, e.g. {{env.GUEST}} will be replaced by the value of GUEST defined in .env

So your templates/deploy.yaml.j2 would look like:

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
      spec:
        container:
          - name: guestbook
            image: {{env.GUEST}}

Another approach (using just bash builtins and xargs) might be

env $(cat .env | xargs) cat <<EOF | kubectl create -f -
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: guestbook
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: guestbook
      spec:
        container:
          - name: guestbook
            image: ${GUEST}
EOF

laimison · Answer 10 · 2021-04-08T14:08:00.867

I think the standard - Helm should be used instead of custom scripts to solve this problem nowadays. You don't need to deploy to generate Kubernets yamls on the machine.

An example:

Install helm on your machine so helm command exists
https://artifacthub.io/packages/helm/pauls-helm-charts/helloworld - Install button
helm repo add pauls-helm-charts http://tech.paulcz.net/charts
helm pull pauls-helm-charts/helloworld --version 2.0.0
tar -zxvf helloworld-2.0.0.tgz && cd helloworld
helm template -f values.yaml --output-dir helloworld . --namespace my-namespace --name-template=my-name

So it created these files from values.yaml:

wrote helloworld/helloworld/templates/serviceaccount.yaml
wrote helloworld/helloworld/templates/service.yaml
wrote helloworld/helloworld/templates/deployment.yaml

Inside values.yaml, you can change predefined repository (or 100% any value can be repeated in Kubernetes yamls as you wish):

image:
  repository: paulczar/spring-helloworld

Now if you want to deploy, make sure kubectl works and just apply these generated files using kubectl apply -f serviceaccount.yaml, etc.

score 2 · Answer 11 · answered May 24 '19 at 19:24

2

I have been using kubetpl

It has three different template flavors and supports ConfigMap/Secret freezing.

answered May 24 '19 at 19:24

Jingshao Chen

3,405
2
26
34

score 2 · Answer 12 · answered Oct 19 '20 at 20:35

2

If you just want to change the image or a tag while your deployment is running, you could set the image of a specific container in your deployment:

kubectl apply -f k8s
kubectl set image deployments/worker-deployment worker=IMAGE:TAG

answered Oct 19 '20 at 20:35

Lukas Brinkmann

21
1

score 1 · Answer 13 · answered Jun 07 '19 at 07:32

1

I create a script called kubectl_apply. It loads variables from .env, replace ${CUSTOMVAR} in yml and pass it to kubectl command

  #!/bin/bash
  set -a
  source .env
  set +a
  eval "cat <<EOF
  $(<$1)
  EOF
  " | kubectl apply -f -

answered Jun 07 '19 at 07:32

Andrea Borraccetti

11
2

score 1 · Answer 14 · answered Jan 15 '20 at 06:49

1

I've published a command-line tool ysed that helps exactly with that, in case you plan to script it.

answered Jan 15 '20 at 06:49

Chakradar Raju

2,691
2
26
42

score 1 · Answer 15 · answered Jun 29 '21 at 13:39

create a file called kubectl_advance as below and enjoy calling it just like kubectl commands.

e.g.

EXPORT MY_VAL="my-v1"

kubectl_advance -c -f sample.yaml # -c option is to call create command
kubectl_advance -r -f sample2.yaml # -r option is to call replace command

Assuming the yaml file has the value like ${MY_VAL} to be replaced by the environment variable.

#!/usr/bin/env bash

helpFunction()
{
   echo "Supported option is [-f] for file"
   exit 1
}

while getopts "f:cr" opt
do
   case "$opt" in
      f ) yamlFile="$OPTARG" ;;
      c ) COMMAND_IS_CREATE="true" ;;
      r ) COMMAND_IS_REPLACE="true" ;;
      ? ) helpFunction ;; # Print helpFunction in case parameter is non-existent
   esac
done

echo 'yaml file is : '$yamlFile

YAML_CONTENT=`eval "cat <<EOF
$(<$yamlFile)
EOF
"`

echo 'Final File Content is :=>'
echo '------------------'

echo "$YAML_CONTENT"


if [[ "$COMMAND_IS_CREATE" == "true" ]]; then
  COMMAND="create"
fi

if [[ "$COMMAND_IS_REPLACE" == "true" ]]; then
  COMMAND="replace"
fi

echo "$YAML_CONTENT" | kubectl $COMMAND -f -

score 0 · Answer 16 · answered Jul 11 '19 at 07:34

Helm is exactly meant for such things and a lot more. It handle complex set of resource deployment as a group etc.

But if we are still looking for some simple alternative then how about using ant?

If you want to modify the file as part of build process or test process then you can go with ant task as well.

Using ant you can load all environment values as property or you can simply load properties file like:

<property environment="env" />
<property file="build.properties" />

Then you can have a target which converts template files into your desired yaml file.

<target name="generate_from_template">

    <!-- Copy task to replaces values and create new file -->
    <copy todir="${dest.dir}" verbose="true" overwrite="true" failonerror="true">

        <!-- List of files to be processed -->
        <fileset file="${source.dir}/xyz.template.yml" />

        <!-- Mapper to transform filename. Removes '.template' from the file
            name when copying the file to output directory -->
        <mapper type="regexp" from="(.*).template(.*)" to="\1\2" />

        <!-- Filter chain that replaces the template values with actual values 
            fetched from properties file -->
        <filterchain>
            <expandproperties />
        </filterchain>
    </copy>
</target>

Of course you can use a fileset instead of file in case you want to change values dynamically for multiple files (nested or whatever)

Your template file xyz.template.yml should look like:

apiVersion: v1
kind: Service
metadata:
  name: ${XYZ_RES_NAME}-ser
  labels:
    app: ${XYZ_RES_NAME}
    version: v1
spec:
  type: NodePort
  ports:
    - port: ${env.XYZ_RES_PORT}
      protocol: TCP
  selector:
    app: ${XYZ_RES_NAME}
    version: v1

env. property being loaded from environment variables and other from property file

Hope it helped :)

score 0 · Answer 17 · answered Feb 12 '21 at 11:27

In the jitsi project the tpl == frep command is used to substitute values, an extension to envsubst

https://github.com/jitsi/docker-jitsi-meet/issues/65

I keep on using the old shell tools like sed and friends but such code is quickly unreadable when its more than a handful of value to deal with.

score 0 · Answer 18 · answered Aug 17 '22 at 14:13

For my deployments, I typically use Helm charts. It requires me to update values.yaml files periodically.

For dynamically updating YAML files, I used 'envsubst' since it is simple and does not require sophisticated configuration. In addition, most of the tools only work with valid Kubernetes manifests, not simple YAML files.

I created a simple script to handle the YAML modification to simplify the usage

https://github.com/alexusarov/vars_replacer

Example:

./vars_replacer.sh -i [input_file] -o [output_file] -p "[key=value] [key=value]"

score 0 · Answer 19 · answered Jul 12 '23 at 12:25

Per YAML's spec, there's no way to do that. but...

This is possible with yq's explode operator.

Namespace, Deployment, ClusterIP, Ingress... Clean and DRY:

cat <<EOF | yq 'explode(.)' | kubectl apply -f -
kind: Namespace
apiVersion: v1
metadata:
  name: &namespace example-namespace
---
kind: Deployment
apiVersion: apps/v1
metadata:
  name: example-deployment
  namespace: *namespace
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: &app-label example-app
    spec:
      containers:
      - name: httpecho
        image: hashicorp/http-echo:0.2.3
        args:
        - "-listen=:5678"
        - "-text=hello world 1"
        ports:
        - containerPort: &app-port 5678
  selector:
    matchLabels:
      app: *app-label
---
kind: Service
apiVersion: v1
metadata:
  name: &app-cluster-ip example-service
  namespace: *namespace
spec:
  type: ClusterIP
  selector:
    app: *app-label
  ports:
  - name: http
    protocol: TCP
    port: *app-port
    targetPort: *app-port
---
kind: Ingress
apiVersion: networking.k8s.io/v1
metadata:
  name: example-ingress
  namespace: *namespace
spec:
  ingressClassName: caddy
  rules:
  - host: example.kubernetes.localhost
    http:
      paths:
      - path: /hello
        pathType: Prefix
        backend:
          service:
            name: *app-cluster-ip
            port:
              number: *app-port
EOF

How to set dynamic values with Kubernetes yaml file

19 Answers19

Use Kustomize to change image name

Alternative: Use yq to change image name

Linked

Related