华为云用户手册

前提条件 在调用API前，确保您的业务系统所在网络与API的访问 域名 或地址互通。 若业务系统与ROMA Connect实例在相同VPC内时，可直接访问API。 若业务系统与ROMA Connect实例在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问API。具体步骤请参考VPC对等连接说明。 若业务系统与ROMA Connect实例在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问API。具体步骤请参考跨区域VPC互通。 若业务系统与ROMA Connect实例通过公网互通，请确保ROMA Connect实例已绑定弹性IP。

步骤详情 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤编排区显示的名称。 部署租户 当前租户：表示将软件包部署到当前租户的FunctionGraph插件中发布。 选中“当前租户”，当前租户需要有FunctionGraph操作权限，如果当前没有FunctionGraph操作权限，可以通过下方的 IAM 授权选择已有权限的授权用户进行部署。 其他租户：表示通过IAM授权方式将软件包部署到其他租户的FunctionGraph中发布。 选中“其他租户”，则必须选择授权租户进行FunctionGraph部署。 说明： 推荐配置拥有FunctionGraph操作权限的子账号的AK/SK，不推荐配置租户账号的AK/SK。 IAM授权 如果当前用户没有FunctionGraph操作权限，可以通过IAM授权选择授权的用户进行部署。 函数名称 FunctionGraph中创建的函数，请参考FunctionGraph使用流程。 函数别名 FunctionGraph中对应函数创建好的别名，函数别名支持绑定两个版本，一个对应版本和开启灰度版本，并且支持配置同一个别名下两个不同版本分流权重，每个版本只能创建一个别名。 对应版本 可通过别名来调用对应版本的函数，仅可以为每个版本创建一个别名。 开启灰度版本 灰度版本可以分流主版本请求的部分，可以通过设置灰度版本的权重值来控制分流的多少，更多灰度版本的介绍，请参考版本管理。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。

删除文件 该步骤用于删除环境下目标主机中指定路径的文件/文件夹，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 删除路径 待删除文件/文件夹的路径。 说明： 删除路径如果为文件，则删除具体的文件；如果为文件夹，则删除该文件夹及文件夹下所有文件。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的文件操作类相关的部署步骤

操作步骤 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。 单击“权限管理”，切换到“权限管理”页面。 根据使用场景为各角色配置相应操作权限，请根据实际情况进行设置。查看应用级默认权限。 表示权限已开启，去勾选可关闭权限。 表示权限已关闭，勾选可开启权限。 表示权限已开启，且不可修改。 开启“使用项目权限配置”后，该页面的权限信息都不可修改。 应用创建者、项目管理员的权限不能修改。 如果当前用户没有“修改”权限则不能进入编辑页面。 如果当前用户有“修改”权限，但没有“权限管理”权限则无法编辑其他权限。 项目管理员（项目创建者和项目经理）支持自定义角色功能，可对自定义角色的权限进行编辑。 修改完所有信息，单击“保存”，保存该应用。

URL健康测试 该步骤通过访问目标主机部署应用的健康检查URL，用于检测服务是否正常启动，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 重试次数 失败后重试次数，超过预设的重试次数，服务未启动会导致URL检测失败。 间隔时间 每次重试测试的间隔时间。 测试路径 健康测试URL，支持添加多个。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用其他的部署步骤

停止服务 该步骤通过指定端口停止目标主机中对应的应用，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 服务的端口号 需要被停止的服务的端口号。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用关于服务启动停止相关的部署步骤

执行PowerShell命令 在Windows机器上执行文本框中输入的PowerShell命令，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 PowerShell命令 待执行的命令。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤执行失败后，应用是否继续执行后续的步骤。 当执行的PowerShell命令长度大于10240个字符时，建议使用“执行PowerShell脚本”插件。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用关于执行命令相关的部署步骤

