Parametri della pipeline

assegnatario

Questo parametro è per la richiesta di pull della promozione. Questo valore contiene l'assegnatario della richiesta di modifica. Deve essere un ID funzionale o un'email che verrà assegnata alla richiesta di modifica nel sistema di gestione modifiche.

piano di backout

Questo parametro è per la richiesta di pull della promozione. Pianificazione del modo in cui verrà eseguito il rollback della modifica in caso di errore. Per impostazione predefinita è vuoto.

ramo

Questo è un parametro facoltativo per la pipeline CI. Determina quale ramo estrae il codice dal repository dell'applicazione. Per impostazione predefinita, è master.

durata - richiesta - modifica

Questo è un parametro facoltativo per la pipeline del CD. Il valore modifica la durata della manutenzione. Il valore predefinito è 30 min.

id - richiesta - modifica

Questo è un parametro facoltativo per la pipeline del CD. Fornendo un ID richiesta di modifica, la pipeline ignora la creazione di una nuova richiesta di modifica e utilizza la richiesta di modifica fornita. Se questo parametro è impostato su notAvailable o lasciato vuoto, una richiesta di modifica viene creata automaticamente dalla pipeline di distribuzione continua. Il valore predefinito è notAvailable.

cluster

Questo parametro contiene i nomi dei cluster nella pipeline CD, che viene utilizzata per la distribuzione Docker. Questo parametro è obbligatorio per l'app di esempio.

nome - cluster

Questo parametro contiene il nome del cluster nella pipeline CI, che viene utilizzato per la distribuzione Docker. Questo parametro è obbligatorio.

regione - cluster

Questo è un parametro per la pipeline del CD. La regione IBM Cloud che ospita il cluster. Questo è un parametro obbligatorio per l'applicazione di esempio.

immagine di base di conformità

Questo parametro contiene la versione di compliance - baseimage. Se si desidera utilizzare qualcosa di diverso dall'ultima immagine, utilizzare questo parametro.

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

etichetta - esente - personalizzata

Questo è un parametro facoltativo per le pipeline CI e CC. Se hai contrassegnato un problema di incidente che è permanentemente esentato con un'etichetta personalizzata, questo parametro deve contenere il valore dell'etichetta personalizzata.

impatto sul cliente

Questo parametro è per la richiesta di pull della promozione. Registra l'impatto della richiesta di modifica sul cliente. Per impostazione predefinita il parametro è la stringa separata da pipe 'Critical | High | Moderate | Low | No_Impact'. Modificare la stringa predefinita per selezionare una delle opzioni.

configurazione-distribuzione

La configurazione di distribuzione viene fornita tramite questa proprietà, sotto forma di stringa JSON. Ecco un esempio di file di configurazione di distribuzione:

"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"
  },
  {
    ...
  }
]

Le seguenti regole di convalida sono applicabili a questa proprietà; il mancato rispetto di una qualsiasi di esse comporta l'interruzione della pipeline con un messaggio di errore appropriato:

• L'array non deve essere vuoto.
• Tutti i valori di trace_id devono essere univoci.
• Ogni elemento deve contenere sia region che trace_id.
• La deployment-config proprietà deve essere fornita solo per cd-change-request-listener
• O tutti gli elementi contengono deployment-prefix, oppure nessuno lo contiene.
• Se deployment-prefix è presente, il suo valore deve essere unico in tutti gli elementi.
• Se non deployment-prefix è presente, allora il valore di region deve essere unico in tutti gli elementi.

Per i seguenti campi, se non sono specificati per oggetto, vengono utilizzate come fallback le variabili di ambiente globali:

• 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 non ha un fallback globale e deve essere definito esplicitamente se utilizzato.

distribuzione - impatto

Questo parametro è per la richiesta di pull della promozione. Registra l'impatto della richiesta di modifica sulla distribuzione. Per impostazione predefinita il parametro è la stringa separata da pipe 'Small | Large'. Modificare la stringa predefinita per selezionare una delle opzioni.

