DevSecOps 应用程序生命周期管理必选和可选变量
使用所需的变量为现成的体验创建工具链。 然后使用可选变量对工具链进行其他调整。
必需的输入变量
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
toolchain_name |
工具链名称的公共元素。 工具链名称将附加 CI Toolchain 或 CD Toolchain 或 CC Toolchain ,后跟时间戳记。 可以使用 ci_toolchain_name ,cd_toolchain_name 和 cc_toolchain_name 显式设置。 |
string |
DevSecOps |
toolchain_region |
缺省情况下用于所有资源创建和服务实例查找的区域标识。 可以在每个资源或服务的基础上覆盖此值。 请参阅 ci_toolchain_region ,cd_toolchain_region ,cc_toolchain_region ,ci_cluster_region ,cd_cluster_region 和 ci_registry_region 。 |
string |
us-south |
toolchain_resource_group |
缺省情况下用于所有资源创建和服务实例查找的资源组。 可以在每个资源或服务的基础上覆盖此值。 请参阅 ci_toolchain_resource_group ,cd_toolchain_resource_group ,cc_toolchain_resource_group 和 ci_cluster_resource_group 。 |
string |
Default |
registry_namespace |
IBM Cloud Container Registry 区域内的唯一命名空间,应用程序映像存储在该区域内。 | string |
"" |
cluster_name |
在其中部署应用程序的 Kubernetes 集群的名称。 这将为 CI 和 CD 工具链设置相同的集群。 请参阅 ci_cluster_name 和 cd_cluster_name 以设置不同的集群。 缺省情况下,CI 的集群名称空间设置为 dev ,CD 的集群名称空间设置为 prod 。 您可以使用 ci_cluster_namespace 和 cd_cluster_namespace 来更改这些设置。 |
string |
mycluster-free |
sm_location |
Secrets Manager 实例的区域位置。 这适用于 CI,CD 和 CC Secret Manager 集成。 请参阅 ci_sm_location ,cd_sm_location 和 cc_sm_location 以单独设置。 |
string |
us-south |
sm_name |
秘密管理器实例的名称。 这适用于 CI,CD 和 CC Secret Manager 集成。 请参阅 ci_sm_name ,cd_sm_name 和 cc_sm_name 以单独设置。 |
string |
sm-instance |
sm_resource_group |
包含 Secrets Manager 实例的资源组。 这适用于 CI,CD 和 CC Secret Manager 集成。 请参阅 ci_sm_resource_group ,cd_sm_resource_group 和 cc_sm_resource_group 以单独设置。 |
string |
Default |
sm_secret_group |
Secrets Manager 中用于组织/分组私钥的组。 这适用于 CI,CD 和 CC Secret Manager 集成。 请参阅 ci_sm_secret_group ,cd_sm_secret_group 和 cc_sm_secret_group 以单独设置。 |
string |
Default |
ibmcloud_api_key |
用于创建工具链的 API 密钥。 |
以 ci
,cd
和 cc
为前缀的变量适用于 CI,CD 和 CC 工具链。 非前缀变量适用于所有工具链。 此外,修改前缀变量输入的缺省值会导致前缀变量输入优先于非前缀变量输入。
可选输入变量
组级别变量
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
add_pipeline_definitions |
设置为 true 可添加管道定义。 |
string |
"true" |
cos_endpoint |
设置用于访问 COS 存储区的 Cloud Object Storage 端点。 此设置为 CI,CD 和 CC 工具链中的 COS 设置相同的端点。 请参阅 ci_cos_endpoint ,cd_cos_endpoint 和 cc_cos_endpoint 以单独设置端点。 |
string |
"" |
enable_slack |
设置为 true 以创建集成。 这需要有效的 slack_channel_name ,slack_team_name 和有效的 webhook (请参阅 slack_webhook_secret_name )。 此设置适用于 CI,CD 和 CC 工具链。 要单独启用 Slack,请参阅 ci_enable_slack ,cd_enable_slack 和 cc_enable_slack 。 |
bool |
false |
slack_channel_name |
向其发布通知的 Slack 通道。 这适用于 CI,CD 和 CC 工具链。 要单独设置,请参阅 ci_slack_channel_name ,cd_slack_channel_name 和 cc_slack_channel_name |
string |
my-channel |
slack_team_name |
Slack 团队名称,即团队 URL 中 .slack.com 前面的单词或短语。 这适用于 CI,CD 和 CC 工具链。 要单独设置,请参阅 ci_slack_team_name ,cd_slack_team_name 和 cc_slack_team_name 。 |
string |
my-team |
slack_webhook_secret_name |
私钥提供程序中 Slack 的 Webhook 私钥的名称。 这适用于 CI,CD 和 CC 工具链。 要单独设置,请参阅 ci_slack_webhook_secret_name ,cd_slack_webhook_secret_name 和 cc_slack_webhook_secret_name 。 |
string |
slack-webhook |
slack_notifications |
创建 Slack 集成时将自动启用此功能。 交换机将覆盖 Slack 通知。 将 1 设置为 on,将 0 设置为 off。 这适用于 CI,CD 和 CC 工具链。 要单独设置,请参阅 ci_slack_notifications ,cd_slack_notifications 和 cc_slack_notifications 。 |
string |
"" |
authorization_policy_creation |
禁用工具链服务以创建 Secrets Manager 服务授权策略。 要禁用,请将值设置为 disabled 。 这适用于 CI,CD 和 CC 工具链。 要单独设置,请参阅 ci_authorization_policy_creation ,cd_authorization_policy_creation 和 cc_authorization_policy_creation 。 |
string |
"" |
repo_group |
为应用程序指定 Git 用户或组。 如果存储库认证类型为 pat (个人访问令牌),那么必须设置此项。 |
string |
"" |
repo_secret_group |
Secrets Manager 中包含存储库私钥的私钥组。 此变量为所有存储库设置相同的密钥组。 可以根据每个私钥组对其进行覆盖。 仅在使用 Secrets Manager时适用。 | string |
"" |
repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 为 Git 令牌指定私钥名称会自动将认证类型设置为 pat 。 |
string |
"" |
repo_git_token_secret_value |
个人访问令牌,将被添加到秘密提供程序中的 repo_git_token_secret_name 秘密中。 |
string |
"" |
compliance_base_image |
用于运行大部分内置管道代码的管道基本映像。 适用于 CI,CD 和 CC 工具链管道。 | string |
"" |
compliance_pipeline_branch |
合规性管道分支。 | string |
"open-v9" |
compliance_pipeline_existing_repo_url |
现有合规管道存储库的 URL。 | string |
"" |
compliance_pipeline_repo_blind_connection |
将此值设置为 true 意味着服务器无法在公共互联网上寻址。 IBM Cloud无法验证您提供的连接详细信息。 某些需要通过 API 访问 git 服务器的功能将被禁用。 交付管道只能使用可通过网络访问 git 服务器的私有 Worker 才能运行。 |
string |
"" |
compliance_pipeline_repo_git_id |
将此值设为 github ( github.com )或自定义 GitHub Enterprise服务器的 ID。 |
string |
"" |
compliance_pipeline_repo_git_provider |
合规管道 repo 的 Git 提供商。 如果未设置,将默认为 hostedgit 。 |
string |
"" |
compliance_pipeline_repo_name |
如果克隆,设置合规管道仓库的名称。 预期行为是链接到现有的合规管道资源库。 | string |
"" |
compliance_pipeline_repo_root_url |
(可选)服务器的根 URL,如 https://git.example.com。 | string |
"" |
compliance_pipeline_repo_title |
(可选)服务器的标题,如 My Git Enterprise Server。 | string |
"" |
compliance_pipeline_repo_use_group_settings |
设为 true 可将组级版本库设置应用到合规管道版本库。 请参见 repo_git_provider 。 |
bool |
false |
compliance_pipeline_source_repo_url |
要克隆的合规管道版本库的 URL。 | string |
"" |
cos_api_key_secret_value |
用户提供的具有 COS 访问权限的 api 密钥可推送到 Secrets Manager。 见 cos_api_key_secret_name 和 create_cos_api_key 。 |
string |
"" |
cos_bucket_name |
设置 COS 存储区的名称。 这将对 CI,CD 和 CC 工具链应用相同的 COS 存储区名称。 | string |
"" |
cos_instance_crn |
Cloud Object Storage 实例的 CRN,其中包含所需的存储桶。 创建 IAM 服务凭证时,需要此值来生成正确的访问策略。 | string |
"" |
create_access_group |
设置为 true 可为 DevSecOps 工具链的操作创建一个访问组。 |
bool |
false |
create_code_engine_access_policy |
为生成的 IAM 访问密钥添加 Code Engine 访问策略。 请参阅 create_ibmcloud_api_key 。 |
bool |
true |
create_git_token |
设为 true 可创建指定的个人访问令牌密文并将其添加到密文提供程序。 使用 repo_git_token_secret_value 设置数值。 |
bool |
false |
create_git_triggers |
设置为 true 可创建与合规性软件仓库和示例应用程序相关联的默认 Git 触发器。 |
string |
"true" |
create_kubernetes_access_policy |
为生成的 IAM 访问密钥添加 Kubernetes 访问策略。 请参阅 create_ibmcloud_api_key 。 |
bool |
true |
create_privateworker_secret |
设置为 true 可将指定的私有 Worker 服务 api 密钥添加到秘密提供程序。 |
bool |
false |
create_signing_key |
设置为 true 可创建并添加 signing-key 和 signing-certificate 到秘密提供者。 |
bool |
false |
create_triggers |
设置为 true 可创建与合规性软件仓库和示例应用程序相关的默认触发器。 |
string |
"true" |
enable_privateworker |
设置为 true 以启用 CI、CD、CC 和 PR 管道的私人工人。 必须在 Secrets Manager 中设置有效的服务 api 密钥。 可以使用 privateworker_credentials_secret_name 指定该秘密的名称。 |
string |
"false" |
rotate_signing_key |
设置为 true 可旋转签名密钥和签名证书。 备份当前代码签名证书非常重要,因为待部署的 CD 可能需要根据以前的签名密钥进行映像验证。 |
bool |
false |
event_notifications_crn |
设置 Event Notifications CRN 以创建 Event Notifications 集成。 此参数适用于 CI,CD 和 CC 工具链。 | string |
"" |
force_create_standard_api_key |
设置为 true 可强制创建标准 api 密钥。 默认情况下,生成的 api 密钥将是服务 api 密钥。 在使用服务 api 密钥运行管道时,必须使用 Git 令牌。 详情请见 repo_git_token_secret_name 。 另一种方法是将 force_create_standard_api_key 设置为 true ,以创建标准 api 密钥。 |
bool |
false |
gosec_private_repository_host |
您的私有资源库基础 URL。 | string |
"" |
gosec_repo_ssh_key_secret_group |
gosec 专用存储库 SSH 密钥的密钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
gosec_repo_ssh_key_secret_name |
私钥提供程序中专用存储库的 SSH 密钥令牌的名称。 | string |
"git-ssh-key" |
ibmcloud_api |
T 环境 URL。 未设置时,默认值为 https://cloud.ibm.com |
string |
"" |
opt_in_gosec |
启用 gosec 扫描 | string |
"" |
pipeline_git_tag |
合规性管道的管道定义存储库中的 Git 标记。 | string |
"" |
sm_instance_crn |
除非单独设置,否则 Secrets Manager 实例的 CRN 将应用于 CI,CD 和 CC 工具链。 | string |
"" |
cos_api_key_secret_crn |
Cloud Object Storage apikey 的 CRN。 | string |
"" |
event_notifications_crn |
设置 Event Notifications CRN 以创建事件通知集成。 该参数适用于 CI、CD 和 CC 工具链。 | string |
"" |
gosec_private_repository_ssh_key_secret_crn |
GoSec 存储库私钥的 CRN。 | string |
"" |
pipeline_doi_api_key_secret_crn |
管道 DOI API 密钥的 CRN。 | string |
"" |
pipeline_ibmcloud_api_key_secret_crn |
IBMCloud apikey 的 CRN。 | string |
"" |
pipeline_ibmcloud_api_key_secret_value |
用户提供的 api 密钥,用于运行可推送至 Secrets Manager 的工具链管道。 见 pipeline_ibmcloud_api_key_secret_name 和 create_ibmcloud_api_key 。 |
string |
"" |
pipeline_config_repo_git_id |
将此值设为 github ( github.com )或自定义 GitHub Enterprise服务器的 GUID。 |
string |
"" |
pipeline_config_repo_git_provider |
管道仓库配置的 Git 提供商 | string |
"" |
privateworker_credentials_secret_crn |
私人工人秘密的 CRN。 | string |
"" |
privateworker_credentials_secret_group |
专用 Worker 密文的密文组前缀。 如果未设置,则默认使用 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
privateworker_credentials_secret_name |
秘密提供者中的私人工作者秘密名称。 | string |
"" |
privateworker_name |
私营工人工具集成的名称。 | string |
"private-worker-tool-01" |
privateworker_secret_value |
私人 Worker 服务 api 密钥,将添加到秘密提供程序中的 privateworker_credentials_secret_name secret 中。 |
string |
"" |
repo_apply_settings_to_compliance_repos |
设置为 true 可将相同设置应用于所有默认合规性存储库。 设置为 false 可将这些设置仅应用于示例应用程序、管道配置和部署存储库。 |
bool |
true |
repo_blind_connection |
将此值设置为 true 意味着服务器无法在公共互联网上寻址。 IBM Cloud无法验证您提供的连接详细信息。 某些需要通过 API 访问 git 服务器的功能将被禁用。 交付管道只能使用可通过网络访问 git 服务器的私有 Worker 才能运行。 |
bool |
false |
repo_git_id |
合规版本库的 Git ID。 | string |
"" |
repo_git_provider |
Git 提供商类型。 | string |
"" |
repo_git_token_secret_crn |
存储库 Git 令牌的 CRN。 | string |
"" |
repo_root_url |
(可选)服务器的根 URL,如 https://git.example.com。 | string |
"" |
repo_title |
(可选)服务器的标题,如 My Git Enterprise Server。 | string |
"" |
scc_instance_crn |
Security and Compliance Center 服务实例 CRN (云资源名称)。 仅当启用了 scc_use_profile_attachment 参数时,此参数才相关。 该值必须与正则表达式匹配。 |
string |
"" |
scc_scc_api_key_secret_crn |
SCC API 密钥的 CRN。 | string |
"" |
slack_webhook_secret_crn |
Slack Webhook 私钥的 CRN。 | string |
"" |
sonarqube_secret_crn |
SonarQube 私钥的 CRN。 | string |
"" |
scc_attachment_id |
附件标识。 在概要文件下配置附件以定义扫描的运行方式。 要查找附件标识,请在浏览器的附件列表中单击附件链接,并显示可用于复制附件标识的面板。 仅当启用了 scc_use_profile_attachment 参数时,此参数才相关。 |
string |
"" |
scc_instance_crn |
Security and Compliance Center 服务实例 CRN (云资源名称)。 仅当启用了 scc_use_profile_attachment 参数时,此参数才相关。 该值必须与正则表达式匹配。 |
string |
"" |
scc_profile_name |
Security and Compliance Center 概要文件的名称。 使用包含 DevSecOps 工具链规则的 IBM Cloud for Financial Services 配置文件,或使用配置为包含这些规则的用户自定义配置文件。 仅当启用了 scc_use_profile_attachment 参数时,此参数才相关。 |
string |
"" |
scc_profile_version |
Security and Compliance Center 概要文件的版本,采用 SemVer 格式,例如 0.0.0 。 仅当启用了 scc_use_profile_attachment 参数时,此参数才相关。 |
string |
"" |
scc_scc_api_key_secret_name |
密钥提供程序中的 Security and Compliance Center API 密钥密钥。 | string |
"scc-api-key" |
scc_scc_api_key_secret_group |
安全与合规性工具私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
scc_use_profile_attachment |
设置为 enabled 以启用带有附件的概要文件,以便管道中的脚本可以与 Security and Compliance Center 服务进行交互。 启用后,其他参数将变得相关; scc_scc_scc_api_key_secret_name ,scc_instance_crn ,scc_profile_name ,scc_profile_version 和 scc_attachment_id 。 |
string |
"disabled" |
toolchain_access_group_name |
DevSecOps 访问组的名称。 请参阅 create_access_group 。 |
string |
"devsecops-toolchain" |
use_legacy_ref |
设置为 true ,则 Secrets Manager 秘密将使用传统秘密参考格式。 |
bool |
true |
工具链创建变量
以下变量确定要创建的工具链。 默认情况下,三者都设置为 true
,这将创建 DevSecOps CI、CD 和 CC 工具链。 可以创建这三个工具链的任意组合。
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
create_ci_toolchain |
决定是否创建 DevSecOps CI 工具链。 如果未创建此工具链,那么必须为以下变量设置值: evidence_repo_existing_url ,issues_repo_existing_url 和 inventory_repo_existing_url 。 |
bool |
true |
create_cd_toolchain |
布尔标志,用于确定是否创建 DevSecOps CD 工具链。 | bool |
true |
create_cc_toolchain |
布尔标志,用于确定是否创建 DevSecOps CC 工具链。 | bool |
true |
合规性存储库
如果未创建 CI 工具链,那么必须设置以下变量。
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
evidence_repo_existing_url |
用于克隆合规性-证据-锁定器的模板库,以参考 DevSecOps 工具链模板。 | string |
"" |
issues_repo_existing_url |
用于克隆 compliance-issues 参考 DevSecOps 工具链模板的模板库。 |
string |
"" |
inventory_repo_existing_url |
用于克隆合规性-目录的模板库,以参考 DevSecOps 工具链模板。 | string |
"" |
自带代码
DevSecOps 工具链的默认体验是使用示例应用程序。 可以更新此缺省值,以便为您自己的应用程序存储库创建集成,此集成可以设置为克隆现有存储库或使用现有存储库。 设置以下变量以克隆或使用现有存储库:
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
ci_app_repo_clone_from_branch |
在提供 app_repo_clone_from_url 时使用,这是 CI 构建所使用的缺省分支,通常为 main 或 master 。 |
string |
"" |
ci_app_repo_clone_from_url |
通过提供自己的示例应用程序 URL 来覆盖默认示例应用程序,并将其克隆到应用程序 repo 中。 如果应用程序存储库存在,请使用 clone_if_not_exists 使存储库内容保持不变。 |
string |
"" |
ci_app_repo_clone_to_git_id |
缺省情况下不存在,否则请对浏览器 UI 中的 git_id 字段使用定制服务器 GUID 或其他选项。 |
string |
"" |
ci_app_repo_clone_to_git_provider |
缺省情况下为 hostedgit ,否则使用 githubconsolidated 或 gitlab 。 |
string |
"" |
ci_app_repo_existing_branch |
在提供 app_repo_existing_url 时使用,这是 CI 构建所使用的缺省分支,通常为 main 或 master 。 |
string |
"" |
ci_app_repo_existing_git_id |
缺省情况下不存在,否则请对浏览器 UI 中的 git_id 字段使用定制服务器 GUID 或其他选项。 |
string |
"" |
ci_app_repo_existing_git_provider |
缺省情况下为 hostedgit ,否则使用 githubconsolidated 或 gitlab 。 |
string |
"" |
ci_app_repo_existing_url |
覆盖,以引入自己现有的应用程序版本库 URL,直接使用该 URL 而不是克隆默认示例。 | string |
"" |
要在 github.ibm.com中使用现有应用程序,请使用以下示例设置:
名称 | 值 |
---|---|
ci_app_repo_existing_url |
"https://github.ibm.com/{my-org}/{my-repo}.git" |
ci_app_repo_existing_branch |
"main" |
ci_app_repo_existing_git_provider |
"githubconsolidated" |
ci_app_repo_existing_git_id |
"integrated" |
密钥
要运行所有工具链,您至少需要以下私钥:
- 用于运行工具链的 API 密钥。
- 用于对 CI 工具链中的图像进行签名的 GPG 密钥。
默认情况下,DevSecOps 工具链希望秘密位于 Secrets Manager 中。 API 密钥必须与 ibmcloud-api-key
条目以及存储在 signing_key
下的签名密钥一起存储。
要为 DevSecOps 工具链创建 API 密钥,请参阅 IBM Cloud® API 密钥,并查看 IAM 访问权限。 仅当您在其他某个帐户中运行工具链时,IAM 访问许可权才相关。 请勿将用于运行工具链的
API 密钥与称为 ibmcloud_api_key
的 API 密钥混淆,这是设置工具链所需的其中一个输入。
ibmcloud-api-key
和 signing_key
是私钥保险库中期望的私钥的缺省名称。 可以更改这些缺省名称。 详见下表:
名称 | 描述 | 值 |
---|---|---|
ci_ibmcloud_api_key_secret_name |
密钥提供程序中的 IBM Cloud® API 密钥的名称。 | "ibmcloud-api-key" |
cd_ibmcloud_api_key_secret_name |
密钥提供程序中的 IBM Cloud® API 密钥的名称。 | "ibmcloud-api-key" |
cc_ibmcloud_api_key_secret_name |
密钥提供程序中的 IBM Cloud® API 密钥的名称。 | "ibmcloud-api-key" |
ci_signing_key_secret_name |
密钥提供程序中签名密钥的名称。 | "signing_key" |
要获取更多私钥名称,请在变量列表中搜索 "secret_name"。
IBM® Key Protect
Secrets Manager 是 DevSecOps 工具链的默认秘密提供程序。 但是,可以改为使用 Key Protect。 为 Key Protect设置以下变量。 这些变量适用于创建的所有 DevSecOps 工具链中的 Key Protect 集成。
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
kp_name |
存储私钥的 Key Protect 实例的名称。 | string |
"kp-compliance-secrets" |
kp_location |
IBM Cloud® 包含 Key Protect 实例的位置或区域。 | string |
"us-south" |
kp_resource_group |
包含私钥的 Key Protect 实例的资源组。 | string |
"Default" |
或者,可以使用变量的前缀形式在各个工具链中设置 Key Protect 集成设置:
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
ci_kp_name |
存储私钥的 Key Protect 实例的名称。 | string |
"" |
ci_kp_location |
IBM Cloud® 包含 Key Protect 实例的位置或区域。 | string |
"" |
ci_kp_resource_group |
包含 Key Protect 实例的资源组。 | string |
"" |
cd_kp_name |
存储私钥的 Key Protect 实例的名称。 | string |
"" |
cd_kp_location |
IBM Cloud® 包含 Key Protect 实例的位置或区域。 | string |
"" |
cd_kp_resource_group |
包含私钥的 Key Protect 实例的资源组。 | string |
"" |
cc_kp_name |
存储私钥的 Key Protect 实例的名称。 | string |
"" |
cc_kp_location |
IBM Cloud® 包含 Key Protect 实例的位置或区域。 | string |
"" |
cc_kp_resource_group |
包含私钥的 Key Protect 实例的资源组。 | string |
"" |
在密钥提供程序之间切换
Secrets Manager 是工具链的缺省提供程序。 使用以下变量在每个工具链的 Key Protect 和 Secrets Manager 之间进行切换。
可以在所有工具链之间切换私钥提供程序。
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
enable_key_protect |
启用 Key Protect 集成。 | bool |
false |
enable_secrets_manager |
启用 Secrets Manager 集成。 | bool |
true |
或者,您可以为不同的工具链分别切换私钥提供程序。 缺省情况下,私钥提供程序的特定于工具链的变量缺省值 (如表 10 中所概述) 设置为 false
。 变量分组在 Key Protect 和 Secrets Manager下。 如果该组中的任何变量更改为缺省值,那么该组中的所有变量都将采用前值。
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
ci_enable_key_protect |
启用 Key Protect 集成。 | bool |
false |
cd_enable_key_protect |
使用 Key Protect 集成。 | bool |
false |
cc_enable_key_protect |
启用 Key Protect 集成。 | bool |
false |
ci_enable_secrets_manager |
启用 Secrets Manager 集成。 | bool |
false |
cd_enable_secrets_manager |
使用 Secrets Manager 集成。 | bool |
false |
cc_enable_secrets_manager |
启用 Secrets Manager 集成。 | bool |
false |
将这些变量设置为 true
以使用 Key Protect 集成而不是 Secrets Manager。 另外,在此情况下,请将 Secrets Manager 值设置为 false
,以便不会在工具链中创建不必要的集成。
可选 CI,CD 和 CC 变量
如果要使用代码引擎进行部署,请参阅 可选 Code Engine CI 和 CD 变量
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
deployment_repo_url |
用于克隆部署 DevSecOps 工具链模板的版本库。 | string |
"" |
ibmcloud_api |
IBM Cloud® API 端点。 | string |
"https://cloud.ibm.com" |
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
ci_app_group |
为应用程序指定 Git 用户或组。 | string |
"" |
ci_app_name |
应用程序映像和库存条目的名称。 | string |
"hello-compliance-app" |
ci_app_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_app_repo_git_token_secret_crn |
应用程序存储库 Git 令牌的 CRN。 | string |
"" |
ci_app_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_app_version |
要部署的应用程序版本。 | string |
"v1" |
ci_authorization_policy_creation |
禁用工具链服务以创建 Secrets Manager 服务授权策略。 | string |
"" |
ci_cluster_name |
在其中部署应用程序的 Kubernetes 集群的名称。 集群可以是用于生产的集群。 | string |
"mycluster-free" |
ci_cluster_namespace |
在其中部署应用程序的 Kubernetes 集群名称空间的名称。 | string |
"dev" |
ci_compliance_base_image |
用于运行大部分内置管道代码的管道基本映像。 | string |
"" |
ci_compliance_pipeline_branch |
CI 管道合规性管道分支。 | string |
"" |
ci_compliance_pipeline_pr_branch |
PR 管道合规性管道分支。 | string |
"" |
ci_compliance_pipeline_group |
指定合规性 pipline 存储库的用户或组。 | string |
"" |
ci_compliance_pipeline_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_compliance_pipeline_repo_git_token_secret_crn |
合规性管道存储库 Git 令牌的 CRN。 | string |
"" |
ci_compliance_pipeline_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_cos_api_key_secret_crn |
Cloud Object Storage apikey 的 CRN。 | string |
"" |
ci_cos_api_key_secret_name |
私钥提供程序中 Cloud Object Storage API 密钥私钥的名称。 | string |
"" |
ci_cos_endpoint |
Cloud Object Storage 端点名称。 | string |
"" |
ci_cra_bom_generate |
将此标记设置为 1 可在 CI 管道中生成 cra bom。 |
string |
"1" |
ci_cra_deploy_analysis |
将此标记设置为 1 以进行 cra 部署分析。 |
string |
"1" |
ci_cra_generate_cyclonedx_format |
如果设置为 1,那么 CRA 还会以 cyclonedx 格式生成 BOM (缺省为 1)。 | string |
"1" |
ci_cra_vulnerability_scan |
将此标记设置为 1 和 ci-cra-bom-generate 至 1 用于 CI 管道中的漏洞扫描。 如果该值设置为 1,且 ci-cra-bom-generate 设置为 0 ,则扫描将被标记为 failure |
string |
"1" |
pr_cra_bom_generate |
将此标记设为 1 时,将在 CC 管道中生成 cra bom。 |
string |
"1" |
pr_cra_deploy_analysis |
将此标记设置为 1 以进行 cra 部署分析。 |
string |
"1" |
pr_cra_vulnerability_scan |
将此标记设置为 1 和 pr-cra-bom-generate 至 1 用于 CI 管道中的漏洞扫描。 如果该值设置为 1,且 pr-cra-bom-generate 设置为 0 ,则扫描将被标记为 failure |
string |
"1" |
ci_custom_image_tag |
以逗号分隔的列表中图像的定制标记。 | string |
"" |
ci_deployment_target |
部署目标,集群或代码引擎。 | string |
"cluster" |
ci_dev_region |
部署应用程序的 Kubernetes 集群的区域。 | string |
"ibm:yp:us-south" |
ci_dev_resource_group |
集群资源组。 | string |
"Default" |
ci_doi_environment |
DevOps Insights 目标环境。 | string |
"" |
ci_doi_toolchain_id |
要链接到的 DevOps Insights 工具链标识。 | string |
"" |
ci_doi_toolchain_id_pipeline_property |
DevOps Insights 实例工具链标识。 | string |
"" |
ci_enable_pipeline_dockerconfigjson |
将 pipeline-dockerconfigjson 属性添加到管道属性。 |
bool |
false |
ci_enable_slack |
设置为 true 以创建集成。 |
bool |
false |
ci_enable_pipeline_notifications |
启用后,管道运行事件将发送到外层工具链中的 Event Notifications 和 Slack 集成。 | bool |
false |
ci_event_notifications |
要启用事件通知,请将 event_notifications 设置为 1 | string |
"0" |
ci_evidence_group |
为证据存储库指定 Git 用户或组。 | string |
"" |
ci_evidence_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_evidence_repo_git_token_secret_crn |
证据存储库 Git 令牌的 CRN。 | string |
"" |
ci_evidence_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_gosec_private_repository_host |
您的私有资源库基础 URL。 | string |
"" |
ci_gosec_private_repository_ssh_key_secret_crn |
GoSec 存储库私钥的 CRN。 | string |
"" |
ci_gosec_repo_ssh_key_secret_group |
gosec 专用存储库 SSH 密钥的密钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_gosec_repo_ssh_key_secret_name |
私钥提供程序中专用存储库的 SSH 密钥令牌的名称。 | string |
"git-ssh-key" |
ci_inventory_group |
指定库存存储库的 Git 用户或组。 | string |
"" |
ci_inventory_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_inventory_repo_git_token_secret_crn |
库存存储库 Git 令牌的 CRN。 | string |
"" |
ci_inventory_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_issues_group |
为问题存储库指定 Git 用户或组。 | string |
"" |
ci_issues_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_issues_repo_git_token_secret_crn |
问题存储库 Git 令牌的 CRN。 | string |
"" |
ci_issues_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_link_to_doi_toolchain |
在另一个工具链中启用指向 DevOps Insights 实例的链接。 | bool |
false |
ci_opt_in_dynamic_api_scan |
启用 OWASP Zap API 扫描。1 启用或 0 禁用。 |
string |
"1" |
ci_opt_in_dynamic_scan |
启用 OWASP Zap 扫描。1 启用或 0 禁用。 |
string |
"1" |
ci_opt_in_dynamic_ui_scan |
启用 OWASP Zap UI 扫描。1 启用或 0 禁用。 |
string |
"1" |
ci_opt_in_gosec |
启用 gosec 扫描 | string |
"" |
ci_opt_in_sonar |
选择 SonarQube。 | string |
"1" |
ci_pipeline_config_group |
指定管道配置存储库的用户或组。 | string |
"" |
ci_pipeline_config_path |
管道配置存储库中 pipeline-config.yaml 文件的名称和路径。 |
string |
".pipeline-config.yaml" |
ci_pipeline_config_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
ci_pipeline_config_repo_branch |
指定包含定制 pipeline-config.yaml 文件的分支。 |
string |
"" |
ci_pipeline_config_repo_clone_from_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 |
string |
"" |
ci_pipeline_config_repo_existing_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 |
string |
"" |
ci_pipeline_config_repo_git_token_secret_crn |
管道配置存储库 Git 令牌的 CRN。 | string |
"" |
ci_pipeline_config_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
ci_pipeline_debug |
缺省情况下为 0 。 设置为 1 以启用调试日志记录。 |
string |
"0" |
ci_pipeline_dockerconfigjson_secret_crn |
Dockerconfig JSON 密钥的 CRN。 | string |
"" |
ci_pipeline_dockerconfigjson_secret_name |
私钥提供程序中管道 Docker 配置 JSON 私钥的名称。 | string |
"pipeline_dockerconfigjson_secret_name" |
ci_pipeline_git_tag |
合规性 CI 管道的管道定义存储库中的 GIT 标记。 | string |
"" |
pr_pipeline_git_tag |
“合规性 PR 管道”的管道定义存储库中的 GIT 标记。 | string |
"" |
ci_pipeline_git_token_secret_crn |
Git 令牌管道属性的 CRN。 | string |
"" |
ci_pipeline_ibmcloud_api_key_secret_crn |
IBMCloud apikey 的 CRN。 | string |
"" |
ci_pipeline_ibmcloud_api_key_secret_name |
私钥提供者中的 Cloud API 密钥私钥的名称。 | string |
"ibmcloud-api-key" |
ci_print_code_signing_certificate |
设置为 1 以允许在日志中打印公用签名证书。 |
string |
"1" |
ci_registry_namespace |
IBM Cloud® Container Registry 区域中存储应用程序映像的唯一名称空间。 | string |
"" |
ci_registry_region |
要在其中创建 IBM Cloud® Container Registry 名称空间的 IBM Cloud® 区域。 | string |
"ibm:yp:us-south" |
ci_repositories_prefix |
克隆的合规性存储库的前缀名称。 对于 repositories_prefix 值,只允许使用 a-z、A-Z 和 0-9 以及特殊字符 -_ 。 此外,字符串不得以特殊字符结尾,也不得有两个连续的特殊字符。 |
string |
"compliance" |
ci_repository_properties |
包含在 CI 工具链管道中创建的版本库和触发器的 JSON 字符串。 | string |
"" |
ci_signing_key_secret_crn |
签名密钥密钥的 CRN。 | string |
"" |
ci_signing_key_secret_name |
密钥提供程序中签名密钥的名称。 | string |
"signing_key" |
ci_slack_channel_name |
向其发布通知的 Slack 通道。 | string |
"" |
ci_slack_notifications |
打开或关闭 Slack 集成的交换机。 | string |
"0" |
ci_slack_pipeline_fail |
生成管道失败通知。 | bool |
true |
ci_slack_pipeline_start |
生成管道启动通知。 | bool |
true |
ci_slack_pipeline_success |
生成管道成功通知。 | bool |
true |
ci_slack_team_name |
Slack 团队名称,即团队 URL 中 slack.com 前面的单词或短语。 | string |
"" |
ci_slack_toolchain_bind |
生成添加到工具链通知的工具。 | bool |
true |
ci_slack_toolchain_unbind |
生成从工具链通知中除去的工具。 | bool |
true |
ci_slack_webhook_secret_name |
私钥提供程序中的 Webhook 私钥的名称。 | string |
"" |
ci_sm_instance_crn |
CI 工具链的 Secrets Manager 实例的 CRN。 | string |
"" |
ci_sm_location |
IBM Cloud® 包含 Secrets Manager 实例的位置或区域。 | string |
"" |
ci_sm_name |
存储私钥的 Secrets Manager 实例的名称。 | string |
"" |
ci_sm_resource_group |
包含 Secrets Manager 实例的资源组。 | string |
"" |
ci_sm_secret_group |
Secrets Manager 中用于组织或分组私钥的组。 | string |
"" |
ci_sonarqube_config |
在隔离的 Docker-Docker 容器 (缺省配置) 或现有 Kubernetes 集群 (定制配置) 中运行 SonarQube 扫描。 选项: 缺省或定制。 缺省值为 default。 | string |
"default" |
ci_sonarqube_secret_crn |
SonarQube 私钥的 CRN。 | string |
"" |
ci_sonarqube_secret_name |
SonarQube 秘密的名称。 | string |
"sonarqube-secret" |
ci_toolchain_description |
CI 工具链的描述。 | string |
"Toolchain created with terraform template for DevSecOps CI Best Practices." |
ci_toolchain_name |
CI 工具链的名称。 | string |
"DevSecOps CI Toolchain - Terraform" |
ci_toolchain_region |
包含 CI 工具链的区域。 | string |
"" |
ci_toolchain_resource_group |
在其中创建工具链的资源组。 | string |
"" |
ci_trigger_git_name |
CI 管道 GIT 触发器的名称。 | string |
"Git CI Trigger" |
ci_trigger_git_enable |
设置为 true 以启用 CI 管道 Git 触发器。 |
bool |
true |
ci_trigger_timed_name |
CI 管道计时触发器的名称。 | string |
"Git CI Timed Trigger" |
ci_trigger_timed_enable |
设置为 true 以启用 CI 管道计时触发器。 |
bool |
false |
ci_trigger_timed_cron_schedule |
仅需要计时器触发器。 用于指示此触发器何时激活的 cron 表达式。 最大频率为每 5 分钟。 该字符串基于 UNIX crontab 语法 :minute,hour,day of month,month,day of week。 示例: 0 * _/2 * * *-每 2 小时。 | string |
"0 4 * * *" |
ci_trigger_manual_name |
CI 管道手动触发器的名称。 | string |
"Manual Trigger" |
ci_trigger_manual_enable |
设置为 true 以启用 CI 管道手动触发器。 |
bool |
true |
ci_trigger_pr_git_name |
PR 管道 GIT 触发器的名称。 | string |
"Git PR Trigger" |
ci_trigger_pr_git_enable |
设置为 true 以启用 PR 管道 Git 触发器。 |
bool |
true |
ci_trigger_manual_pruner_name |
手动 Pruner 触发器的名称。 | string |
"Evidence Pruner Manual Trigger" |
ci_trigger_manual_pruner_enable |
设置为 true 以启用手动 Pruner 触发器。 |
bool |
true |
ci_trigger_timed_pruner_name |
定时 Pruner 触发器的名称。 | string |
"Evidence Pruner Timed Trigger" |
ci_trigger_timed_pruner_enable |
设置为 true 以启用定时 Pruner 触发器。 |
bool |
false |
ci_pipeline_ibmcloud_api_key_secret_group |
管道 ibmcloud API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_signing_key_secret_group |
签名密钥密钥的密钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_cos_api_key_secret_group |
Cloud Object Storage API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_slack_webhook_secret_crn |
Slack Webhook 私钥的 CRN。 | string |
"" |
ci_slack_webhook_secret_group |
Slack Webhook 私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_pipeline_dockerconfigjson_secret_group |
管道 DockerConfigJson 秘密的组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_pipeline_git_token_secret_group |
管道 Git 令牌私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_app_repo_secret_group |
应用存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_issues_repo_secret_group |
Issues 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_inventory_repo_secret_group |
库存存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_evidence_repo_secret_group |
证据存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_compliance_pipeline_repo_secret_group |
Compliance Pipeline 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_pipeline_config_repo_secret_group |
管道配置存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
ci_pipeline_git_token_secret_name |
私钥提供程序中管道 Git 令牌私钥的名称。 | string |
"pipeline-git-token" |
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
cd_app_version |
要部署的应用程序版本。 | string |
"v1" |
cd_authorization_policy_creation |
禁用工具链服务以创建 Secrets Manager 服务授权策略。 | string |
"" |
cd_change_management_group |
指定变更管理存储库的组。 | string |
"" |
cd_change_management_repo |
此存储库保存为部署创建的变更管理请求。 | string |
"" |
cd_change_management_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_change_management_repo_git_provider |
变更管理仓库的 Git 提供者。 如果未设置,将默认为 hostedgit 。 |
string |
"" |
cd_change_management_repo_git_token_secret_crn |
变更管理存储库 Git 令牌的 CRN。 | string |
"" |
cd_change_management_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_change_repo_clone_from_url |
覆盖克隆到应用程序存储库中的缺省管理存储库。 如果应用程序存储库存在,请使用 clone_if_not_exists 使存储库内容保持不变。 |
string |
"" |
cd_change_request_id |
打开的变更请求的标识。 如果此变量设置为 notAvailable ,那么连续部署管道将自动创建变更请求。 |
string |
"notAvailable" |
cd_cluster_name |
在其中部署应用程序的 Kubernetes 集群的名称。 | string |
"mycluster-free" |
cd_cluster_namespace |
在其中部署应用程序的 Kubernetes 集群名称空间的名称。 | string |
"prod" |
cd_cluster_region |
部署应用程序的 Kubernetes 集群的区域。 | string |
"ibm:yp:us-south" |
cd_code_signing_cert_secret_crn |
密钥提供程序中公用签名密钥证书的 CRN。 | string |
"" |
cd_code_signing_cert_secret_group |
管道公用签名密钥证书私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_code_signing_cert_secret_name |
私钥提供者中的 Cloud API 密钥私钥的名称。 | string |
"signing-certificate" |
cd_compliance_base_image |
用于运行大部分内置管道代码的管道基本映像。 | string |
"" |
cd_compliance_pipeline_branch |
CD 管道合规性管道分支。 | string |
"" |
cd_compliance_pipeline_group |
指定合规性 pipline 存储库的用户或组。 | string |
"" |
cd_compliance_pipeline_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_compliance_pipeline_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_cos_api_key_secret_crn |
Cloud Object Storage apikey 的 CRN。 | string |
"" |
cd_cos_api_key_secret_name |
私钥提供程序中 Cloud Object Storage API 密钥私钥的名称。 | string |
"" |
cd_cos_endpoint |
Cloud Object Storage 端点名称。 | string |
"" |
cd_customer_impact |
变更请求的定制影响。 | string |
"no_impact" |
cd_deployment_group |
指定要部署的组。 | string |
"" |
cd_deployment_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_deployment_repo_clone_from_branch |
在提供 deployment_repo_clone_from_url 时使用,这是 CD 构建所使用的缺省分支,通常为 main 或 master 。 |
string |
"" |
cd_deployment_repo_clone_from_url |
提供自己的示例部署 URL,覆盖默认示例应用程序,并将其克隆到应用程序 repo 中。 如果应用程序存储库存在,请使用 clone_if_not_exists 使存储库内容保持不变。 |
string |
"" |
cd_deployment_repo_clone_to_git_id |
缺省情况下不存在,否则请对浏览器 UI 中的 git_id 字段使用定制服务器 GUID 或其他选项。 |
string |
"" |
cd_deployment_repo_clone_to_git_provider |
缺省情况下为 hostedgit ,否则使用 githubconsolidated 或 gitlab 。 |
string |
"" |
cd_deployment_repo_existing_branch |
在提供 deployment_repo_existing_url 时使用,这是 CD 构建的缺省分支,通常为 main 或 master 。 |
string |
"" |
cd_deployment_repo_existing_git_id |
缺省情况下不存在,否则请对浏览器 UI 中的 git_id 字段使用定制服务器 GUID 或其他选项。 |
string |
"" |
cd_deployment_repo_existing_git_provider |
缺省情况下为 hostedgit ,否则使用 githubconsolidated 或 gitlab 。 |
string |
"hostedgit" |
cd_deployment_repo_existing_url |
覆盖以带来自己现有的部署资源库 URL,直接使用该 URL 而不是克隆默认部署示例。 | string |
"" |
cd_deployment_repo_git_token_secret_crn |
部署存储库 Git 令牌的 CRN。 | string |
"" |
cd_deployment_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_doi_environment |
DevOps Insights CD 部署的 DevSecOps 环境。 | string |
"" |
cd_doi_toolchain_id |
要链接到的 DevOps Insights 工具链标识。 | string |
"" |
cd_emergency_label |
将拉取请求标识为紧急情况。 | string |
"EMERGENCY" |
cd_enable_slack |
设置为 true 以创建集成。 | bool |
false |
cd_enable_pipeline_notifications |
启用后,管道运行事件将发送到外层工具链中的 Event Notifications 和 Slack 集成。 | bool |
false |
cd_event_notifications |
要启用事件通知,请将 event_notifications 设置为 1 | string |
"0" |
cd_evidence_group |
为证据存储库指定 Git 用户或组。 | string |
"" |
cd_evidence_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_evidence_repo_git_token_secret_crn |
证据存储库 Git 令牌的 CRN。 | string |
"" |
cd_evidence_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_inventory_group |
指定库存存储库的 Git 用户或组。 | string |
"" |
cd_inventory_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_inventory_repo_git_token_secret_crn |
库存存储库 Git 令牌的 CRN。 | string |
"" |
cd_inventory_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_issues_group |
为问题存储库指定 Git 用户或组。 | string |
"" |
cd_issues_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_issues_repo_git_token_secret_crn |
问题存储库 Git 令牌的 CRN。 | string |
"" |
cd_issues_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_link_to_doi_toolchain |
在另一个工具链 (true 或 false) 中启用指向 DevOps Insights 实例的链接。 | bool |
true |
cd_merge_cra_sbom |
合并 SBOM | string |
"1" |
cd_pipeline_config_group |
指定管道配置存储库的用户或组。 | string |
"" |
cd_pipeline_config_path |
Pipeline-config 存储库中 pipeline-config.yaml 文件的名称和路径。 | string |
".pipeline-config.yaml" |
cd_pipeline_config_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cd_pipeline_config_repo_branch |
指定包含定制 pipeline-config.yaml 文件的分支。 | string |
"" |
cd_pipeline_config_repo_clone_from_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 | string |
"" |
cd_pipeline_config_repo_existing_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 | string |
"" |
cd_pipeline_config_repo_git_token_secret_crn |
配置库 Git 令牌的 CRN。 | string |
"" |
cd_pipeline_config_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cd_pipeline_debug |
缺省情况下为 0 。 设置为 1 以启用调试日志记录。 |
string |
"0" |
cd_pipeline_git_token_secret_crn |
管道属性中 Git 令牌密钥的 CRN。 | string |
"" |
cd_pipeline_ibmcloud_api_key_secret_crn |
管道 API 密钥的 CRN。 | string |
"" |
cd_pipeline_ibmcloud_api_key_secret_name |
私钥提供者中的 Cloud API 密钥私钥的名称。 | string |
"ibmcloud-api-key" |
cd_pipeline_properties |
包含 CD 工具链管道属性的 JSON 字符串。 | string |
"" |
cd_repositories_prefix |
克隆的合规性存储库的前缀名称。 | string |
"compliance" |
cd_satellite_cluster_group |
Satellite 群组 | string |
"" |
cd_scc_enable_scc |
启用 SCC 集成。 | bool |
true |
cd_scc_integration_name |
SSC 集成名称的名称。 | string |
"Security and Compliance" |
cd_slack_channel_name |
向其发布通知的 Slack 通道。 | string |
"" |
cd_slack_notifications |
用于打开或关闭 Slack 集成的开关。 | string |
"0" |
cd_slack_pipeline_fail |
生成管道失败通知。 | bool |
true |
cd_slack_pipeline_start |
生成管道启动通知。 | bool |
true |
cd_slack_pipeline_success |
生成管道成功通知。 | bool |
true |
cd_slack_team_name |
Slack 团队名称,即团队 URL 中 slack.com 前面的单词或短语。 | string |
"" |
cd_slack_toolchain_bind |
生成添加到工具链通知的工具。 | bool |
true |
cd_slack_toolchain_unbind |
生成从工具链通知中除去的工具。 | bool |
true |
cd_slack_webhook_secret_name |
私钥提供程序中的 Webhook 私钥的名称。 | string |
"" |
cd_sm_location |
IBM Cloud® 包含 Secrets Manager 实例的位置或区域。 | string |
"" |
cd_sm_name |
存储私钥的 Secrets Manager 实例的名称。 | string |
"" |
cd_sm_resource_group |
包含私钥的 Secrets Manager 实例的资源组。 | string |
"" |
cd_sm_secret_group |
Secrets Manager 中用于组织或分组私钥的组。 | string |
"" |
cd_source_environment |
从中提升应用程序的源环境。 | string |
"master" |
cd_target_environment |
应用程序部署到的目标环境。 | string |
"prod" |
cd_target_environment_detail |
正在更新的环境的详细信息。 | string |
"" |
cd_target_environment_purpose |
要更新的环境的用途。 | string |
"production" |
cd_toolchain_description |
CD 工具链的描述。 | string |
"Toolchain created with terraform template for DevSecOps CD Best Practices." |
cd_toolchain_name |
CD 工具链的名称。 | string |
"DevSecOps CD Toolchain - Terraform" |
cd_toolchain_region |
包含 CD 工具链的区域。 | string |
"" |
cd_toolchain_resource_group |
在其中创建工具链的资源组。 | string |
"" |
cd_trigger_git_name |
CD 管道 GIT 触发器的名称。 | string |
"Git CD Trigger" |
cd_trigger_git_enable |
设置为 true 以启用 CD 管道 Git 触发器。 |
bool |
true |
cd_trigger_timed_name |
CD 管道计时触发器的名称。 | string |
"Git CD Timed Trigger" |
cd_trigger_timed_enable |
设置为 true 以启用 CI 管道计时触发器。 |
bool |
false |
cd_trigger_timed_cron_schedule |
仅需要计时器触发器。 用于指示此触发器何时激活的 cron 表达式。 最大频率为每 5 分钟。 该字符串基于 UNIX crontab 语法 :minute,hour,day of month,month,day of week。 示例: 0 * _/2 * * *-每 2 小时。 | string |
"0 4 * * *" |
cd_trigger_manual_name |
CD 管道手动触发器的名称。 | string |
"Manual Trigger" |
cd_trigger_manual_enable |
设置为 true 以启用 CD 管道手动触发器。 |
bool |
true |
cd_trigger_manual_promotion_name |
CD 管道手动提升触发器的名称。 | string |
"Manual Promotion Trigger" |
cd_trigger_manual_promotion_enable |
设置为 true 以启用 CD 管道手动提升触发器。 |
bool |
true |
cd_trigger_manual_pruner_name |
手动 Pruner 触发器的名称。 | string |
"Evidence Pruner Manual Trigger" |
cd_trigger_manual_pruner_enable |
设置为 true 以启用手动 Pruner 触发器。 |
bool |
true |
cd_trigger_timed_pruner_name |
定时 Pruner 触发器的名称。 | string |
"Evidence Pruner Timed Trigger" |
cd_trigger_timed_pruner_enable |
设置为 true 以启用定时 Pruner 触发器。 |
bool |
false |
cd_scc_enable_scc |
将 SCC 工具集成添加到工具链。 | bool |
true |
cd_slack_webhook_secret_crn |
Slack Webhook 私钥的 CRN。 | string |
"" |
cd_slack_webhook_secret_group |
Slack Webhook 私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_sm_instance_crn |
Secrets Manager 实例的 CRN。 | string |
"" |
cd_change_management_repo_secret_group |
变更管理存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_deployment_repo_secret_group |
部署存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_issues_repo_secret_group |
Issues 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_inventory_repo_secret_group |
库存存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_evidence_repo_secret_group |
证据存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_compliance_pipeline_repo_secret_group |
Compliance Pipeline 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_pipeline_config_repo_secret_group |
管道配置存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_cos_api_key_secret_group |
Cloud Object Storage API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_pipeline_ibmcloud_api_key_secret_group |
管道 ibmcloud API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_pipeline_git_tag |
合规性 CD 管道的管道定义存储库中的 GIT 标记。 | string |
"" |
cd_pipeline_git_token_secret_group |
管道 Git 令牌私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cd_code_signing_cert |
base64 编码的 GPG 公用密钥。 | string |
"" |
cd_pipeline_git_token_secret_name |
私钥提供程序中管道 Git 令牌私钥的名称。 | string |
"pipeline-git-token" |
change_management_existing_url |
现有变更管理存储库的 URL。 | string |
"" |
change_management_repo_git_id |
将此值设为 github ( github.com )或自定义 GitHub Enterprise服务器的 ID。 |
string |
"" |
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
cc_app_group |
指定应用程序存储库的用户或组。 | string |
"" |
cc_app_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
oauth |
cc_app_repo_branch |
应用程序存储库的缺省分支。 | string |
"master" |
cc_app_repo_git_id |
缺省情况下不存在,否则请将定制服务器 GUID 或其他选项用于浏览器 UI 中的 git_id 字段。 |
string |
"" |
cc_app_repo_git_provider |
Git 提供程序的类型。 | string |
"hostedgit" |
cc_app_repo_git_token_secret_crn |
应用程序存储库 Git 令牌的 CRN。 | string |
"" |
cc_app_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_app_repo_url |
应用程序仓库的 Git URL。 | string |
"" |
cc_artifactory_token_secret_crn |
Artifactory 私钥的 CRN。 | string |
"" |
cc_authorization_policy_creation |
禁用工具链服务以创建 Secrets Manager 服务授权策略。 | string |
"" |
cc_compliance_base_image |
用于运行大部分内置管道代码的管道基本映像。 | string |
"" |
cc_compliance_pipeline_branch |
CC 管道合规性管道分支。 | string |
"" |
cc_compliance_pipeline_group |
指定合规性 pipline 存储库的用户或组。 | string |
"" |
cc_compliance_pipeline_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cc_compliance_pipeline_repo_git_token_secret_crn |
合规性管道存储库 Git 令牌的 CRN。 | string |
"" |
cc_compliance_pipeline_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_cos_api_key_secret_crn |
Cloud Object Storage apikey 的 CRN。 | string |
"" |
cc_cos_api_key_secret_name |
私钥提供程序中 Cloud Object Storage API 密钥私钥的名称。 | string |
"" |
cc_cos_endpoint |
Cloud Object Storage 端点名称。 | string |
"" |
cc_cra_bom_generate |
将此标记设为 1 时,将在 CC 管道中生成 cra bom。 |
string |
"1" |
cc_cra_deploy_analysis |
将此标记设置为 1 以进行 cra 部署分析。 |
string |
"1" |
cc_cra_vulnerability_scan |
将此标记设置为 1 和 cc-cra-bom-generate 至 1 用于 CI 管道中的漏洞扫描。 如果该值设置为 1,且 cc-cra-bom-generate 设置为 0 ,则扫描将被标记为 failure |
string |
"1" |
cc_doi_environment |
DevOps Insights CD 部署的 DevSecOps 环境。 | string |
"" |
cc_doi_toolchain_id |
要链接到的 DevOps Insights 工具链标识。 | string |
"" |
cc_enable_pipeline_dockerconfigjson |
将 pipeline-dockerconfigjson 属性添加到管道属性。 | bool |
false |
cc_enable_slack |
创建 Slack 集成。 | bool |
false |
cc_environment_tag |
表示库存中目标环境的标记名称。 示例: prod_latest 。 |
string |
"prod_latest" |
cc_enable_pipeline_notifications |
启用后,管道运行事件将发送到外层工具链中的 Event Notifications 和 Slack 集成。 | bool |
false |
cc_event_notifications |
要启用事件通知,请将 event_notifications 设置为 1 | string |
"0" |
cc_evidence_group |
为证据存储库指定 Git 用户或组。 | string |
"" |
cc_evidence_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cc_evidence_repo_git_token_secret_crn |
证据存储库 Git 令牌的 CRN。 | string |
"" |
cc_evidence_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_inventory_group |
指定库存存储库的 Git 用户或组。 | string |
"" |
cc_inventory_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cc_inventory_repo_git_token_secret_crn |
库存存储库 Git 令牌的 CRN。 | string |
"" |
cc_inventory_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_issues_group |
为问题存储库指定 Git 用户或组。 | string |
"" |
cc_issues_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cc_issues_repo_git_token_secret_crn |
问题存储库 Git 令牌的 CRN。 | string |
"" |
cc_issues_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_gosec_private_repository_host |
您的私有资源库基础 URL。 | string |
"" |
cc_gosec_private_repository_ssh_key_secret_crn |
部署存储库 Git 令牌的 CRN。 | string |
"" |
cc_gosec_repo_ssh_key_secret_group |
gosec 专用存储库 SSH 密钥的密钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_gosec_repo_ssh_key_secret_name |
私钥提供程序中专用存储库的 SSH 密钥令牌的名称。 | string |
"git-ssh-key" |
cc_link_to_doi_toolchain |
在另一个工具链 (true 或 false) 中启用指向 DevOps Insights 实例的链接。 | bool |
true |
cc_opt_in_auto_close |
允许在 CC 管道运行不再检测到漏洞时自动关闭来自漏洞的问题。 | string |
"1" |
cc_opt_in_dynamic_api_scan |
启用 OWASP Zap API 扫描。1 启用或 0 禁用。 |
string |
"" |
cc_opt_in_dynamic_scan |
启用 OWASP Zap 扫描。1 启用或 0 禁用。 |
string |
"" |
cc_opt_in_dynamic_ui_scan |
启用 OWASP Zap UI 扫描。1 启用或 0 禁用。 |
string |
"" |
cc_opt_in_gosec |
启用 gosec 扫描 | string |
"" |
cc_pipeline_config_group |
指定管道配置存储库的用户或组。 | string |
"" |
cc_pipeline_config_path |
管道配置存储库中 pipeline-config.yaml 文件的名称和路径。 |
string |
".pipeline-config.yaml" |
cc_pipeline_config_repo_auth_type |
选择用于访问 Git 提供程序的认证方法。oauth 或 pat 。 |
string |
"" |
cc_pipeline_config_repo_branch |
指定包含定制 pipeline-config.yaml 文件的分支。 |
string |
"" |
cc_pipeline_config_repo_clone_from_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 |
string |
"" |
cc_pipeline_config_repo_existing_url |
指定包含定制 pipeline-config.yaml 文件的存储库。 |
string |
"" |
cc_pipeline_config_repo_git_token_secret_crn |
管道配置存储库 Git 令牌的 CRN。 | string |
"" |
cc_pipeline_config_repo_git_token_secret_name |
私钥提供程序中 Git 令牌私钥的名称。 | string |
"" |
cc_pipeline_debug |
缺省情况下为 0 。 设置为 1 以启用调试日志记录。 |
string |
"0" |
cc_pipeline_dockerconfigjson_secret_crn |
Dockerconfig JSON 私钥的 CRN。 | string |
"" |
cc_pipeline_dockerconfigjson_secret_name |
私钥提供程序中管道 Docker 配置 JSON 私钥的名称。 | string |
"pipeline_dockerconfigjson_secret_name" |
cc_pipeline_doi_api_key_secret_crn |
管道 DOI API 密钥的 CRN。 | string |
"" |
cc_pipeline_git_tag |
合规性 CC 管道的管道定义存储库中的 GIT 标记。 | string |
"" |
cc_pipeline_git_token_secret_crn |
管道 Git 令牌属性的 CRN。 | string |
"" |
cc_pipeline_ibmcloud_api_key_secret_crn |
IBMCloud apikey 的 CRN。 | string |
"" |
cc_pipeline_ibmcloud_api_key_secret_name |
私钥提供者中的 Cloud API 密钥私钥的名称。 | string |
"ibmcloud-api-key" |
cc_pipeline_properties |
包含 CC 工具链管道属性的 JSON 字符串。 | string |
"" |
cc_repositories_prefix |
合规性存储库的前缀。 | string |
"compliance" |
cc_scc_enable_scc |
启用 SCC 集成。 | bool |
true |
cc_scc_integration_name |
SSC 集成名称。 | string |
"Security and Compliance" |
cc_slack_channel_name |
向其发布通知的 Slack 通道。 | string |
"" |
cc_slack_notifications |
打开或关闭 Slack 集成。 | string |
"0" |
cc_slack_pipeline_fail |
生成管道失败通知。 | bool |
true |
cc_slack_pipeline_start |
生成管道启动通知。 | bool |
true |
cc_slack_pipeline_success |
生成管道成功通知。 | bool |
true |
cc_slack_team_name |
Slack 团队名称,即团队 URL 中 .slack.com 前面的单词或短语。 |
string |
"" |
cc_slack_toolchain_bind |
生成添加到工具链通知的工具。 | bool |
true |
cc_slack_toolchain_unbind |
生成从工具链通知中除去的工具。 | bool |
true |
cc_slack_webhook_secret_crn |
Slack Webhook 私钥的 CRN。 | string |
"" |
cc_slack_webhook_secret_name |
私钥提供程序中的 Webhook 私钥的名称。 | string |
"" |
cc_sm_instance_crn |
Secrets Manager 实例的 CRN。 | string |
"" |
cc_sm_location |
IBM Cloud® 包含 Secrets Manager 实例的位置或区域。 | string |
"" |
cc_sm_name |
存储私钥的 Secrets Manager 实例的名称。 | string |
"" |
cc_sm_resource_group |
包含私钥的 Secrets Manager 实例的资源组。 | string |
"" |
cc_sm_secret_group |
Secrets Manager 中用于组织或分组私钥的组。 | string |
"" |
cc_sonarqube_config |
在隔离的 Docker-Docker 容器 (缺省配置) 或现有 Kubernetes 集群 (定制配置) 中运行 SonarQube 扫描。 选项: 缺省或定制。 缺省值为 default。 | string |
"default" |
cc_sonarqube_secret_crn |
SonarQube 私钥的 CRN。 | string |
"" |
cc_sonarqube_secret_name |
SonarQube 秘密的名称。 | string |
"" |
cc_toolchain_description |
CC 工具链的描述。 | string |
"Toolchain created with terraform template for DevSecOps CC Best Practices." |
cc_toolchain_name |
CC 工具链的名称。 | string |
"DevSecOps CC Toolchain - Terraform" |
cc_toolchain_region |
包含 CI 工具链的区域。 | string |
"" |
cc_toolchain_resource_group |
在其中创建工具链的资源组。 | string |
"" |
cc_trigger_timed_name |
CC 管道计时触发器的名称。 | string |
"CC Timed Trigger" |
cc_trigger_timed_enable |
设置为 true 以启用 CC 管道计时触发器。 |
bool |
false |
cc_trigger_timed_cron_schedule |
仅需要计时器触发器。 用于指示此触发器何时激活的 cron 表达式。 最大频率为每 5 分钟。 该字符串基于 UNIX crontab 语法 :minute,hour,day of month,month,day of week。 示例: 0 * _/2 * * *-每 2 小时。 | string |
"0 4 * * *" |
cc_trigger_manual_name |
CC 管道手动触发器的名称。 | string |
"CC Manual Trigger" |
cc_trigger_manual_enable |
设置为 true 以启用 CI 管道手动触发器。 |
bool |
true |
cc_trigger_manual_pruner_name |
手动 Pruner 触发器的名称。 | string |
"Evidence Pruner Manual Trigger" |
cc_trigger_manual_pruner_enable |
设置为 true 以启用手动 Pruner 触发器。 |
bool |
true |
cc_trigger_timed_pruner_name |
定时 Pruner 触发器的名称。 | string |
"Evidence Pruner Timed Trigger" |
cc_trigger_timed_pruner_enable |
设置为 true 以启用定时 Pruner 触发器。 |
bool |
false |
cc_scc_enable_scc |
将 SCC 工具集成添加到工具链。 | bool |
true |
cc_pipeline_ibmcloud_api_key_secret_group |
管道 ibmcloud API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_cos_api_key_secret_group |
Cloud Object Storage API 密钥私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_slack_webhook_secret_group |
Slack Webhook 私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_pipeline_dockerconfigjson_secret_group |
管道 DockerConfigJson 秘密的组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_app_repo_secret_group |
应用存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_issues_repo_secret_group |
Issues 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_inventory_repo_secret_group |
库存存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_evidence_repo_secret_group |
证据存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_compliance_pipeline_repo_secret_group |
Compliance Pipeline 存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
cc_pipeline_config_repo_secret_group |
管道配置存储库私钥的私钥组前缀。 如果未设置,那么缺省为 sm_secret_group 。 仅与 Secrets Manager 配合使用。 |
string |
"" |
可选的 Code Engine CI 和 CD 变量
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
code_engine_project |
要使用的 Code Engine 项目的名称。 如果不存在,则创建。 适用于 CI 和 CD 工具链。 要单独设置,请使用 ci_code_engine_project 和 cd_code_engine_project 。 |
string |
"" |
code_engine_project_prefix |
前缀为 ci_code_engine_project 和 cd_code_engine_project 的字符串。 |
string |
"" |
ci_code_engine_app_concurrency |
每个实例可并行处理的最大请求数量。 | string |
"100" |
ci_code_engine_app_deployment_timeout |
应用程序部署的最大超时。 | string |
"300" |
ci_code_engine_app_max_scale |
可用于此应用程序的最大实例数。 如果将该值设为 0,应用程序将根据需要进行缩放。 应用程序缩放仅受应用程序的项目的每个资源配额的实例限制。 | string |
"1" |
ci_code_engine_app_min_scale |
可用于此应用程序的最小实例数。 此选项对于确保不需要任何实例时都未在运行非常有用。 | string |
"0" |
ci_code_engine_app_port |
应用程序侦听的端口。 格式为 [NAME:]PORT ,其中 [NAME:] 是可选的。 如果指定了 [NAME:] ,那么有效值为 h2c 或 http1 。 如果未指定 [NAME:] 或为 http1 ,那么端口将使用 HTTP/1.1 。 当 [NAME:] 为 h2c 时,端口将使用未加密的 HTTP/2 。 |
string |
"8080" |
ci_code_engine_app_visibility |
应用程序的可视性。 有效值为“公共”、“私人”和“项目”。 设置公共可视性意味着应用程序可以从公共因特网或 Code Engine 项目中的组件接收请求。 设置专用的可视性意味着无法从公共因特网访问应用程序,并且只能使用在同一项目中运行的虚拟专用端点 (VPE) 或 Code Engine 组件从其他 IBM Cloud 进行网络访问。 只有当项目支持应用程序私有可见性时,可见性才能是私有的。 设置项目可见性意味着您的应用程序不能从公共互联网访问,只能从运行在同一项目中的其他 Code Engine 组件进行网络访问。 | string |
"public" |
ci_code_engine_binding_resource_group |
用于 Code Engine 项目服务绑定身份验证的资源组名称。 为该资源组中的所有服务创建一个具有操作员和管理员角色的服务 ID。 使用 "*" 来指定此帐户中的所有资源组。 | string |
"" |
ci_code_engine_build_size |
用于构建的大小,这将确定所使用的资源数量。 有效值包括 small , medium , large , xlarge 。 |
string |
"large" |
ci_code_engine_build_strategy |
Code Engine 组件的构建策略。 可以是 dockerfile 或 buildpacks 。 |
string |
"dockerfile" |
ci_code_engine_build_timeout |
在构建运行必须成功或失败之前可以经过的时间量 (以秒计)。 | string |
"1200" |
ci_code_engine_build_use_native_docker |
要选择性加入的属性,用于使用本机 Docker 构建功能,而不是使用 Code Engine 构建来容器化源。 请注意,仅当构建策略设置为 dockerfile 时,此设置才会生效。 有效值为 true 和 false 。 |
string |
"false" |
ci_code_engine_context_dir |
存储库中包含 buildpack 文件或 Dockerfile 的目录。 | string |
"." |
ci_code_engine_cpu |
为应用程序或任务实例设置的 CPU 数量。 | string |
"0.25" |
ci_code_engine_deployment_type |
要在部署过程中创建/更新的 Code Engine 组件的类型。 它可以是 application 或 job 。 |
string |
"application" |
ci_code_engine_dockerfile |
Dockerfile 的路径。 仅当名称不是 Dockerfile 时才指定此选项 |
string |
"Dockerfile" |
ci_code_engine_env_from_configmaps |
以分号分隔的配置映射列表,用于设置环境变量。 | string |
"" |
ci_code_engine_env_from_secrets |
用于设置环境变量的私钥的分号分隔列表。 | string |
"" |
ci_code_engine_ephemeral_storage |
要为应用程序实例或作业运行设置的临时存储量。 用 M 表示兆字节,用 G 表示千兆字节。 | string |
"0.4G" |
ci_code_engine_image_name |
构建的映像的名称。 | string |
"code-engine-compliance-app" |
ci_code_engine_job_instances |
指定用于作业运行的实例数。 使用此选项时,系统会将其转换为数组下标。 例如,如果指定 5 的实例,系统会转换为 0 - 4 的数组索引。 只有在未指定 --array-indices 选项时才能指定该选项。 缺省值为 1。 | string |
"1" |
ci_code_engine_job_maxexecutiontime |
作业运行的最大执行时间(以秒为单位)。 | string |
"7200" |
ci_code_engine_job_retrylimit |
将作业标记为失败之前重新运行该作业的实例的次数。 | string |
"3" |
ci_code_engine_memory |
为应用程序或作业实例设置的内存量。 用 M 表示兆字节,用 G 表示千兆字节。 | string |
"0.5G" |
ci_code_engine_project |
要用于 CI 管道构建的 Code Engine 项目的名称。 如果项目还不存在,则将创建该项目。 | string |
"Sample_CI_Project" |
ci_code_engine_project_prefix |
将以 ci_code_engine_project 为前缀的字符串。 这优先于 code_engine_project_prefix 中设置的值。 |
string |
"" |
ci_code_engine_region |
要为 Code Engine 项目创建/查找的区域。 | string |
"" |
ci_code_engine_registry_domain |
用于构建和标记图像的容器注册表 URL 域。 在使用专用端点容器注册表时很有用。 | string |
"" |
ci_code_engine_remove_refs |
除去对未指定配置资源 (configmap/secret) 引用的引用 (从 env-from-configmap,env-from-secret 以及由 CD 自动管理)。 | string |
"false" |
ci_code_engine_resource_group |
Code Engine 项目的资源组。 | string |
"" |
ci_code_engine_service_bindings |
包含简单 JSON 字符串形式的服务名称的 JSON 数组。 | string |
"" |
ci_code_engine_source |
要在存储库中构建的代码的位置的路径。 缺省为源代码存储库的根目录。 | string |
"" |
ci_code_engine_wait_timeout |
要等待的 CLI 操作的最大超时。 | string |
"1300" |
名称 | 描述 | Type | 缺省值 |
---|---|---|---|
cd_code_engine_app_concurrency |
每个实例可并行处理的最大请求数量。 | string |
"100" |
cd_code_engine_app_deployment_timeout |
应用程序部署的最大超时。 | string |
"300" |
cd_code_engine_app_max_scale |
可用于此应用程序的最大实例数。 如果将该值设为 0,应用程序将根据需要进行缩放。 应用程序缩放仅受应用程序的项目的每个资源配额的实例限制。 | string |
"1" |
cd_code_engine_app_min_scale |
可用于此应用程序的最小实例数。 此选项对于确保不需要任何实例时都未在运行非常有用。 | string |
"0" |
cd_code_engine_app_port |
应用程序侦听的端口。 格式为 [NAME:]PORT ,其中 [NAME:] 是可选的。 如果指定了 [NAME:] ,那么有效值为 h2c 或 http1 。 如果未指定 [NAME:] 或为 http1 ,那么端口将使用 HTTP/1.1 。 当 [NAME:] 为 h2c 时,端口将使用未加密的 HTTP/2 。 |
string |
"8080" |
cd_code_engine_app_visibility |
应用程序的可视性。 有效值为“公共”、“私人”和“项目”。 设置公共可视性意味着应用程序可以从公共因特网或 Code Engine 项目中的组件接收请求。 设置专用的可视性意味着无法从公共因特网访问应用程序,并且只能使用在同一项目中运行的虚拟专用端点 (VPE) 或 Code Engine 组件从其他 IBM Cloud 进行网络访问。 只有当项目支持应用程序私有可见性时,可见性才能是私有的。 设置项目可见性意味着您的应用程序不能从公共互联网访问,只能从运行在同一项目中的其他 Code Engine 组件进行网络访问。 | string |
"public" |
cd_code_engine_binding_resource_group |
用于 Code Engine 项目服务绑定身份验证的资源组名称。 为该资源组中的所有服务创建一个具有操作员和管理员角色的服务 ID。 使用 "*" 来指定此帐户中的所有资源组。 | string |
"" |
cd_code_engine_cpu |
为应用程序或任务实例设置的 CPU 数量。 | string |
"0.25" |
cd_code_engine_deployment_type |
要在部署过程中创建/更新的 Code Engine 组件的类型。 它可以是 application 或 job 。 |
string |
"application" |
cd_code_engine_env_from_configmaps |
以分号分隔的配置映射列表,用于设置环境变量。 | string |
"" |
cd_code_engine_env_from_secrets |
用于设置环境变量的私钥的分号分隔列表。 | string |
"" |
cd_code_engine_ephemeral_storage |
要为应用程序实例或作业运行设置的临时存储量。 用 M 表示兆字节,用 G 表示千兆字节。 | string |
"0.4G" |
cd_code_engine_job_instances |
指定用于作业运行的实例数。 使用此选项时,系统会将其转换为数组下标。 例如,如果指定 5 的实例,系统会转换为 0 - 4 的数组索引。 只有在未指定 --array-indices 选项时才能指定该选项。 缺省值为 1。 | string |
"1" |
cd_code_engine_job_maxexecutiontime |
作业运行的最大执行时间(以秒为单位)。 | string |
"7200" |
cd_code_engine_job_retrylimit |
将作业标记为失败之前重新运行该作业的实例的次数。 | string |
"3" |
cd_code_engine_memory |
为应用程序或作业实例设置的内存量。 用 M 表示兆字节,用 G 表示千兆字节。 | string |
"0.5G" |
cd_code_engine_project |
要用于 CD 管道提升代码的 Code Engine 项目的名称。 如果项目还不存在,则将创建该项目。 | string |
"Sample_CD_Project" |
cd_code_engine_project_prefix |
将以 cd_code_engine_project 为前缀的字符串。 这优先于 code_engine_project_prefix 中设置的值。 |
string |
"" |
cd_code_engine_region |
要为 Code Engine 项目创建/查找的区域。 | string |
"" |
cd_code_engine_remove_refs |
除去对未指定配置资源 (configmap/secret) 引用的引用 (从 env-from-configmap,env-from-secret 以及由 CD 自动管理)。 | string |
"false" |
cd_code_engine_resource_group |
Code Engine 项目的资源组。 | string |
"" |
cd_code_engine_service_bindings |
包含简单 JSON 字符串形式的服务名称的 JSON 数组。 | string |
"" |
cd_code_signing_cert |
base64 编码的 GPG 公用密钥。 | string |
"" |
cd_code_engine_service_bindings |
包含简单 JSON 字符串形式的服务名称的 JSON 数组。 | string |
"" |
输出变量
名称 | 描述 |
---|---|
app_repo_url |
应用程序软件仓库 URL。 |
compliance_cc_toolchain_id |
合规性 CC 工具链的标识。 |
compliance_cd_toolchain_id |
合规性 CD 工具链的标识。 |
compliance_ci_toolchain_id |
合规性 CI 工具链的标识。 |
compliance_cc_toolchain_url |
合规 CC 工具链 URL。 |
compliance_cd_toolchain_url |
合规 CD 工具链 URL。 |
compliance_ci_toolchain_url |
合规 CI 工具链 URL。 |
evidence_repo_url |
证据 Repo URL。 |
inventory_repo_url |
清单重置 URL。 |
issues_repo_url |
问题库 URL。 |
secrets_manager_instance_id |
私钥管理实例标识 |
key_protect_instance_id |
Key Protect 实例 ID |