步骤详情 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 部署租户 当前租户：表示将软件包部署到当前租户的CCE集群中发布。 选择“当前租户”，当前租户需要有CCE集群操作权限，如果当前没有CCE集群操作权限，可以通过下方的IAM授权选择已有权限的授权用户进行部署。 其他租户：表示通过IAM授权方式将软件包部署到其他租户的CCE集群中发布。 选择“其他租户”，则必须选择授权租户进行CCE集群部署。 说明： IAM授权 如果当前用户无操作权限执行接口时，可通过IAM提权获取到其他用户的临时AK/SK去执行CCE接口。 区域 选择要部署的区域。 集群名称 选择CCE云容器引擎中申请的K8S集群。 命名空间名称 选择CCE云容器引擎中K8S集群的命名空间。 工作负载名称 选择需要部署的工作负载。 实例数量 填写需要部署的实例数量。 说明： 若实例数量输入为空，则自动适配CCE集群实时实例数量。 容器名称 选择需要部署的容器实例名。 镜像名称 选择需要部署的镜像。 镜像版本 选择需要部署的镜像版本。 容器规格 可配置目标工作负载中的目标容器的容器规格。 CPU配额 配额申请：容器使用的最小CPU需求，作为容器调度时资源分配的判断依赖。只有当节点上可分配CPU总量 ≥ 容器CPU申请数时，才允许将容器调度到该节点。 配额限制：容器能使用的CPU最大值，如果CPU使用值大于限制值，则容器使用CPU资源可能会被限流。 内存配额 配额申请：容器使用的最小内存需求，作为容器调度时资源分配的判断依赖。只有当节点上可分配内存总量 ≥ 容器内存申请数时，才允许将容器调度到该节点。 配额限制：容器能使用的内存最大值。当内存使用率超出设置的内存限制值时，该实例可能会被重启进而影响工作负载的正常使用。 环境变量 支持配置目标工作负载中的目标容器的环境变量 支持获取容器实时环境变量并同步到当前页面，同步后将覆盖本页面原有环境变量。 JAVA探针 可协助您快速进行工作负载的问题定位与性能瓶颈分析，详情可参考性能管理配置（性能瓶颈分析） 。 探针类型： APM 2.0探针：JAVA探针将分配 0.25 Core CPU 和 250 MiB 内存供初始化容器使用； 不启用：不启用探针问题定位； 当探针类型选择“APM2.0探针”时，需要填选以下信息。 探针版本：选择探针的版本； 探针升级策略：选择“重启自动升级”或“重启手动升级”； 重启自动升级：每次都尝试重新下载镜像。 重启手动升级：如果本地有该镜像，则使用本地镜像，本地不存在时下载镜像。 APM环境：填写APM环境信息（选填）； APM业务：选择已有的APM业务； 子业务：填写子业务（选填）； 接入密钥AK：将会自动获取APM服务的密钥信息，可前往APM控制台查看密钥详情。 关于APM2.0参数概念的详细说明，请参见APM参数说明。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 超时时间 指定该步骤最大执行时间，时间单位为分钟。在手动停止应用之前，执行时长大于超时时长，系统将该步骤设置为执行超时状态。取值范围：1-30 。

启动/停止SpringBoot服务 该步骤可通过指定环境下目标主机中SpringBoot应用的路径，用于启动或者停止SpringBoot服务，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 服务操作类型 配置启动服务或者停止服务。 服务对应的绝对路径 SpringBoot服务的绝对路径。 系统变量 选填。 Java运行参数，使用JVM变量，常用的是 -D 参数。 -XX 和-X 参数是用来设定内存和GC参数, 不同JVM的参数设置可能不同。 -D 和 -X 参数紧跟在 java 后面，当选择启动服务时，可设置服务运行所需内存大小等。 说明： 常见填入参数形式为 ：-Dfile.encoding=UTF-8 -Xms256m -Xmx512m 命令行参数 选填。 SpringBoot运行参数，即应用程序自己的参数。 当选择启动服务时，可以通过--参数方法, 设定SpringBoot服务监听端口等。 说明： 常见填入参数形式为 ：--server.port=9000 --spring.profiles.active=prod 等待时间 等待服务启动的时间。当选择启动服务时，启动过程中会通过检测进程方式检测服务是否成功启动。可根据服务启动实际所需时间进行调整，如时间设置不合理，会导致检测结果无效。 组件监控 配置是否启用应用运维服务（ AOM ），该服务提供指标监控、日志查询、告警功能（勾选后自动安装数据采集器 ICAgent，仅支持华为云linux主机，且与此应用在同一region下），详细请参见配置组件监控。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用关于服务启动停止相关的部署步骤

