配置CodeArts Deploy应用的参数

创建并配置参数

介绍应用中自定义参数的创建和配置。

1. 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。
2. 单击“参数设置”，切换到“参数设置”页面。

   

   参数信息说明如下：

   基本信息	说明
   新建参数	单击“新建参数”，可以新增参数。
   名称	参数名称。可修改自定义参数名称。 说明： 自定义参数名称不可与系统预定义参数名称相同。
   类型	参数可选类型，包括：字符串类型、枚举类型和环境类型。
   默认值	根据需要填写/选择参数值。 说明： 选择环境类型时，如果没有环境，需要手动新建环境。
   私密参数	参数为私密参数时，系统会将输入参数做加密存储，使用时进行解密，不可设置“运行时设置”。
   运行时设置	打开“运行时设置”开关，表示部署应用时支持变更参数值，并且也会把该参数上报应用。运行时参数需要执行时输入。
   参数描述	对本参数的描述。
   操作	单击参数所在行，可以删除该参数。

3. 单击“新建参数”，新增一个参数，根据需要自定义参数名称、类型（默认为“字符串”类型）、默认值，设置私密参数及运行时设置等。
   • 字符串类型

     参数值为字符串，可在“默认值”列自定义参数值，设置私密参数及运行时设置等。

     

   • 枚举类型

     选中枚举类型后弹出“枚举”对话框，可以设置“可选取值”，如需设置多个，可单击图标添加。如需删除，可单击图标移除。

     

     设置完成后，在“默认值”列的下拉列表选择其中一个值，如下图。

     

   • 环境类型

     该类型参数通过“默认值”列下拉列表选择环境，下拉列表中可选所在应用下创建的所有环境。

     

     如果下拉列表没有可选项，需要在“环境管理”页签新建环境，新建完成后回到参数配置页面，然后单击刷新，将新的环境刷新到下拉列表中即可使用。

4. 修改完所有信息，单击“保存”，保存该应用。

编辑参数

1. 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。
2. 单击“参数设置”，切换到“参数设置”页面。
   • 编辑参数

     可对已有参数的参数名称、类型、默认值、私密参数、运行时设置、参数描述进行编辑。并可通过单击图标，拖拽参数行，移动参数顺序。

   • 新增参数

     单击“新建参数”，可在已有参数的基础上新增参数。同样单击参数操作列的图标，可在当前参数下方，新增一行参数并设置。

   • 删除参数

     单击图标，可对已有参数进行删除。

参数使用

下面以具体示例演示介绍如何使用自定义参数。

1. 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。
2. 单击“参数设置”，切换到“参数设置”页面，分别创建环境、枚举、字符串三种类型的自定义参数并打开“运行时设置”。
3. 单击“部署步骤”，切换到“部署步骤”页面，在步骤详情中引用自定义参数。

   参数引用形式：${参数名}，在参数输入框输入“$”符号后会自动出现已创建的参数列表，根据需要选择对应参数。

   例如，配置“选择软件包”项时，可以输入“$”符号带出已配置好的“package_url”参数，并选择该参数。

   

4. 单击“保存并部署”，在弹窗中可重新对参数进行赋值。
5. 单击“确定”，保存并部署该应用。

1. 在流水线关联应用的时候，可将参数动态绑定；
2. 在运行流水线的时候，输入的参数值会替换到应用中并运行；
3. 在流水线中添加一个类型为部署的任务步骤，选择已配置运行时设置参数的应用，运行流水线时可动态设置。