Para configurar imagens Docker, as seguintes variáveis ambientais devem estar disponíveis na instância GitLab do projeto.

• SNOW_TOKEN: ServiceNow número de token. É uma variável mascarada e não será exibida nos trabalhos.
• SNOW_TOOLID: ServiceNow ID da ferramenta.
• SNOW_URL: ServiceNow URL da instância.

Quando você configura um projeto GitLab, as variáveis ambientais são criadas para o projeto e os valores de variáveis configurados mais recentes são considerados. Se você for um cliente de atualização, deverá reconfigurar seus projetos GitLab existentes ou adicionar manualmente as variáveis ambientais em sua instância GitLab. Para obter informações sobre como adicionar variáveis, consulte a documentação do GitLab.

As variáveis de ambiente a seguir devem ser configuradas na instância de Ações do GitHub.

• SNOW_TOKEN: ServiceNow número de token. É uma variável mascarada e não será exibida nos trabalhos.
• SNOW_TOOLID: ServiceNow ID da ferramenta.
• SNOW_URL: ServiceNow URL da instância.

As seguintes variáveis de ambiente devem ser passadas no pipeline de ações do GitHub:

• CI_PIPELINE_ID: ID de execução do fluxo de trabalho de um repositório. Uso - CI_PIPELINE_ID: ${{github.run_id }}
• CI_API_V4_URL: URL do servidor GitHub. Uso - CI_API_V4_URL: ${{ github.server_url }}
• CI_Job_ID: ID de execução do fluxo de trabalho de um repositório. Uso - CI_PIPELINE_ID: ${{github.run_id }}
• CI_PROJECT_PATH: nome do fluxo de trabalho. Uso - CI_PROJECT_PATH: ${{ github.repository }}/${{github.workflow}}
• CI_REPOSITORY_NAME: nome do repositório. Uso - CI_REPOSITORY_NAME: ${{ github.repository }}
• CI_RUN_ATTEMPT: número de tentativas de fluxo de trabalho. Uso - CI_RUN_ATTEMPT: ${{ github.run_attempt }}
• CI_PROJECT_TITLE: nome do fluxo de trabalho. Uso - CI_PROJECT_TITLE: ${{ github.repository }}/${{github.workflow}}
• CI_COMMIT_BRANCH: nome da ramificação na qual o fluxo de trabalho está sendo executado. Uso - CI_COMMIT_BRANCH: ${{ github.ref_name }}
• CI_WORKFLOW_NAME: nome do fluxo de trabalho. Uso - CI_WORKFLOW_NAME: ${{ github.workflow }}

Quando você configura um repositório, as variáveis ambientais são criadas para o repositório e os valores de variáveis configurados mais recentes são considerados. Se você for um cliente de atualização, deverá reconfigurar seus repositórios existentes ou adicionar manualmente as variáveis ambientais em sua instância.

As seguintes variáveis ambientais devem ser configuradas em sua instância do Harness.

• SNOW_TOKEN: ServiceNow número de token. É uma variável mascarada e não será exibida nos trabalhos.
• SNOW_TOOLID: ServiceNow ID da ferramenta.
• SNOW_URL: ServiceNow URL da instância.

• HARNESS_STAGE_NAME: "<+stage.identifier>"

• HARNESS_PIPELINE_NAME: "<+org.identifier>/<+project.identifier>/<+pipeline.name>"

Quando você configura um repositório, as variáveis ambientais são criadas para o repositório e os valores de variáveis configurados mais recentes são considerados. Se você for um cliente de atualização, deverá reconfigurar seus repositórios existentes ou adicionar manualmente as variáveis ambientais em sua instância.

Você deve passar a ServiceNow Docker Image (servicenowdocker/sndevops:5.1.0) no pipeline antes de adicionar ações personalizadas ao pipeline. Você pode clonar o repositório público app-devops-gitlab localizado em https://github.com/ServiceNow/app-devops-gitlabe criar a imagem do Docker executando os seguintes comandos:

docker build -t servicenowdocker/sndevops:5.1.0

docker push servicenowdocker/sndevops:5.1.0

Você pode adicionar a imagem do Docker no início do arquivo .yml. Você não precisa adicioná-lo para cada trabalho separadamente.

