向部署传递参数

使用 Cloud Deploy,您可以传递版本的参数,这些值会在清单应用到各自的目标之前提供给清单。此替换是在呈现清单之后执行的,是 Cloud Deploy 呈现操作的最后一步。系统会向 skaffold.yaml 文件中标识的包含相应占位符的所有清单提供值。

您只需在清单中添加占位符,然后在 Cloud Deploy 提交流水线或目标配置中为这些占位符设置值,或者在创建版本时设置值即可。

本文介绍了如何实现这一点。

为何使用部署参数?

这项功能的典型用途是在并行部署中为不同目标的清单应用不同的值。不过,您可以针对清单中需要在呈现后进行键值对替换的任何内容使用部署参数。

工作原理

以下步骤介绍了配置部署参数和提供值的一般流程:

  1. 您可以按照此处所述配置部署参数化。

    这包括以下内容:

    • 将占位符添加到清单中。

    • 为这些占位符添加值。

      您可以通过三种方法实现此目的,具体方法请参阅此处

  2. 创建版本后,系统会呈现您的清单。

    如果您从模板化清单开始,系统现在会为模板变量应用值。如果您从原始清单开始,则该清单会保持不变。此渲染由 Skaffold 完成。

    不过,您可以在清单中添加其他变量,并在渲染时不应用其值。这些是本文档中介绍的部署参数。

    在创建版本时,所有部署参数都会编译为字典,该字典用于在应用清单之前替换值。

  3. 渲染后,Cloud Deploy 会将值替换为部署参数。

    这些是您在第一步中配置的值。

    呈现流程已将值应用于清单模板,替换了部分值,并添加了 Cloud Deploy 专用标签。不过,这些部署参数的值会在呈现后替换。如需了解清单模板和部署参数之间的区别,请参阅此处

  4. 系统会将清单应用于目标运行时,以部署您的应用。

    这包括在呈现时替换的值,以及任何部署参数的值

传递值的不同方式

您可以通过以下三种方式提供参数及其值:

  • 在交付流水线定义中

    您可以在交付流水线进程中某个阶段的定义中提供该参数及其值。该参数会传递给该阶段所代表的目标。如果该阶段引用多目标,则此处设置的值将应用于所有子目标。

    借助此方法,您可以为给定流水线中的所有版本替换所有受影响的目标的值。为阶段定义的参数用于标识标签,并且相应阶段的相应目标必须具有匹配的标签。

  • 在目标定义中

    您可以在目标本身的定义中配置该参数及其值。通过此方法,您可以为所有版本替换该目标的值。

  • 在命令行中创建版本时

    您可以使用 gcloud deploy releases create 命令中的 --deploy-parameters 标志添加该参数及其值。

    借助此方法,您可以在创建版本时替换值,并将该值应用于所有受影响目标的清单。

如需详细了解如何配置这些功能,请点击此处

我可以同时使用这两种方法吗?

可以,您可以在流水线阶段、目标配置中以及命令行中添加部署参数。结果是,系统会接受所有参数并将其添加到字典中。不过,如果在多个位置传递特定参数,但值不同,gcloud deploy releases create 命令将失败并显示错误。

这与清单模板有何不同

本文中所述的部署参数与模板化清单中的占位符通过语法进行区分。不过,如果您想知道为什么需要部署参数,而不是仅使用标准技术来处理模板化清单,请参阅下表,了解不同用途:

方法 换人时间 适用对象
清单模板 渲染阶段 特定版本;特定目标平台
在命令行中 呈现后 特定版本;所有目标平台
在交付流水线中 呈现后 所有版本;特定目标(按标签)
符合目标 呈现后 所有版本;特定目标平台

本文档仅介绍部署参数(在命令行、流水线和目标上),不介绍模板化清单

限制

  • 对于每种参数类型,您最多可以创建 25 个参数。

  • 此外,子目标还可以从其父级多目标继承最多 25 个参数,因此目标上的参数最多可达 100 个,包括在流水线阶段设置的参数。

  • 密钥名称不得超过 63 个字符,并且符合以下正则表达式:

    ^[a-zA-Z0-9]([-A-Za-z0-9_.]{0,61}[a-zA-Z0-9])?$
    

    有一个例外情况:如果您在自定义目标中将部署参数用作环境变量,则必须在关键字 customTarget 和变量名称 (customTarget/VAR_NAME) 之间使用斜线。如需了解支持的语法,请参阅必需的输入和输出

  • 前缀 CLOUD_DEPLOY_ 已被保留,不能用作键名称。

  • 您不能对同一目标应用两个同名的键。

  • 此值可以为空,但最多包含 512 个字符。

  • 部署参数占位符不能用于 Helm 配置值,但必须通过惯例传递

