IBM Cloud Docs
パイプラインのパラメーター

パイプラインのパラメーター

プル要求、継続的統合、継続的デプロイメント、継続的コンプライアンス、およびプロモーション・パイプラインのパラメーターが提供されます。

パイプラインUIでパイプラインにパラメータを追加し、カスタムスクリプト からアクセスできます。

表 1 から 5 は、パイプラインのプル要求、継続的統合、継続的デプロイメント、継続的コンプライアンス、およびプロモーションの各パラメーターをリストして説明しています。

表 1. プル要求のパラメーター
名前 タイプ 説明 必須またはオプションです
artifactory-dockerconfigjson シークレット artifactory の資格情報を保管する Base64 エンコードの Docker config.json ファイル。 オプション
base-branch テキスト PR がマージされるターゲット・ブランチ。 通常、 master はデフォルトのベース・ブランチです。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターはトリガーから取り込まれます。 必須
base-repo テキスト PR がマージされているリポジトリーの URL。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
base-repo-name テキスト PR がマージされるリポジトリーの名前です。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
base-repo-owner テキスト PR がマージされるリポジトリーの所有者です。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
baseimage-auth-email テキスト Code Risk Analyzerのスキャンで必要となる、アプリケーションDockerfileのベースイメージの電子メール認証情報。 オプション
baseimage-auth-host テキスト Code Risk Analyzerのスキャンで必要となる、アプリケーションDockerfileのベースイメージのホストクレデンシャル。 オプション
baseimage-auth-password シークレット Code Risk Analyzerのスキャンで必要となる、アプリケーションDockerfileのベースイメージのパスワードクレデンシャル。 オプション
baseimage-auth-user テキスト Code Risk Analyzerのスキャンで必要となる、アプリケーションDockerfileのベースイメージのユーザークレデンシャル。 オプション
branch-protection-rules-path テキスト 統合アプリケーション・リポジトリーを基準とした、必要な準拠性検査のカスタマイズされたリストを含む JSON ファイルへのパスを設定します。 オプション
branch-protection-status-check-prefix テキスト ブランチ保護状況検査の接頭部テキスト (デフォルトは tekton) オプション
cocoa-config-retry-status-code テキスト ココア CLI で再試行する必要がある API 呼び出しに対する応答状況コード。 例: 500,404 デフォルト値: 500 オプション
cocoa-config-max-retry-attempts テキスト Cocoa CLI が API 呼び出しを再試行できる回数。 例: 5 デフォルト値: 3 オプション
cocoa-config-git-default-branch (supported in Q4, 2022) テキスト Cocoa CLI のデフォルトの Git ブランチ。 例: main デフォルト値: master オプション
collect-evidence-in-pr テキスト 選択したオプションに基づいてPRパイプラインに証拠を収集するには、このフラグを設定します。 オプション noneallsuccess オプション
cos-api-key シークレット Cloud Object Storage の API キー。 オプション
cos-access-key-id シークレット HMAC 資格情報からの Cloud Object Storage アクセス・キー ID。 ( cos-api-key の代わりに cos-secret-access-key とともに提供) オプション
cos-secret-access-key シークレット HMAC 資格情報からの Cloud Object Storage 秘密アクセス・キー。 ( cos-api-key の代わりに cos-access-key-id とともに提供) オプション
cos-bucket-name テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンス内のバケットの名前。 オプション
cos-endpoint テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンスにエビデンスを保管するエンドポイント。 詳しくは、 エンドポイント・タイプ を参照してください。 オプション
cra-custom-script-path テキスト CRA スキャンの前に実行するカスタム・スクリプトのパス。 このスクリプトは、CRA BOM ツールのコンテキストで ENV 変数を設定するオプションを提供するためのものです。 オプション
cra-cveignore-path テキスト cveignore へのファイル・パス (アプリケーション・リポジトリー・ルートからの相対パス)。 値が指定されていない場合、デフォルトのファイル・パスは .cra/.cveignore です。 オプション
cra-docker-build-context テキスト このフラグが指定された場合、Code Risk AnalyzerはDockerビルド・コンテキストとしてpathパラメータのディレクトリを使用します。 デフォルト値は falseです。 オプション
cra-docker-buildflags テキスト docker build コマンドをカスタマイズしてビルド・ステージをスキャンする。 このパラメータはデフォルトでは空である。 オプション
cra-dockerfile-pattern テキスト 異なる命名規則 ( enterprise-linux.Dockerfile など) を使用して Dockerfile を追加する機能 オプション
cra-exclude-devdependencies テキスト スキャンから開発依存関係を除外するかどうかを指定します (true または false)。 デフォルト値はfalseです。 オプション
cra-gradle-exclude-configs テキスト Gradle のどの設定をスキャンする際に依存関係を除外するかを指定します。 例: runtimeClasspath,testCompileClasspath。 このパラメータはデフォルトでは空である。 オプション
cra-maven-exclude-scopes テキスト スキャンで依存関係を除外する maven スコープを指定します。 例: test,compile。 このパラメータはデフォルトでは空である。 オプション
cra-nodejs-create-package-lock テキスト Code Risk Analyzer Discovery が node.js リポジトリー用に package-lock.json ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
cra-python-create-requirements-txt テキスト 非推奨。 新しい CRA ツールでは、このパラメーターは使用されなくなりました。 Code Risk Analyzer Discovery が Python リポジトリー用に requirements.txt ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
detect-secrets-baseline-filename テキスト アプリケーション・リポジトリー内のベースライン・ファイルの名前。 オプション
detect-secrets-exclusion-list テキスト 検出シークレット・スキャンで除外するファイルの正規表現リスト。 オプション
detect-secrets-image テキスト カスタム・イメージまたは特定のバージョンの公式イメージを含む、代替の detect-secrets イメージを指定します。 オプション
detect-secrets-verbose テキスト 現在スキャン中のファイルの名前を出力します。 オプション
dind-image テキスト サイドカーを実行するための基本イメージ。 オプション
evidence-repo ツール統合 エビデンス・リポジトリーの URL。 オプション
evidence-reuse テキスト エビデンスの再利用を有効にするには、このフラグを 1 に設定します。 オプション
evidence-validity-period テキスト 証拠を再利用できる有効期間(時間)。 デフォルト値:24時間。 最大値:720時間(30日間) オプション
git-token シークレット Git リポジトリーのアクセス・トークン。 オプション
github-token シークレット GitHub リポジトリのアクセストークン。 オプション
grit-token シークレット Git Repos and Issue Tracking アクセストークン。 オプション
head-branch テキスト PR が発行されるソース・ブランチ。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
head-repo テキスト PR が生成されたリポジトリーの URL。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
head-sha テキスト head-branch での HEAD コミット。 PR Git トリガーが構成されている場合 (通常はこの場合)、このパラメーターは PR トリガーから取り込まれます。 必須
iam_retry_count テキスト IAM トークンのフェッチを待機する再試行の回数。 オプション
iam_retry_sleep テキスト IAM トークンをフェッチするための待機時間の長さ。 オプション
ibmcloud-api-key シークレット ibmcloud CLI ツールと対話するための IBM Cloud® API キー。 必須
incident-repo ツール統合 インシデントはレポのURLを発行する。 オプション
one-pipeline-dockerconfigjson シークレット プライベート・レジストリーからイメージをプルするための Base64 エンコードの Docker config.json ファイル。 オプション
pipeline-config テキスト パイプラインの動作をカスタマイズするための構成ファイル。 オプション
pipeline-config-branch テキスト DevSecOps パイプライン構成のブランチ。 オプション
pipeline-config-repo テキスト DevSecOps パイプライン構成ロケーションのリポジトリー URL。 オプション
pipeline-dockerconfigjson シークレット プライベート・レジストリーからイメージをプルするための Base64 エンコードの Docker config.json ファイル。 オプション
pipeline-debug 選択 パイプラインのデバッグ・モードのスイッチ。 オプション
slack-notifications テキスト Slack 統合をオンまたはオフにするスイッチ。 オプション
[slack-notifications](#pipeline-parm-slack-notifications) テキスト Slackとの統合をオン・オフするスイッチ オプション
表 2. 継続的統合のパラメーター
名前 タイプ 説明 必須またはオプションです
app-name テキスト ツールチェーンの設定で指定されたアプリケーションの名前。 必須
artifactory-dockerconfigjson シークレット artifactory の資格情報を保管する Base64 エンコードの Docker config.json ファイル。 オプション
baseimage-auth-email テキスト Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-host テキスト Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-password シークレット Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-user テキスト Code Risk Analyzerのスキャンに必要な、アプリケーションDockerfileのベースイメージのユーザークレデンシャル。 オプション
batched-evidence-collection テキスト バッチ・モードでの証拠収集を有効にするには、このフラグを設定します。これにより、ネットワーク呼び出しが最小限に抑えられます。 デフォルト 1 オプション
branch テキスト アプリケーションのソース・コードが含まれているリポジトリーの Git リポジトリー・ブランチ。 デフォルト値: master オプション
branch-protection-rules-path テキスト 統合アプリケーション・リポジトリーを基準とした、必要な準拠性検査のカスタマイズされたリストを含む JSON ファイルへのパスを設定します。 オプション
branch-protection-status-check-prefix テキスト ブランチ保護状況検査の接頭部テキスト (デフォルトは tekton) オプション
ciso-ibmcloud-api-key シークレット イメージの署名および署名の検証のために ibmcloud-api-key をオーバーライドします。 オプション
cocoa-config-retry-status-code テキスト ココア CLI で再試行する必要がある API 呼び出しに対する応答状況コード。 例: 500,404 デフォルト値: 500 オプション
cocoa-config-max-retry-attempts テキスト Cocoa CLI が API 呼び出しを再試行できる回数。 例: 5 デフォルト値: 3 オプション
cocoa-config-git-default-branch (supported in Q4, 2022) テキスト Cocoa CLI のデフォルトの Git ブランチ。 例: main デフォルト値: master オプション
cluster-name テキスト Docker ビルド・クラスターの名前。 必須
compliance-baseimage テキスト 組み込みパイプライン・コードを実行するための基本イメージ。 オプション
cos-api-key シークレット Cloud Object Storage の API キー。 オプション
cos-access-key-id シークレット HMAC 資格情報からの Cloud Object Storage アクセス・キー ID。 ( cos-api-key の代わりに cos-secret-access-key とともに提供) オプション
cos-secret-access-key シークレット HMAC 資格情報からの Cloud Object Storage 秘密アクセス・キー。 ( cos-api-key の代わりに cos-access-key-id とともに提供) オプション
cos-bucket-name テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンス内のバケットの名前。 オプション
cos-endpoint テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンスにエビデンスを保管するエンドポイント。 詳しくは、 エンドポイント・タイプ を参照してください。 オプション
cr-ibmcloud-api-key シークレット Sysdig スキャンの Container Registry からイメージをプルするために、指定されている場合は ibmcloud-api-key をオーバーライドします。 オプション
cr-resource-group テキスト Container Registryへのアクセスに使用されるリソース・グループ。 オプション
cra-custom-script-path テキスト CRA スキャンの前に実行するカスタム・スクリプトのパス。 このスクリプトは、CRA BOM ツールのコンテキストで ENV 変数を設定するオプションを提供するためのものです。 オプション
cra-cveignore-path テキスト cveignore へのファイル・パス (アプリケーション・リポジトリー・ルートからの相対パス)。 値が指定されていない場合、デフォルトのファイル・パスは .cra/.cveignore です。 オプション
cra-docker-build-context テキスト このフラグが指定された場合、Code Risk AnalyzerはDockerビルド・コンテキストとしてpathパラメータのディレクトリを使用します。 デフォルト値は falseです。 オプション
cra-docker-buildflags テキスト docker build コマンドをカスタマイズしてビルド・ステージをスキャンする。 このパラメータはデフォルトでは空である。 オプション
cra-dockerfile-pattern テキスト 異なる命名規則 ( enterprise-linux.Dockerfile など) を使用して Dockerfile を追加する機能 オプション
cra-exclude-devdependencies テキスト スキャンから開発依存関係を除外するかどうかを指定します (true または false)。 デフォルト値はfalseです。 オプション
cra-gradle-exclude-configs テキスト Gradle のどの設定をスキャンする際に依存関係を除外するかを指定します。 例: runtimeClasspath,testCompileClasspath。 このパラメータはデフォルトでは空である。 オプション
cra-ibmcloud-api-key シークレット CRA タスクによって使用される ibmcloud-api-key を上書きします。 オプション
cra-maven-exclude-scopes テキスト スキャンで依存関係を除外する maven スコープを指定します。 例: test,compile。 このパラメータはデフォルトでは空である。 オプション
cra-nodejs-create-package-lock テキスト Code Risk Analyzer Discovery が node.js リポジトリー用に package-lock.json ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
cra-python-create-requirements-txt テキスト 非推奨。 新しい CRA ツールでは、このパラメーターは使用されなくなりました。 Code Risk Analyzer Discovery が Python リポジトリー用に requirements.txt ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
custom-exempt-label テキスト インシデントの問題に免除のマークを付ける際に使用するカスタム・ラベルを定義します。 オプション
custom-image-tag テキスト イメージのカスタム・タグをコンマ区切りのリストにしたもの。 オプション
detect-secrets-baseline-filename テキスト アプリケーション・リポジトリー内のベースライン・ファイルの名前。 オプション
detect-secrets-exclusion-list テキスト 検出シークレット・スキャンで除外するファイルの正規表現リスト。 オプション
detect-secrets-image テキスト カスタム・イメージまたは特定のバージョンの公式イメージを含む、代替の detect-secrets イメージを指定します。 オプション
detect-secrets-verbose テキスト 現在スキャン中のファイルの名前を出力します。 オプション
dev-cluster-namespace テキスト Docker エンジンがホストされてデプロイされている Kubernetes クラスター名前空間。 必須
dev-region テキスト クラスターをホストしている IBM Cloud リージョン。 必須
dev-resource-group テキスト クラスター・リソース・グループ。 必須
doi-buildnumber テキスト --buildnumber コマンドで ibmcloud doi フラグとして使用するビルド番号の値。 オプション
doi-environment テキスト DevOps Insights ターゲット環境。 オプション
doi-ibmcloud-api-key シークレット IBM Cloud API キー。DOI レコードがアップロードされる DevOps Insights インスタンスと対話します。 オプション
doi-logicalappname テキスト --logicalappname コマンドで ibmcloud doi フラグとして使用するアプリ名。 オプション
doi-tags テキスト コンマ区切りのカスタム・タグ。 オプション
doi-toolchain-id テキスト DevOps Insights インスタンスのツールチェーン ID。 オプション
evidence-repo ツール統合 エビデンス・リポジトリーの URL。 オプション
evidence-reuse テキスト エビデンスの再利用を有効にするには、このフラグを 1 に設定します。 オプション
evidence-validity-period テキスト 証拠を再利用できる有効期間(時間)。 デフォルト値:24時間。 最大値:720時間(30日間) オプション
git-token シークレット Git リポジトリーのアクセス・トークン。 オプション
github-token シークレット GitHub リポジトリのアクセストークン。 オプション
gosec-additional-flags テキスト gosec コマンドの先頭に付加される追加のフラグ。 オプション
gosec-private-repository-url テキスト (非推奨) プライベート・リポジトリーのベース URL。 例えば、https://github.ibm.com です。 オプション
gosec-private-repository-host テキスト プライベート・リポジトリー・ホスト。 例: github.ibm.com オプション
gosec-private-repository-ssh-key 秘密 (secret) プライベート・リポジトリーの SSH 鍵。 オプション
gosec-private-repository-user テキスト https アクセス権限を持つプライベート・リポジトリーのユーザー (デフォルトは x-oauth-basic) オプション
gosec-private-repository-token 秘密 (secret) プライベート・リポジトリーへの https アクセスに使用されるトークン (デフォルトは、リポジトリー URL が gosec-private-repository-host の値でホストされているツールチェーン内の最初の Git 統合用に構成されたトークン) オプション
gosec-proxy-virtual-repository-token 秘密 (secret) gosec プロキシーの仮想リポジトリー・トークン。 オプション
gosec-proxy-virtual-repository-user テキスト gosec プロキシーの仮想リポジトリー・ユーザー。 オプション
gosec-proxy-virtual-repository-url テキスト gosec プロキシーの仮想リポジトリー URL。 オプション
gosec-scan-image テキスト カスタム・イメージまたは公式イメージの特定のバージョンを含む、代替 gosec イメージを指定します。 オプション
grit-token シークレット Git Repos and Issue Tracking アクセストークン。 オプション
iam_retry_count テキスト IAM トークンのフェッチを待機する再試行の回数。 オプション
iam_retry_sleep テキスト IAM トークンをフェッチするための待機時間の長さ。 オプション
ibmcloud-api-key シークレット IBM CloudのAPIキーで、ibmcloud CLIツールとやりとりします。 必須
ibmcloud-enable-session-keep-alive 選択 この値が 1 に設定されている場合は、Code Risk Analyzer スキャンで長時間実行されるジョブに対して IBM Cloud CLI セッションを活動状態に保ちます。 オプション
icr-dockerconfigjson シークレット base64-encoded Docker config.json ファイルは、IBM Container Registryのクレデンシャル情報を格納します。 このパラメーターは、SLSA 認証で使用されます。 オプション
incident-assignee テキスト インシデント問題の割り当て対象者 (GitHub または GitLab ユーザー名)。 オプション
incident-assignees テキスト インシデントの問題に対する割り当て対象者 (コンマで区切られた 1 つ以上のユーザー名)。 このパラメーターは、 GitHub および GitLab プレミアム・アカウントでのみ使用できます。 オプション
incident-label テキスト 新しいインシデント Issue のラベル。 オプション
incident-labels テキスト 新規インシデント問題のラベル。 incident-labels は、コンマで区切られた 1 つ以上のラベルにすることができます。 オプション
incident-repo ツール統合 インシデントはレポのURLを発行する。 オプション
inventory-repo ツール統合 インベントリー・リポジトリーの URL。 オプション
dind-image テキスト サイドカーを実行するための基本イメージ。 オプション
opt-in-gosec テキスト gosec 静的スキャンを有効にします。 オプション
one-pipeline-dockerconfigjson シークレット プライベート・レジストリーからイメージをプルするための Base64 エンコードの Docker config.json ファイル。 オプション
opt-in-dynamic-api-scan テキスト OWASP Zap API スキャンを有効にします。 オプション
opt-in-dynamic-scan テキスト OWASP Zap スキャンを有効にします。 オプション
opt-in-dynamic-ui-scan テキスト OWASP Zap UI スキャンを有効にします。 オプション
opt-in-pr-collection テキスト PR 収集を有効にするには、任意の値を追加します。 オプション
opt-in-sonar テキスト Sonarqube スキャン統合。 オプション
opt-in-sonar-hotspots テキスト Sonarqube スキャンでのホット・スポット検出を許可します。 オプション
opt-out-ci-set-commit-status テキスト このパラメーターに何らかの値がある場合、CI パイプライン実行の結果 (成功または失敗) に従って、ソース・コード・リポジトリーのコミット状況値が CI パイプラインによって設定されることはありません。 オプション
opt-out-nonvulnerability-issue-collection テキスト 脆弱性に関連しない問題の収集をオプトアウトするには、任意の値を追加します。 オプション
peer-review-compliance テキスト CI および CD パイプラインで peer-review-compliance 環境変数を 1 に設定して、ピア・レビュー・チェックをアクティブにします。 同様に、CD パイプラインでは、この構成は、現在のデプロイメントにリンクされているすべてのプル要求に対してピア・レビュー検証を実行します。 オプション
peer-review-collection テキスト 進行中のデプロイメントのプル要求とその関連タイトルのリストを取得するには、この値を 1 に設定します。 オプション
pipeline-config テキスト パイプラインの動作をカスタマイズするための構成ファイル。 必須
pipeline-config-branch テキスト DevSecOps パイプライン構成のブランチ。 オプション
pipeline-config-repo テキスト DevSecOps パイプライン構成ロケーションのリポジトリー URL。 オプション
publish-retry-duration テキスト 次の公開エビデンス試行を開始する前に待機する期間を秒単位で指定します。 オプション
pipeline-debug 選択 パイプラインのデバッグ・モードのスイッチ。 オプション
registry-namespace テキスト イメージのコンテナー・レジストリー名前空間。 必須
registry-region テキスト イメージ・レジストリーの IBM Cloud リージョン。 必須
repository テキスト アプリケーションのソース・コード・リポジトリーの URL。 オプション
repository-integration テキスト リポジトリーの統合名。 オプション
sbom-validation-collect-evidence テキスト Cyclonedx sbom の sbom 検証スキャンのエビデンス収集を有効にします。 この値が 1 に設定されている場合、sbom 検証はエビデンスを収集します。 オプション
signing-key シークレット .pfx ファイル・データを使用してイメージに署名するための Base64 エンコードの秘密鍵。 必須
skip-inventory-update-on-failure テキスト 失敗した CI 実行で在庫更新を停止するスイッチ。 オプション
slack-notifications テキスト Slackとの統合をオン・オフするスイッチ オプション
slsa-attestation 選択 SLUSA 認証を有効にするスイッチ。 オプション
slsa-attestation-public-key シークレット SRSA 認証レポートを検証するための base64-encoded 公開鍵。 オプション
sonarqube ツール統合 Sonarqube ツール統合。 オプション
sonarqube_standby ツール統合 フォールバックとして使用できる待機 Sonarqube ツールの統合。 オプション
sonarqube-config テキスト 分離された Docker-in-Docker コンテナー (デフォルト構成) または既存の開発 Kubernetes クラスター (クラスター構成) で SonarQube スキャンを実行します。 あるいは、独自の SonarQube インスタンスを持ち込み、 SonarQube ツール統合 (カスタム構成) を構成することもできます。 オプション: defaultcluster、または custom。 デフォルトは default です。 詳しくは、継続的統合パイプラインへの SonarQube の追加 を参照してください。 必須
sonarqube-namespace テキスト パイプラインによって作成される SonarQube インスタンスで使用するように構成された Kubernetes 名前空間。 オプション
sonarqube-instance-image テキスト 分離された Docker-in-Docker コンテナーとして実行するために使用される sonarqube インスタンス・イメージ。 オプション
sonarqube-scanner-image テキスト デフォルトの sonarqube スキャン・コマンドに使用される sonarqube スキャナー CLI イメージ。 オプション
sonarqube-scan-command テキスト sonarqube スキャンを開始する sonarqube スキャン・コマンド。 sonarqube-scan-command は、Maven Java プロジェクト用に設定する必要があります。 詳しくは、 sonarqube-scan-command を参照してください。 オプション
static-scan-retry-count テキスト Sonarqube インスタンスが確立されるのを待機する再試行回数。 オプション
static-scan-retry-sleep テキスト 再試行を繰り返すたびに待機する時間。 オプション
subpipeline-webhook-token シークレット 非同期パイプラインをトリガーする ための Subpipeline Webhook Trigger の Webhook 秘密。 非同期ステージ Webhook の更新 も参照してください。 オプション
sysdig-api-token テキスト Sysdig API トークン値。 トークンは、Sysdig インスタンスの「ユーザー・プロファイル」ページから表示できます。 この値は、Sysdig スキャンを実行するために必要です。 必須
sysdig-inline-scanner-image テキスト スキャンに使用される Sysdig インライン・スキャナー・イメージ。 デフォルト値: quay.io/sysdig/secure-inline-scan:2 オプション
sysdig-scan 選択 イメージの Sysdig スキャンを有効にします。 この値を 1 に設定すると、Sysdig スキャンが有効になります。 必須
sysdig-policies テキスト コンマ区切り値を持つ sysdig ポリシーの ID。 ポリシー ID は、セクション How to scan Images with this policy の下にあります ( --policy タグの後にある名前を探します)。 オプション
sysdig-url テキスト スキャンのために使用される Sysdig インスタンスの URL。 デフォルト値: https://us-south.security-compliance-secure.cloud.ibm.com オプション
va-scan-retry-count テキスト 脆弱性レポート・スキャンを待機する再試行の回数。 必須
va-scan-retry-sleep テキスト 再試行を繰り返すたびに待機する時間を表す数値。 オプション
version テキスト デプロイするアプリのバージョン。 必須
表 3. 継続的デプロイメント・パラメーター
名前 タイプ 説明 必須またはオプションです
artifact-token シークレット 成果物が保管されるトークン 成果物リポジトリーが別のソース・プロバイダーにある場合は必須です。
artifactory-dockerconfigjson シークレット artifactory の資格情報を保管する Base64 エンコードの Docker config.json ファイル。 オプション
assignee テキスト 変更要求の割り当て対象者。 オプション
backout-plan テキスト 障害が発生した場合の変更のロールバック方法を計画します。 オプション
batched-evidence-collection テキスト バッチ・モードでの証拠収集を有効にするには、このフラグを設定します。これにより、ネットワーク呼び出しが最小限に抑えられます。 デフォルト 1 オプション
ciso-ibmcloud-api-key シークレット イメージの署名および署名の検証のために ibmcloud-api-key をオーバーライドします。 オプション
cocoa-config-retry-status-code テキスト ココア CLI で再試行する必要がある API 呼び出しに対する応答状況コード。 例: 500,404 デフォルト値: 500 オプション
cocoa-config-max-retry-attempts テキスト Cocoa CLI が API 呼び出しを再試行できる回数。 例: 5 デフォルト値: 3 オプション
cocoa-config-git-default-branch (supported in Q4, 2022) テキスト Cocoa CLI のデフォルトの Git ブランチ。 例: main デフォルト値: master オプション
change-request-duration テキスト 変更の計画された終了時刻。 オプション
change-management-repo テキスト 変更管理リポジトリーの URL です。 オプション
change-request-id テキスト オープン状態の変更要求の ID。 このパラメータがデフォルトで notAvailable に設定されている場合、継続的デプロイメントパイプラインによって変更要求が自動的に作成されます。 オプション
cluster テキスト Docker ビルド・クラスターの名前。 必須
cluster-region テキスト クラスターをホストしている IBM Cloud リージョン。 必須
compliance-baseimage テキスト 組み込みパイプライン・コードを実行するための基本イメージ。 オプション
cos-api-key シークレット Cloud Object Storage の API キー。 オプション
cos-access-key-id シークレット HMAC 資格情報からの Cloud Object Storage アクセス・キー ID。 ( cos-api-key の代わりに cos-secret-access-key とともに提供) オプション
cos-secret-access-key シークレット HMAC 資格情報からの Cloud Object Storage 秘密アクセス・キー。 ( cos-api-key の代わりに cos-access-key-id とともに提供) オプション
cos-bucket-name テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンス内のバケットの名前。 オプション
cos-endpoint テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンスにエビデンスを保管するエンドポイント。 詳しくは、 エンドポイント・タイプ を参照してください。 オプション
cr-pipeline-name テキスト 変更要求を作成しているパイプラインの名前です。 オプション
cr-pipeline-version テキスト 変更要求を作成しているパイプラインのバージョンです。 オプション
cra-ibmcloud-api-key シークレット CRA タスクによって使用される ibmcloud-api-key を上書きします。 オプション
customer-impact テキスト お客様に対する変更の影響。 オプション
deployment-impact テキスト 変更によるデプロイメントへの影響。 オプション
description テキスト 変更要求の説明に追加される変更の説明。 オプション
dind-image テキスト サイドカーを実行するための基本イメージ。 オプション
doi-buildnumber テキスト --buildnumber コマンドで ibmcloud doi フラグとして使用するビルド番号の値。 オプション
doi-environment テキスト DevOps Insights ターゲット環境。 オプション
doi-ibmcloud-api-key シークレット IBM Cloud API キー。DOI レコードがアップロードされる DevOps Insights インスタンスと対話します。 オプション
doi-logicalappname テキスト --logicalappname コマンドで ibmcloud doi フラグとして使用するアプリ名。 オプション
doi-tags テキスト コンマ区切りのカスタム・タグ。 オプション
doi-toolchain-id テキスト DevOps Insights インスタンスのツールチェーン ID。 オプション
emergency-label テキスト プル要求を緊急と見なします。 オプション
evidence-repo ツール統合 エビデンス・リポジトリーの URL。 オプション
force-redeploy テキスト 最後のデプロイメントとの差分がインベントリーに含まれていなくても、アプリのデプロイメントまたは再デプロイメントを強制的に実行します。 指定したターゲット環境への最初のデプロイメントであるかのようにアプリのデプロイメントを強制的に実行するには、このパラメーターを true に設定します。 デフォルトでは、このパラメーターは false に設定されます。 オプション
git-token シークレット Git リポジトリーのアクセス・トークン。 オプション
github-token シークレット GitHub リポジトリのアクセストークン。 オプション
grit-token シークレット Git Repos and Issue Tracking アクセストークン。 オプション
iam_retry_count テキスト IAM トークンのフェッチを待機する再試行の回数。 オプション
iam_retry_sleep テキスト IAM トークンをフェッチするための待機時間の長さ。 オプション
ibmcloud-api-key シークレット IBM CloudのAPIキーで、ibmcloud CLIツールとやりとりします。 必須
impact テキスト この変更の実装が何に影響するかについての補足説明。 オプション
incident-repo ツール統合 インシデントはレポのURLを発行する。 オプション
inventory-repo ツール統合 インベントリー・リポジトリーの URL。 オプション
incident-assignee テキスト インシデント問題の割り当て対象者 (GitHub または GitLab ユーザー名)。 オプション
incident-assignees テキスト インシデントの問題に対する 1 人以上の担当者 (コンマで区切られた 1 つ以上のユーザー名)。 このパラメーターは、 GitHub および GitLab プレミアム・アカウントでのみ使用できます。 オプション
incident-label テキスト 新しいインシデント Issue のラベル。 オプション
incident-labels テキスト 新規インシデント問題のラベル。 incident-labels は、コンマで区切られた 1 つ以上のラベルにすることができます。 オプション
opt-in-pr-collection テキスト PR 収集を有効にするには、任意の値を追加します。 オプション
opt-out-nonvulnerability-issue-collection テキスト 脆弱性に関連しない問題の収集をオプトアウトするには、任意の値を追加します。 オプション
pipeline-config テキスト パイプラインの動作をカスタマイズするための構成ファイル。 必須
pipeline-config-branch テキスト DevSecOps パイプライン構成のブランチ。 オプション
pipeline-config-repo テキスト DevSecOps パイプライン構成ロケーションのリポジトリー URL。 オプション
pipeline-debug 選択 パイプラインのデバッグ・モードのスイッチ。 オプション
pipeline-dockerconfigjson シークレット プライベート・レジストリーからイメージをプルするための Base64 エンコードの Docker config.json ファイル。 オプション
pre-prod-evidence-collection テキスト 実動デプロイメントで実動前の証拠と変更依頼を収集するには、このフラグを設定します (target-environment-purposeproduction に設定します)。 デフォルト値は 0 です。 オプション
priority テキスト 変更要求の優先度。 オプション
publish-retry-duration テキスト 次の公開エビデンス試行を開始する前に待機する期間を秒単位で指定します。 オプション
purpose テキスト 変更が必要な理由。 オプション
region テキスト アプリがデプロイされるターゲット・リージョン。 オプション
rollback-enabled テキスト インライン・ロールバック機能を有効にするかどうかを設定するフラグ。 デフォルトは「0」です。 オプション
sbom-validation-collect-evidence テキスト CI パイプラインでの sbom 検証スキャンのステータスの検証を有効にします。 この値が 1 に設定されている場合、sbom 検証 (成功または失敗) スキャンのステータスが CI であることが検証されます。 オプション
source-environment テキスト アプリのプロモート元のソース環境。 必須
summary-retry-attempts テキスト エビデンス要約アップロードの再試行の最大回数を設定します。 デフォルトは 5 です。 オプション
summary-max-retry-time テキスト エビデンス・サマリー・アップロードの最大バックオフ時間を設定します。 実際のバックオフ時間は、このパラメーターで設定された最大バックオフ時間に達するまで、再試行ごとに指数関数的に生成されます。 デフォルトは 32 です。 オプション
target-environment テキスト アプリがデプロイされるターゲット環境。 必須
target-environment-purpose テキスト アプリがデプロイされている環境のコンテキスト。 有効な値: pre_prodproduction 必須
target-environment-detail テキスト アプリがデプロイされているターゲット環境の説明。 必須
version テキスト デプロイするアプリのバージョン。 必須
表 4。 継続的コンプライアンス・パラメーター
名前 タイプ 説明 必須またはオプションです
app-url テキスト ターゲット上にデプロイされているアプリケーションの URL。 ステージング・アプリケーション URL を使用するアプリケーションに推奨されます。 必須
artifactory-dockerconfigjson シークレット artifactory の資格情報を保管する Base64 エンコードの Docker config.json ファイル。 オプション
baseimage-auth-email テキスト Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-host テキスト Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-password シークレット Code Risk Analyzerのスキャンに必要なアプリケーションDockerfileベースイメージの認証情報。 オプション
baseimage-auth-user テキスト Code Risk Analyzerのスキャンに必要な、アプリケーションDockerfileのベースイメージのユーザークレデンシャル。 オプション
batched-evidence-collection テキスト バッチ・モードでの証拠収集を有効にするには、このフラグを設定します。これにより、ネットワーク呼び出しが最小限に抑えられます。 デフォルト 1 オプション
branch テキスト アプリケーションのソース・コードが含まれているリポジトリーの Git リポジトリー・ブランチ。 デフォルト値: master オプション
cocoa-config-retry-status-code テキスト ココア CLI で再試行する必要がある API 呼び出しに対する応答状況コード。 例: 500,404 デフォルト値: 500 オプション
cocoa-config-max-retry-attempts テキスト Cocoa CLI が API 呼び出しを再試行できる回数。 例: 5 デフォルト値: 3 オプション
cocoa-config-git-default-branch (supported in Q4, 2022) テキスト Cocoa CLI のデフォルトの Git ブランチ。 例: main デフォルト値: master オプション
cocoa-display-elapsed-time テキスト このパラメーターを空でない値に設定すると、cocoa CLI コマンド実行の経過時間 (秒) が出力されます。 例: Elapsed time: 5.32 seconds オプション
compliance-baseimage テキスト 組み込みパイプライン・コードを実行するための基本イメージ。 オプション
cos-api-key シークレット Cloud Object Storage の API キー。 オプション
cos-access-key-id シークレット HMAC 資格情報からの Cloud Object Storage アクセス・キー ID。 ( cos-api-key の代わりに cos-secret-access-key とともに提供) オプション
cos-secret-access-key シークレット HMAC 資格情報からの Cloud Object Storage 秘密アクセス・キー。 ( cos-api-key の代わりに cos-access-key-id とともに提供) オプション
cos-bucket-name テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンス内のバケットの名前。 オプション
cos-endpoint テキスト エビデンス・ロッカーとして使用される Cloud Object Storage インスタンスにエビデンスを保管するエンドポイント。 詳しくは、 エンドポイント・タイプ を参照してください。 オプション
cr-ibmcloud-api-key シークレット Sysdig スキャンの Container Registry からイメージをプルするために、指定されている場合は ibmcloud-api-key をオーバーライドします。 オプション
cr-resource-group テキスト Container Registryへのアクセスに使用されるリソース・グループ。 オプション
cra-custom-script-path テキスト CRA スキャンの前に実行するカスタム・スクリプトのパス。 このスクリプトは、CRA BOM ツールのコンテキストで ENV 変数を設定するオプションを提供するためのものです。 オプション
cra-cveignore-path テキスト cveignore へのファイル・パス (アプリケーション・リポジトリー・ルートからの相対パス)。 値が指定されていない場合、デフォルトのファイル・パスは .cra/.cveignore です。 オプション
cra-docker-build-context テキスト このフラグが指定された場合、Code Risk AnalyzerはDockerビルド・コンテキストとしてpathパラメータのディレクトリを使用します。 デフォルト値は falseです。 オプション
cra-docker-buildflags テキスト docker build コマンドをカスタマイズしてビルド・ステージをスキャンする。 このパラメータはデフォルトでは空である。 オプション
cra-dockerfile-pattern テキスト 異なる命名規則 ( enterprise-linux.Dockerfile など) を使用して Dockerfile を追加する機能 オプション
cra-exclude-devdependencies テキスト スキャンから開発依存関係を除外するかどうかを指定します (true または false)。 デフォルト値はfalseです。 オプション
cra-gradle-exclude-configs テキスト Gradle のどの設定をスキャンする際に依存関係を除外するかを指定します。 例: runtimeClasspath,testCompileClasspath。 このパラメータはデフォルトでは空である。 オプション
cra-generate-cyclonedx-format テキスト 1 に設定すると、CRA は cyclonedx 形式で BOM も生成します (デフォルトは 0)。 オプション
cra-ibmcloud-api-key シークレット CRA タスクによって使用される ibmcloud-api-key を上書きします。 オプション
cra-maven-exclude-scopes テキスト スキャンで依存関係を除外する maven スコープを指定します。 例: test,compile。 このパラメータはデフォルトでは空である。 オプション
cra-nodejs-create-package-lock テキスト Code Risk Analyzer Discovery が node.js リポジトリー用に package-lock.json ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
cra-python-create-requirements-txt テキスト 非推奨。 新しい CRA ツールでは、このパラメーターは使用されなくなりました。 Code Risk Analyzer Discovery が Python リポジトリー用に requirements.txt ファイルをビルドできるようにします。 デフォルトでは、このパラメーターは false に設定されています。 オプション
custom-exempt-label テキスト インシデントの問題に免除のマークが付けられたカスタム・ラベルを定義します。 オプション
detect-secrets-baseline-filename テキスト アプリケーション・リポジトリー内のベースライン・ファイルの名前。 オプション
detect-secrets-exclusion-list テキスト 検出シークレット・スキャンで除外するファイルの正規表現リスト。 オプション
detect-secrets-image テキスト カスタム・イメージまたは特定のバージョンの公式イメージを含む、代替の detect-secrets イメージを指定します。 オプション
detect-secrets-verbose テキスト 現在スキャン中のファイルの名前を出力します。 オプション
dev-region テキスト クラスターをホストしている IBM Cloud リージョン。 デフォルトの静的スキャンおよび動的スキャンの場合は必須です。 必須
dev-resource-group テキスト クラスター・リソース・グループ。 必須
dind-image テキスト サイドカーを実行するための基本イメージ。 オプション
doi-environment テキスト DevOps Insights ターゲット環境。 オプション
doi-ibmcloud-api-key シークレット IBM Cloud API キー。DOI レコードがアップロードされる DevOps Insights インスタンスと対話します。 オプション
doi-tags テキスト コンマ区切りのカスタム・タグ。 オプション
doi-toolchain-id テキスト DevOps Insights インスタンスのツールチェーン ID。 オプション
environment-tag テキスト インベントリー内のターゲット環境を表すタグ名。 例: prod_latest 必須
evidence-repo ツール統合 エビデンス・リポジトリーの URL。 オプション
git-token シークレット Git リポジトリーのアクセス・トークン。 オプション
github-token シークレット GitHub リポジトリのアクセストークン。 オプション
grit-token シークレット Git Repos and Issue Tracking アクセストークン。 オプション
ibmcloud-api-key シークレット IBM CloudのAPIキーで、ibmcloud CLIツールとやりとりします。 必須
ibmcloud-enable-session-keep-alive 選択 この値が 1 に設定されている場合は、Code Risk Analyzer スキャンで長時間実行されるジョブに対して IBM Cloud CLI セッションを活動状態に保ちます。 オプション
incident-assignee テキスト インシデント問題の割り当て対象者 (GitHub または GitLab ユーザー名)。 オプション
incident-assignees テキスト インシデントの問題に対する 1 人以上の担当者 (コンマで区切られた 1 つ以上のユーザー名)。 このパラメーターは、 GitHub および GitLab プレミアム・アカウントでのみ使用できます。 オプション
incident-label テキスト 新しいインシデント Issue のラベル。 オプション
incident-labels テキスト 新規インシデント問題のラベル。 incident-labels は、コンマで区切られた 1 つ以上のラベルにすることができます。 オプション
incident-repo ツール統合 インシデントはレポのURLを発行する。 オプション
inventory-exclude テキスト CC パイプラインでのスキャンおよびテストのために除外されるインベントリー・エントリーのコンマ区切りリスト。 グロブ・パターンを使用して項目を指定することもできます。 オプション
inventory-include テキスト CC パイプラインでのスキャンおよびテストのために含まれるインベントリー項目のコンマ区切りリスト。 グロブ・パターンを使用して項目を指定することもできます。 設定されていない場合、すべての項目がスキャンされ、テストされます。 オプション
inventory-repo ツール統合 インベントリー・リポジトリーの URL。 オプション
opt-in-auto-close テキスト 脆弱性が CC パイプラインの実行によって検出されなくなった場合に、脆弱性からの問題の自動クローズを有効にします。 オプション
opt-in-cra-auto-remediation テキスト IBM Cloud cra auto remediation を実行するかどうかを指定します (true または false)。 オプション
opt-in-cra-auto-remediation-enabled-repos テキスト IBM Cloud cra auto remediation に対してオンにする、コンマ区切りのリポジトリー名のリストを指定します。 このパラメーターは、 opt-in-cra-auto-remediationtrue に設定されている場合にのみ考慮されます。 オプション
opt-in-cra-auto-remediation-force テキスト メジャー・バージョンが現行の脆弱なパッケージ・バージョン (true または false) と異なる場合でも、 IBM Cloud cra auto remediation にパッケージの更新を強制します。 このパラメーターは、 opt-in-cra-auto-remediationtrue に設定されている場合にのみ考慮されます。 オプション
opt-in-dynamic-api-scan テキスト OWASP Zap API スキャンを有効にします。 オプション
opt-in-dynamic-scan テキスト OWASP Zap スキャンを有効にします。 オプション
opt-in-dynamic-ui-scan テキスト OWASP Zap UI スキャンを有効にします。 オプション
opt-in-sonar テキスト Sonarqube スキャン統合。 オプション
opt-in-sonar-hotspots テキスト Sonarqube スキャンでのホット・スポット検出を許可します。 オプション
opt-out-nonvulnerability-issue-collection テキスト 脆弱性に関連しない問題の収集をオプトアウトするには、任意の値を追加します。 オプション
pipeline-config テキスト パイプラインの動作をカスタマイズするための構成ファイル。 必須
pipeline-config-branch テキスト DevSecOps パイプライン構成のブランチ。 オプション
pipeline-config-repo テキスト DevSecOps パイプライン構成ロケーションのリポジトリー URL。 オプション
pipeline-debug 選択 パイプラインのデバッグ・モードのスイッチ。 オプション
pipeline-dockerconfigjson シークレット プライベート・レジストリーからイメージをプルするための Base64 エンコードの Docker config.json ファイル。 オプション
publish-retry-duration テキスト 次の公開エビデンス試行を開始する前に待機する期間を秒単位で指定します。 オプション
region-prefix テキスト ターゲット環境の latest タグの接頭部としてのリージョン名。 例: us-south オプション
repo-url テキスト アプリケーション・リポジトリーの URL。 複数のアプリケーション成果物を保管するために同じインベントリーを使用する場合は必須です。
repository-integration テキスト リポジトリーの統合名。 オプション
sbom-validation-collect-evidence テキスト Cyclonedx sbom の sbom 検証スキャンのエビデンス収集を有効にします。 この値が 1 に設定されている場合、sbom 検証はエビデンスを収集します。 オプション
slack-notifications テキスト Slackとの統合をオン・オフするスイッチ オプション
sonarqube ツール統合 Sonarqube ツール統合。 オプション
sonarqube-config テキスト 分離された Docker-in-Docker コンテナー (デフォルト構成) または既存の開発 Kubernetes クラスター (クラスター構成) で SonarQube スキャンを実行します。 あるいは、独自の SonarQube インスタンスを持ち込み、 SonarQube ツール統合 (カスタム構成) を構成することもできます。 オプション: defaultcluster、または custom。 デフォルトは default です。 詳しくは、継続的統合パイプラインへの SonarQube の追加 を参照してください。 必須
sysdig-api-token テキスト Sysdig API トークン値。 トークンは、Sysdig インスタンスの「ユーザー・プロファイル」ページから表示できます。 この値は、Sysdig スキャンを実行するために必要です。 必須
sysdig-inline-scanner-image テキスト スキャンに使用される Sysdig インライン・スキャナー・イメージ。 デフォルト値: quay.io/sysdig/secure-inline-scan:2 オプション
sysdig-scan 選択 イメージの Sysdig スキャンを有効にします。 この値を 1 に設定すると、Sysdig スキャンが有効になります。 必須
sysdig-url テキスト スキャンのために使用される Sysdig インスタンスの URL。 デフォルト値: https://secure.sysdig.com オプション
表 5. 販売促進パラメーター
名前 タイプ 説明 必須またはオプションです
dind-image テキスト サイドカーを実行するための基本イメージ。 オプション
インベントリ無視ファイル テキスト .inventoryignore ファイルのカスタム ファイル名。このファイルには、部分プロモーションの実行ごとに無視するファイル/フォルダーのリストが含まれています。 オプション
在庫を含める テキスト 部分プロモーションで選択的にプロモーションする在庫エントリ。 オプション
在庫除外 テキスト 部分プロモーションで除外する在庫エントリ。 オプション

仕様

以下の指定は、パラメーターの説明に役立ちます。

assignee

このパラメーターは、販売促進プル要求用です。 この値は、変更要求の割り当て対象者を保持します。 これは、変更管理システムで変更要求に割り当てられる機能 ID または E メールでなければなりません。

backout-plan

このパラメーターは、販売促進プル要求用です。 障害が発生した場合の変更のロールバック方法を計画します。 デフォルトでは空である。

branch

これは、CI パイプラインのオプション・パラメーターです。 どのブランチがアプリ・リポジトリーからコードをプルするかを決定します。 デフォルトでは master です。

変更要求期間

これは、CD パイプラインのオプション・パラメーターです。 この値により、保守期間が変更されます。 デフォルト値は 30 minです。

change-request-id

これは、CD パイプラインのオプション・パラメーターです。 変更要求 ID を指定すると、パイプラインは新規変更要求の作成をスキップし、指定された変更要求を使用します。 このパラメータが notAvailable に設定されているか、空のままだと、継続的デプロイメントパイプラインによって変更要求が自動的に作成されます。 デフォルト値はnotAvailableです。

クラスター

このパラメーターは、 Docker のデプロイに使用される、CD パイプライン内のクラスターの名前を保持します。 このパラメーターはサンプルアプリに必要です。

クラスター名

このパラメーターは、 Docker のデプロイに使用される CI パイプライン内のクラスターの名前を保持します。 このパラメーターは必須です。

cluster-region

これは CD パイプラインのパラメーターです。 クラスターをホストしている IBM Cloud リージョン。 これは、サンプル・アプリの必須パラメーターです。

compliance-baseimage

このパラメーターは、compliance-baseimage のバージョンを保持します。 最新のイメージ以外のイメージを使用する場合は、このパラメーターを使用します。

例: icr.io/continuous-delivery/toolchains/devsecops/baseimage:some-other-tag

カスタム免除ラベル

これは、CI パイプラインおよび CC パイプラインのオプション・パラメーターです。 カスタム・ラベルを使用して永続的に免除されるインシデント問題にマークを付けた場合、このパラメーターはカスタム・ラベルの値を保持する必要があります。

顧客への影響

このパラメーターは、販売促進プル要求用です。 これは、顧客に対する変更要求の影響を記録します。 デフォルトでは、このパラメーターはパイプで区切られたストリング 'Critical | High | Moderate | Low | No_Impact' です。 デフォルト・ストリングを編集して、いずれかのオプションを選択します。

デプロイメントへの影響

このパラメーターは、販売促進プル要求用です。 これは、デプロイメントに対する変更要求の影響を記録します。 デフォルトでは、このパラメーターはパイプで区切られたストリング 'Small | Large' です。 デフォルト・ストリングを編集して、いずれかのオプションを選択します。

説明

このパラメーターは、販売促進プル要求用です。 このパラメーターには、変更要求の説明が付加された変更の説明が含まれます。 デフォルトでは空である。

detect-secrets-baseline-filename

このパラメーターは、detect-secrets で使用されるベースライン・ファイルのカスタム・ファイル名を指定します。 デフォルトでは、detect-secrets は、リポジトリー・ルート・ディレクトリー内で .secrets.baseline という名前のファイルを探します。 ただし、ベースライン・ファイルに別の名前を付ける場合は、このパラメーターを使用してそのファイル名を指定できます。

detect-secrets-exclusion-list

このパラメーターは、既存のベースライン・ファイルを使用せずに実行した場合に、デフォルトの除外リストをオーバーライドする環境プロパティーです。 このパラメーターは、無視するファイルを識別して、それらにリンクされた問題が作成されないようにします。

detect-secrets-image

このパラメーターを使用して、カスタム・イメージや特定のバージョンの公式 detect-secrets イメージなど、使用する別の detect-secrets イメージを指定できます。

detect-secrets-verbose

このパラメーターを 1 に設定すると、スキャンされている現行ファイルの名前がログに記録されます。

ディンド・イメージ

このパラメーターは、カスタム dind イメージを設定するために使用されます。 カスタム dind イメージ・タグを使用するには、このパラメーターを設定します

impact

このパラメーターは、販売促進プル要求用です。 この変更実装がどのような影響を及ぼすかについての追加の注記。 デフォルトでは空である。

pipeline-debug

このパラメーターが 1 に設定されている場合、パイプラインはデバッグ・モードで実行され、ログにはより多くの情報が表示されます。 デフォルトでは0に設定されている。

優先

このパラメーターは、販売促進プル要求用です。 変更要求の優先度。 デフォルトは 'Critical | High | Moderate | Low | Plan' です。 これらの値のいずれかに変更できます。

目的

このパラメーターは、販売促進プル要求用です。 変更が必要な理由。 デフォルトでは空である。

署名鍵

このパラメーターは CI パイプライン用です。 これは、 .pfx ファイル・データを使用してイメージに署名するための base64-encoded 秘密鍵を保持する秘密タイプ・パラメーターです。

slack-notifications

Slack 統合をオンまたはオフに切り替えます。 これはデフォルトではオフになっているため、値は 0 です。 オンにするには 1 に設定し、オフにするには 0 に設定します。

sonarqube

このパラメーターは、静的スキャン・ステージを使用するすべてのパイプライン用です。 これは統合タイプ・パラメーターです。 独自の sonarqube 統合を使用する場合は、その統合を値として選択します。 デフォルトでは、このパラメータは空である。

sonarqube-namespace

このパラメーターは、静的スキャン・ステージを使用するすべてのパイプライン用です。 これは、パイプラインによって作成される SonarQube インスタンスで使用するように構成された Kubernetes 名前空間です。使用する任意の名前空間に変更できます。

sonarqube-scan コマンド

このパラメーターは、静的スキャン・ステージを使用するパイプライン用です。 sonarqube-scan-command は、sonarqube スキャンを開始するコマンドを指定します。 このパラメーターが設定されていない場合、デフォルトは docker run --network host -v "$SONAR_DIR":/usr/sonar_scan -v "$WORKSPACE/$path":/usr/src "$sonarqube_scanner_image" sonar-scanner -Dsonar.working.directory=/usr/sonar_scan です。 デフォルト・パラメーターは、 Docker sonar-scanner イメージを使用してスキャンを実行します。

Maven Java プロジェクトの場合、ソナー・スキャンに Maven 計算クラスパスを使用するには、このパラメーターを mvn -Dmaven.repo.local="${WORKSPACE}/.m2" -Dsonar.login="$(cat /tmp/sonarqube-token)" -Dsonar.host.url="$SONAR_HOST_URL" -Dsonar.projectKey="$SONAR_PROJECT_KEY" -Dsonar.projectName="$SONAR_PROJECT_KEY" -Dsonar.working.directory="$SONAR_DIR" sonar:sonar に設定します。

source-environment

アプリケーションのプロモート元のソース環境。これは、プロモーションのソース・インベントリー・ブランチです。 デフォルト値は masterです。 ペイロードに source-environment プロパティーを追加して Web フック・トリガーを使用し、このパラメーターの値を上書きします。

static-scan-retry-count

このパラメーターは、パイプラインで実行する静的スキャンのためのものです。 これらのスキャンでは API 呼び出しが使用されるため、作業に少し時間がかかる可能性があります。 そのため、必要に応じてこれらの呼び出しを再試行してください。 このパラメーターを使用して、再試行の回数を変更することができます。 デフォルトでは30に設定されている。

static-scan-retry-sleep

このパラメーターは、パイプラインで実行する静的スキャンのためのものです。 これらのスキャンでは API 呼び出しが使用されるため、作業に少し時間がかかる可能性があります。 そのため、必要に応じてこれらの呼び出しを再試行してください。 このパラメーターを使用して、待機する秒数を変更できます。 デフォルトでは10に設定されている。

再試行の要約

再試行メソッドを使用してエビデンス・サマリーをアップロードし、それが正常に行われたことを確認します。 このパラメーターを使用して、再試行の回数を変更することができます。 デフォルトでは、このパラメータは5に設定されている。

要約-最大再試行時間

再試行メソッドを使用してエビデンス・サマリーをアップロードし、それが正常に行われたことを確認します。 このパラメーターを使用して、待機する秒数を変更できます。 デフォルトでは、このパラメータは32に設定されている。

target-environment

アプリケーションのデプロイ先のターゲット環境。これは、販売促進のターゲット・インベントリー・ブランチです。 デフォルト値は prodです。 ペイロードに target-environment プロパティーを追加して Web フック・トリガーを使用し、このパラメーターの値を上書きします。

ターゲット環境の目的

このパラメーターは CD パイプライン用です。 target-environment-purpose は、ターゲット環境のコンテキストとその使用方法を決定します。 有効な値は pre_prodproduction です。 production 関連の変更ではないものに pre_prod のマークを付けます。

ターゲット環境詳細

このパラメーターは CD パイプライン用です。 これは、ターゲット環境を記述します。

sysdig-スキャン

このパラメーターは、 icr.io イメージで sysdig inline scanner を使用して Sysdig スキャンを実行するためにスキャン成果物ステージを使用するパイプライン用です。