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

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' です。 デフォルト・ストリングを編集して、いずれかのオプションを選択します。

デプロイメント設定

デプロイ構成は、このプロパティを通じて提供され、JSON文字列として指定されます。 以下に、deployment-config のサンプルを示します：

"deployment-config": [
  {
    "region": "region-1",
    "servicenow-crn-mask": "crn:region-1:kubernetes::::::",
    "inventory-ignore-file": "filepath/relative/to/the/inventory-repo",
    "evidence-checks-config-path": "filepath/relative/to/the/pipeline-config-repo",
    "deployment-prefix": "prefix1",
    "trace_id": "guid1"
  },
  {
    ...
  }
]

このプロパティに対して以下の検証ルールが適用され、いずれかが失敗した場合、適切なエラーメッセージと共にパイプラインが終了します：

• 配列は空であってはなりません。
• trace_id の値はすべて一意でなければなりません。
• 各要素は と region の両方を含まなければならない trace_id。
• 当該 deployment-config 物件は、以下の目的でのみ提供されなければならない。 cd-change-request-listener
• すべての要素がを含むか deployment-prefix、あるいはどれ一つとして含まないかのいずれかである
• が存在 deployment-prefix する場合、その値は全要素を通じて一意でなければならない
• が存在 deployment-prefix しない場合、の値は**全ての要素において **region 一意でなければならない

以下のフィールドについては、オブジェクトごとに指定されていない場合、グローバル環境変数がフォールバックとして使用されます：

• servicenow-crn-mask → $(get_env servicenow-crn-mask)
• inventory-ignore-file → $(get_env inventory-ignore-file)
• evidence-checks-config-path → $(get_env evidence-checks-config-path)

deployment-prefix グローバルなフォールバックを持たず、使用する場合は明示的に定義する必要があります。

デプロイメントへの影響

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

説明

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

detect-secrets-baseline-ファイル名

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

ディテクト・シークレット除外リスト

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

秘密画像検出

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

ディテクト・シークレット・バーボーズ

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

ディンド・イメージ

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

impact

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

pipeline-debug

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

パイプライン表示名

pipeline-display-name カスタムプロパティでは、パイプライン実行の表示名をカスタマイズできます。 この機能により、パイプライン実行の可視性とトレーサビリティが向上します。

例

pipeline-display-name を prod-deployment-v2.1.0 に設定する：

• パイプラインのラン名 ： prod-deployment-v2.1.0
• タスク名 ： prod-deployment-v2.1.0 、システム識別子とタスク固有の接尾辞が続く

優先

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

目的

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

署名鍵

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

slack-notifications

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

sonarqube

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

ソナーキューブ-ネームスペース

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

sonarqube-scan コマンド

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

Maven Java プロジェクトの場合、ソナー・スキャンに Maven 計算クラスパスを使用するには、このパラメーターを mvn -Dmaven.repo.local="${WORKSPACE}/.m2" -Dsonar.token="$SONAR_TOKEN" -Dsonar.host.url="$SONAR_HOST_URL" -Dsonar.projectKey="$SONAR_PROJECT_KEY" -Dsonar.projectName="$SONAR_PROJECT_KEY" -Dsonar.working.directory="$SONAR_DIR" org.sonarsource.scanner.maven:sonar-maven-plugin: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_prod および production です。 production 関連の変更ではないものに pre_prod のマークを付けます。

ターゲット環境詳細

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

sysdig-スキャン

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

在庫除外ファイル

このパラメータは、インベントリの除外ファイルのカスタムファイル名を指定します。 デフォルトでは、パイプラインはインベントリリポジトリのルートディレクトリにある「 .inventoryignore 」という名前のファイルを探します。 このファイルには、インベントリ操作の対象から除外するファイルとフォルダのリストが含まれています。

このパラメータは、ブランチ固有の無視ファイル、複数のデプロイ構成、リージョン固有の除外設定など、さまざまなユースケースに対応しています。 無視ファイルの形式、使用例、およびベストプラクティスに関する詳細については、「 インベントリからファイルやディレクトリを除外する方法 」を参照してください。

物件をロックする方法

環境プロパティをロックするには、環境プロパティの編集プロパティをクリックし、ロックされたプロパティを有効にします。

ロックの効果

環境プロパティでプロパティをロックした後、トリガーレベルを変更することはできない。 そのため、プロパティがロックされると、それらのプロパティはトリガー・レベルでは更新できなくなる。

ロックされたプロパティをトリガー・レベルに置こうとすると、エラーになります。

トリガー・レベルの変数を変更したい場合は、その変数のロックを無効にすればよい。