snDevOpsConfig

Carregue, valide e publique mudanças de dados de configuração em uma só etapa.

Esta ação combina as ações snDevOpsConfigUpload, snDevOpsConfigGetSnapshots e snDevOpsConfigRegisterPipeline em uma ação, em vez de ter que executar cada ação separadamente.

Variáveis de entrada

arquivo de configuração	Especifica o arquivo de dados de configuração a ser carregado no componente ou no caminho implantável no modelo de dados.
applicationName	Especifica a aplicação para a qual os dados de configuração serão carregados.
target	Especifica o destino do modelo de dados para onde os dados de configuração serão carregados (por exemplo, componente, coleção, implantável).
collectionName	(Opcional) Nome da coleção para carregar (obrigatório se o destino for uma coleção).
implantávelNome	(Opcional) Nome do implantável para carregar (necessário se o destino for implantável).
namePath	Especifica o caminho do nome no modelo de dados para onde os dados de configuração serão carregados. Nota: Ao carregar para uma pasta de variáveis, você deve iniciar o caminho do nome com "vars/" para especificar o caminho da pasta de variáveis.
dataFormat	Especifica o formato de dados do arquivo de configuração (por exemplo, JSON, YAML, XMLetc.)
confirmação automática	Especifica se os dados de configuração devem ser confirmados após o upload (verdadeiro/falso). O valor padrão é verdadeiro.
autoValidate	Especifica se os dados de configuração devem ser validados durante a confirmação (verdadeiro/falso). O valor padrão é verdadeiro.
publicação automática	Especifica se os dados de configuração devem ser publicados após a validação (verdadeiro/falso). O valor padrão é verdadeiro.
changesetNumber	(Opcional) Especifica o changeset (aberto) ao qual esta atividade de upload está associada. Se não for fornecido, um novo changeset será criado. Nota: Usado somente para vários cenários de upload.
marcarCom falha	(Opcional) Falha no pipeline caso a tentativa de validação tenha falhado (devido a um problema de back-end).
mostrarResultados	(Opcional) Mostre os resultados da validação no log do console de trabalho Jenkins.
continuarComMais Recente	(Opcional) Especifica se o snapshot mais recente deve ser retornado pela combinação applicatioName-deployableName-changesetNumber se nenhum snapshot for gerado (verdadeiro/falso). O valor padrão é falso.

Saída

• Se for bem-sucedido, um snapshot ou conjunto de snapshots.
• Em caso de falha, uma mensagem de falha de API/back-end será mostrada.

Exemplo

• Entrada:

  
  snapshotObj = snDevOpsConfig(
       applicationName: "PaymentDemo",
       configFile: "config/application/Collection/Collection2/*.json",
       target: "collection",
       collectionName: "release-1.0",
       namePath: "settings/infrastructure/database",
       dataFormat: "json",
       autoCommit: 'true',
       autoValidate: 'true',
       autoPublish: 'true',
       continueWithLatest: 'true',
       markFailed: 'true',
       showResults: 'false'
  )
  
  echo"*************************\n ${snapshotObj}"

• Saída

Exemplo - coleção

Nota:

Ao carregar em uma coleção, o argumento collectionName é necessário.

snDevOpsConfig(
     applicationName: 'PaymentDemo',
     target: 'collection',
     collectionName: 'release-1.0',
     namePath: 'web-api-v1.0',
     configFile: 'k8s/helm/*.yml',
     dataFormat: 'yaml',
     autoCommit: 'true',
     autoValidate: 'true',
     autoPublish: 'true'
)

Exemplo - implantável

Nota:

Ao carregar em um implantável, o argumento deployableName é necessário.

snDevOpsConfig(
     applicationName: 'PaymentDemo',
     target: 'deployable',
     deployableName: 'Production',
     namePath: 'web-api-v1.0',
     configFile: 'k8s/helm/*.yml',
     dataFormat: 'yaml',
     autoCommit: 'true',
     autoValidate: 'true',
     autoPublish: 'true'
)

Vários uploads em uma confirmação

Para carregar dados de configuração de diferentes locais ou para carregar um conjunto de dados para vários destinos (por exemplo, um componente, um implantável) rastreados como uma única confirmação para o seu modelo de dados, você pode chamar a ação snDevOpsConfigUpload quantas vezes forem necessárias para o primeiro conjunto de carregamentos e chame a ação snDevOpsConfig para o carregamento final.