安装/卸载Docker 在主机上安装或者卸载Docker环境。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 服务操作类型 选择需要安装或者卸载docker服务。 说明： docker服务只支持拥有sudo权限的用户，此次安装会覆盖之前的docker版本。 docker版本 安装docker的目标版本。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 父主题： 配置CodeArts Deploy应用的软件安装类部署步骤

步骤详解 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 部署租户 当前租户：表示将软件包部署到当前租户的CCE集群中发布。 选择“当前租户”，当前租户需要有CCE集群操作权限，如果当前没有CCE集群操作权限，可以通过下方的IAM授权选择已有权限的授权用户进行部署。 其他租户：表示通过IAM授权方式将软件包部署到其他租户的CCE集群中发布。 选择“其他租户”，则必须选择授权租户进行CCE集群部署。 说明： 推荐配置拥有CCE集群操作权限的子账号的AK/SK，不推荐配置租户账号的AK/SK。 IAM授权 如果当前用户无操作权限执行接口时，可通过IAM提权获取到其他用户的临时AK/SK去执行CCE接口。 区域 选择要部署的区域。 集群名称 选择CCE云容器引擎中申请的K8S集群。 命名空间名称 选择CCE云容器引擎中K8S集群的命名空间。 工作负载名称 选择需要部署的无状态工作负载。 访问方式名称 选择与目标工作负载所绑定的service服务名称。 路由名称 选择与目标service服务所绑定的路由名称。 容器名称 选择需要部署的容器实例名。 镜像名称 选择需要部署的镜像。 镜像版本 选择需要部署的镜像版本。 开启灰度配置 灰度策略： Header Header-Key：支持输入自定义Header的键。 Header-Value：支持输入自定义Header的值，支持字符串及正则表达式，正则表达式格式为：^....$。 灰度流量权重（%）：支持流量自定义配置。 Cookie Cookie：支持输入自定义Cookie内容。 灰度流量权重（%）：支持流量自定义配置。 说明： Header与Cookie所输入的字符串长度最大为500。

拷贝文件 该步骤支持环境下主机内目录间的文件拷贝和跨主机间的文件拷贝，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 拷贝方式 主机内拷贝：用于一台主机内不同目录间的文件拷贝。 主机间拷贝：用于在不同主机之间进行文件拷贝。 环境 进行拷贝应用的主机所在环境。 目标环境 拷贝方式为“主机间拷贝”时，表示拷贝的目标环境。 注意： 当环境下有多个主机时，对目标环境下的所有主机执行拷贝操作。 拷贝文件 指定待拷贝文件的源路径和目标路径，均为绝对路径。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法 。 父主题： 配置CodeArts Deploy应用的文件操作类相关的部署步骤

解压文件 该步骤用于在主机上将压缩文件从主机上的一个路径解压到另外一个目录下，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 解压文件 指定待解压文件的路径和解压目录。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的文件操作类相关的部署步骤

启动/停止GO服务 该步骤可根据服务的指定路径进行启动、停止服务。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 服务操作类型 配置启动服务或者停止服务。 服务对应的绝对路径 GO服务的安装路径。 等待时间 等待服务启动的时间。当选择启动服务时，启动过程中会通过检测进程方式检测服务是否成功启动。可根据服务启动实际所需时间进行调整，如时间设置不合理，会导致检测结果无效。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 父主题： 配置CodeArts Deploy应用关于服务启动停止相关的部署步骤

