Parameter für Pipelines

Verantwortlicher

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Dieser Wert enthält den Verantwortlichen der Änderungsanforderung. Es muss sich um eine Funktions-ID oder eine E-Mail handeln, die der Änderungsanforderung im Change-Management-System zugewiesen wird.

backout-plan

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Plan, wie die Änderung rückgängig gemacht wird, wenn ein Fehler auftritt. Standardmäßig ist es leer.

Verzweigung

Dies ist ein optionaler Parameter für die CI-Pipeline. Sie legt fest, welche Verzweigung den Code aus dem App-Repository extrahiert. Standardmäßig lautet die Adresse „ master “.

Dauer der Änderungsanforderung (Change Request Duration)

Dies ist ein optionaler Parameter für die CD-Pipeline. Der Wert ändert die Wartungsdauer. Der Standardwert ist 30 min.

change-request-id

Dies ist ein optionaler Parameter für die CD-Pipeline. Durch Angabe einer Änderungsanforderungs-ID überspringt die Pipeline die Erstellung einer neuen Änderungsanforderung und verwendet die bereitgestellte Änderungsanforderung. Wenn dieser Parameter auf „ notAvailable “ gesetzt oder leer gelassen wird, wird automatisch ein Änderungsantrag von der Continuous-Deployment-Pipeline erstellt. Der Standardwert ist notAvailable.

Cluster

Dieser Parameter enthält den Namen des Clusters in der CD-Pipeline, der für die Docker-Bereitstellung verwendet wird. Dieser Parameter ist für die Beispiel-App erforderlich.

Clustername

Dieser Parameter enthält den Namen des Clusters in der CI-Pipeline, der für die Docker-Bereitstellung verwendet wird. Dieser Parameter ist erforderlich.

cluster-region

Dies ist ein Parameter für die CD-Pipeline. Die IBM Cloud-Region, die den Cluster hostet. Dies ist ein erforderlicher Parameter für die Beispiel-App.

compliance-baseimage

Dieser Parameter enthält die Version des Konformitätsbasisimage. Wenn Sie etwas anderes als das neueste Image verwenden möchten, verwenden Sie diesen Parameter.

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

freizustellendes Etikett

Dies ist ein optionaler Parameter für die CI-und CC-Pipelines. Wenn Sie ein Vorfallproblem markiert haben, das dauerhaft von einer benutzerdefinierten Bezeichnung ausgeschlossen ist, muss dieser Parameter den Wert der benutzerdefinierten Bezeichnung enthalten.

Auswirkung auf den Kunden

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Es zeichnet die Auswirkungen der Änderungsanforderung auf den Kunden auf. Standardmäßig ist der Parameter die durch Pipe-Zeichen getrennte Zeichenfolge 'Critical | High | Moderate | Low | No_Impact'. Bearbeiten Sie die Standardzeichenfolge, um eine der Optionen auszuwählen.

Bereitstellungskonfiguration

Die Bereitstellungskonfiguration wird über diese Eigenschaft bereitgestellt, die als JSON-Zeichenfolge angegeben wird. Hier ist ein Beispiel für eine „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"
  },
  {
    ...
  }
]

Die folgenden Validierungsregeln gelten für diese Eigenschaft. Bei Verstößen gegen eine dieser Regeln wird die Pipeline mit einer entsprechenden Fehlermeldung beendet:

• Das Array darf nicht leer sein.
• Alle Werte unter „ trace_id “ müssen eindeutig sein.
• Jedes Element muss sowohl region als auch trace_id enthalten.
• Die deployment-config Eigenschaft darf nur bereitgestellt werden für cd-change-request-listener
• Entweder enthalten **alle Elemente **deployment-prefix oder keines.
• Wenn deployment-prefix vorhanden ist, muss sein Wert über alle Elemente hinweg eindeutig sein
• Wenn nicht vorhanden deployment-prefix ist, muss der Wert region von über alle Elemente hinweg eindeutig sein

Für die folgenden Felder werden globale Umgebungsvariablen als Fallbacks verwendet, wenn sie nicht pro Objekt angegeben sind:

• 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 hat keinen globalen Fallback und muss bei Verwendung explizit definiert werden.

Implementierung-Auswirkung

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Sie erfasst die Auswirkungen der Änderungsanfrage auf die Implementierung. Standardmäßig ist der Parameter die durch Pipe-Zeichen getrennte Zeichenfolge 'Small | Large'. Bearbeiten Sie die Standardzeichenfolge, um eine der Optionen auszuwählen.

Beschreibung

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Dieser Parameter enthält die Beschreibung der Änderung, die an die Änderungsanforderungsbeschreibung angehängt wird. Standardmäßig ist es leer.

