Parámetros de la interconexión

Responsable

Este parámetro es para la solicitud de extracción de promoción. Este valor contiene el asignado de la solicitud de cambio. Debe ser un ID funcional o un correo electrónico que se asignará a la solicitud de cambio en el sistema de gestión de cambios.

backout-plan

Este parámetro es para la solicitud de extracción de promoción. Planifique cómo se retrotraerá el cambio si se produce un error. Por defecto está vacío.

branch

Este es un parámetro opcional para la interconexión de AC. Determina qué rama extrae el código del repositorio de aplicaciones. Por defecto, es master.

duración-solicitud-cambio

Este es un parámetro opcional para la interconexión de CD. El valor cambia la duración del mantenimiento. El valor predeterminado es 30 min.

change-request-id

Este es un parámetro opcional para la interconexión de CD. Al proporcionar un ID de solicitud de cambio, la interconexión omite la creación de una nueva solicitud de cambio y utiliza la solicitud de cambio proporcionada. Si este parámetro se establece en notAvailable o se deja vacío, la canalización de despliegue continuo creará automáticamente una solicitud de cambio. El valor predeterminado es notAvailable.

clúster

Este parámetro contiene el nombre del clúster en la interconexión de CD, que se utiliza para el despliegue de Docker. Este parámetro es necesario para la aplicación de ejemplo.

cluster-name

Este parámetro contiene el nombre del clúster en el conducto de AC, que se utiliza para el despliegue de Docker. Este parámetro es obligatorio.

cluster-region

Este es un parámetro para la interconexión de CD. La región de IBM Cloud que aloja el clúster. Este es un parámetro necesario para la aplicación de ejemplo.

compliance-baseimage

Este parámetro contiene la versión de compliance-baseimage. Si desea utilizar algo que no sea la imagen más reciente, utilice este parámetro.

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

etiqueta-exenta-personalizada

Este es un parámetro opcional para las interconexiones CI y CC. Si ha marcado un problema de incidencia que está exento de forma permanente con una etiqueta personalizada, este parámetro debe contener el valor de la etiqueta personalizada.

impacto en el cliente

Este parámetro es para la solicitud de extracción de promoción. Registra el impacto de la solicitud de cambio en el cliente. De forma predeterminada, el parámetro es la serie separada por barras verticales 'Critical | High | Moderate | Low | No_Impact'. Edite la serie predeterminada para seleccionar una de las opciones.

configuración de implementación

La configuración de implementación se proporciona a través de esta propiedad, suministrada como una cadena JSON. A continuación se muestra un ejemplo de 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"
  },
  {
    ...
  }
]

Las siguientes reglas de validación son aplicables a esta propiedad. El incumplimiento de cualquiera de ellas dará lugar a la terminación del proceso con el mensaje de error correspondiente:

• La matriz no debe estar vacía.
• Todos los valores de trace_id deben ser únicos.
• Cada elemento debe contener tanto region como trace_id.
• La deployment-config propiedad solo debe proporcionarse para cd-change-request-listener
• O bien todos los elementos contienen deployment-prefix, o ninguno lo hace.
• Si deployment-prefix está presente, su valor debe ser único en todos los elementos.
• Si no deployment-prefix está presente, entonces el valor de region debe ser único en todos los elementos.

Para los siguientes campos, si no se especifican por objeto, se utilizan variables de entorno globales como alternativas:

• 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 no tiene un valor predeterminado global y debe definirse explícitamente si se utiliza.

impacto de despliegue

Este parámetro es para la solicitud de extracción de promoción. Registra el impacto de la solicitud de cambio en el despliegue. De forma predeterminada, el parámetro es la serie separada por barras verticales 'Small | Large'. Edite la serie predeterminada para seleccionar una de las opciones.

descripción

Este parámetro es para la solicitud de extracción de promoción. Este parámetro contiene la descripción del cambio, que se añade con la descripción de solicitud de cambio. Por defecto está vacío.

detectar-secretos-nombre-archivo-línea-base

Este parámetro especifica un nombre de archivo personalizado para el archivo de línea base que utiliza detect-secrets. De forma predeterminada, detect-secrets busca un archivo denominado .secrets.baseline en el directorio raíz del repositorio. Sin embargo, si nombra el archivo de línea base de forma diferente, puede proporcionar su nombre de archivo utilizando este parámetro.

detectar-secretos-exclusión-lista

Este parámetro es una propiedad de entorno que altera temporalmente la lista de exclusión predeterminada cuando se realiza una ejecución sin un archivo de línea base existente. Este parámetro identifica los archivos que se deben ignorar para que no se creen problemas que estén enlazados a ellos.

detectar-secretos-imagen

Este parámetro se puede utilizar para especificar una imagen de detecto-secretos diferente a utilizar, como una imagen personalizada o una versión específica de la imagen de detecto-secretos oficial.

detectar-secretos-verboso

Este parámetro, cuando se establece en 1, registra el nombre del archivo actual que se está explorando.

imagen-dind

Este parámetro se utiliza para establecer una imagen dind personalizada. Establezca este parámetro para utilizar la etiqueta de imagen dind personalizada

impact

Este parámetro es para la solicitud de extracción de promoción. Notas adicionales sobre lo que afectará esta implementación del cambio. Por defecto está vacío.

pipeline-debug

Si este parámetro se establece en 1, la interconexión se ejecuta en modalidad de depuración y los registros muestran más información. Por defecto, se establece en 0.