配置部署参数

本部分介绍了如何配置将应用于 Kubernetes 清单、Cloud Run 服务或 Helm 模板的部署参数值。

除了配置这些键值对之外,您还需要将占位符添加到清单中,如本部分所述。

向清单添加占位符

在 Kubernetes 清单(适用于 GKE)或服务 YAML(适用于 Cloud Run)中,您可以为要在呈现后替换的任何值添加占位符。

语法

对于未将 Helm 渲染程序与 Skaffold 搭配使用的版本,请对占位符使用以下语法:

[PROPERTY]: [DEFAULT_VALUE] # from-param: ${VAR_NAME}

在此行中…

  • PROPERTY:

    是 Kubernetes 清单或 Cloud Run 服务 YAML 中的配置属性。

  • DEFAULT_VALUE

    如果命令行、流水线或目标配置中未为此属性提供值,则使用此值。

  • # from-param:

    使用注释字符来设置 Cloud Deploy deploy-parameters 指令,from-param: 用于告知 Cloud Deploy 后面会跟随 deploy-parameters 占位符。

  • ${VAR_NAME}

    是替换项的占位符。此值必须与提交流水线或目标配置中提供的键值对的键一致,或者与版本创建时提供的键值对的键一致。

Helm 图表值的参数

如果您要呈现接受配置值的 Helm 图表,并且您想使用部署参数设置这些值,则部署参数的名称必须与您要设置的 Helm 配置值相匹配。所有部署参数都会在渲染时作为 --set 参数传递给 Helm,而无需修改 skaffold.yaml

例如,如果您的 skaffold.yaml 正在安装一个 Helm 图表,该图表使用配置参数 webserver.port 来指定 Web 服务器将从哪个端口启动,而您希望通过部署参数动态设置此参数,则需要创建一个名称为 webserver.port 的部署参数,并为其指定您希望的 Web 服务器端口值。

因此,如果您不仅要在 skaffold.yaml 中引用 Helm 模板,还要编写这些模板,则可以在 Helm 模板中使用 {{ .Values.VAR_NAME }}标准 Helm 变量语法

例如,如果我们配置了 webserver.port 部署参数,则可以按如下方式使用该参数:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: webserver
spec:
  replicas: 3
  selector:
    matchLabels:
      app: webserver
  template:
    metadata:
      labels:
        app: webserver
    spec:
      containers:
      - name: webserver
        image: gcr.io/example/webserver:latest
        ports:
        - containerPort: {{ .Values.webserver.port }} # replaced by deploy parameter `webserver.port`.
          name: web
        env:
        - name: WEBSERVER_PORT
          value: {{ .Values.webserver.port }} # replaced by deploy parameter `webserver.port`.

向流水线阶段添加参数

您可以向传送流水线进程中的某个阶段添加键值对。这对于并行部署非常有用,可用于区分子目标。

  1. 将占位符添加到您的 Kubernetes 清单或 Cloud Run 服务,如此处所述。

    示例如下:

    apiVersion: apps/v1
    kind: Deployment
    metadata:
     name: nginx-deployment
     labels:
       app: nginx
    spec:
     replicas: 1 # from-param: ${deploy_replicas}
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: nginx:1.14.2
           ports:
           - containerPort: 80
    
  2. 配置交付流水线,为适用的流水线阶段添加 deployParameters

    以下 YAML 是流水线阶段的配置,其目标是多目标,在本例中,该目标有两个子目标:

    serialPipeline:
     stages:
       - targetId: dev
         profiles: []
       - targetId: prod  # multi-target
         profiles: []
         deployParameters:
           - values:
               deploy_replicas: 1
               log_level: "NOTICE"
             matchTargetLabels: # optional, applies to all resources if unspecified; AND'd
               my-app: "post-render-config-1"
           - values:
               deploy_replicas: 2
               log_level: "WARNING"
             matchTargetLabels: # optional, applies to all resources if unspecified; AND'd
               my-app: "post-render-config-2"
    

    在此提交流水线配置中,deployParameters 诗节包含两个 values,每个 values 都具有以下内容:

    • 变量名称,该名称与您在清单中设置的变量名称相同

    • 该变量的值

    • 一个或多个标签(可选),用于与目标专用标签进行匹配

      如果您未在 matchTargetLabels 诗节中指定标签,则该值将用于相应阶段中的所有目标。

  3. 如果您添加了 matchTargetLabels,则还必须在目标上添加标签,以便进行匹配。这样,您就可以确定要将哪个值分配给哪个子目标。

    目标必须与 values 诗节中设置的所有标签匹配。

    如果您省略 matchTargetLabels,则您在流水线上设置的 values 会应用于所有子目标。但是,如果您为同一参数设置多个值,则发布将失败。