步骤详情 表1 部署系统为云容器引擎的参数说明 参数 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 区域 ServiceStage部署的区域（region）。 部署系统 支持云容器引擎、弹性云服务器、弹性伸缩组三种部署系统。 应用名称 选择在ServiceStage中创建的应用。 技术栈 云容器引擎CCE支持Docker及其他技术栈。 组件名称 选择需要部署的组件。 组件版本 组件版本号用于ServiceStage中回滚历史版本。 环境名称 选择需要部署的环境。 集群选择 选择上述环境中需要部署的CCE集群。 命名空间选择 选择组件要部署到CCE集群中的命名空间。 实例数量 输入组件的实例数量。 镜像名称 选择需要部署的镜像（需要在 容器镜像服务 SWR上传所需的镜像）。 镜像版本 选择镜像的版本。 容器规格 规格选择： 默认：可选择系统提供的默认资源配置。 自定义：您可根据需要自行配置资源。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 表2 部署系统为弹性云服务器的参数说明 参数 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 区域 ServiceStage部署的区域（region）。 部署系统 支持云容器引擎、弹性云服务器、弹性伸缩组三种部署系统。 应用名称 选择在ServiceStage中创建的应用。 组件名称 选择需要部署的组件。 组件版本 组件版本号用于ServiceStage中回滚历史版本。 环境名称 选择需要部署的环境。 弹性云服务器选择 选择需要部署的弹性云服务器。 选择部署来源 制品仓库：选择制品仓库已有软件包。 对象存储服务 ：选择OBS上传的软件包。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 表3 部署系统为弹性伸缩组的参数说明 参数 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 区域 ServiceStage部署的区域（region）。 部署系统 支持云容器引擎、弹性云服务器、弹性伸缩组三种部署系统。 应用名称 选择在ServiceStage中创建的应用。 组件名称 选择需要部署的组件。 组件版本 组件版本号用于ServiceStage中回滚历史版本。 环境名称 选择需要部署的环境。 弹性伸缩组名称 选择需要部署的弹性伸缩组。 弹性伸缩组实例选择 选择需要部署的弹性伸缩组实例。 选择部署来源 制品仓库：选择制品仓库已有软件包。 对象存储服务：选择OBS上传的软件包。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。

安装PHP 添加该应用步骤可以在主机上安装PHP，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 php版本 php的版本。 php安装路径 php的安装路径。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的软件安装类部署步骤

ServiceStage组件部署 应用管理与运维平台（ServiceStage）是一个应用托管和微服务管理平台，将应用部署到ServiceStage上，可以帮助企业简化部署、监控、运维和治理等应用生命周期管理工作。为适配ServiceStge新特性，推出ServiceStage组件部署2.0插件，对于新应用，推荐使用ServiceStage组件部署2.0插件，ServiceStage组件部署插件仅存量应用使用，不再更新。 表1 部署系统为容器部署的参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 组件名称 部署的实例，将以servicestage组件的形式，部署在servicestage的default应用和default环境下。 组件版本 组件的版本号。 选择组件类型 目前支持：Web应用和ServiceComb应用。 运行环境 设置应用的运行环境。 部署系统 目前支持：虚机部署、容器部署。 集群选择 选择上述环境中需要部署的CCE集群。 命名空间选择 选择组件要部署到CCE集群中的命名空间。 实例数量 应用可以有一个或多个实例，您可以设置具体实例个数。 设置多个实例主要用于实现高可靠性，当某个实例故障时，应用还能正常运行。 资源配置 可选择容器的配置。 选择软件包 可以选择制品仓库已有软件包，也可以选择本地上传的软件包/文件。 说明：本地上传的软件包/文件会上传到制品仓库，可以重复使用。 负载均衡 选择已经创建的负载均衡，若不存在，请创建新的负载均衡，详细步骤参考创建增强型负载均衡器。 Java 探针 勾选探针会启用 应用性能管理 服务并在节点上安装探针，产生少量资源消耗。当勾选时，需要填写监控组。 控制项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 表2 部署系统为虚机部署的参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 组件名称 部署的实例，将以servicestage组件的形式，部署在servicestage的default应用和default环境下。 组件版本 组件的版本号。 选择组件类型 目前支持：Web应用和ServiceComb应用。 运行环境 设置应用的运行环境。 部署系统 目前支持：虚机部署、容器部署。 弹性伸缩组 新建应用所在的弹性伸缩组及伸缩实例，新建弹性伸缩组请参考创建弹性伸缩组。 实例数量 应用可以有一个或多个实例，您可以设置具体实例个数。 设置多个实例主要用于实现高可靠性，当某个实例故障时，应用还能正常运行。 选择软件包 可以选择制品仓库已有软件包，也可以选择本地上传的软件包/文件。 说明： 本地上传的软件包/文件会上传到制品仓库，可以重复使用。 负载均衡 选择已经创建的负载均衡，若不存在，请创建新的负载均衡，详细步骤参考创建增强型负载均衡器。 控制项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的容器类部署步骤