Adicione a etapa personalizada ServiceNow DevOps Change no nível do trabalho para criar uma mudança em sua instância da ServiceNow. Por exemplo:

stages:
  - DevOpsChangeApproval

ServiceNow DevOps Change:
  stage: DevOpsChangeApproval
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli create change -p "{\"changeStepDetails\":{\"timeout\":3600,\"interval\":100},\"attributes\":{\"short_description\":\"Software Deployment\",\"description\":\"Software Deployment.\",\"assignment_group\":\"xxxxxxxxx\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}}"

• changeStepDetails: [opcional] Contém os detalhes do tempo limite e do intervalo.
• intervalo: [opcional] O tempo em segundos de espera entre tentativas da API. O valor padrão é 100 segundos.
• timeout: [opcional] O tempo máximo em segundos de espera até que a ação falhe. O valor padrão é 3600 segundos.
  Nota:

  Quando o valor de tempo limite também estiver disponível aqui na ferramenta, o valor de tempo limite que for anterior será considerado.
• atributos: [opcional] Os detalhes do atributo da solicitação de mudança devem ser usados ao criar uma mudança em uma instância ServiceNow. A solicitação de mudança é um objeto JSON entre chaves {} que contém pares de chave-valor separados por uma vírgula (,). Um par de chave-valor consiste em uma chave e um valor separados por dois pontos (:). As chaves compatíveis com o par chave-valor são short_description, description, assign_group, execution_plan, backout_plan, test_plan e assim por diante.
• -ctx: [opcional] Parâmetros de contexto adicionais no formato JSON. Detalhes da variável de ambiente do GitHub que serão usados para criar a solicitação da API DevOps Change. Por exemplo,

  sndevopscli create change -ctx "{\"projectId\": \"123456\", \"attemptNumber\": \"${{ github.run_attempt }}\"}" -p "{\"changeStepDetails\": {\"timeout\":3600,\"interval\":100},\"autoCloseChange\":true,\"attributes\":{\"short_description\":\"G Venkata Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"a715cd759f2002002920bde8132e7018\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}}"

• -w: [opcional] Especifique se o pipeline deve aguardar a criação e a aprovação da mudança. Por padrão, o pipeline aguardará a criação da mudança e sua aprovação.

Adicione a etapa personalizada ServiceNow Resultados do SonarScan do DevOps no nível do trabalho para criar um resumo do Sonar em sua instância da ServiceNow. Por exemplo:

stages:
  - DevOpsSonarStage

ServiceNow DevOps SonarScan Results:
  stage: DevOpsSonarStage
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'devsystem2019_TestImportTest'

• url: [Obrigatório] Especifica a URL do Sonar.
• projectKey: [Obrigatório] Especifica a chave do projeto do Sonar.

Limitação

Ao criar resultados de resumo de qualidade de software, a variável de ambiente CI_MERGE_REQUEST_SOURCE_BRANCH_NAME será usada para pipelines de mesclagem e CI_DEFAULT_BRANCH será usada para pipelines de marcador porque a variável CI_COMMIT_BRANCH não está disponível para pipelines de mesclagem ou de marcador. Para obter mais informações, consulte a documentação do GitLab.

Adicione a etapa personalizada do artefato no nível do trabalho para registrar um artefato em sua instância da ServiceNow. Por exemplo:

stages:
  - artifact

artifact:
  stage: artifact
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli create artifact -a "[{\"name\":\"Artifact-${CI_JOB_NAME}\",\"repositoryName\":\"Repo\",\"version\":\"1.${CI_JOB_ID}.0\"}]"
 

Adicione a etapa personalizada de pacote no nível do trabalho para registrar um pacote em sua instância da ServiceNow. Por exemplo:

stages:
  - package

package:
  stage: package
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli create package -n "Package2" -a "[{\"name\":\"Artifact-${CI_JOB_NAME}\",\"repositoryName\":\"Repo\" ,\"version\":\"1.${CI_JOB_ID}.0\"}]"

Por exemplo:

stages:
  - DevOpsGetChange

ServiceNow DevOps Get Change:
  stage: DevOpsGetChange
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli get change -p "{\"buildNumber\":${CHG_JOB_ID},\"stageName\":\"ServiceNow DevOps Change Step\",\"pipelineName\":\"GitlabDockerGetAndUpdateChange\"}"

