Paramètres de pipeline

assignee

Ce paramètre est destiné à la demande d'extraction de promotion. Cette valeur contient le cessionnaire de la demande de changement. Il doit s'agir d'un ID fonctionnel ou d'un courrier électronique qui sera affecté à la demande de changement dans le système de gestion des changements.

backout-plan

Ce paramètre est destiné à la demande d'extraction de promotion. Plan de la manière dont la modification sera annulée en cas d'échec. Par défaut, il est vide.

branch

Il s'agit d'un paramètre facultatif pour le pipeline d'EC. Il détermine la branche qui extrait le code du référentiel d'application. Par défaut, c'est master.

durée-demande-modification

Il s'agit d'un paramètre facultatif pour le pipeline CD. La valeur change la durée de la maintenance. La valeur par défaut est 30 min.

change-request-id

Il s'agit d'un paramètre facultatif pour le pipeline CD. En fournissant un ID de demande de changement, le pipeline ignore la création d'une nouvelle demande de changement et utilise la demande de changement fournie. Si ce paramètre est défini sur « notAvailable » ou laissé vide, une demande de modification est automatiquement créée par le pipeline de déploiement continu. La valeur par défaut est notAvailable.

grappe

Ce paramètre contient le nom du cluster dans le pipeline CD, qui est utilisé pour le déploiement Docker. Ce paramètre est obligatoire pour l'application d'exemple.

cluster-name

Ce paramètre contient le nom du cluster dans le pipeline d'EC, qui est utilisé pour le déploiement Docker. Ce paramètre est obligatoire.

cluster-region

Il s'agit d'un paramètre pour le pipeline CD. Région IBM Cloud qui héberge le cluster. Il s'agit d'un paramètre obligatoire pour l'exemple d'application.

compliance-baseimage

Ce paramètre contient la version de compliance-baseimage. Si vous souhaitez utiliser autre chose que l'image la plus récente, utilisez ce paramètre.

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

libellé-exempt-personnalisé

Il s'agit d'un paramètre facultatif pour les pipelines d'EC et de CC. Si vous avez marqué un problème d'incident qui est définitivement exempté avec un libellé personnalisé, ce paramètre doit contenir la valeur du libellé personnalisé.

impact sur le client

Ce paramètre est destiné à la demande d'extraction de promotion. Il enregistre l'impact de la demande de changement sur le client. Par défaut, le paramètre est la chaîne 'Critical | High | Moderate | Low | No_Impact' séparée par une barre verticale. Editez la chaîne par défaut pour sélectionner l'une des options.

configuration-de-déploiement

La configuration de déploiement est fournie via cette propriété, sous forme de chaîne JSON. Voici un exemple de fichier de configuration de déploiement :

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

Les règles de validation suivantes s'appliquent à cette propriété. Le non-respect de l'une d'entre elles entraîne l'interruption du pipeline et l'affichage d'un message d'erreur approprié :

• Le tableau ne doit pas être vide.
• Toutes les valeurs de « trace_id » doivent être uniques.
• Chaque élément doit contenir à la fois region et trace_id.
• La deployment-config propriété ne doit être fournie que pour cd-change-request-listener
• Soit tous les éléments contiennent deployment-prefix, soit aucun ne le contient.
• Si deployment-prefix est présent, sa valeur doit être unique pour tous les éléments.
• Si deployment-prefix n'est pas présent, alors la valeur de region doit être unique pour tous les éléments.

Pour les champs suivants, s'ils ne sont pas spécifiés par objet, les variables d'environnement globales sont utilisées comme solutions de secours :

• 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 n'a pas de solution de repli globale et doit être défini explicitement s'il est utilisé.

impact-déploiement

Ce paramètre est destiné à la demande d'extraction de promotion. Il enregistre l'impact de la demande de changement sur le déploiement. Par défaut, le paramètre est la chaîne 'Small | Large' séparée par une barre verticale. Editez la chaîne par défaut pour sélectionner l'une des options.

description

Ce paramètre est destiné à la demande d'extraction de promotion. Ce paramètre contient la description de la modification, qui s'ajoute à la description de la demande de modification. Par défaut, il est vide.