步骤详情 表1 参数说明 参数项 说明 步骤显示名称 该参数项为必填项。步骤显示名称添加后，会在部署步骤编排区显示该名称。 说明： 步骤名可包含汉字、大小写字母、数字、中划线、下划线、逗号、分号、冒点、/、圆括号（中英文）及空格，但不能以空格开头或结尾，长度为1-128。 Manifest文件来源 该参数项为必填。包括“制品仓库”、“代码仓库”和“obs”三种类型选择。 选择代码仓库 当Manifest文件来源选择“代码仓库”时，需填写该项。 该参数为必选。选择对应的代码仓库。 选择分支 当Manifest文件来源选择“代码仓库”时，需填写该项。 该参数为必选。选择对应的分支。 Manifest文件 该参数项为必填。 当Manifest文件来源选择“制品仓库”或“obs”时，选择需要部署的Manifest文件，这些文件必须以.yaml、.yml或.json为后缀。 单击按钮，可进入Manifest文件选择页面，选择制品仓库中需要部署的Manifest文件。其中，所属项目默认不可更改，可根据关键字进行Manifest搜索，也可先上传本地Manifest文件到仓库，单击按钮，刷新仓库的文件再选择。选择好Manifest文件后，单击按钮，结束Manifest文件选择。 当Manifest文件来源选择“代码仓库”时，填写以.yaml、.yml或.json为后缀的文件名称，单击按钮进行文件编辑。 部署租户 该参数项为必填。包括两个选择： 当前租户：表示将软件包部署到当前租户的CCE集群中发布。 选择“当前租户”，当前租户需要有CCE集群操作权限，如果当前没有CCE集群操作权限，可以通过下方的IAM授权选择已有权限的授权用户进行部署。 其他租户：表示通过IAM授权方式将软件包部署到其他租户的CCE集群中发布。 选择“其他租户”，则必须选择授权租户进行CCE集群部署。 说明： 推荐配置拥有CCE集群操作权限的子账号的AK/SK，不推荐配置租户账号的AK/SK。 IAM授权 该参数项为非必填。如果当前用户无操作权限执行接口时，可通过IAM授权获取到其他用户的临时AK/SK去执行CCE接口。 区域 选择要部署的区域。 集群名称 选择CCE云容器引擎中申请的K8S集群。 命名空间名称 选择CCE云容器引擎中K8S集群的命名空间。 JAVA探针 可协助您快速进行工作负载的问题定位与性能瓶颈分析，详情可参考性能管理配置（性能瓶颈分析） 。 探针类型： APM2.0探针：JAVA探针将分配 0.25 Core CPU 和 250 MiB 内存供初始化容器使用； 不启用：不启用探针问题定位； 当探针类型选择“APM2.0探针”时，需要填选以下信息。 探针版本：选择探针的版本； 探针升级策略：选择“重启自动升级”或“重启手动升级”； 重启自动升级：每次都尝试重新下载镜像。 重启手动升级：如果本地有该镜像，则使用本地镜像，本地不存在时下载镜像。 APM环境：填写APM环境信息（选填）； APM业务：选择已有的APM业务； 子业务：填写子业务（选填）； 接入密钥AK：将会自动获取APM服务的密钥信息，可前往APM控制台查看密钥详情。 关于APM2.0参数概念的详细说明，请参见APM参数说明。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 超时时间 指定该步骤最大执行时间，时间单位为分钟。在手动停止应用之前，执行时长大于超时时长，系统将该步骤设置为执行超时状态。取值范围：1-30 。

