Implementieren Sie anwenderdefinierte Aktionen für Pipelines mit einem generischen Docker-Container-Image
Verwenden Sie ServiceNow Anwenderdefinierte Aktionen zum Sammeln von Daten im Zusammenhang mit der Erstellung von Change-Anforderungen, dem Sonar-Scan, der Artefaktregistrierung und der Paketregistrierung in Ihrer Pipeline mit Hilfe des generischen Docker Container-Image.
Docker Image ist ein Softwarepaket, das zum Ausführen einer Anwendung verwendet werden kann. Dieses Bild gibt an, wie ein Container instanziiert werden soll und welche Softwarekomponenten ausgeführt werden müssen. Docker Container ist eine virtuelle Umgebung, die Anwendungscode und alle Abhängigkeiten kombiniert, die zum Ausführen der Anwendung erforderlich sind. Weitere Informationen zu Docker finden Sie unter Docker-Dokumentation .
Umgebungsvariablen für GitLab
Zum Konfigurieren Docker Images müssen die folgenden Umgebungsvariablen in verfügbar sein GitLab Instanz für Ihr Projekt.
- SNOW_TOKEN: ServiceNow Tokennummer. Es handelt sich um eine maskierte Variable, die nicht in den Aufträgen angezeigt wird.
- SNOW_TOOLID: ServiceNow Tool-ID.
- SNOW_URL: ServiceNow Instanz-URL.
Wenn Sie die Variable „SNOW_TOKEN“ hinzufügen, können Sie das Token abrufen, indem Sie auswählen Token kopieren Schaltfläche im Tooldatensatz, die sich in der Tabelle „Tool“ [sn_devops_Tool] befindet.
Die Umgebungsvariablen müssen mit den Werten aktualisiert werden, die im Popup-Fenster Webhooks manuell konfigurieren auf der Tooldatensatzseite verfügbar sind. Weitere Informationen zum Anzeigen der Verbindungsdetails finden Sie unter Konfigurieren Sie Webhooks über den Tooldatensatz Und Konfigurieren Sie Webhooks in GitLab Manuell.
Umgebungsvariablen für GitHub Actions
Zum Konfigurieren Docker Bilder, bestimmte Umgebungsvariablen müssen in verfügbar sein GitHub Actions Instanz.
Die folgenden Umgebungsvariablen müssen in Ihrer GitHub-Aktionsinstanz konfiguriert werden.
Hinweis:
Die Variablen müssen mit den Werten aktualisiert werden, die im Popup-Fenster Webhooks manuell konfigurieren auf der Tooldatensatzseite verfügbar sind.
- SNOW_TOKEN: ServiceNow Tokennummer. Es handelt sich um eine maskierte Variable, die nicht in den Aufträgen angezeigt wird.
- SNOW_TOOLID: ServiceNow Tool-ID.
- SNOW_URL: ServiceNow Instanz-URL.
Hinweis:
Für Informationen zum Hinzufügen von Variablen in GitHub Actions, Siehe GitHub-Dokumentation .
Die folgenden Umgebungsvariablen müssen in Ihrer GitHub-Aktionen-Pipeline übergeben werden:
Hinweis:
Die Werte für diese Variablen werden dynamisch aus GitHub abgerufen, und Sie müssen sie nicht separat konfigurieren.
- PIPELINE_ID: ID der Workflow-Ausführung eines Repositorys. Nutzung – PIPELINE_ID: ${{github.run_id }}
- API_V4_URL: URL des GitHub-Servers. Nutzung – API_V4_URL: ${{ github.server_url }}
- JOB_ID: ID der Workflow-Ausführung eines Repositorys. Nutzung – PIPELINE_ID: ${{github.run_id }}
- PROJECT_PATH: Name des Workflows. Verwendung – PROJECT_PATH: ${{ github.Repository }}/${{github.Workflow}}
- REPOSITORY_NAME: Name des Repositorys. Nutzung – REPOSITORY_NAME: ${{ github.Repository }}
- RUN_ATTEMPT: Anzahl der Workflow-Versuche. Nutzung – RUN_ATTEMPT: ${{ github.run_attempt }}
- PROJECT_TITLE: Name des Workflows. Nutzung – PROJECT_TITLE: ${{ github.Repository }}/${{github.Workflow}}
- COMMIT_BRANCH: Name der Verzweigung, auf der der Workflow ausgeführt wird. Verwendung – COMMIT_BRANCH: ${{ github.ref_Name }}
- WORKFLOW_NAME: Name des Workflows. Nutzung – WORKFLOW_NAME: ${{ github.Workflow }}
Umgebungsvariablen für Harness
Zum Konfigurieren Docker Bilder, bestimmte Umgebungsvariablen müssen in Ihrer Harness-Instanz verfügbar sein.
Die folgenden Umgebungsvariablen müssen in Ihrer Kabelbauminstanz konfiguriert werden.
Hinweis:
Die Variablen müssen mit den Werten aktualisiert werden, die im Popup-Fenster Webhooks manuell konfigurieren auf der Tooldatensatzseite verfügbar sind.
- SNOW_TOKEN: ServiceNow Tokennummer. Es handelt sich um eine maskierte Variable, die nicht in den Aufträgen angezeigt wird.
- SNOW_TOOLID: ServiceNow Tool-ID.
- SNOW_URL: ServiceNow Instanz-URL.
Die folgenden Umgebungsvariablen müssen in Ihrer Kabelbaum-Pipeline übergeben werden:
-
HARNESS_STAGE_NAME: „<+stage.Identifier>“
-
HARNESS_PIPELINE_NAME: „<+org.Identifier>/<+project.Identifier>/<+pipeline.name>"
ServiceNow Docker-Image
Sie müssen übergeben ServiceNow Docker-Image (servicenowdocker/sndevops:5,1.0) in Ihrer Pipeline, bevor Sie anwenderdefinierte Aktionen in Ihrer Pipeline hinzufügen. Sie können das öffentliche App-devops-gitlab-Repository klonen, das sich unter befindet https://github.com/ServiceNow/app-devops-gitlab, Und erstellen Sie das Docker-Image, indem Sie die folgenden Befehle ausführen:
docker build -t servicenowdocker/sndevops:5.1.0docker push servicenowdocker/sndevops:5.1.0Sie können das Docker-Image zu Beginn der .yml-Datei hinzufügen. Sie müssen sie nicht für jeden Auftrag separat hinzufügen.
Hinweis:
Wenn Sie mehrere Bilder verwenden möchten, fügen Sie sie auf Auftragsebenen hinzu.
Sie können auch anpassen App-devops-gitlab Öffentliches Repository und erstellen Sie Ihr eigenes Docker-Image, das in der Pipeline übergeben werden soll.
ServiceNow DevOps-Change-Schritt
Fügen Sie hinzu ServiceNow Anwenderdefinierter DevOps-Change-Schritt auf Auftragsebene zum Erstellen eines Change in Ihrer ServiceNow-Instanz. Zum Beispiel:
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\"}}"
Hinweis:
Wenn Sie sowohl den Docker-Change-Schritt als auch den Schritt „Wann: Manueller Anweisungswechsel“ verwenden, stellen Sie sicher, dass Sie sie auf verschiedenen Positionsebenen hinzufügen.
Sie müssen die Eingabewerte für diese anwenderdefinierte Aktion als JSON-formatierte Zeichenfolge eingeben.
- ChangeStepDetails : [Optional] enthält die Zeitüberschreitung und Intervalldetails.
- Intervall : [Optional] die Wartezeit in Sekunden zwischen dem Versuch der API. Der Standardwert ist 100 Sekunden.
- Zeitüberschreitung : [Optional] die maximale Wartezeit in Sekunden, bis die Aktion fehlschlägt. Der Standardwert ist 3600 Sekunden.Hinweis:Wenn der Zeitüberschreitungswert auch hier in Ihrem Tool verfügbar ist, wird der frühere Zeitüberschreitungswert berücksichtigt.
- Attribute : [Optional] die Details des Change-Anforderungsattributs sollen beim Erstellen eines Change in verwendet werden ServiceNow Instanz. Die Change-Anforderung ist ein JSON-Objekt, umgeben von geschweiften Klammern {}, das Schlüssel-Wert-Paare enthält, die durch ein Komma (,) getrennt sind. Ein Schlüssel-Wert-Paar besteht aus einem Schlüssel und einem durch einen Doppelpunkt (:) getrennten Wert. Die im Schlüssel-Wert-Paar unterstützten Schlüssel sind short_description, description, assignment_Group, implementation_Plan, Backout_Plan, Test_Plan usw.
- -CTX : [Optional] zusätzliche Kontextparameter im JSON-Format. Umgebungsvariablen-Details aus GitHub, die zum Erstellen der Anforderung für die DevOps-Change-API verwendet werden. Beispiel:
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 : [Optional] Geben Sie an, ob die Pipeline auf die Erstellung und Genehmigung von Changes warten soll. Standardmäßig wartet die Pipeline bis zur Change-Erstellung und Genehmigung.
Hinweis:
Der Name des Change-Schritts muss enthalten ServiceNow DevOps-Change Stichwort, das der Auftragsname ist.
ServiceNow DevOps-SonarScan-Ergebnisse
Fügen Sie hinzu ServiceNow Anwenderdefinierter Schritt für DevOps-SonarScan-Ergebnisse auf Auftragsebene zum Erstellen einer Sonar-Zusammenfassung in Ihrer ServiceNow-Instanz. Zum Beispiel:
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 : [Erforderlich] Dies gibt die Sonar-URL an.
- ProjectKey : [Erforderlich] Dies gibt den Sonar-Projektschlüssel an.
Hinweis:
Der Name des Sonar-Schritts muss mit dem Auftragsnamen identisch sein, d. h. SonarScan-Ergebnisse von ServiceNow DevOps .
- Einschränkung
- Beim Erstellen von Zusammenfassungsergebnissen der Softwarequalität wird die Umgebungsvariable MERGE_REQUEST_SOURCE_BRANCH_NAME für Zusammenführungs-Pipelines verwendet, und DEFAULT_BRANCH wird für Tag-Pipelines verwendet, da die Variable „COMMIT_BRANCH“ für Zusammenführungs- oder Tag-Pipelines nicht verfügbar ist. Weitere Informationen finden Sie unter GitLab-Dokumentation .
Artefakt Registrieren
Fügen Sie den anwenderdefinierten Artefakt-Schritt auf Auftragsebene hinzu, um ein Artefakt in Ihrer ServiceNow-Instanz zu registrieren. Zum Beispiel:
stages:
- artifact
artifact:
stage: artifact
image: servicenowdocker/sndevops:5.1.0
script:
- sndevopscli create artifact -a "[{\"name\":\"Artifact-${JOB_NAME}\",\"repositoryName\":\"Repo\",\"version\":\"1.${JOB_ID}.0\"}]"
Sie müssen die Eingabewerte für diese anwenderdefinierte Aktion als JSON-formatierte Zeichenfolge eingeben.
-A : [Erforderlich] gibt Artefaktdetails an.
Paket registrieren
Fügen Sie den anwenderdefinierten Paketschritt auf Auftragsebene hinzu, um ein Paket in Ihrer ServiceNow-Instanz zu registrieren. Zum Beispiel:
stages:
- package
package:
stage: package
image: servicenowdocker/sndevops:5.1.0
script:
- sndevopscli create package -n "Package2" -a "[{\"name\":\"Artifact-${JOB_NAME}\",\"repositoryName\":\"Repo\" ,\"version\":\"1.${JOB_ID}.0\"}]"Sie müssen die Eingabewerte für diese anwenderdefinierte Aktion als JSON-formatierte Zeichenfolge eingeben.
-N : [Erforderlich] Dies gibt den Paketnamen an.
Change abrufen
Auf Positionsebene hinzufügen, um changeRequestNumber abzurufen ServiceNow Instanz mit den angegebenen Change-Details zur Identifizierung der Change-Anforderung.
Zum Beispiel:
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.
Aktualisieren Sie den Change
Auf Positionsebene hinzufügen, um den Change in zu aktualisieren ServiceNow Instanz für die changeRequestNumber, die als Eingabe zusammen mit changeRequestDetails bereitgestellt wird.
Zum Beispiel:
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"}'
Change automatisch schließen
Integrieren Sie den Change automatisch schließen in ServiceNow Instanz. Detaillierte Informationen zum automatischen Schließen finden Sie unter Wird Konfiguriert DevOps Details zur Change-Anforderung in der Pipeline.
Zum Beispiel:
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
Sicherheitsscanergebnisse
Fügen Sie hinzu ServiceNow Anwenderdefinierter Schritt für DevOps-Sicherheitsscanergebnisse auf Auftragsebene zum Abrufen von Sicherheitsscanergebnissen. Zum Beispiel:
stages:
- DevOpsSecurityScanStageServiceNow
ServiceNow DevOps Security Scan Results:
stage: DevOpsSecurityScanStageimage
image: servicenowdocker/sndevops:5.1.0
script:
- sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"${PIPELINE_ID}\",\"pipelineExecutionUrl\":\"${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: PIPELINE_ID (mandatory)pipelineExecutionUrl: 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.
Beispiel Pipelines
Beispiel für eine GitLab-Pipeline
image: servicenowdocker/sndevops:5.1.0
stages:
- pre-build
- build
- sonar
- securityscan
- changeapproval
- getchange
- updatechange
- deploy
Pre-Build:
stage: pre-build
script:
- echo $JOB_NAME
Artifact and Package:
stage: build
script:
- sndevopscli create artifact -a "[{\"name\":\"Artifact-${JOB_NAME}\",\"repositoryName\":\"TestRepo\",\"version\":\"1.${RUNNER_ID}.0\"}]"
- sndevopscli create package -n "Test_Package" -a "[{\"name\":\"Artifact-${JOB_NAME}\",\"repositoryName\":\"TestRepo\",\"version\":\"1.${RUNNER_ID}.0\"}]"
ServiceNow DevOps SonarScan Results:
stage: sonar
script:
- sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'xxxxxxx'
ServiceNow DevOps Security Scan Results:
stage: securityscan
script:
- sndevopscli create securityScan -p "{\"pipelineInfo\":{\"buildNumber\":\"${JOB_ID}\", \"stageName\":\"ServiceNow DevOps Security Scan Results\",\"taskExecutionUrl\":\"${JOB_URL}\" },\"securityResultAttributes\":{ \"scanner\":\"Veracode\",\"applicationName\":\"PetStoreAPI-Github\",\"buildVersion\":\"\",\"securityToolId\":\"\"}}"
ServiceNow DevOps Change Step:
stage: changeapproval
variables:
CHG_JOB_ID: $JOB_ID
script:
- echo "CHG_JOB_ID=$CHG_JOB_ID" >> generated_job_id.env
- 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\":\"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\"}}"
- sndevopscli get change #If we are placing get change cli command in the same job where we are creating change then no need to mention the changeDetails.
artifacts:
paths:
- generated_job_id.env
DevOps Get Change:
stage: getchange
script:
- source generated_job_id.env
- sndevopscli get change -p "{\"buildNumber\":${CHG_JOB_ID},\"stageName\":\"ServiceNow DevOps Change Step\",\"pipelineName\":\"SmrutiTestDemoProject\"}"
artifacts:
paths:
- sndevopschg.json
dependencies:
- ServiceNow DevOps Change Step
DevOps Update Change:
stage: updatechange
script:
#- sndevopscli update change -n 'CHGXXXX' -p "{\"short_description\":\"Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"xxxxxxx\",\"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\"}"
- sndevopscli update change -p "{\"short_description\":\"Updated Automated Software Deployment\",\"description\":\"Automated Software Deployment.\",\"assignment_group\":\"xxxxxxx\",\"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\"}"
dependencies:
- DevOps Get Change
Deploy Job:
stage: deploy
script:
- echo $JOB_NAMEBeispiel für eine GitHub-Aktionen-Pipeline
name: GithubAction
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
permissions:
contents: read
env:
SNOW_URL: ${{ secrets.SNOW_URL }}
SNOW_TOKEN: ${{ secrets.SNOW_TOKEN }}
SNOW_TOOLID: ${{ secrets.SNOW_TOOLID }}
# These are the optional env variables
#PIPELINE_ID: ${{ github.run_id }}
#API_V4_URL: ${{ github.server_url }}
#JOB_ID: ${{ github.run_id }}
#PROJECT_PATH: ${{ github.job }}
#REPOSITORY_NAME: ${{ github.repository }}
#RUN_ATTEMPT: ${{ github.run_attempt }}
#PROJECT_TITLE: ${{ github.repository }}/${{github.workflow}}
#COMMIT_BRANCH: ${{ github.ref_name }}
#WORKFLOW_NAME: ${{ github.workflow }}
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Set up JDK 17
run: |
echo 'hello'
ServiceNowDevOpsChange:
runs-on: ubuntu-latest
needs: build
container:
image: servicenowdocker/sndevops:5.1.0
env:
JOB_NAME: "ServiceNowDevOpsChange"
steps:
- name: create change
run: |
sndevopscli create change -p "{\"changeStepDetails\":{\"timeout\":3600,\"interval\":10},\"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\"}}"
ServiceNowUpdateDevOpsChange:
runs-on: ubuntu-latest
needs: ServiceNowDevOpsChange
container:
image: servicenowdocker/sndevops:5.1.0
env:
JOB_NAME: "ServiceNowDevOpsChange"
steps:
- name: update change
run: |
sndevopscli update change -p "{\"short_description\":\"Updated 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\"}"
ArtifactAndPackage:
runs-on: ubuntu-latest
needs: build
container:
image: servicenowdocker/sndevops:5.1.0
env:
JOB_NAME: "ArtifactAndPackage"
steps:
- name: create artifact
run: |
sndevopscli create artifact -a "[{\"name\": \"com:customactiondemo\",\"version\": \"1.${{ github.run_number }}\",\"semanticVersion\": \"1.${{ github.run_number }}.0\",\"repositoryName\": \"${{ github.repository }}\"}]"
sndevopscli create package -n "Test_Package" -a "[{\"name\": \"com:customactiondemo\",\"version\": \"1.${{ github.run_number }}\",\"semanticVersion\": \"1.${{ github.run_number }}.0\",\"repositoryName\": \"${{ github.repository }}\"}]"
ServiceNowDevOpsSonarScanResults:
name: ServiceNowDevOpsSonarScanResults
needs: ArtifactAndPackage
runs-on: ubuntu-latest
container:
image: servicenowdocker/sndevops:5.1.0
env:
JOB_NAME: "ServiceNowDevOpsSonarScanResults"
steps:
- name: devops soanr results
run: |
sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'xxxxxxx'
ServiceNowDevOpsSecurityScan:
name: ServiceNowDevOpsSecurityScan
runs-on: ubuntu-latest
needs: build
container:
image: servicenowdocker/sndevops:5.1.0
steps:
- name: security scan
run: |
sndevopscli create securityScan -p "{ \"pipelineInfo\": { \"runId\": \"${{ github.run_id }}\", \"runNumber\": \"${{ github.run_number }}\", \"runAttempt\": \"${{ github.run_attempt }}\", \"job\": \"ServiceNowDevOpsSecurityScan\", \"workflow\": \"${{ github.workflow }}\", \"repository\": \"${{github.repository}}\" }, \"securityResultAttributes\": { \"scanner\": \"Veracode\", \"applicationName\": \"PetStoreAPI-Github\",\"buildVersion\": \"\", \"securityToolId\": \"\"}}"
Beispiel für eine Kabelbaum-Pipeline
# This is an example pipeline, and your pipeline and container configurations may vary from the setup shown here.
# Refer to the pipeline stages for Security, Software, and Change configurations.
# Using this YAML file directly will not work as it contains several Harness-specific configurations; check the Command section present for container steps.
pipeline:
name: Example pipeline
identifier: Example_pipeline
projectIdentifier: Example_project
orgIdentifier: ExampleOrg
tags: {}
stages:
- stage:
name: Build
identifier: Build
description: ""
type: Custom
spec:
execution:
steps:
- step:
type: ShellScript
name: ShellScript_1
identifier: ShellScript_1
spec:
shell: Bash
executionTarget: {}
source:
type: Inline
spec:
script: echo "Building.."
environmentVariables: []
outputVariables: []
timeout: 10m
tags: {}
- stage:
name: ServiceNow DevOps Sonar Scan Results
identifier: ServiceNow_DevOps_Sonar_Scan_Results
description: ""
type: Custom
spec:
execution:
steps:
- step:
type: Container
name: Sonar container
identifier: Sonar_container
spec:
connectorRef: docker_connector # harness docker connector
image: servicenowdocker/sndevops:5.1.0
command: |-
export SNOW_URL="<+variable.SNOW_URL>"
export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
export SNOW_TOKEN="<+variable.SNOW_TOKEN>"
export HARNESS_STAGE_NAME="<+stage.identifier>"
export HARNESS_PIPELINE_NAME="<+org.identifier>/<+project.identifier>/<+pipeline.name>"
export COMMIT_BRANCH="main"
sndevopscli create sonar -url 'https://sonarcloud.io' -projectKey 'SONAR_PROJECT_KEY' -branch "main"
shell: Sh
infrastructure:
type: KubernetesDirect
spec:
connectorRef: KUBE_CONNECTOR # harness kubernates connector
namespace: harness-delegate-ng
resources:
limits:
cpu: "0.5"
memory: 500Mi
annotations: {}
labels: {}
containerSecurityContext:
capabilities:
drop: []
add: []
nodeSelector: {}
reports:
type: JUnit
spec:
paths: []
outputVariables: []
envVariables: {}
timeout: 1h
tags: {}
- stage:
name: ServiceNow DevOps Security Scan Results
identifier: ServiceNow_DevOps_Security_Scan_Results
description: ""
type: Custom
spec:
execution:
steps:
- step:
type: Container
name: security
identifier: security
spec:
connectorRef: docker_connector # harness docker connector
image: servicenowdocker/sndevops:5.1.0
command: |-
export SNOW_URL="<+variable.SNOW_URL>"
export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
export SNOW_TOKEN="<+variable.SNOW_TOKEN>"
sndevopscli create securityScan -p \
"{\"pipelineInfo\":{
\"buildNumber\":\"<+stage.nodeExecutionId>\",
\"taskExecutionUrl\":\"<+pipeline.executionUrl>?stage=<+stage.nodeExecutionId>\",
\"orchestrationPipeline\":\"<+org.identifier>/<+project.identifier>/<+pipeline.name>\"
},
\"securityResultAttributes\":{
\"scanner\":\"Veracode\",
\"applicationName\":\"VeraDemo-10\"
}
}"
shell: Sh
infrastructure:
type: KubernetesDirect
spec:
connectorRef: KUBE_CONNECTOR # harness kubernates connector
namespace: harness-delegate-ng
resources:
limits:
cpu: "0.5"
memory: 500Mi
annotations: {}
labels: {}
containerSecurityContext:
capabilities:
drop: []
add: []
nodeSelector: {}
reports:
type: JUnit
spec:
paths: []
outputVariables: []
envVariables: {}
timeout: 1h
tags: {}
- stage:
name: Deploy
identifier: Deploy
description: ""
type: Deployment
spec:
deploymentType: Kubernetes
service:
serviceRef: service
environment:
environmentRef: Dev
deployToAll: false
infrastructureDefinitions:
- identifier: Infra
execution:
steps:
- step:
type: Container
name: ServiceNow change
identifier: ServiceNow_change
spec:
connectorRef: docker_connector # harness docker connector
image: servicenowdocker/sndevops:5.1.0
command: |-
# set mandetory variables. These can be set from Environment variable section of Optional configuration as well.
export HARNESS_STAGE_NAME="<+stage.identifier>"
export SNOW_URL="<+variable.SNOW_URL>"
export SNOW_TOOLID="<+variable.SNOW_TOOLID>"
export SNOW_TOKEN="<+variable.SNOW_TOKEN>"
# "sndevopscli create change" command notifies ServiceNow DevOps to create a change.
# Ensure to update "upstreamStage" accordingly. Example, if you have 3 stages Test, Change and Deploy in your pipeline, then you must update as "upstreamStage": "<+pipeline.stages.Test.nodeExecutionId>". Note that if your change stage is the first stage, you can remove this line.
sndevopscli create change -ctx \
"{
\"pipelineExecutionUrl\":\"<+pipeline.executionUrl>\",
\"stageIdentifier\": \"<+stage.identifier>\",
\"stageNodeExecutionId\": \"<+stage.nodeExecutionId>\",
\"pipelineName\": \"<+pipeline.name>\",
\"upstreamStage\": \"<+pipeline.stages.ServiceNow_DevOps_Security_Scan_Results.nodeExecutionId>\"
}" -p \
"{
\"changeStepDetails\":
{
\"timeout\":3600,
\"interval\":100
},
\"autoCloseChange\":true,
\"attributes\":{
\"chg_model\":\"adffaa9e4370211072b7f6be5bb8f2ed\",
\"short_description\":\"Software Deployment\",
\"description\":\"Automated Software Deployment.\",
\"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\"
}
}"
shell: Sh
infrastructure:
type: KubernetesDirect
spec:
connectorRef: KUBE_CONNECTOR # harness kubernates connector
namespace: harness-delegate-ng
resources:
limits:
cpu: "0.5"
memory: 500Mi
annotations: {}
labels: {}
containerSecurityContext:
capabilities:
drop: []
add: []
nodeSelector: {}
reports:
type: JUnit
spec:
paths: []
outputVariables: []
envVariables: {}
timeout: 1h
- step:
type: ShellScript
name: ShellScript_1
identifier: ShellScript_1
spec:
shell: Bash
executionTarget: {}
source:
type: Inline
spec:
script: echo "Deploying.."
environmentVariables: []
outputVariables: []
timeout: 10m
rollbackSteps: []
tags: {}
failureStrategies:
- onFailure:
errors:
- AllErrors
action:
type: StageRollback
properties:
ci:
codebase:
connectorRef: CONNECTOR
repoName: REPO_NAME
build: <+input>
sparseCheckout: []
notificationRules:
- name: devopsbugbashwp5
identifier: devopsbugbashwp5
pipelineEvents:
- type: AllEvents
notificationMethod:
type: Webhook
spec:
webhookUrl: https://{instance_url}/api/sn_devops/v2/devops/tool/orchestration?toolId={tool sys id}&projectId={project sys id}&ni.nolog.token={token}
enabled: trueHinweis:
Wenn Sie die Sonar-Scan-Ergebnisse und Security Scan-Ergebnisse in derselben Phase hinzufügen möchten, können Sie für beide anwenderdefinierten Aktionen unterschiedliche Schrittnamen verwenden, indem Sie ihren Standardwert in aktualisieren Sonar_STEP_NAMES Und Security_STEP_NAMES Felder in der Tabelle „sn_devops_Tool_Integration_Configuration“.