détecter-secrets-base-nom-de-fichier

Ce paramètre spécifie un nom de fichier personnalisé pour le fichier de référence utilisé par detect-secrets. Par défaut, detect-secrets recherche un fichier nommé .secrets.baseline dans le répertoire racine du référentiel. Toutefois, si vous nommez votre fichier de version de référence différemment, vous pouvez fournir son nom de fichier à l'aide de ce paramètre.

liste-exclusion-secrets-de-détection

Ce paramètre est une propriété d'environnement qui remplace la liste d'exclusion par défaut lorsqu'une exécution est effectuée sans fichier de version de référence existant. Ce paramètre identifie les fichiers à ignorer afin que les problèmes qui leur sont liés ne soient pas créés.

Image-secrets-de-détection

Ce paramètre peut être utilisé pour spécifier une image detect-secrets différente à utiliser, telle qu'une image personnalisée ou une version spécifique de l'image detect-secrets officielle.

détecter-secrets-verbose

Ce paramètre, lorsqu'il est défini sur 1, consigne le nom du fichier en cours d'analyse.

dind-image

Ce paramètre est utilisé pour définir une image de liaison personnalisée. Définissez ce paramètre pour utiliser une balise d'image de liaison personnalisée

impact

Ce paramètre est destiné à la demande d'extraction de promotion. Des remarques supplémentaires sur l'impact de cette mise en oeuvre du changement. Par défaut, il est vide.

pipeline-debug

Si ce paramètre est défini sur 1, le pipeline s'exécute en mode débogage et les journaux affichent plus d'informations. Par défaut, cette valeur est définie sur 0.

nom de l'affichage du pipeline

La propriété personnalisée pipeline-display-name vous permet de personnaliser le nom d'affichage des parcours de pipeline. Cette fonctionnalité offre une meilleure visibilité et une meilleure traçabilité de l'exécution de vos pipelines.

Exemples

Réglage de pipeline-display-name à prod-deployment-v2.1.0:

• Nom de l'exécution du pipeline: prod-deployment-v2.1.0
• Noms des tâches: Préfixe : prod-deployment-v2.1.0 suivi des identifiants du système et des suffixes spécifiques à la tâche

priority

Ce paramètre est destiné à la demande d'extraction de promotion. Le niveau de priorité de la demande de modification. Par défaut, il s'agit de 'Critical | High | Moderate | Low | Plan'. Vous pouvez la remplacer par l'une de ces valeurs.

purpose

Ce paramètre est destiné à la demande d'extraction de promotion. La raison pour laquelle ce changement est nécessaire. Par défaut, il est vide.

clé de signature

Ce paramètre est destiné au pipeline d'EC. Il s'agit d'un paramètre de type secret qui contient la clé privée base64-encoded pour la signature d'images à l'aide des données de fichier .pfx.

slack-notifications

Activez ou désactivez l'intégration Slack. Cette option étant désactivée par défaut, la valeur est 0. Défini sur 1 pour l'activer, défini sur 0 pour le désactiver.

sonarqube

Ce paramètre s'applique à tous les pipelines qui utilisent des étapes d'analyse statique. Il s'agit d'un paramètre de type d'intégration. Si vous utilisez votre propre intégration sonarqube, sélectionnez cette intégration comme valeur. Par défaut, ce paramètre est vide.

espace-noms sonarqube-namespace

Ce paramètre s'applique à tous les pipelines qui utilisent des étapes d'analyse statique. Il s'agit de l'espace de nom Kubernetes configuré à utiliser avec l'instance SonarQube créée par le pipeline. Vous pouvez le remplacer par n'importe quel espace de nom que vous souhaitez utiliser.

sonarqube-scan-commande

Ce paramètre est destiné aux pipelines qui utilisent des étapes d'analyse statique. sonarqube-scan-command indique la commande permettant de démarrer l'analyse sonarqube. Si ce paramètre n'est pas défini, la valeur par défaut est 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". Le paramètre par défaut utilise l'image Docker sonar-scanner pour effectuer l'analyse.

Pour un projet Java Maven, définissez ce paramètre sur 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 afin d'utiliser le chemin d'accès aux classes calculé Maven pour l'analyse sonar.