Manifest文件在线编辑 当“Manifest文件来源”为“代码仓库”时，将支持Manifest文件在线编辑功能，单击“Manifest文件”旁的图标，进入在线编辑界面。 修改代码托管中的Manifest文件需要具有相应的角色权限，请参考 代码托管服务 “仓库成员权限”章节。 单击图标，将对Manifest文件的内容进行基本的语法校验，便于您更好地优化代码。 单击图标，将对Manifest文件的内容进行基本的格式优化。 单击图标，将对Manifest文件的内容进行全量复制。 单击图标，将全屏展示Manifest文件的内容，便于您更好地浏览代码。

安装Python 添加该应用步骤可以在主机上安装Python，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 python版本 python的版本。 python安装路径 python的安装路径。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用的软件安装类部署步骤

使用执行shell脚本创建并部署通用应用 基于执行shell脚本实现通用的应用部署。 该模板涉及的部署步骤如下所示： 下载软件包 执行部署脚本 健康测试 该模板需要填写的参数如表1所示。 表1 模板参数说明 参数 说明 host_group 该应用部署的目标环境。 package_url 软件包下载地址，可前往制品仓库-软件发布库获取下载链接。 app_name 应用名称，用于获取进程ID并停止。 service_port 应用端口。 父主题： 使用预置模板新建并部署应用

启动/停止Node.js服务 添加该部署步骤可以在主机上根据指定的Node.js服务路径启动或者停止服务，信息配置如下所示。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 服务操作类型 配置启动服务或者停止服务。 服务对应的绝对路径 Node.js 服务的路径。 命令行参数 选填。 Node.js运行参数，即应用程序自己的参数。 当选择启动服务时，可以通过--参数方法, 设定Node.js服务监听端口等。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用关于服务启动停止相关的部署步骤

选择部署来源 选择软件包路径或者根据构建记录，将制品库中对应的软件包下载到目标环境中，信息配置如下所示。 表1 选择源类型为制品仓库的参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 选择源类型 包括“制品仓库”和“构建任务”两种类型。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 选择软件包 选择制品仓库中需要部署的软件包。 下载到主机的部署目录 软件包下载到目标主机的路径。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 表2 选择源类型为构建任务的参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 选择源类型 包括“制品仓库”和“构建任务”两种类型。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 请选择构建任务 目标构建任务，若无构建任务，请创建构建任务 。 制品过滤方式 包括“构建版本”和“构建分支”。 构建序号 目标构建序号。 下载到主机的部署目录 软件包下载到目标主机的路径。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法 。 父主题： 配置CodeArts Deploy应用其他的部署步骤

示例：通过shell命令步骤查看服务日志 应用部署完毕需要查看服务的启动或执行日志，可使用执行shell命令操作直接查看。 准备工作 您有查看服务启动或执行日志的权限。 需要确定服务启动日志的全路径。 以安装Tomcat服务为例： 服务启动日志的全路径：/usr/local/tomcat/apache-tomcat-8.5.38/logs/catalina.out 操作步骤 使用tail命令可查询服务的启动或执行日志。 在“执行shell命令”步骤详情中，执行以下命令可查询日志的最后20行，执行结果如下图所示。 tail -n 20 /usr/local/tomcat/apache-tomcat-8.5.38/logs/catalina.out 使用shell命令查看文件时尽量不要使用cat命令，如果日志文件过大可能会导致页面加载缓慢。禁止使用tail –f命令。 当执行的shell命令长度大于10240个字符时，建议使用“执行shell脚本”插件。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。

制品仓库使用案例 在应用步骤信息配置页面，“选择playbook来源”勾选“制品仓库”，单击“选择playbook文件”属性框右边的。 弹出“选择文件”对话框，选择对应的playbook文件压缩包，如下图所示。 填写playbook入口执行文件路径。 入口执行文件路径以选择的playbook压缩包解压后的目录为基准。 如果解压后的目录如下图所示，则入口执行文件路径为“AnsibleDemo/install.yml”。 如果解压后的目录如下图所示，则入口执行文件路径为“install.yml”。

