Parâmetros de pipeline

assignee

Esse parâmetro é para a solicitação de pull de promoção Esse valor mantém o designado da solicitação de mudança.. Deve ser um ID funcional ou um e-mail que será designado à solicitação de mudança no sistema de gerenciamento de mudanças.

backout-plan

Esse parâmetro é para a solicitação de pull de promoção Plano de como a mudança será revertida se houver uma falha. Por padrão, está vazio.

branch

Este é um parâmetro opcional para o pipeline de IC Ele determina qual ramificação extrai o código do repositório de aplicativos Por padrão, é master.

change-request-duração

Este é um parâmetro opcional para o pipeline de CD O valor altera a duração da manutenção O valor padrão é 30 min.

change-request-id

Este é um parâmetro opcional para o pipeline de CD Ao fornecer um ID de solicitação de mudança, o pipeline ignora a criação de uma nova solicitação de mudança e usa a solicitação de mudança fornecida. Se esse parâmetro for definido como “ notAvailable ” ou for deixado em branco, uma solicitação de alteração será criada automaticamente pelo pipeline de implantação contínua. O valor padrão é notAvailable.

cluster

Esse parâmetro retém o nome do cluster no pipeline do CD, que é usado para a implementação do Docker Esse parâmetro é obrigatório para o aplicativo de exemplo.

nome do cluster

Esse parâmetro contém o nome do cluster no pipeline de IC, que é usado para a implementação do Docker. Esse parâmetro é obrigatório.

cluster-region

Este é um parâmetro para o pipeline de CD A região do IBM Cloud que hospeda o cluster. Este é um parâmetro necessário para o aplicativo de exemplo

compliance-baseimage

Este parâmetro contém a versão do mage de conformidade. Se você desejar usar algo diferente da imagem mais recente, use esse parâmetro

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

custom-isenta-rótulo

Este é um parâmetro opcional para os pipelines de CI e CC Se você marcou um problema de incidente que está permanentemente isento com um rótulo customizado, esse parâmetro deverá conter o valor do rótulo customizado.

cliente-impacto

Esse parâmetro é para a solicitação de pull de promoção Ele registra o impacto da solicitação de mudança no cliente. Por padrão, o parâmetro é a sequência separada por barra vertical 'Critical | High | Moderate | Low | No_Impact'. Edite a sequência padrão para selecionar uma das opções.

configuração de implantação

A configuração de implantação é fornecida por meio dessa propriedade, apresentada como uma string JSON. Aqui está um exemplo de configuração de implantação:

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

As seguintes regras de validação são aplicáveis a esta propriedade. O não cumprimento de qualquer uma delas resulta na interrupção do pipeline, com a exibição de uma mensagem de erro apropriada:

• A matriz não deve estar vazia.
• Todos os valores de trace_id devem ser únicos.
• Cada elemento deve conter tanto region quanto trace_id.
• A deployment-config propriedade deve ser fornecida apenas para cd-change-request-listener
• Ou todos os elementos contêm deployment-prefix, ou nenhum contém.
• Se deployment-prefix estiver presente, seu valor deve ser único em todos os elementos.
• Se não deployment-prefix estiver presente, então o valor de region deve ser único em todos os elementos.

Para os campos a seguir, se não forem especificados por objeto, as variáveis de ambiente globais são usadas 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 não possui um recurso alternativo global e deve ser definido explicitamente se for utilizado.

implementação-impacto

Esse parâmetro é para a solicitação de pull de promoção Ele registra o impacto da solicitação da mudança na implementação.. Por padrão, o parâmetro é a sequência separada por barra vertical 'Small | Large'. Edite a sequência padrão para selecionar uma das opções.

descrição

Esse parâmetro é para a solicitação de pull de promoção Esse parâmetro contém a descrição da mudança, que é anexada à Descrição da Solicitação de Mudança. Por padrão, está vazio.

detect-secrets-linha de base-nome do arquivo

Esse parâmetro especifica um nome de arquivo customizado para o arquivo de linha de base que é usado por detect-secrets (segredos de detecção) Por padrão, detect-secrets procura um arquivo denominado .secrets.baseline no diretório raiz do repositório. No entanto, se você nomear seu arquivo de linha de base de forma diferente, será possível fornecer seu nome de arquivo usando esse parâmetro

detect-secrets-exclusão-lista

Este parâmetro é uma propriedade de ambiente que substitui a lista de exclusão padrão quando uma execução é feita sem um arquivo de linha de base existente Esse parâmetro identifica os arquivos a serem ignorados para que não sejam criados problemas vinculados a eles.

detect-secrets-imagem

Esse parâmetro pode ser usado para especificar uma imagem detectar segredos diferente a ser usada, como uma imagem customizada ou uma versão específica da imagem detectar segredos oficiais.

detect-secrets-detalhado

Esse parâmetro, quando configurado como 1, registra o nome do arquivo atual sendo varrido.

dind-imagem

Esse parâmetro é usado para configurar uma imagem dind customizada. Configure este parâmetro para usar tag de imagem dind customizada

impact

Esse parâmetro é para a solicitação de pull de promoção Notas adicionais sobre o impacto dessa Implementação de Mudança. Por padrão, está vazio.

pipeline-debug

Se esse parâmetro for configurado como 1, o pipeline será executado no modo de depuração e os logs mostrarão mais informações.. Por padrão, o valor está definido como 0.

nome de exibição do pipeline

A propriedade personalizada pipeline-display-name permite que você personalize o nome de exibição das execuções do pipeline. Esse recurso oferece melhor visibilidade e rastreabilidade para as execuções do pipeline.