Veja um exemplo.

• No primeiro carregamento, crie uma variável (por exemplo, $changeset) e atribua o valor de retorno da etapa a ela para que possa ser reutilizada em carregamentos subsequentes​.

  Carregar 1 - Arquivo XML para o componente:

  
  $changeset = snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'component',
       namePath: 'paymentService-v1.0',
       configFile: 'infra/v1/config.xml',
       dataFormat: 'xml',
       autoCommit: 'false',
       autoValidate: 'false',
       autoPublish: 'false'
  )

• Em uploads subsequentes (e uploads finais), use a variável como uma entrada​.

  Carregar arquivo 2 - JSON para a pasta de variáveis do implantável:

  
  snDevOpsConfig(
       applicationName: 'PaymentDemo',
       target: 'deployable',
       deployableName: 'Production',
       namePath: 'vars/dbSettings',
       configFile: 'infra/prod/dbConfig.json',
       dataFormat: 'json',
       changesetNumber: ”${changeset}”,
       autoCommit: 'false',
       autoValidate: 'false',
       autoPublish: 'false',
       continueWithLatest: 'true'
  )

Carregar vários formatos de dados

Para carregar dados de configuração em diferentes formatos de arquivo, você pode chamar a ação snDevOpsConfig com essas especificações.

• Certifique-se de que o argumento configFile esteja usando um curinga no caminho.
• Não especifique o argumento dataFormat.

Veja um exemplo.

• Digamos que temos esses arquivos de configuração.

  

• Esta é a forma de carregar os arquivos de configuração usando snDevOpsConfig.

  
  snDevOpsConfig(
       applicationName: 'PaymentDemo',
       target: 'component',
       namePath: 'paymentService-v1.0',
       configFile: 'infra/v1/*',
       autoCommit: 'true',
       autoValidate: 'true',
       autoPublish: 'true'
  )

snDevOpsConfigUpload

Esta ação carrega um arquivo de configuração para um determinado local em um modelo de dados da aplicação.

Ele deve ser usado de forma iterativa para todos os arquivos de configuração a serem carregados no modelo de dados da aplicação durante a execução do pipeline.

Variáveis de entrada

arquivo de configuração	Especifica o arquivo de dados de configuração a ser carregado no componente ou no caminho implantável no modelo de dados.
applicationName	Especifica a aplicação para a qual os dados de configuração serão carregados.
target	Especifica o destino do modelo de dados para onde os dados de configuração serão carregados (por exemplo, componente, coleção, implantável).
collectionName	(Opcional) Nome da coleção para carregar (obrigatório se o destino for uma coleção).
implantávelNome	Nome do implantável para o qual carregar (necessário se o destino for implantável).
namePath	Especifica o caminho do nome no modelo de dados para onde os dados de configuração serão carregados. Nota: Ao carregar para uma pasta de variáveis, você deve iniciar o caminho do nome com "vars/" para especificar o caminho da pasta de variáveis.
dataFormat	Especifica o formato de dados do arquivo de configuração (por exemplo, JSON, YAML, XMLetc.)
convertPath	(Opcional) Especifica se a estrutura de diretórios dos arquivos de configuração deve ser preservada (em relação ao espaço) e convertida o diretório em caminhos dentro do modelo de dados.
changesetNumber	(Opcional) Especifica o changeset (aberto) ao qual esta atividade de upload está associada. Se não for fornecido, um novo changeset será criado. Nota: Usado somente para vários cenários de upload.
confirmação automática	Especifica se os dados de configuração devem ser confirmados após o upload (verdadeiro/falso). O valor padrão é falso.
autoValidate	Especifica se os dados de configuração devem ser validados durante a confirmação (verdadeiro/falso). O valor padrão é falso.

Variável de saída

changesetNumber

(Opcional) Especifica o changeset (aberto) ao qual esta atividade de upload está associada. Se um número de changeset não for fornecido, um novo changeset será criado.

Exemplo