渲染每个清单后,Cloud Deploy 会将每个变量的值添加到渲染的清单中。

向目标配置添加参数

您可以向目标添加键值对。如果您使用部署参数来区分多个子目标,请在这些子目标上配置这些参数,而不是在多目标上配置。

  1. 使用参数(而非您要在部署时设置的值)配置 Kubernetes 清单或 Cloud Run 服务定义。

    示例如下:

    apiVersion: apps/v1
    kind: Deployment
    metadata:
     name: nginx-deployment
     labels:
       app: nginx
    spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: nginx:1.14.2
           env:
           - name: envvar1
             value: example1 # from-param: ${application_env1}
           - name: envvar2
             value: example2 # from-param: ${application_env2}
    

    在此清单中,参数 envvar1 的默认值设为 example1envvar2 的默认值设为 example2

  2. 目标配置为包含 deployParameters

    对于要添加的每个参数,您都需要确定以下各项:

    • 键名称,该名称与您在清单中设置的键(变量)相同。

    • 该键的值。如果您未提供值,系统会使用清单中设置的默认值。

    以下 YAML 是两个目标的配置。每个目标都包含一个用于设置值的 deployParameters 诗节。每个目标还包含一个标签,用于与在流水线阶段配置的部署参数进行匹配。

    apiVersion: deploy.cloud.google.com/v1beta1
    kind: Target
    metadata:
      name: prod1
      labels:
        my-app: "post-render-config-1"
    description: development cluster
    deployParameters:
      application_env1: "newValue1"
    ---
    
    apiVersion: deploy.cloud.google.com/v1beta1
    kind: target
    metadata:
      name: prod2
      labels:
        my-app: "post-render-config-2"
    description: development cluster
    deployParameters:
      application_env1: "newValue2"
    

在创建版本但在呈现清单之后,如果这些值包含关联的键,Cloud Deploy 会将这些值添加到呈现的清单中。

在创建版本时传递参数

请按照以下步骤将参数和值传递给版本:

  1. 使用参数(而非您要在部署时设置的值)配置 Kubernetes 清单或 Cloud Run 服务定义。

    示例如下:

    apiVersion: apps/v1
    kind: Deployment
    metadata:
     name: nginx-deployment
     labels:
       app: nginx
    spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       annotations:
         commit: defaultShaValue # from-param: ${git-sha}
       spec:
         containers:
         - name: nginx
           image: nginx:1.14.2
    

    在此示例中,提交 SHA 设置为名为 ${git-sha} 的变量。在创建版本时,系统会使用 --deploy-parameters= 选项传递此值,如下一步所示。

    此变量的语法为 $ 加上括号中的变量名称。在此示例中,该 IP 地址为 ${git-sha}

  2. 创建版本时,请在 gcloud deploy releases create 命令中添加 --deploy-parameters 选项。

    --deploy-parameters 接受键值对的逗号分隔列表,其中键是您添加到清单中的占位符。

    该命令将如下所示:

    gcloud deploy releases create test-release-001 \
    --project=my-example-project \
    --region=us-central1 \
    --delivery-pipeline=my-params-demo-app-1 \
    --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
    --deploy-parameters="git-sha=f787cac"
    
    

在创建版本后,但在清单呈现之后,如果所呈现的清单包含关联的键,Cloud Deploy 会向其提供相应值。

使用自定义目标部署参数

您可以在自定义目标中将任何部署参数用作环境变量。执行此操作时,请使用为自定义目标指定的语法

要用作自定义目标的输入的部署参数可以以 customTarget/ 开头,例如 customTarget/vertexAIModel。如果您使用此前缀,则在将部署参数作为环境变量引用时,请使用以下语法:

CLOUD_DEPLOY_customTarget_[VAR_NAME]

其中,VAR_NAME部署参数名称中斜线后面的名称。例如,如果您定义了一个名为 customTarget/vertexAIModel 的部署参数,请以 CLOUD_DEPLOY_customTarget_vertexAIModel 的形式引用该参数。

使用部署钩子部署参数

您可以在部署钩子中将任何部署参数用作环境变量。

部署参数(包含部署验证)

您可以在部署验证中将任何部署参数用作环境变量。

查看版本的所有参数

您可以查看为给定版本设置的参数。这些信息会显示在版本详情页面和命令行 (gcloud deploy releases describe) 上的表格中。

  1. 在 Cloud Deploy 主页面中,点击包含要查看的版本的交付流水线。

  2. 版本详情页面上,选择工件标签页。

为此版本设置的所有部署参数都会显示在一个表格中,其中一个列包含变量名称和值,另一个列包含受影响的目标。

Google Cloud 控制台中显示的部署参数和值

后续步骤