管線參數

受託人

此參數適用於促銷活動取回要求。 此值保留變更要求的受託人。 它必須是功能 ID 或將指派給變更管理系統中變更要求的電子郵件。

取消計劃

此參數適用於促銷活動取回要求。 如果失敗，如何回復變更的計劃。 預設情況下為空。

分支 (branch)

這是 CI 管線的選用參數。 它會決定哪個分支從應用程式儲存庫取回程式碼。 預設情況下，它是 master.

變更要求時間

這是 CD 管線的選用參數。 此值會變更維護持續時間。 預設值為 30 min。

變更-請求-id

這是 CD 管線的選用參數。 透過提供變更要求 ID，管線會跳過建立新的變更要求，並使用所提供的變更要求。 如果此參數設為 notAvailable 或保留空白，則持續部署管線會自動建立變更要求。 預設值為 notAvailable。

叢集

此參數會保留 CD 管線中用於 Docker 部署的叢集名稱。 此參數為範例應用程式所必需。

叢集名稱

此參數會保留 CI 管線中用於 Docker 部署的叢集名稱。 這是必要參數。

叢集地區

這是 CD 管線的參數。 管理叢集的 IBM Cloud 地區。 這是範例應用程式的必要參數。

法規遵循-baseimage

此參數會保留 compliance-baseimage 的版本。 如果您要使用最新映像檔以外的其他項目，請使用此參數。

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

自訂豁免標籤

這是 CI 及 CC 管線的選用參數。 如果您標示使用自訂標籤永久豁免的發生事件問題，則此參數必須保留自訂標籤的值。

客戶影響

此參數適用於促銷活動取回要求。 它會記錄變更要求對客戶的影響。 依預設，參數是以垂直線區隔的字串 'Critical | High | Moderate | Low | No_Impact'。 編輯預設字串以選取其中一個選項。

部署設定

部署配置透過此屬性提供，以 JSON 字串形式呈現。 以下是一個範例部署設定檔：

"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-secret 所使用之基準線檔案的自訂檔名。 依預設，detect-secret 會在儲存庫根目錄中尋找名為 .secrets.baseline 的檔案。 不過，如果您以不同方式命名基準線檔案，則可以使用此參數來提供其檔名。

偵測機密排除清單

此參數是一個環境內容，在沒有現有基準線檔案的情況下執行時，會置換預設排除清單。 此參數會識別要忽略的檔案，因此不會建立鏈結至它們的問題。

偵測機密影像

此參數可用來指定要使用的不同 detect-secrets 映像檔，例如自訂映像檔或官方 detect-secrets 映像檔的特定版本。

detect-secret-verbose

當此參數設為 1 時，會記載所掃描現行檔案的名稱。

dind-image

此參數用於設定自訂 Dind 映像檔。 將此參數設為使用自訂 did 映像檔標籤

影響

此參數適用於促銷活動取回要求。 此「變更實作」將影響的其他附註。 預設情況下為空。

管道除錯

如果此參數設為 1，則管線會以除錯模式執行，且日誌會顯示更多資訊。 預設情況下，它被設定為 0。

優先順序

此參數適用於促銷活動取回要求。 變更要求的優先順序。 依預設，它是 'Critical | High | Moderate | Low | Plan'。 您可以將它變更為下列其中一個值。

purpose

此參數適用於促銷活動取回要求。 需要變更的原因。 預設情況下為空。

簽署金鑰

此參數適用於 CI 管線。 它是秘密類型參數，用於保留 base64-encoded 私密金鑰，以使用 .pfx 檔案資料來簽署映像檔。

松弛通知

切換以開啟或關閉「Slack 整合」。 依預設會關閉此選項，因此值為 0。 設為 1 以開啟它，設為 0 以關閉它。

sonarqube

此參數適用於使用靜態掃描階段的所有管線。 這是整合類型參數。 如果您使用自己的 sonarqube 整合，請選取該整合作為值。 依預設，此參數是空的。

國家名稱空間

此參數適用於使用靜態掃描階段的所有管線。 這是已配置的 Kubernetes 名稱空間，與管線所建立的 SonarQube 實例搭配使用，您可以將它變更為您要使用的任何名稱空間。

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 專案，請將此參數設為 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" sonar:sonar，以使用 Maven 計算的類別路徑來進行聲納掃描。

來源環境

從中升級應用程式的來源環境，這是促銷活動的來源庫存分支。 預設值為 master。 將 source-environment 內容新增至有效負載以改寫此參數的值，以使用 Webhook 觸發程式。

靜態掃描重試計數

此參數適用於您要在管線中執行的任何靜態掃描。 這些掃描使用 API 呼叫，可能需要一小段時間才能運作。 因此，必要的話，請重試這些呼叫。 您可以使用此參數來變更重試次數。 預設情況下，此參數設定為 30。

靜態掃描重試休眠

此參數適用於您要在管線中執行的任何靜態掃描。 這些掃描使用 API 呼叫，可能需要一小段時間才能運作。 因此，必要的話，請重試這些呼叫。 您可以使用此參數變更等待的秒數。 預設情況下，此參數設定為 10。

摘要-重試-次數

請使用重試方法來上傳證明摘要，以確保它成功。 您可以使用此參數來變更重試次數。 預設情況下，此參數設定為 5。

最大重試次數

請使用重試方法來上傳證明摘要，以確保它成功。 您可以使用此參數變更等待的秒數。 預設情況下，此參數設定為 32。

目標環境

應用程式部署至其中的目標環境，這是促銷活動的目標庫存分支。 預設值為 prod。 將 target-environment 內容新增至有效負載以改寫此參數的值，以使用 Webhook 觸發程式。

目標環境用途

此參數適用於 CD 管線。target-environment-purpose 決定目標環境的環境定義及其使用方式。 有效值為 pre_prod 和 production。 將任何非 production 相關變更標示為 pre_prod。

目標環境詳細資訊

此參數適用於 CD 管線。 它說明目標環境。

sysdig 掃描

此參數適用於使用掃描構件階段，在 icr.io 映像檔上使用 sysdig inline scanner 來執行 Sysdig 掃描的管線。

如何鎖定財產

若要鎖定環境屬性，請按一下環境屬性的編輯屬性，然後啟用已鎖定的屬性。

鎖定的影響

鎖定環境屬性中的屬性後，我們無法變更觸發等級。 因此，一旦屬性被鎖定，這些屬性就無法在觸發等級中更新。

如果您嘗試將任何鎖定的屬性放入觸發級別，將會導致錯誤。

如果要更改觸發層級中的變量，我們可以停用該變數的鎖定。