代码仓库使用案例 在应用步骤信息配置页面，“选择playbook来源”勾选“代码仓库”。 单击“选择代码仓库”属性下拉框，选择对应的代码仓库对应的地址（即代码仓库存放playbook具体的SSHurl地址）。 需要先选择代码仓库，然后联动选择分支。 选择入口执行文件路径。 入口执行文件路径以解压playbook包后的目录为基准。 参数设置。 切换到“参数设置”页签，单击“新建参数”，可以为Ansible应用步骤增加参数或者替换all文件参数。 部署应用后，会把相应构建序号的构建任务下载到指定的路径下。 all文件的文件架构及内容样例如下： tomcat_url: http://mirror.olnevhost.net/pub/apache/tomcat/tomcat-7/v7.0.78/bin/apache-tomcat-7.0.78.tar.gz war_url: http://test.com/xxx.war 图1 文件架构 如果添加的参数在playbook参数all文件中存在，则会将all文件中的同名参数替换掉，否则会作为新增参数。 参数设置中参数名称不能包含英文状态的“.”（小数点）、“-”（中划线）和“:”（冒号）。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。

启动/停止Nginx 该步骤可通过指定环境下目标主机中Nginx服务路径，用于启动或者停止Nginx服务，信息配置如下所示。 表1 数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 操作类型 支持启动（nginx）、重载配置文件（reload）、快速停止（stop）、优雅停止（quit）四种操作类型。 Nginx安装的路径 目标环境中Nginx服务的安装路径。 是否在操作之前修改配置文件 根据是否修改目标主机中Nginx配置文件，启用或关闭该功能。 要修改的Nginx配置文件路径 目标主机中Nginx配置文件所在路径。 配置文件备份路径 目标主机中原Nginx配置文件备份目标路径。 配置文件内容 新配置文件内容。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 使用sudo权限执行：配置是否使用sudo权限部署该步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用关于服务启动停止相关的部署步骤

执行等待 该步骤用于控制前后步骤间的执行等待时间。 表1 参数说明 参数项 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 环境 选择当前资源类型为主机集群的环境，作为部署对象。 执行等待时间 前后步骤间的执行等待时间。 控制选项 配置是否启用该操作。 失败后继续运行：当前步骤部署失败后，应用是否继续部署后续的步骤。 若在部署过程中遇到问题，可参考该步骤的常见问题解决办法。 父主题： 配置CodeArts Deploy应用其他的部署步骤

操作步骤 选择目标应用，单击图标，单击“编辑”，进入“部署步骤”页面。 添加部署步骤： 单击已添加部署步骤上方或者下方的，页面右侧显示可添加的所有部署步骤，可在当前部署步骤前后添加新的部署步骤。 修改部署步骤详情： 单击目标部署步骤，在界面右侧修改部署步骤详情信息。 复制/删除/禁用部署步骤： 单击图标，单击“复制”，复制该部署步骤到当前应用下。 单击图标，单击“删除”，从当前应用中删除该部署步骤。 单击图标，单击“禁用”，在当前应用中禁用该部署步骤。 调整部署步骤执行顺序： 通过拖拉拽的方式，任意调整部署步骤的执行顺序。 修改完所有信息，单击“保存”，保存该应用。

ServiceStage组件回滚 针对部署到ServiceStage上的实例快照进行历史版本回滚。 回滚到某一版本后，该版本之后的实例均被覆盖清除。 表1 参数说明 参数 说明 步骤显示名称 步骤添加后在部署步骤显示的名称。仅支持汉字、英文字母、数字、空格、或-_,;:./()（）符号，其中空格不可在名称开头或结尾使用，长度为1-128。 选择区域 ServiceStage部署的区域（region）。 部署系统 支持云容器引擎、弹性云服务器、弹性伸缩组等多种部署系统。 应用名称 选择在ServiceStage中创建的应用。 组件名称 选择需要部署的组件。 环境名称 选择需要部署的环境。 组件实例 选择需要部署的组件实例。 实例快照 选择需要部署的版本快照。 控制选项 当前步骤部署失败后，应用是否继续部署后续的步骤。 父主题： 配置CodeArts Deploy应用的容器类部署步骤