Descrizione

Questo parametro è per la richiesta di pull della promozione. Questo parametro contiene la descrizione della modifica, che viene aggiunta alla descrizione della richiesta di modifica. Per impostazione predefinita è vuoto.

rileva - segreti - baseline - nomefile

Questo parametro specifica un nome file personalizzato per il file di baseline utilizzato da detect - secrets. Per impostazione predefinita, detect - secrets ricerca un file denominato .secrets.baseline nella directory root del repository. Tuttavia, se si assegna un nome diverso al file di base, è possibile fornirne il nome utilizzando questo parametro.

rileva - segreti - elenco - esclusioni

Questo parametro è una proprietà di ambiente che sovrascrive l'elenco di esclusione predefinito quando un'esecuzione viene eseguita senza un file di baseline esistente. Questo parametro identifica i file da ignorare in modo da non creare problemi ad essi collegati.

rileva - segreti - immagine

Questo parametro può essere utilizzato per specificare un'immagine detect - secrets differente da utilizzare, ad esempio un'immagine personalizzata o una versione specifica dell'immagine detect - secrets ufficiale.

detect - secrets - verbose

Questo parametro, se impostato su 1, registra il nome del file corrente sottoposto a scansione.

immagine - dind

Questo parametro viene utilizzato per impostare un'immagine dind personalizzata. Impostare questo parametro per utilizzare la tag di immagine dind personalizzata

impatto

Questo parametro è per la richiesta di pull della promozione. Ulteriori note sull'impatto di questa implementazione della modifica. Per impostazione predefinita è vuoto.

debug pipeline

Se questo parametro è impostato su 1, la pipeline viene eseguita in modalità di debug e i log mostrano ulteriori informazioni. Per impostazione predefinita, il valore è 0.

nome della pipeline

La proprietà personalizzata pipeline-display-name consente di personalizzare il nome di visualizzazione delle corse della pipeline. Questa funzione offre una migliore visibilità e tracciabilità delle esecuzioni della pipeline.

Esempi

Impostazione di pipeline-display-name su prod-deployment-v2.1.0:

• Nome della corsa della pipeline: prod-deployment-v2.1.0
• Nomi dei task: Prefisso con prod-deployment-v2.1.0 seguito dagli identificatori di sistema e dai suffissi specifici del task

priorità

Questo parametro è per la richiesta di pull della promozione. La priorità della richiesta di modifica. Per default è 'Critical | High | Moderate | Low | Plan'. È possibile modificarlo in uno di tali valori.

scopo

Questo parametro è per la richiesta di pull della promozione. Il motivo per cui la modifica è necessaria. Per impostazione predefinita è vuoto.

chiave di firma

Questo parametro è per la pipeline CI. È un parametro di tipo segreto che contiene la chiave privata base64-encoded per la firma delle immagini utilizzando i dati del file .pfx.

notifiche slack

Attivare o disattivare l'integrazione Slack. Questa opzione è disattivata per impostazione predefinita, quindi il valore è 0. Impostare su 1 per attivarlo, impostare su 0 per disattivarlo.

sonarqube

Questo parametro è per tutte le pipeline che utilizzano stage di scansione statici. Si tratta di un parametro di tipo integrazione. Se si utilizza la propria integrazione sonarqube, selezionare tale integrazione come valore. Per default, questo parametro è vuoto.

sonarqube-spazio dei nomi

Questo parametro è per tutte le pipeline che utilizzano stage di scansione statici. Questo è lo spazio dei nomi Kubernetes configurato da utilizzare con l'istanza SonarQube creata dalla pipeline, puoi modificarlo in qualsiasi spazio dei nomi che vuoi utilizzare.

comando sonarqube - scan

Questo parametro è per le pipeline che utilizzano stage di scansione statici. sonarqube-scan-command specifica il comando per avviare la scansione sonarqube. Se questo parametro non è impostato, il valore predefinito è 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". Il parametro predefinito utilizza l'immagine Docker sonar-scanner per eseguire la scansione.