• Entrada:

  Aqui está um exemplo da ação snDevOpsConfigUpload. Para fins de ilustração, atribuiremos a resposta a uma variável, changeSetId, que pode ser repetida para o log do console para cenários de depuração.

  
  changeSetId = snDevOpsConfigUpload(
       applicationName: "PaymentDemo",
       target: 'component',
       namePath: "web-api-v1.0",
       configFile: "k8s/helm/values.yml",
       dataFormat: "json",
       autoCommit: 'true',
       autoValidate: 'true'
  )
  
  echo "Changeset: $changeSetId created"

• Saída:

  Além dos dados que estão sendo carregados para o nosso modelo de dados em Configuração de DevOps, a saída seria semelhante a esta (usando o plug-in Blue Ocean para visualizar a saída do console).

  

Exemplo - Vários uploads (componente)

Você pode chamar a ação de upload mais de uma vez para carregar dados de configuração em diferentes formatos de arquivo de locais diferentes, mantendo os uploads parte de um conjunto de mudanças.

• No primeiro carregamento, nomeie a ação para que a variável de saída changesetNumber possa ser reutilizada em carregamentos subsequentes.
  Carregamento de arquivo YAML:

  
  $changeset = snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'component',
       namePath: 'wep-api-v1.0',
       configFile: 'k8s/helm/values.yml',
       dataFormat: 'yaml',
       autoCommit: 'false',
       autoValidate: 'false'
  )

• Em carregamentos subsequentes, faça referência à variável de saída changesetNumber do primeiro carregamento como uma variável de entrada.
  Carregamento de 3 arquivos JSON:

  
  snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'component',
       namePath: 'wep-api-v1.0',
       configFile: 'infra/*.json',
       dataFormat: 'json',
       autoCommit: 'false',
       autoValidate: 'false',
       changesetNumber: ”${changeset}”
  )

• Na chamada final, além de fazer referência à variável de saída changesetNumber do primeiro carregamento como uma variável de entrada, defina autoCommit e autoValidate como verdadeiro.
  Carregamento do arquivo INI:

  
  snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'component',
       namePath: 'wep-api-v1.0',
       configFile: 'featureToggles/set1.ini',
       dataFormat: 'ini',
       autoCommit: 'true',
       autoValidate: 'true',
       changesetNumber: ”${changeset}”
  )

Exemplo - Vários uploads (coleção e variáveis)

Você pode chamar a ação de upload mais de uma vez para carregar dados de configuração em diferentes formatos de arquivo de locais diferentes, mantendo os uploads parte de um conjunto de mudanças.

• No primeiro carregamento, crie uma variável (por exemplo, $changeset) e atribua o valor de retorno da etapa a ela para que possa ser reutilizada em carregamentos subsequentes.
  Carregamento de arquivo XML:

  
  $changeset = snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'collection',
       collectionName: 'release-v1.0',
       namePath: 'v1-common-configs',
       configFile: 'infra/v1/config.xml',
       dataFormat: 'xml',
       autoCommit: 'false',
       autoValidate: 'false'
  )

• Em carregamentos subsequentes, use a variável como uma entrada.
  Carregamento de arquivo JSON:

  
  snDevOpsConfigUpload(
       applicationName: 'PaymentDemo',
       target: 'deployable',
       deployableName: 'Production',
       namePath: 'vars/dbSettings',
       configFile: 'infra/prod/dbConfig.json',
       dataFormat: 'json',
       autoCommit: 'true',
       autoValidate: 'true',
       changesetNumber: ”${changeset}”
  )

Nota:

Para carregar em uma pasta de variáveis, uploadTarget deve ser definido como implantávele os valores corretos devem ser definidos para deployableName e changesetNumber.

snDevOpsConfigGetSnapshots

Esta ação deve ser usada em diferentes cenários:

• Recupere todos os snapshots de todos os implantáveis afetados.

  Quando os arquivos de configuração forem carregados em um modelo de dados da aplicação, o sistema criará snapshots para todos os implantáveis determinados a serem afetados pelo carregamento. Seguindo o fluxo de IC, supondo que a última chamada de upload tenha a validação habilitada, a próxima etapa seria iterar a lista de snapshots e garantir que todos tenham sido aprovados na validação.

• Recupere um snapshot específico.

  Seguindo o fluxo de CD, um snapshot específico é recuperado para que possa ser publicado e exportado para ser consumido no downstream (por exemplo, para provisionar infraestrutura ou aplicação).

