Runbook erstellen

Erstellen Sie mit dem visuellen Designer ein benutzerdefiniertes Runbook in Fleet Application Management.

Fleet Application Management stellt mehrere Runbooks mit vordefinierten Schritten bereit, mit denen Sie allgemeine Lebenszyklusmanagementaufgaben ausführen können, wie Health Checks vor der Ausführung oder Oracle HTTP-Server-Discovery. Diese Runbooks sind in der Runbooks-Bibliothek verfügbar. Sie können auch Ihre benutzerdefinierten Runbooks erstellen und für alle Benutzer veröffentlichen.

Wählen Sie auf der Listenseite Runbooks die Option Runbook erstellen aus. Wenn Sie Hilfe beim Suchen der Listenseite benötigen, finden Sie weitere Informationen unter Runbooks auflisten.

Das Erstellen eines Runbooks besteht aus den folgenden Seiten:
Führen Sie die folgenden Workflows nacheinander aus. Sie können zu einer vorherigen Seite zurückkehren, indem Sie Zurück auswählen.
1. Basisinformationen
Auf der Seite Basisinformationen geben Sie die grundlegenden Informationen für das Runbook an.

Geben Sie folgende Informationen ein:
- Name: Geben Sie einen benutzerfreundlichen Namen für das Runbook ein. Der Name muss nicht eindeutig sein, kann jedoch in der Konsole nicht geändert werden. Er kann jedoch mit der API geändert werden. Geben Sie dabei keine vertraulichen Informationen ein.
- Beschreibung: Geben Sie eine geeignete Beschreibung für das Runbook ein.
- Erstellen in Compartment: Wählen Sie das Compartment aus, in welchem Sie die Runbook erstellen möchten.
- Compartment für Lebenszyklusvorgänge: Wählen Sie ein Compartment aus, in dem der spezifische Lebenszyklusvorgang vorhanden ist. Weitere Informationen zu verschiedenen Lebenszyklusvorgängen finden Sie unter Lebenszyklusvorgang in Fleet Application Management.
- Lebenszyklusvorgang: Wählen Sie einen Lebenszyklusvorgang aus, z.B. Patch, Discovery, Provisioning oder benutzerdefiniert.
- Geben Sie für Patch- oder Discovery-Lebenszyklusvorgänge die folgenden Informationen ein:
  
  Produkt-/Produktstack-Compartment: Wählen Sie das Compartment aus, in dem sich das Produkt oder der Produktstack befindet.
  
  Produkt-/Produktstack: Wählen Sie ein Produkt oder einen Produktstack aus, zu dem die Aufgabe aus dem Compartment gehört.
- BS-Typ: Wählen Sie eine unterstützte Plattform aus den Optionen aus, auf denen das Runbook ausgeführt wird.
- Geschätzte Zeit (Stunden): Wählen Sie die geschätzte Zeit in Stunden aus, um die Runbook-Ausführung abzuschließen.
- Als Standard-Runbook festlegen: Aktivieren Sie den Umschalter, damit Fleet Application Management dieses Runbook als Standard-Runbook zur Ausführung von Lebenszyklusvorgängen verwenden kann.
  
  Hinweis
  
  Sie können nur ein Runbook für einen bestimmten Lebenszyklusvorgang und eine Kombination aus Produkt oder Produkt-Stack als Standard-Runbook festlegen. Fleet Application Management verwendet das standardmäßige Discovery Runbook eines Produkts oder Produktstacks, um den Softwarebestand des Produkts zu ermitteln, und das standardmäßige Patching Runbook, um während der Zeitplanerstellung und der Compliancefixierungsaufgaben automatisch ein Runbook auszuwählen.