pipeline-display-name

La propiedad personalizada pipeline-display-name le permite personalizar el nombre de visualización de las ejecuciones de la tubería. Esta función proporciona una mejor visibilidad y trazabilidad de las ejecuciones de sus canalizaciones.

Ejemplos

Configuración de pipeline-display-name en prod-deployment-v2.1.0:

• Nombre de la ejecución del oleoducto: prod-deployment-v2.1.0
• Nombres de tareas: Con el prefijo prod-deployment-v2.1.0 seguido de identificadores del sistema y sufijos específicos de la tarea

prioridad

Este parámetro es para la solicitud de extracción de promoción. La prioridad de la solicitud de cambio. De forma predeterminada es 'Critical | High | Moderate | Low | Plan'. Puede cambiarlo por uno de estos valores.

Finalidad

Este parámetro es para la solicitud de extracción de promoción. La razón por la que es necesario el cambio. Por defecto está vacío.

clave de firma

Este parámetro es para la interconexión de AC. Es un parámetro de tipo secreto que contiene la clave privada base64-encoded para firmar imágenes utilizando datos de archivo .pfx.

slack-notifications

Conmute para activar o desactivar la integración de Slack. Está desactivado de forma predeterminada, por lo que el valor es 0. Establézcalo en 1 para activarlo, establézcalo en 0 para desactivarlo.

sonarqube

Este parámetro es para todas las interconexiones que utilizan etapas de exploración estática. Este es un parámetro de tipo de integración. Si está utilizando su propia integración sonarqube, seleccione dicha integración como valor. Por defecto, este parámetro está vacío.

espacio de nombres sonarqube-namespace

Este parámetro es para todas las interconexiones que utilizan etapas de exploración estática. Este es el espacio de nombres Kubernetes configurado para utilizarlo con la instancia de SonarQube creada por la interconexión, puede cambiarlo por cualquier espacio de nombres que desee utilizar.

mandato sonarqube-scan-

Este parámetro es para las interconexiones que utilizan etapas de exploración estática. sonarqube-scan-command especifica el mandato para iniciar la exploración sonarqube. Si este parámetro no está establecido, el valor predeterminado es 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". El parámetro predeterminado utiliza la imagen Docker sonar-scanner para realizar el escaneo.

Para un proyecto Maven Java, establezca este parámetro en 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 para utilizar la vía de acceso de clases calculada Maven para el escaneo sonar.

source-environment

El entorno de origen desde el que se promociona la aplicación, que es la rama de inventario de origen de la promoción. El valor predeterminado es master. Utilice un desencadenante de webhook añadiendo la propiedad source-environment a la carga útil para sobrescribir el valor de este parámetro.

static-scan-retry-count

Este parámetro es para cualquier exploración estática que desee ejecutar en un conducto. Estas exploraciones utilizan llamadas de API, que pueden tardar poco tiempo en funcionar. Por lo tanto, vuelva a intentar estas llamadas si es necesario. Puede cambiar las horas de reintentos con este parámetro. Por defecto, este parámetro está fijado en 30.

static-scan-retry-sleep

Este parámetro es para cualquier exploración estática que desee ejecutar en un conducto. Estas exploraciones utilizan llamadas de API, que pueden tardar poco tiempo en funcionar. Por lo tanto, vuelva a intentar estas llamadas si es necesario. Puede cambiar el número de segundos a esperar con este parámetro. Por defecto, este parámetro está fijado en 10.

intentos de reintento de resumen

Utilice un método de reintento para cargar el resumen de pruebas para asegurarse de que es satisfactorio. Puede cambiar las horas de reintentos con este parámetro. Por defecto, este parámetro está ajustado a 5.

tiempo máximo de reintento de resumen

Utilice un método de reintento para cargar el resumen de pruebas para asegurarse de que es satisfactorio. Puede cambiar el número de segundos a esperar con este parámetro. Por defecto, este parámetro está fijado en 32.

target-environment

El entorno de destino en el que se despliega la aplicación, que es la rama de inventario de destino de la promoción. El valor predeterminado es prod. Utilice un desencadenante de webhook añadiendo la propiedad target-environment a la carga útil para sobrescribir el valor de este parámetro.

objetivo-entorno-destino

Este parámetro es para la interconexión de CD. target-environment-purpose determina el contexto del entorno de destino y cómo se utiliza. Los valores válidos son pre_prod y production. Marque cualquier cosa que no sea un cambio relacionado con production como pre_prod.

detalle-entorno-destino

Este parámetro es para la interconexión de CD. Describe el entorno de destino.

exploración de sysdig

Este parámetro es para las interconexiones que utilizan etapas de artefacto de exploración para ejecutar la exploración de Sysdig utilizando sysdig inline scanner en imágenes de icr.io.

Cómo cerrar una propiedad

Para bloquear una propiedad de entorno, haga clic en editar propiedad de la propiedad de entorno y, a continuación, active la propiedad bloqueada.

Efectos del bloqueo

Después de bloquear una propiedad en la propiedad de entorno, no podemos cambiar el nivel de activación. Así, una vez que una propiedad está bloqueada, esas propiedades no se pueden actualizar en el nivel de activación.

Si intenta poner cualquier propiedad bloqueada en el nivel de activación, se producirá un error.

Si desea cambiar la variable en el nivel de activación, podemos desactivar el bloqueo para esa variable.