Konfigurationsdaten werden validiert und korrigiert

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer
  • Für jeden Change an einer Umgebung können Dutzende oder Hunderte von Regeln (Richtlinien) vorhanden sein, die überprüft werden müssen. CDMErmöglicht Ihnen die automatische Validierung von Konfigurationsdaten, um sicherzustellen, dass Konfigurationsänderungen fehlerfrei und richtlinienkonform sind, bevor die Konfigurationsdaten verbraucht werden.

    Wichtig:
    Ab dem Release Washington DC wird DevOps Config auf den Übergang in den Zustand „Veraltet“ vorbereitet. Es wird ausgeblendet und in neuen Instanzen nicht mehr installiert, aber weiterhin unterstützt. Weitere Informationen finden Sie im Artikel Deprecation Process [KB0867184] (Abkündigungsprozess) in der Now Support Knowledge Base.

    CDM Automatisiert einen Großteil des Validierungsprozesses

    Wenn Teams eine Anwendung bereitstellen, müssen sie normalerweise sicherstellen, dass keine Fehler auf Code- und Konfigurationsebene auftreten und Compliance-Richtlinien eingehalten werden. Für jeden Change an einer Umgebung können Dutzende oder Hunderte von Regeln (Richtlinien) vorhanden sein, die überprüft werden müssen. Ein manueller Validierungsprozess ist fehleranfällig.

    DevOpsStellt Entwicklern, IT-Administratoren, DevOps ConfigIngenieure oder das Team leiten eine Möglichkeit, sicherzustellen, dass Konfigurationsänderungen fehlerfrei und richtlinienkonform sind. Darüber hinaus erhalten Entwickler oder IT-Administratoren nach der Validierung genügend kontextbezogene Informationen, um Probleme zu identifizieren und zu beheben. Dies bedeutet, dass nach dem Commit von Änderungen an Konfigurationsdaten alle relevanten Richtlinien angewendet, Ergebnisse ausgewertet und entsprechende Aktionen ausgelöst werden (z. B. „Bereitstellen“ oder „nicht bereitstellen“).

    Hier ist CDMProzess, der Konfigurationsdaten automatisch validiert, bevor sie verbraucht werden.

    1. Sie erstellen eine Richtlinienversion basierend auf einer vorhandenen Richtlinie und aktivieren und veröffentlichen dann die neue Version.
    2. Sie ordnen die Richtlinie einem bereitstellbaren Element zu Um sicherzustellen, dass die Richtlinie für jeden Snapshot des bereitstellbaren Elements ausgeführt wird, wenn dies angefordert wird (manuelle oder automatisierte Anforderung).
    3. Wenn Sie ein Changeset für das bereitstellbare Element festlegen, muss das System den resultierenden Snapshot validieren. Wählen Sie aus, um die Ausführung der zugeordneten Richtlinien automatisch auszulösen, wenn ein Changeset bestätigt wird Validieren Option beim Commit des Changesets. Sie haben auch die Möglichkeit, den Snapshot manuell zu validieren.

      In beiden Fällen werden die mit statischer Zuordnung und dynamischer Zuordnung zugeordneten Richtlinien ausgeführt.

      • Wenn Sie den automatisierten Prozess für die Integration in Ihre Pipeline konfiguriert haben, geben die Richtlinien die Ergebnisse des Validierungsprozesses in JSON-Dateien an die Pipeline zurück. Die Pipeline entscheidet, ob der Vorgang basierend auf der Validierungsentscheidung fortgesetzt werden soll: Konform, nicht konform.
      • Wenn der Prozess nicht in Ihre Pipeline integriert ist oder wenn die Validierung fehlgeschlagen ist oder nicht abgeschlossen wurde, überprüfen Sie die Validierungsentscheidung und ergreifen die entsprechenden Maßnahmen.

    Verwenden Sie vordefinierte Richtlinien als Modelle für Ihre anwenderdefinierten Richtlinien

    CDM Enthält Richtlinien, die Sie als Modelle für anwenderdefinierte Richtlinien verwenden können, die bestimmte Anforderungen erfüllen. Beachten Sie die folgenden wichtigen Muster in den vordefinierten Richtlinien:
    • Die Richtlinien verwenden alle CdmAbfrage Skripteinbindung zum Abrufen von Konfigurationsdaten.
    • Verwenden CdmAbfrage Mit Geheimnissen, um sicherzustellen, dass alle Daten enthalten sind.
    • Die CdmPolicyUtil Skripteinbindung fügt Warnungen und Fehler hinzu.
    • Wenn alle Richtlinien ausgeführt wurden und ein Fehler in der Ausgabe ausgefüllt wurde, lautet die Entscheidung Nicht_konform .
    • Verwenden Sie den Protokollierer für das Debugging. Entfernen Sie die Protokolle, wenn die Richtlinie zur Veröffentlichung bereit ist.
    • Verwenden Sie Zuordnungseingabeparameter, um dynamische Eingabewerte bereitzustellen.

    Richtlinien für die Validierung von Snapshots

    • Validieren Sie Snapshots, die bereits validiert und veröffentlicht wurden, nicht manuell.
    • Wenn Sie auswählen Validieren Sie Snapshots Oder Validieren und veröffentlichen Sie Snapshots Option beim Commit eines Changesets validiert das System jeden Snapshot automatisch, wenn er zuerst generiert wird.
    • Um die aktuellen Validierungsfehler oder Warnungen für einen Snapshot anzuzeigen, öffnen Sie den Snapshot, und wählen Sie aus Validierungsergebnisse Registerkarte. Details finden Sie unter Zeigen Sie die Ergebnisse der Snapshot-Validierung an.
    • Verwenden Sie die Playground-Funktion für Richtlinientests, um Snapshots erneut zu validieren, während Sie eine Richtlinie entwickeln. Die resultierenden Validierungsergebnisse werden als Testergebnisse gekennzeichnet und wirken sich nicht auf den Betrieb aus.
    • Wenn die erneute Validierung aller Snapshots für ein bereitstellbares Element erforderlich ist, validieren Sie sie erst, nachdem Sie die Richtlinien getestet und veröffentlicht haben.

    Zu vermeidende Praktiken

    • Nicht verwenden GlideRecord Zum Abrufen von Konfigurationsdatensätzen.
    • So zeigen Sie Richtlinienentscheidungen auf der Anwenderoberfläche an: CDMErfordert Warnungs- und Fehlerdaten in einer bestimmten Struktur. Verwenden CdmPolicyUtil Zum Hinzufügen von Warnungen oder Fehlern (nicht manuelles Einfügen). (Verstehen Sie zumindest die Struktur, die CdmPolicyUtil Fügt in Fehler und Warnungen ein.)
    • Versuchen Sie in Richtlinien nicht, Daten abzurufen, die nicht von stammen CDMDaten. Diese Praxis kann zu Problemen beim bereichsübergreifenden Zugriff führen.
    • Schreiben Sie keine Richtlinien „immer konform“ oder „immer nicht konform“.
    • Geben Sie keine Namen oder Werte in Richtlinien fest. Verwenden Sie stattdessen Zuordnungseingabeparameter, um dynamische Eingabewerte bereitzustellen.

    Snapshot-Status

    • Nicht validiert: Dies ist der anfängliche Snapshot-Status, in dem keine Richtlinie für den Snapshot ausgeführt wurde.
    • Angefordert: Der Validierungs-Flow wurde gestartet.
    • In Bearbeitung: Der Validierungs-Flow wird ausgeführt, und Richtlinien werden derzeit ausgeführt.
    • Bestanden: Der Snapshot hat alle Richtlinien bestanden.
    • Fehlgeschlagen: Der Snapshot ist mindestens eine Richtlinie fehlgeschlagen.
    • Ausführungsfehler: Eine Richtlinie konnte nicht bis zum Abschluss ausgeführt werden .

    Beispiel-Flow

    Ein Anwender bestätigt Änderungen an Konfigurationsdaten vor einer Bereitstellung.

    Daten werden anhand aller zugewiesenen Richtlinien validiert.

    Wenn die Validierung fehlschlägt, wird die Bereitstellung gestoppt. Eine Liste von Fehlern, die auf ihren Standort in den Konfigurationsdaten verweisen, wird dem Anwender angezeigt. Verfügbare Aktionen müssen im Kontext der Anwendung selbst und der Umgebung bestimmt werden, in der die Anwendung bereitgestellt wird. Zum Beispiel:
    • Bereitstellung in einer TESTUMGEBUNG unabhängig von der Anzahl der Fehler oder Warnungen zulassen.
    • Stoppen Sie die Bereitstellung in PROD, wenn ein Fehler auftritt.
    • Beenden Sie die Bereitstellung in PROD, wenn eine Warnung vorliegt und die Anwendung kritisch ist.
    • Bereitstellung in PROD unabhängig von der Anzahl der Warnungen zulassen, wenn nicht kritisch.

    Anwender behebt Fehler und Commits von Changes.

    Die Daten werden erneut validiert, und die Ergebnisse sind in Ordnung.

    Ein Snapshot wird erstellt.

    Bereitstellung wird ausgeführt.