Per un progetto Maven Java, imposta questo parametro su 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 per utilizzare il percorso classi calcolato Maven per la scansione sonar.

ambiente - origine

L'ambiente di origine da cui viene promossa l'applicazione, che è il ramo di inventario origine della promozione. Il valore predefinito è master. Utilizza un trigger webhook aggiungendo la proprietà source-environment al payload per sovrascriverne il valore.

conteggio - tentativi - scansione - statica

Questo parametro è per qualsiasi scansione statica che vuoi eseguire in una pipeline. Queste scansioni utilizzano le chiamate API, che possono richiedere un breve periodo di tempo per funzionare. Quindi, ritentare queste chiamate, se necessario. È possibile modificare l'ora dei tentativi con questo parametro. Per impostazione predefinita, questo parametro è impostato su 30.

statico - scansione - nuovo tentativo - sospensione

Questo parametro è per qualsiasi scansione statica che vuoi eseguire in una pipeline. Queste scansioni utilizzano le chiamate API, che possono richiedere un breve periodo di tempo per funzionare. Quindi, ritentare queste chiamate, se necessario. È possibile modificare il numero di secondi da attendere con questo parametro. Per impostazione predefinita, questo parametro è impostato su 10.

tentativi di riepilogo

Utilizzare un metodo di ripetizione per caricare il riepilogo delle prove per assicurarsi che sia corretto. È possibile modificare l'ora dei tentativi con questo parametro. Per impostazione predefinita, questo parametro è impostato su 5.

tempo - massimo - tentativi - riepilogo

Utilizzare un metodo di ripetizione per caricare il riepilogo delle prove per assicurarsi che sia corretto. È possibile modificare il numero di secondi da attendere con questo parametro. Per impostazione predefinita, questo parametro è impostato su 32.

ambiente - destinazione

L'ambiente di destinazione a cui è distribuita l'applicazione, che è il ramo di inventario della promozione. Il valore predefinito è prod. Utilizza un trigger webhook aggiungendo la proprietà target-environment al payload per sovrascriverne il valore.

destinazione - ambiente - scopo

Questo parametro è per la pipeline CD. target-environment-purpose determina il contesto dell'ambiente di destinazione e come viene utilizzato. I valori validi sono pre_prod e production. Contrassegnare qualsiasi elemento che non sia una modifica correlata production come pre_prod.

dettagli - ambiente - destinazione

Questo parametro è per la pipeline CD. Descrive l'ambiente di destinazione.

sysdig - scansione

Questo parametro è per le pipeline che utilizzano le fasi della risorsa utente di scansione per eseguire la scansione Sysdig utilizzando le immagini sysdig inline scanner on icr.io.

file di esclusione dall'inventario

Questo parametro specifica un nome personalizzato per il file di esclusione dell'inventario. Per impostazione predefinita, la pipeline cerca un file denominato « .inventoryignore » nella directory principale del repository dell'inventario. Questo file contiene un elenco di file e cartelle da escludere dalle operazioni di inventario.

Il parametro supporta diversi casi d'uso, tra cui file di esclusione specifici per i rami, configurazioni di distribuzione multiple ed esclusioni specifiche per regione. Per informazioni dettagliate sul formato del file di esclusione, sui casi d'uso e sulle migliori pratiche, consultare Come escludere file e cartelle dall'inventario.

Come bloccare una proprietà

Per bloccare una proprietà dell'ambiente, fare clic su modifica della proprietà dell'ambiente e poi abilitare la proprietà bloccata.

Effetti del bloccaggio

Dopo aver bloccato una proprietà nella proprietà dell'ambiente, non è possibile modificare il livello di attivazione. Quindi, una volta che una proprietà è bloccata, queste proprietà non possono essere aggiornate nel livello di trigger.

Se si tenta di inserire una proprietà bloccata nel livello di attivazione, si otterrà un errore.

Se si desidera modificare la variabile nel livello di trigger, è possibile disabilitare il blocco per tale variabile.