detect-secrets-baseline-dateiname

Dieser Parameter gibt einen angepassten Dateinamen für die Referenzdatei an, die von 'detect-secrets' verwendet wird. Standardmäßig sucht detect-secrets nach einer Datei mit dem Namen .secrets.baseline im Repository-Stammverzeichnis. Wenn Sie Ihre Referenzdatei jedoch anders benennen, können Sie ihren Dateinamen mit diesem Parameter angeben.

'detect-secrets-ausschlussliste'

Dieser Parameter ist eine Umgebungseigenschaft, die die Standardausschlussliste überschreibt, wenn eine Ausführung ohne vorhandene Referenzdatei erfolgt. Dieser Parameter gibt Dateien an, die ignoriert werden sollen, damit keine Probleme erstellt werden, die mit ihnen verknüpft sind.

Geheimnisse-Bild erkennen

Dieser Parameter kann verwendet werden, um ein anderes Image 'detect-secrets' anzugeben, das verwendet werden soll, z. B. ein angepasstes Image oder eine bestimmte Version des offiziellen Image 'detect-secrets'.

'detect-secrets-verbose'

Wenn dieser Parameter auf 1 gesetzt ist, wird der Name der aktuell gescannten Datei protokolliert.

dind-Bild

Dieser Parameter wird zum Festlegen eines angepassten dind-Image verwendet. Legen Sie diesen Parameter so fest, dass der angepasste dind-Image-Tag verwendet wird

impact

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Zusätzliche Hinweise zu den Auswirkungen dieser Change-Implementierung. Standardmäßig ist es leer.

pipeline-debug

Wenn dieser Parameter auf 1 gesetzt ist, wird die Pipeline im Debugmodus ausgeführt und die Protokolle zeigen weitere Informationen an. Standardmäßig ist der Wert auf 0 gesetzt.

pipeline-anzeigen-name

Mit der benutzerdefinierten Eigenschaft pipeline-display-name können Sie den Anzeigenamen von Pipelineläufen anpassen. Diese Funktion ermöglicht eine bessere Sichtbarkeit und Rückverfolgbarkeit Ihrer Pipeline-Ausführungen.

Beispiele

Stellen Sie pipeline-display-name auf prod-deployment-v2.1.0 ein:

• Name des Pipeline-Laufs: prod-deployment-v2.1.0
• Aufgabennamen: Mit prod-deployment-v2.1.0 als Präfix, gefolgt von Systemkennungen und aufgabenspezifischen Suffixen

priority

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Die Priorität des Änderungsantrags. Standardmäßig ist dies 'Critical | High | Moderate | Low | Plan'. Sie können ihn in einen dieser Werte ändern.

purpose

Dieser Parameter gilt für die Pull-Anforderung für Rabatte. Der Grund, warum die Änderung notwendig ist. Standardmäßig ist es leer.

signierschlüssel

Dieser Parameter gilt für die CI-Pipeline. Dies ist ein Parameter des Typs 'secret', der den base64-encoded privaten Schlüssel zum Signieren von Images unter Verwendung von .pfx-Dateidaten enthält.

slack-notifications

Schalten Sie die Slack-Integration ein oder aus. Diese Option ist standardmäßig inaktiviert, d. h., der Wert lautet 0. Setzen Sie dieses Attribut auf 1, um es zu aktivieren, und auf 0, um es zu inaktivieren.

SonarQube

Dieser Parameter gilt für alle Pipelines, die Stages für statische Scans verwenden. Dies ist ein Integrationstypparameter. Wenn Sie Ihre eigene Sonarqube-Integration verwenden möchten, wählen Sie diese Integration als Wert aus. Standardmäßig ist dieser Parameter leer.

Sonarqube-Namensraum

Dieser Parameter gilt für alle Pipelines, die Stages für statische Scans verwenden. Dies ist der konfigurierte Kubernetes-Namensbereich für die Verwendung mit der SonarQube-Instanz, die von der Pipeline erstellt wird. Sie können ihn in einen beliebigen Namensbereich ändern, den Sie verwenden wollen.

sonarqube-scan-befehl

Dieser Parameter gilt für Pipelines, die Stages für statische Scans verwenden. sonarqube-scan-command gibt den Befehl zum Starten des Sonarqube-Scans an. Wenn dieser Parameter nicht festgelegt ist, ist der Standardwert 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". Der Standardparameter verwendet das Docker sonar-scanner-Image, um den Scan auszuführen.

Setzen Sie diesen Parameter für ein Maven- Java-Projekt auf 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, damit der berechnete Maven-Klassenpfad für den Sonarscan verwendet wird.