- Dieses Runbook benötigt SUDO-Zugriff: Aktivieren Sie den Umschalter, wenn der BS-Typ "Oracle Linux" lautet, um Patches für die auf Compute-Instanzen ausgeführte Software zu ermitteln und einzuspielen.
  Der sudo-Zugriff ist erforderlich, wenn der Produktsupport für Oracle WebLogic Server, Oracle HTTP Server (OHS) und Oracle Java erforderlich ist, die nicht OCI-spezifisch sind.
  Hinweis
  
  Wenn für das Runbook der Zugriff sudo aktiviert ist, führt das Flottenanwendungsmanagement-Plug-in die Aufgaben mit der Berechtigung sudo aus. Das Fleet Application Management-Plug-in verwendet eine integrierte sudo-Berechtigung, die jedoch vollständig über die Runbook-Eigenschaft isSudoAccessNeeded gesteuert wird. Siehe Referenz zu Runbook.
Wählen Sie Weiter aus, um mit dem nächsten Schritt fortzufahren.
2. Optimieren (Runbook entwerfen)
Auf der Seite Optimierung (Runbook entwerfen) entwerfen Sie einen Runbook-Workflow mit dem visuellen Designer oder Runbook-Code.

Mit dem visuellen Designer können Sie eine Aktion aus dem Bereich Aktionen in die Leinwand ziehen und dort platzieren, wo sie im Workflow Ihres Arbeitsmappen angezeigt werden soll. Sie können Aktionen in Ihrem Workflow auch neu anordnen, indem Sie sie an eine andere Position ziehen.
Wählen Sie eine der folgenden Optionen:

Designansicht: Verwenden Sie den visuellen Designer, indem Sie die Komponenten ziehen und konfigurieren. Fahren Sie mit Schritt 2 fort.

Codeansicht: Laden Sie den Runbook-Code in eine YAML- oder JSON-Datei hoch. Zu Schritt 3 wechseln.

Wenn Sie Ansicht entwerfen für die Runbook-Erstellung ausgewählt haben, führen Sie die folgenden Schritte aus:

Wichtig

Um eine Aufgabe hinzuzufügen, müssen Sie zuerst eine parallele oder rollierende Ressourcengruppe hinzufügen. Eine Aufgabe muss sich innerhalb einer Gruppe befinden. Weitere Informationen zur Verwendung des visuellen Designers finden Sie unter Runbook mit Visual Designer entwerfen.

Wählen Sie im Aktionsbereich auf der Registerkarte Komponenten eine parallele Ressourcengruppe oder eine rollierende Ressourcengruppe aus, und ziehen Sie sie auf die Leinwand. Fügen Sie beliebig viele Gruppen hinzu.

Für die parallele Ausführung von Runbook-Aufgaben über Ressourcen hinweg wählen Sie eine parallele Gruppe aus. Eine parallele Ressourcengruppe ist ein Platzhalter für eine oder mehrere darin enthaltene Aufgaben oder eine andere parallele Aufgabengruppe, die mehrere Aufgaben für eine Zielressource parallel ausführt. Für jede Aufgabe, die einer parallelen Ressourcengruppe hinzugefügt wird, wird die Aufgabenliste nacheinander für eine bestimmte Ressource ausgeführt, jedoch gleichzeitig für eine Ressourcenliste.

Wählen Sie für die sequenzielle Ausführung von Runbook-Aufgaben eine rollende Ressourcengruppe aus. Eine rollierende Ressourcengruppe ist ein Platzhalter für eine oder mehrere Aufgaben, bei denen die Aufgabenliste nacheinander für eine bestimmte Ressource ausgeführt wird. Nachdem die Aufgaben in der Ressource erfolgreich ausgeführt wurden, wird die nächste Aufgabe auf einer anderen Ressource ausgeführt.

Tipp

Sie können Komponenten neu anordnen, indem Sie das Ziehpunktsymbol () in der rechten Ecke einer Komponente verwenden und sie an eine andere Position im Arbeitsbereich der Arbeitsmappe ziehen. Nachdem Sie eine Komponente auf der Leinwand platziert haben, wird ihr Code automatisch generiert und dem Runbook-Code hinzugefügt.