Exemplos

Configuração de pipeline-display-name para prod-deployment-v2.1.0:

• Nome da execução do pipeline: prod-deployment-v2.1.0
• Nomes de tarefas: Prefixado com prod-deployment-v2.1.0 seguido de identificadores de sistema e sufixos específicos da tarefa

prioridade

Esse parâmetro é para a solicitação de pull de promoção A prioridade da solicitação de alteração. Por padrão, ele é 'Critical | High | Moderate | Low | Plan' É possível alterá-lo para um desses valores

Propósito

Esse parâmetro é para a solicitação de pull de promoção O motivo pelo qual a mudança é necessária. Por padrão, está vazio.

chave de assinatura

Esse parâmetro é para o pipeline de IC É um parâmetro de tipo de segredo que contém a chave privada base64-encoded para assinar imagens usando dados do arquivo .pfx.

slack-notifications

Alterne para ativar ou desativar a Integração do Slack Isso é desativado por padrão, portanto, o valor é 0 Configure como 1 para ativá-lo, configure como 0 para desativá-lo..

sonarqube

Esse parâmetro é para todos os pipelines que usam estágios de varredura estática Este é um parâmetro de tipo de integração Se você estiver usando sua própria integração sonarqube, selecione essa integração como valor. Por padrão, esse parâmetro está vazio.

sonarqube-namespace

Esse parâmetro é para todos os pipelines que usam estágios de varredura estática Esse é o namespace Kubernetes configurado para ser usado com a instância SonarQube que é criada pelo pipeline; é possível mudá-lo para qualquer namespace que você deseja usar

comando sonarqube-scan

Esse parâmetro é para os pipelines que usam estágios de varredura estática sonarqube-scan-command especifica o comando para iniciar a varredura sonarqube. Se esse parâmetro não for configurado, o padrão será 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" O parâmetro padrão usa a imagem Docker sonar-scanner para executar a varredura.

Para um projeto Java do Maven, configure esse parâmetro como 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 usar o caminho de classe calculado do Maven para varredura de sonar.

source-environment

O ambiente de origem do qual o aplicativo é promovido, que é a ramificação do inventário de origem da promoção. O valor padrão é master. Use um acionador de webhook incluindo a propriedade source-environment na carga útil para sobrescrever o valor desse parâmetro.

static-scan-retry-count

Esse parâmetro é para qualquer varredura estática que você deseja executar em um pipeline. Essas varreduras usam chamadas de API, que podem demorar um pouco para funcionar. Portanto, tente novamente essas chamadas, se necessário É possível alterar os horários de novas tentativas com esse parâmetro Por padrão, esse parâmetro está definido como 30.

static-scan-retry-sleep

Esse parâmetro é para qualquer varredura estática que você deseja executar em um pipeline. Essas varreduras usam chamadas de API, que podem demorar um pouco para funcionar. Portanto, tente novamente essas chamadas, se necessário É possível alterar o número de segundos a aguardar com esse parâmetro Por padrão, esse parâmetro está definido como 10.

summary-retry-tentativas

Use um método de nova tentativa para fazer upload do resumo de evidência para assegurar que ele seja bem-sucedido. É possível alterar os horários de novas tentativas com esse parâmetro Por padrão, esse parâmetro está definido como 5.

resumo-tempo-máximo-de-repetição

Use um método de nova tentativa para fazer upload do resumo de evidência para assegurar que ele seja bem-sucedido. É possível alterar o número de segundos a aguardar com esse parâmetro Por padrão, esse parâmetro está definido como 32.

target-environment

O ambiente de destino no qual o app é implementado, que é a ramificação de inventário de destino da promoção O valor padrão é prod. Use um acionador de webhook incluindo a propriedade target-environment na carga útil para sobrescrever o valor desse parâmetro.

destino-ambiente-propósito-

Esse parâmetro é para o pipeline do CD target-environment-purpose determina o contexto do ambiente de destino e como é usado. Os valores válidos são pre_prod e production. Marque qualquer coisa que não seja uma mudança relacionada ao production como pre_prod

target-ambiente-detalhe

Esse parâmetro é para o pipeline do CD Ele descreve o ambiente de destino

sysdig-varredura

Esse parâmetro é para os pipelines que usam estágios de artefato de varredura para executar a varredura do Sysdig usando as imagens sysdig inline scanner on icr.io

arquivo-de-exclusão-de-inventário

Este parâmetro especifica um nome de arquivo personalizado para o arquivo de exclusão do inventário. Por padrão, o pipeline procura um arquivo chamado .inventoryignore na raiz do repositório de inventário. Este arquivo contém uma lista de arquivos e pastas a serem excluídos das operações de inventário.

O parâmetro oferece suporte a vários casos de uso, incluindo arquivos de exclusão específicos de ramificação, várias configurações de implantação e exclusões específicas por região. Para obter informações detalhadas sobre o formato do arquivo de exclusão, casos de uso e práticas recomendadas, consulte Como excluir arquivos e diretórios do inventário.

Como trancar uma propriedade

Para bloquear uma propriedade de ambiente, clique em editar propriedade da propriedade de ambiente e, em seguida, ative a propriedade bloqueada.

Efeitos do bloqueio

Depois de bloquear uma propriedade na propriedade de ambiente, não podemos alterar o nível de acionamento. Portanto, quando uma propriedade é bloqueada, essas propriedades não podem ser atualizadas no nível do acionador.

Se você tentar colocar qualquer propriedade bloqueada no nível de acionamento, isso resultará em um erro.

Se você quiser alterar a variável no nível do acionador, podemos desativar o bloqueio dessa variável.