• Recupere os snapshots mais recentes de um implantável de uma aplicação caso um carregamento não gere nenhum snapshot.

  Um conjunto de dados de configuração está disponível para implantação em um ambiente para uma combinação aplicação-implantável-changeset quando nenhuma mudança de configuração é feita.

• Mostre os resultados da validação de política em uma execução de pipeline.

  Exiba os resultados de validação de política como resultados de testes na página de resultados de testes de compilação do Jenkins, incluindo conformidade com exceção, ao obter um snapshot.

Definições de entrada

applicationName	Especifica a aplicação para carregar dados de configuração ou de onde os dados serão exportados.
implantávelNome	(Opcional) Especifica o implantável da aplicação na qual obter os dados de snapshot mais recentes.
changesetNumber	(Opcional) Especifica o ID do changeset para o conjunto de mudanças de configuração no qual o usuário está interessado.
estáValidado	(Opcional) Especifica se devem ser retornados somente snapshots aprovados ou aprovados com exceção (verdadeiro/falso). O valor padrão é verdadeiro.
continuarComMais Recente	(Opcional) Especifica se o snapshot mais recente deve ser retornado pela combinação applicatioName-deployableName-changesetNumber se nenhum snapshot for gerado (verdadeiro/falso). O valor padrão é falso.

Saída

• Se for bem-sucedido, um snapshot ou conjunto de snapshots.
• Em caso de falha, uma mensagem de falha de API/back-end será mostrada.

Exemplo

• Snapshot específico (especificado):

  
  $snapshots = snDevOpsConfigGetSnapshots(
       applicationName: 'PaymentDemo',
       deployableName: 'Production',
       changesetNumber: 'Chset-16',
       isValidated: 'true',
       continueWithLatest: 'true'
  )

• Snapshot validado mais recente (retorna o snapshot mais recente da combinação de aplicação e implantável):

  
  $snapshots = snDevOpsConfigGetSnapshots(
       applicationName: 'PaymentDemo',
       deployableName: 'Production',
       isValidated: 'true'
  )

• Todos os snapshots do changeset (retorna todos os snapshots da combinação de aplicação e implantável):

  
  $snapshots = snDevOpsConfigGetSnapshots(
       applicationName: 'PaymentDemo',
       changesetNumber: 'Chset-16'
  )

• Mostre os resultados da validação de política em uma execução de pipeline.
  1. Atribua uma variável ao caminho do arquivo que contém os resultados de validação de snapshot gerados durante a ação snDevOpsConfigGetSnapshots.
  2. Chame a ação JUnit para carregar os resultados de validação de snapshot na seção de teste de execução do pipeline.

  
  stage('Validate') {
      steps {
  	script {
             changeSetResults = snDevOpsConfigGetSnapshots( … )
             if (!changeSetResults) {
                echo "No snapshots were created"
             } else {
  	       def changeSetResultsObject = readJSON text: changeSetResults
  
  	       changeSetResultsObject.each {
                    snapshotName = it.name
                    snapshotObject = it
  	       }
  	       // STEP 1
  		validationResultsPath = "${snapshotName}_${currentBuild.projectName}_${currentBuild.number}.xml"
  	    }
  	}
      }
  }
  
  post {
      always {
          // STEP 2
          junit testResults: "${validationResultsPath}", skipPublishingChecks: true
      }
  }
  

snDevOpsConfigPublish

Esta ação publica um snapshot para a aplicação e o implantável fornecidos. A partir daqui, o snapshot pode ser consumido por meio do processo de exportação.

Definições de entrada

applicationName	Especifica a aplicação da qual os dados de configuração serão publicados.
implantávelNome	Especifica o implantável da aplicação da qual os dados de configuração serão publicados.
nomeSnapshot	Especifica o nome do snapshot a ser publicado.

Saída

• Se for bem-sucedido, verdadeiro.
• Caso contrário, falso.

Exemplo

snDevOpsConfigPublish(
     applicationName: 'PaymentDemo',
     deployableName: 'Production',
     snapshotName: 'Production-v23.dpl',
)

snDevOpsConfigExportar

Esta ação exporta um snapshot da aplicação e do implantável fornecidos.