Wählen Sie eine neue Aufgabe aus, und ziehen Sie sie in eine hinzugefügte Ressourcengruppe. Geben Sie auf der Seite Aufgabe erstellen Details ein. Anweisungen finden Sie in den Schritten 4 bis 17 unter Aufgabe erstellen mit der Konsole. Sie können eine vordefinierte Aufgabe auch hinzufügen, indem Sie sie in eine Ressourcengruppe ziehen.

Die Aufgaben, die Sie im Runbook erstellen, sind lokal im Runbook und können nicht von anderen Runbooks wiederverwendet werden.

Die Aufgabenbibliothek enthält eine Liste der wiederverwendbaren Aufgaben, die vorhanden oder von Ihnen erstellt wurden. Sie können das Ziehpunktsymbol () in der rechten Ecke einer Aufgabe verwenden, um es in die Ressourcengruppe zu ziehen.
Tipp

Sie können Runbook-Aufgaben nach Bedarf erstellen und später einem oder mehreren Runbooks hinzufügen.

Um eine Kopie der Aufgabe in der Aufgabenbibliothek zu erstellen, wählen Sie Kopie dieser Aufgabe in Bibliothek erstellen. Diese Aufgabe ist dann Teil des Runbooks und der Task-Library. Sie können die Bibliotheksaufgabe jedoch unabhängig von der Runbook-Aufgabe wiederverwenden und aktualisieren.

Um die Eigenschaften einer Aufgabe zu aktualisieren, wählen Sie das Bearbeitungssymbol neben der Aufgabe aus, und aktualisieren Sie dann die Feldwerte auf der Seite Aufgabe bearbeiten.

Nachdem Sie die erforderlichen Komponenten zum Runbook hinzugefügt haben, wählen Sie das Symbol "Eigenschaften" () der Komponente aus, um sie mit der Registerkarte Eigenschaften zu konfigurieren.

Geben Sie einen eindeutigen Schrittnamen basierend auf seinem Zweck ein. Geben Sie dabei keine vertraulichen Informationen ein.

Wählen Sie eine der folgenden Aktionen in der Liste Bei Fehler aus, um zu konfigurieren, wie die Automatisierung Fehler im Workflow des Runbooks verarbeiten kann:

Hinweis

Wenn eine Runbook-Komponente einen Fehler meldet, stoppt die Automatisierung des Flottenanwendungsmanagements standardmäßig den Workflow des Runbook vollständig. Der Grund dafür ist, dass der Standardwert für die Eigenschaft Bei Fehler für alle Komponenten Abbrechen ist.

Abbrechen: Stoppen Sie den Runbook-Workflow vollständig, wenn die Komponentenausführung nicht erfolgreich ist. Diese Aktion ist standardmäßig festgelegt.

Fortfahren: Fahren Sie mit dem nächsten Schritt im Runbook-Workflow fort, wenn die Komponentenausführung nicht erfolgreich verläuft.

Rollback: Machen Sie die Änderung rückgängig, und kehren Sie zu der Ebene zurück, auf der die Runbook-Komponente ursprünglich war.
Um ein Rollback durchzuführen, stellen Sie sicher, dass Sie die Eigenschaft Bei Fehler als Rollback auswählen. Sie können die Rollback-Funktion auf Ziel- oder Gruppenebene (Aktionsgruppe) angeben. Um ein Rollback auf Zielebene durchzuführen, wählen Sie Bei Ausfall von Aufgaben aus, oder wählen Sie Bei Ausfall von Rollback-Aufgaben aus, um ein Rollback auf Gruppenebene durchzuführen.

Um bedingte Anweisungen für jede Runbook-Komponente mit der Option Bedingung zu erstellen,
Geben Sie eine Variable in das Bedingungsfeld ein, wählen Sie einen der arithmetischen Operatoren wie AND, NOT oder andere aus, und geben Sie einen Wert für die Bedingung ein. Im Folgenden finden Sie ein Beispiel für eine bedingte Anweisung:
Wenn die Variable backuptype für eine Aufgabe für die folgende Bedingung dem Wert hot entspricht, wird die Aufgabe ausgeführt, oder der Bedingungsbuilder überspringt und fährt mit der nächsten Aufgabe fort.
backuptype=hot