-p: It stands for changeDetails. The change details to be used for identifying change request in ServiceNow instance. The change details is a JSON object surrounded by curly braces {} containing key-value pair separated by a comma ,. A key-value pair consists of a key and a value separated by a colon :. The keys supported in key-value pair are buildNumber, pipelineName, stageName

buildNumber: [mandatory]
This specifies ID of the Job where we have created change request.

stageName: [mandatory]
This specifies the Job name where we have created change request..

pipelineName: [mandatory]
This specifies the pipeline name.

Outputs:
  sndevopschg.json file created with content: {
    "status": "SUCCESS",
    "changeRequestNumber": "CHGXXXXX"
  }
  
  changeRequestNumber: Change Request Number found for the given change details
  status: To know the status of the Change Request GET.

Por exemplo:

stages:
  - DevOpsUpdateChangeStage

ServiceNow DevOps Update Change:
  stage: DevOpsUpdateChangeStage
  image: servicenowdocker/sndevops:5.1.0
  script: 
    - sndevopscli update change -n 'CHGXXXXXX' -p "{\"short_description\":\"G Venkata12345 Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"XXXXX\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}"

-n [Not mandatory if we have sndevopschg.json in our pipeline yml]: It stands for changeRequestNumber. The change request number to identify a unique change request. 
   Precedence of choosing changeRequestNumber: 
     - changeRequestNumber mentioned in the pipeline yml
     - changeRequestNumber stored in sndevopschg.json.

-p : It stands for changeDetails. The change details to be used for Updating the change request information identified by the specified change request number with the key-value pairs. The change details is a JSON object surrounded by curly braces {} containing key-value pair separated by a comma ,. A key-value pair consists of a key and a value separated by a colon :. The keys supported in key-value pair are short_description, state, description, work_notes ..so on

OR
  - sndevopscli update change -p "{\"short_description\":\"Updated Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"XXXXXXXXXX\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}"

NOTE: State should be specified at last in case if you are update the state of change request.
- sndevopscli update change -p "{\"short_description\":\"Updated Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"XXXXXXXXXX\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\","state":"3"}'

Por exemplo:

stages:
  - changeapproval

ServiceNow DevOps Change Step:
  stage: changeapproval
  image: servicenowdocker/sndevops:5.1.0
  script: 
     - sndevopscli create change -p "{\"changeStepDetails\":{\"timeout\":3600,\"interval\":100},\"autoCloseChange\":true,\"attributes\":{\"short_description\":\"G Venkata Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"xxxxxxxx\",\"implementation_plan\":\"Software update is tested and results can be found in Test Summaries Tab.\",\"backout_plan\":\"When software fails in production, the previous software release will be re-deployed.\",\"test_plan\":\"Testing if the software was successfully deployed or not\"}}"
  
autoCloseChange: [optional] : Boolean value

Adicione a etapa personalizada ServiceNow Resultados da verificação de segurança para DevOps no nível do trabalho para recuperar os resultados da verificação de segurança. Por exemplo:

stages:
  - DevOpsSecurityScanStageServiceNow 

ServiceNow DevOps Security Scan Results:
  stage: DevOpsSecurityScanStageimage 
  image: servicenowdocker/sndevops:5.1.0
  script: 
      - sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"${CI_PIPELINE_ID}\",\"pipelineExecutionUrl\":\"${CI_PIPELINE_URL}\" },\"securityResultAttributes\":{ \"scanner\":\"Veracode\",\"applicationName\":\"PetStoreAPI-Github\",\"buildVersion\":\"\",\"securityToolId\":\"\"}}"
  -p: [mandatory]It the payload of security result attributes. The payload will have attributes as follows:
    buildNumber: CI_PIPELINE_ID (mandatory)pipelineExecutionUrl: CI_PIPELINE_URL (mandatory)scanner: Scanning tool and is required e.g. Checkmarx One.projectName/projectId: Name/Id of your Checkmarx One project and is required. This attribute is applicable only for Checkmarx One.applicationName: Name of your Veracode application and is required. This attribute is applicable only for Veracode.buildVersion": Veracode Scan name / build version and is optional. This attribute is applicable only for Veracode.scanId: Checkmarx One scan id and is optional. This attribute is applicable only for Checkmarx One.securityToolId: Security tool onboarded in ServiceNow (sys_id of the onboarded security tool) and is optional.