source-environment

L'environnement source à partir duquel l'application est promue, qui est la branche d'inventaire source de la promotion. La valeur par défaut est master. Utilisez un déclencheur de webhook en ajoutant la propriété source-environment au contenu pour remplacer la valeur de ce paramètre.

static-scan-retry-count

Ce paramètre s'applique à tout examen statique que vous souhaitez exécuter dans un pipeline. Ces analyses utilisent des appels d'API, qui peuvent prendre peu de temps à fonctionner. Par conséquent, réessayez ces appels si nécessaire. Vous pouvez modifier les heures de nouvelles tentatives à l'aide de ce paramètre. Par défaut, ce paramètre est défini sur 30.

static-scan-retry-sleep

Ce paramètre s'applique à tout examen statique que vous souhaitez exécuter dans un pipeline. Ces analyses utilisent des appels d'API, qui peuvent prendre peu de temps à fonctionner. Par conséquent, réessayez ces appels si nécessaire. Vous pouvez modifier le nombre de secondes à attendre avec ce paramètre. Par défaut, ce paramètre est défini sur 10.

summary-relances-tentatives

Utilisez une méthode de nouvelle tentative pour télécharger le récapitulatif des informations collectées afin de vous assurer qu'il aboutit. Vous pouvez modifier les heures de nouvelles tentatives à l'aide de ce paramètre. Par défaut, ce paramètre est défini sur 5.

summary-max-temps-nouvelle-tentative

Utilisez une méthode de nouvelle tentative pour télécharger le récapitulatif des informations collectées afin de vous assurer qu'il aboutit. Vous pouvez modifier le nombre de secondes à attendre avec ce paramètre. Par défaut, ce paramètre est défini sur 32.

target-environment

L'environnement cible dans lequel l'application est déployée, qui est la branche d'inventaire cible de la promotion. La valeur par défaut est prod. Utilisez un déclencheur de webhook en ajoutant la propriété target-environment au contenu pour remplacer la valeur de ce paramètre.

objectif-environnement-cible

Ce paramètre est destiné au pipeline CD. target-environment-purpose détermine le contexte de l'environnement cible et la manière dont il est utilisé. Les valeurs admises sont pre_prod et production. Marquez tout élément qui n'est pas une modification liée à production comme pre_prod.

détail-environnement-cible

Ce paramètre est destiné au pipeline CD. Il décrit l'environnement cible.

Analyse sysdig

Ce paramètre est destiné aux pipelines qui utilisent des étapes d'artefact d'analyse pour exécuter l'analyse Sysdig à l'aide d'images sysdig inline scanner on icr.io.

fichier-d'exclusion-de-l'inventaire

Ce paramètre permet de définir un nom de fichier personnalisé pour le fichier d'exclusion de l'inventaire. Par défaut, le pipeline recherche un fichier nommé « .inventoryignore » à la racine du référentiel d'inventaire. Ce fichier contient une liste des fichiers et dossiers à exclure des opérations d'inventaire.

Ce paramètre prend en charge divers cas d'utilisation, notamment les fichiers d'exclusion spécifiques à une branche, les configurations de déploiement multiples et les exclusions spécifiques à une région. Pour plus d'informations sur le format des fichiers d'exclusion, les cas d'utilisation et les bonnes pratiques, consultez la section « Comment exclure des fichiers et des répertoires de l'inventaire ».

Comment verrouiller un bien immobilier

Pour verrouiller une propriété d'environnement, cliquez sur la propriété d'édition de la propriété d'environnement, puis activez la propriété verrouillée.

Effets du verrouillage

Après avoir verrouillé une propriété dans la propriété d'environnement, nous ne pouvons pas modifier le niveau de déclenchement. Ainsi, une fois qu'une propriété est verrouillée, ces propriétés ne peuvent plus être mises à jour au niveau du déclencheur.

Si vous essayez de placer une propriété verrouillée dans le niveau de déclenchement, vous obtiendrez une erreur.

Si vous souhaitez modifier la variable dans le niveau de déclenchement, nous pouvons désactiver le verrouillage pour cette variable.