Konfigurieren Sie Ausführen am, um eine der folgenden Optionen zum Ausführen einer Aufgabe auszuwählen:

Nach Zeitplan angegebene Instanzen: Um die Ausführung einer Aufgabe nur für bestimmte Komponenten zuzulassen, die auf das Produkt (wie in den Produktmetadaten definiert) in der Ressource anwendbar sind, wählen Sie Instanzen filtern aus. Anweisungen zum Hinzufügen von Filterbedingungen finden Sie in Unterschritt i.

Selbst gehostete Instanz: Um bei Bedarf nach der Provisioning-Aktivität zu prüfen, wählen Sie eine geeignete selbst gehostete Instanz aus, die Sie unter Metadatenmanagement im Abschnitt Administration erstellt haben.
Hinweis

Durch die Auswahl einer Instanz wird sichergestellt, dass die Aufgabe nur auf diesem Host (Instanz) ausgeführt wird.
Beispiel: Es können zwei Aufgaben vorhanden sein, bei denen der Aktionstyp der ersten Aufgabe Terraform ausführen lautet, mit dem die Ressourcen bereitgestellt werden. Die zweite Aufgabe kann den Aktionstyp Skript ausführen aufweisen, wobei das Skript die selbst gehostete Instanz (zentraler Host) enthält, die prüft, ob die Ressourcen bereitgestellt und ausgeführt werden.

Wichtig

Stellen Sie sicher, dass Sie das Fleet Application Management-Plug-in auf Ihrer selbst gehosteten Instanz und der zugehörigen Instanz aktivieren. Dieser Schritt stellt sicher, dass Fleet Application Management diese Instanzen für Lebenszyklusvorgänge effektiv berücksichtigen kann.

Durch vorherige Aufgabe angegebene Instanz: So prüfen Sie, ob bereitgestellte Ressourcen erstellt werden und ausgeführt werden, wenn Sie keinen zentralen Host konfigurieren.
Beispielsweise können zwei Aufgaben die folgenden Vorgänge ausführen:

Erstellen Sie eine erste Aufgabe mit dem Aktionstyp Terraform ausführen, die Compute-Instanzen bereitstellt und die OCID der bereitgestellten Ressourcen als Ausgabevariable zurückgibt.

Erstellen Sie eine zweite Aufgabe mit dem Aktionstyp Skript ausführen.

Wählen Sie Ausgabevariable aus vorheriger Aufgabe aus, um die Aufgabenvariablen anzugeben.

Geben Sie die Ressourcen-OCID ein, die der Unterschritt i zurückgibt, oder einen optionalen Ressourcentyp. Fügen Sie weitere Hostinformationen hinzu, wie sie von der ersten Aufgabe erstellt wurden. Die OCIDs oder Ressourcentypen dienen als Eingabe für die zweite Aufgabe.
Tipp

Die Hostinformationen können als JSON-Datei mit Ressourcen-OCIDs angegeben werden, die als Array beschrieben werden.

Fleet Application Management parst jetzt die Ausgabevariablen und führt das Skript für die Ressourcen aus.

Wenn Sie in Unterschritt h die Option Nach Zeitplan angegebene Instanzen ausgewählt haben, wählen Sie Instanzen aus, um das Dialogfeld Instanzen filtern zu öffnen.

Wählen Sie Produkt- oder Komponenteneigenschaften aus dem Feld auf der linken Seite aus, um sie dem Filterfeld auf der rechten Seite hinzuzufügen.

Wählen Sie einen der arithmetischen Operatoren, wie AND, NOT oder andere.

Geben Sie einen Wert für die Bedingung im Feld "Bedingung" ein.
Hinweis