source-environment

Die Quellenumgebung, aus der die App hochgestuft wird. Dies ist die Quellenbestandsverzweigung der Hochstufung. Der Standardwert ist master. Verwenden Sie einen Webhook-Auslöser, indem Sie den Nutzdaten die Eigenschaft source-environment hinzufügen, um den Wert dieses Parameters zu überschreiben.

static-scan-retry-count

Dieser Parameter gilt für jeden statischen Scan, den Sie in einer Pipeline ausführen wollen. Diese Scans verwenden API-Aufrufe, was eine kurze Zeit dauern kann. Wiederholen Sie diese Aufrufe bei Bedarf. Sie können die Wiederholungen mit diesem Parameter ändern. Standardmäßig ist dieser Parameter auf 30 eingestellt.

static-scan-retry-sleep

Dieser Parameter gilt für jeden statischen Scan, den Sie in einer Pipeline ausführen wollen. Diese Scans verwenden API-Aufrufe, was eine kurze Zeit dauern kann. Wiederholen Sie diese Aufrufe bei Bedarf. Mit diesem Parameter können Sie die Wartezeit in Sekunden ändern. Standardmäßig ist dieser Parameter auf 10 gesetzt.

Zusammenfassung-Wiederholungsversuche

Verwenden Sie eine Wiederholungsmethode, um die Angabenzusammenfassung hochzuladen, um sicherzustellen, dass sie erfolgreich ist. Sie können die Wiederholungen mit diesem Parameter ändern. Standardmäßig ist dieser Parameter auf 5 gesetzt.

summary-max-wiederholungszeit

Verwenden Sie eine Wiederholungsmethode, um die Angabenzusammenfassung hochzuladen, um sicherzustellen, dass sie erfolgreich ist. Mit diesem Parameter können Sie die Wartezeit in Sekunden ändern. Standardmäßig ist dieser Parameter auf 32 eingestellt.

target-environment

Die Zielumgebung, in der die App bereitgestellt wird. Dies ist der Zielbestandszweig des Rabatts. Der Standardwert ist prod. Verwenden Sie einen Webhook-Auslöser, indem Sie den Nutzdaten die Eigenschaft target-environment hinzufügen, um den Wert dieses Parameters zu überschreiben.

zielumgebung-zweck

Dieser Parameter gilt für die CD-Pipeline. target-environment-purpose bestimmt den Kontext der Zielumgebung und deren Verwendung. Gültige Werte sind pre_prod und production. Markieren Sie alle Änderungen, die keine production zugehörige Änderung sind, als pre_prod.

Zielumgebungsdetails

Dieser Parameter gilt für die CD-Pipeline. Es beschreibt die Zielumgebung.

Sysdig-Scan

Dieser Parameter gilt für Pipelines, die Scanartefaktphasen verwenden, um den Sysdig-Scan mithilfe von sysdig inline scanner on icr.io-Images auszuführen.

Datei zum Ignorieren bei der Bestandsaufnahme

Dieser Parameter legt einen benutzerdefinierten Dateinamen für die Ignorierdatei der Bestandsaufnahme fest. Standardmäßig sucht die Pipeline im Stammverzeichnis des Inventar-Repositorys nach einer Datei namens „ .inventoryignore “. Diese Datei enthält eine Liste der Dateien und Ordner, die von Inventarisierungsvorgängen ausgeschlossen werden sollen.

Der Parameter unterstützt verschiedene Anwendungsfälle, darunter branchspezifische Ignore-Dateien, mehrere Bereitstellungskonfigurationen und regionsspezifische Ausschlüsse. Ausführliche Informationen zum Format der Ignorierdatei, zu Anwendungsfällen und zu bewährten Vorgehensweisen finden Sie unter „ So schließen Sie Dateien und Verzeichnisse aus dem Inventar aus “.

Wie man eine Immobilie abschließt

Um eine Umgebungseigenschaft zu sperren, klicken Sie auf Eigenschaft der Umgebungseigenschaft bearbeiten und aktivieren Sie dann die gesperrte Eigenschaft.

Auswirkungen von Sperren

Nachdem eine Eigenschaft in der Umgebungseigenschaft gesperrt wurde, kann die Auslöseschwelle nicht mehr geändert werden. Sobald also eine Eigenschaft gesperrt ist, können diese Eigenschaften in der Auslöseebene nicht mehr aktualisiert werden.

Wenn Sie versuchen, eine gesperrte Eigenschaft in die Auslöseebene zu setzen, führt dies zu einem Fehler.

Wenn Sie die Variable in der Auslöserebene ändern wollen, können wir die Sperre für diese Variable aufheben.