O usuário deve especificar o exportador, os argumentos relevantes do exportador, o formato de exportação (por exemplo, YAML, JSON etc.) e o local de saída para os dados de configuração exportados.

A partir daqui, os dados de configuração podem ser usados diretamente como uma entrada para uma ferramenta de implantação ou provisionamento descendente no pipeline.

Argumentos de entrada

applicationName	Especifica a aplicação da qual os dados serão exportados.
implantávelNome	Especifica a configuração implantável da aplicação da qual os dados serão exportados.
nomeSnapshot	(Opcional) Especifica o snapshot do qual os dados serão exportados. Se um snapshot não for especificado, o snapshot mais recente do implantável será usado.
exportName	Especifica o exportador a ser aplicado ao snapshot (por exemplo, UniqueCDIs).
exporterArgs	(Opcional) Especifica os argumentos a serem usados junto com o exportador.
exportarFormato	Especifica o formato para exportar os dados do snapshot (por exemplo, INI, YAML, PROPS).
nomeArquivo	Especifica o arquivo para o qual os dados serão exportados (presume-se que esteja no espaço). Se um nome de arquivo não for especificado, uma concatenação de nome da aplicação e nome implantável (mais a extensão do arquivo) será usada por padrão.

Saída

• Se for bem-sucedido, verdadeiro.
• Caso contrário, falso.

Exemplo

snDevOpsConfigExport(
     applicationName: 'PaymentDemo',
     deployableName: 'Production',
     snapshotName: 'Production-v23.dpl',
     exporterFormat: 'yaml',
     exporterName: 'returnAllData-now',
     exporterArgs: '',
     fileName: 'exported_file-Production-20220302.yml'
)

snDevOpsConfigRegisterPipeline

Esta ação vincula um changeset e/ou snapshot ao pipeline para que ele possa ser rastreado durante a execução do pipeline. Em Velocidade de mudança para DevOps, isso é mostrado na IU do Pipeline.

Consulte Acelerando seu DevOps processo de mudança para obter mais informações sobre o DevOps recurso de aceleração de mudança.

Argumentos de entrada

applicationName	Especifica o nome da aplicação.
changesetNumber	(Opcional) Especifica o changeset a ser associado à execução do pipeline. Nota: Especifique changesetNumber ou snapshotName, mas não ambos.
nomeSnapshot	(Opcional) Especifica o nome do snapshot a ser associado à execução do pipeline. Nota: Especifique changesetNumber ou snapshotName, mas não ambos.

Saída

• Se for bem-sucedido, verdadeiro.
• Caso contrário, falso.

Exemplo

• Entrada:

  Aqui está um exemplo da ação snDevOpsConfigRegisterPipeline. Para fins de ilustração, atribuiremos a resposta a uma variável, changeSetRegResult, que pode ser repetida para o log do console para depurar cenários.

  
  changeSetRegResult = snDevOpsConfigRegisterPipeline(
       applicationName: "PaymentDemo",
       changesetNumber: "Chset-122"
  )
  
  echo "Pipeline registration result: ${changeSetRegResult}"

• Saída:

  Além dos dados que estão sendo carregados para o nosso modelo de dados em Configuração de DevOps, a saída seria semelhante a esta (usando o plug-in Blue Ocean para visualizar a saída do console).

  

snDevOpsConfigValidate

Valide os dados de configuração em relação às políticas da sua organização.

Argumentos de entrada

applicationName	Aplicação a ser validada.
implantávelNome	Implantável para a aplicação validar.
nomeSnapshot	(Opcional) Nome do snapshot a ser validado.
marcarCom falha	(Opcional) Falha no pipeline caso a tentativa de validação tenha falhado (devido a um problema de back-end).
mostrarResultados	(Opcional) Mostre os resultados da validação no log do console de trabalho Jenkins.

Saída

• Se for bem-sucedido, não haverá saída.
• Em caso de falha, uma mensagem de falha de API/back-end será mostrada.

Exemplo

• Snapshot específico (especificado):

  
  snDevOpsConfigValidate(
       applicationName: 'PaymentDemo',
       deployableName: 'Production',
       snapshotName: 'Production-v23.dpl',
  )