Wenn Sie Produkteigenschaften oder Komponenteneigenschaften auswählen, wird das Filterfeld mit einer relevanten Grammatikbedingung aufgefüllt.
Beispiel für die Grammatikbedingung Run on:
target.product.name = <product_name> target.product.properties.<property_name> = <property_value> target.product.components.has(<component_name>) target.product.components.<component_name>.properties.<property_name> = <property_value>
Hinweis

Die Bedingungen, die auf Eigenschaften basieren, hängen von Ihrem Verständnis der Produkt-Discovery ab.

Fügen Sie nach Bedarf weitere Filterinstanzen hinzu. Diese Instanzen werden der nächsten Zeile im Filterfeld hinzugefügt.

Schalten Sie die Option Ausführung unterbrechen ein, um die Ausführung von Aufgaben für eine bestimmte Zeit anzuhalten oder zu verzögern, bis bestimmte Bedingungen erfüllt sind. Beispiel: Sie können die Ausführung einer Aufgabe auf unbestimmte Zeit unterbrechen, bis Sie die Aufgabe fortsetzen, oder für eine bestimmte Zeit, die Sie auswählen.

Um benachrichtigt zu werden, wenn sich der Aufgabenstatus ändert, aktivieren Sie den Umschalter Benachrichtigung, und aktivieren Sie dann das Kontrollkästchen für die Aktivität der Aufgabe, für die Sie benachrichtigt werden möchten, z.B. bei einem Aufgabenfehler, bei einer Unterbrechung oder wenn die Aufgabe erfolgreich ist.

Konfigurieren Sie die Eigenschaften der hinzugefügten Aufgaben. Eine Feldbeschreibung der Aufgabeneigenschaften finden Sie in den Schritten 4 bis 17 unter Aufgabe erstellen mit der Konsole.

Wenn Sie in Schritt 1 Codeansicht für die Runbook-Erstellung ausgewählt haben, wählen Sie aus, ob Sie JSON oder YAML verwenden, und wählen Sie Runbook-Code hochladen aus, um die entsprechende Datei hinzuzufügen.
Wählen Sie Weiter aus, um mit dem nächsten Schritt fortzufahren.
3. Überprüfen

Prüfen Sie den Inhalt des Runbooks auf der Seite Prüfen. Bearbeiten Sie die Einstellungen, oder kehren sie zu vorherigen Bildschirmen, um Informationen hinzuzufügen.

Wählen Sie Als Entwurf speichern aus, um das Runbook zunächst zu speichern, bis Sie alle Komponenten kennen.
Hinweis

Diese Entwurfsversion des Runbooks ist nicht aktiv, kann nicht verwendet werden und ist als Entwurf markiert.

Um das Runbook verwendbar zu machen, nachdem Sie sich über alle Aufgaben im Klaren sind und die Ausführung optimieren (Ausführungssequenz), wählen Sie auf der Detailseite des Runbooks die Option Aktuelle Version veröffentlichen aus.

Das veröffentlichte Runbook ist für Provisioning, Discovery, Anwendung von Patches oder Rollback verfügbar und hat den Status "Aktiv".
Hinweis

Das Runbook wird mit Version 1 als Erstversion erstellt, und es hat den Status "Aktiv".
Verwenden Sie den Befehl oci fleet-apps-management fleet-apps-management-runbooks runbook create und die erforderlichen Parameter, um ein benutzerdefiniertes Runbook zu erstellen:
oci fleet-apps-management fleet-apps-management-runbooks runbook create --compartment-id <compartment_OCID> --display-name <text> --operation <text> --runbook-version <json_file_or_string> [OPTIONS]
Eine vollständige Liste der Flags und Variablenoptionen für Fleet Application Management-CLI-Befehle finden Sie in der CLI für Fleet Application Management.
Führen Sie den Vorgang CreateRunbook aus, um ein benutzerdefiniertes Runbook zu erstellen.

Oracle Cloud Infrastructure-Dokumentation

Runbook erstellen

1. Basisinformationen

2. Optimieren (Runbook entwerfen)

3. Überprüfen