Verstehen von Commons-Skripten in DevSecOps

In DevSecOps, führen einige Stufen Standard-Skripte aus, wenn sie nicht in der config YAML-Datei angegeben sind. Diese Standardskripte sind Teil einer gemeinsamen Skriptbibliothek, die eine Reihe von wiederverwendbaren Skripten enthält, die als Ausgangspunkt für die Anpassung der Pipelinekonfiguration verwendet werden können.

Commons Skript-Bibliothek

  • Die Commons-Skriptbibliothek ist eine Sammlung von wiederverwendbaren Skripten, die in DevSecOps verwendet werden können.
  • Die Skripte und Funktionen in dieser Commons-Skriptbibliothek können zur Anpassung der Pipeline-Konfiguration an Ihre spezifischen Pipeline-Anforderungen verwendet werden.

Lesen Sie die Dokumentation der Commons-Skriptbibliothek, um mehr über die Commons-Skriptbibliothek und ihre Verwendung zu erfahren.

Anzeigen von Standardskripten

Um das Standard-Skript zu sehen, das in einer Stufe läuft, untersuchen Sie die Protokolle dieser Stufe. Zum Beispiel in der Phase " scan-artifact:

=== Executing custom script for stage 'scan-artifact' ===

The custom script can be viewed using the following link: '<SCRIPT URL>'

You can customize this stage in your pipeline config. For more information, see [Custom scripts](/docs/devsecops?topic=devsecops-cd-devsecops-pipelines-custom-customize).

The script(s) used in this stage can be found at the following location(s):

- path: scan-artifact
  repo: <REPO URL>
  sha: b0fff29d715e0f9a33b3c84e649777cfb9d40738
- path: icr-va
  repo: <REPO URL>
  sha: de693814ba2bd992941b432fc71111efb54e2b27

Using the following defaults for stage "scan-artifact":

scan-artifact:
  image: icr.io/continuous-delivery/pipeline/pipeline-base-image:2.12@sha256:ff4053b0bca784d6d105fee1d008cfb20db206011453071e86b69ca3fde706a4
  dind: false
  abort_on_failure: false
  image_pull_policy: IfNotPresent
  script: |
    #!/bin/sh

    "/opt/commons/scan-artifact/scan.sh"

Diese Nachricht besteht aus drei Teilen:

  1. Die erste Zeile zeigt das genaue Skript URL, das derzeit ausgeführt wird, und verweist auf es auf einer Commit-Ebene.

  2. Der zweite Teil ist eine Liste von Pfaden, Repos und Commit-Hashes, die während des Builds in das Pipeline-Basisimage importiert werden. Sie werden zur Laufzeit nicht aus diesen Repos gezogen. Diese Informationen verbessern die öffentliche Nachvollziehbarkeit dessen, was genau in der Pipeline enthalten ist.

  3. Der dritte Teil ist die Standardkonfiguration, die als config YAML verwendet wird. Sie können dieses YAML-Snippet in Ihre DevSecOps einfügen. Diese Aktion überschreibt die Standardkonfiguration mit Ihrer, verwendet aber weiterhin das Standardskript aus dem Basisbild. Diese Methode ist hilfreich, wenn Sie andere Prüfungen vor den Standardprüfungen durchführen möchten.

Diese Informationen werden angezeigt, um den Adoptierenden zu helfen, das Skript und die Funktion aus der Commons-Skriptbibliothek zu identifizieren, die standardmäßig in Phasen ausgeführt werden. Schließlich können sie die Skripte inspizieren, verstehen, was sie tun, das Skript in ihre Skriptsammlung kopieren und sie an ihre Anwendungsfälle anpassen.

Anpassen mit Commons Scripts Library

Die Commons-Bibliothek kann auch als Quelle für das Kopieren von Code und die Anpassung an bestimmte Randfälle dienen. Verwenden Sie die Bibliothek als Ausgangspunkt für die Erstellung benutzerdefinierter Skripte nach verschiedenen Anforderungen.

Hier erfahren Sie mehr über die Anpassung von Pipelines

Bewährte Verfahren

  • Verwenden Sie die Commons-Bibliothek als Referenz für die Rohrleitungsmechanik.
  • Anpassen von Standardskripten für bestimmte Randfälle.
  • Verwenden Sie das Skript " collect-evidence, um Beweise in benutzerdefinierten Skripten zu sammeln.