如何使用Kubernetes yaml文件设置动态值？

时间：2018-01-17 07:53:08

标签： templates kubernetes yaml config key-value

例如，部署yaml文件：

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}}

Kubernetes有一个ConfigMap功能，但它也会将键/值写入yaml文件。有没有办法将密钥设置为环境变量？

15 个答案:

答案 0 :(得分：18)

你不能自动完成，你需要使用外部脚本来编译＆＃34;您的模板，或使用@Jakub建议的掌舵。

您可能希望使用自定义bash脚本，可能与CI管道集成。

鉴于名为deploy.yml.template的模板yml文件与您提供的文件非常相似，您可以使用以下内容：

#!/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 -

答案 1 :(得分：7)

一行：

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

在Yaml中：

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

答案 2 :(得分：4)

我不认为可以通过Kubernetes中的变量或配置图设置图像。但您可以使用例如Helm来使您的部署更加灵活和可配置。

答案 3 :(得分：2)

使用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

然后... 

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

或更妙的是，使用ytt的堂兄kapp获得高度控制的部署体验：

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

答案 4 :(得分：1)

我的方法：

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")

制定规则：

_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)

在.j2模板文件中，您可以使用任何jinja语法构造，例如{{env.GUEST}}将由GUEST

中定义的.env的值替换

因此您的templates/deploy.yaml.j2如下所示：

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

另一种方法（仅使用bash内置函数和xargs）

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

答案 5 :(得分：1)

您还可以在部署时使用envsubst。

例如

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

它将用其值替换文件中的所有变量。 在部署到多个环境中时，我们已经在CI上成功使用了这种方法，并且还将CI_TAG等注入到部署中。

答案 6 :(得分：1)

我认为现在应该使用标准 - Helm 而不是自定义脚本来解决这个问题。无需部署即可在机器上生成 Kubernets yaml。

示例：

  1. 在您的机器上安装 helm 以便 helm 命令存在

  2. https://artifacthub.io/packages/helm/pauls-helm-charts/helloworld - 安装按钮

  3. helm repo add pauls-helm-charts http://tech.paulcz.net/charts

  4. helm pull pauls-helm-charts/helloworld --version 2.0.0

  5. tar -zxvf helloworld-2.0.0.tgz && cd helloworld

  6. helm template -f values.yaml --output-dir helloworld . --namespace my-namespace --name-template=my-name

因此它从 values.yaml 创建了这些文件：

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

在 values.yaml 中，您可以更改预定义的 repository（或者可以根据需要在 Kubernetes yaml 中 100% 重复任何值）：

image:
  repository: paulczar/spring-helloworld

现在，如果您要部署，请确保 kubectl 正常工作，并仅使用 kubectl apply -f serviceaccount.yaml 等应用这些生成的文件。

答案 7 :(得分：0)

我创建了一个名为kubectl_create的脚本，并使用它来运行create命令。它将替换环境变量中引用的模板中的任何值。

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

例如，如果模板文件具有：

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

运行kubectl_create nginx-service.yaml，然后在运行实际的kubectl create命令之前将替换环境变量PUBLIC_IP。

答案 8 :(得分：0)

我一直在使用kubetpl

它具有三种不同的模板样式，并支持ConfigMap / Secret冻结。

答案 9 :(得分：0)

我创建了一个名为kubectl_apply的脚本。它从.env加载变量，在yml中替换$ {CUSTOMVAR}并将其传递给kubectl命令

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

答案 10 :(得分：0)

Helm正是用于此类事情以及更多。它可以像一组一样处理复杂的资源部署集。

但是，如果我们仍在寻找一些简单的替代方法，那么使用ant怎么办？

如果要在构建过程或测试过程中修改文件，则也可以执行ant任务。

使用ant可以将所有环境值加载为属性，也可以简单地加载属性文件，例如：

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

然后，您可以有一个将模板文件转换为所需的Yaml文件的目标。

<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>

当然，如果要动态更改多个文件（嵌套或其他文件）的值，可以使用fileset而不是file

您的模板文件xyz.template.yml应该如下所示：

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.属性是从环境变量加载的，而其他属性是从属性文件加载的

希望对您有所帮助：）

答案 11 :(得分：0)

如果您打算编写脚本，我已经发布了一个命令行工具ysed，可以为您提供帮助。

答案 12 :(得分：0)

如果只想在部署运行时更改映像或标签，则可以在部署中设置特定容器的映像：

XMLHttpRequest

答案 13 :(得分：0)

在jitsi项目中，tpl == frep命令用于替换值，对envsubst的扩展

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

我一直在使用旧的 shell 工具，比如 sed 和朋友，但是当这些代码有很多价值需要处理时，这些代码很快就会变得不可读。

答案 14 :(得分：0)

创建一个名为 kubectl_advance 的文件，如下所示，并像 kubectl 命令一样调用它。

例如

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

假设 yaml 文件具有 ${MY_VAL} 之类的值将被环境变量替换。

#!/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 -
相关问题
最新问题