• Snapshot mais recente (recupera e valida o snapshot mais recente da combinação de aplicação e implantável):

  
  $changeset = snDevOpsConfigValidate(
       applicationName: 'PaymentDemo',
       deployableName: 'Production'
  )

Mudança de snDevOps

Crie uma solicitação de mudança e anexe um snapshot para referência.

Consulte Acelerando seu DevOps processo de mudança para obter mais informações sobre o DevOps recurso de aceleração de mudança.

Argumentos de entrada

applicationName	Especifica o nome da aplicação.
nomeSnapshot	Especifica o nome do snapshot a ser associado à solicitação de mudança.

Exemplo

snDevOpsChange(
     applicationName: 'PaymentDemo',
     snapshotName: 'Production-v23.dpl'
)

Exemplo de pipeline do Jenkins

pipeline {
    environment {
        buildArtifactsPath = "build_artifacts/${currentBuild.number}"
        validationResultsPath = ""
    }

    agent any

    stages {
        // Initialize pipeline
        stage('Initialize') {
            steps {
                script {
                    // DevOps Config application related information
                    appName = 'PaymentDemo'
                    deployableName = 'Production'
                    componentName = "web-api-v1.0"
                    collectionName = "release-1.0"
                    // Configuration file information
                    exportFormat = 'yaml'
                    configFilePath = "k8s/helm/values.yml"
                    // Exporter related information
                    exporterName = 'returnAllData-nowPreview' 
                    exporterArgs = ''
                    // Jenkins variables declared to be used in pipeline
                    exportFileName = "${buildArtifactsPath}/export_file-${appName}-${deployableName}-${currentBuild.number}.${exportFormat}"
                    changeSetId = ""
                    snapshotName = ""
                    snapshotObject = ""
                    isSnapshotValidateionRequired = false
                    isSnapshotPublisingRequired = false
                }
            }
        }
            
        // Validate configuration data changes
        stage('Validate') {
            parallel {
                stage('Config') {
                    stages('Config Steps') {
                        // Upload configuration data to DevOps Config
                        stage('Upload, Validate, & Publish') {
                            steps {
                                sh "echo uploading and auto-validating configuration file: ${configFilePath}"
                                script {
                                    changeSetResults = snDevOpsConfig(
                                        applicationName: "${appName}",
                                        target: 'component',
                                        namePath: "${componentName}",
                                        configFile: "${configFilePath}",
                                        dataFormat: "${configFileFormat}",
                                        autoCommit: 'true',
                                        autoValidate: 'true',
                                        autoPublish: 'true',
                                        isValidated: 'true',
                                        continueWithLatest: 'true',
                                        markFailed: 'true'
                                    )

                                    echo "Snapshots generated, validated, and published: ${changeSetResults}"

                                    def changeSetResultsObject = readJSON text: changeSetResults

                                    changeSetResultsObject.each {
                                        snapshotName = it.name
                                        snapshotObject = it
                                    }

                                    validationResultsPath = "${snapshotName}_${currentBuild.projectName}_${currentBuild.number}*.xml"
                                }
                            }
                        }
                        // Export published snapshot to be used by downstream deployment tools
                        stage('Export') {
                            steps {
                                script {
                                    // create build artifacts dir to store export file
                                    sh "mkdir -p ${buildArtifactsPath}"
                                    
                                    exportResponse = snDevOpsConfigExport(
                                        applicationName: "${appName}",
                                        snapshotName: "${snapshotObject.name}",
                                        deployableName: "${deployableName}",
                                        exporterFormat: "${exportFormat}",
                                        fileName: "${exportFileName}",
                                        exporterName: "${exporterName}",
                                        exporterArgs: "${exporterArgs}"
                                    )
                                }
                            }
                        }
                    }
                }
            }
        }
        
        // Create change request and attach snapshot for reference
        stage('Change Management') {
            steps {
                script {
                    // Trigger change request
                    snDevOpsChange(
                        applicationName: "${appName}",
                        snapshotName: "${snapshotName}"
                    )
                }     
            }
        }
    }
    // NOTE: attach snapshot validation results to run (if the snapshot fails validation)
    post {
        always {
            // attach policy validation results
            junit testResults: "${validationResultsPath}", skipPublishingChecks: true
        }
    }
}