Runbook mit Visual Designer entwerfen
Mit dem visuellen Designer können Sie benutzerdefinierte Runbooks in Fleet Application Management entwerfen und erstellen. Der Designer bietet eine Drag-Oberfläche mit einer Option zum Hinzufügen von Code, sodass Sie Runbooks einfacher erstellen und bearbeiten können. Runbook kann in YAML oder JSON geschrieben werden. Sie können jedoch ein Runbook erstellen, ohne es mit dem visuellen Designer in nativer JSON oder YAML erstellen zu müssen.
Mit dem visuellen Designer können Sie folgende Aufgaben ausführen:
- Entwerfen Sie ein Runbook mit den Runbook-Komponenten.
- Optimieren Sie die Runbook-Ausführung.
- Konfigurieren Sie bedingte Anweisungen mit dem Condition Builder.
- Konfigurieren Sie bedingte Aufgabenausführungen basierend auf Produktkomponenten, Eingabe- und Ausgabevariablen oder beidem.
- Konfigurieren Sie die Fehlerbehandlung.
- Illustrieren Sie Runbooks von Fleet Application Management.
- Klonen Sie illustrierte Runbooks, um benutzerdefinierte Runbooks zu erstellen, in denen Sie Ihren Code im Quell- oder Designermodus hinzufügen.
Beim Erstellen eines Runbooks validiert der visuelle Designer Ihre Arbeit und generiert automatisch Code. Sie können den generierten Code prüfen oder für die lokale Entwicklung exportieren. Nachdem Sie das Runbook erstellt haben, können Sie es speichern, veröffentlichen und die Ergebnisse in der Konsole prüfen.
- Der Bereich Aktionen auf der rechten Seite enthält die Registerkarten Komponenten und Eigenschaften.
- Die Leinwand in der Mitte ist ein Platzhalter, in dem Sie das Runbook entwerfen. Sie können die Komponenten aus dem Aktionsbereich wie parallele oder rollierende Ressourcengruppen ziehen und Aufgaben in diese Gruppen ziehen. Sie können die Reihenfolge der Komponenten auf der Leinwand ändern, indem Sie sie in der Reihenfolge platzieren, in der die Aufgaben ausgeführt werden sollen, oder Aktionen auswählen, um Eigenschaften zu konfigurieren oder Fehler zu behandeln.
Die Leinwand enthält außerdem das Bearbeitungssymbol neben jeder Aufgabenkomponente, um die Runbook-Aufgabe anzuzeigen und zu ändern.
Um den automatisch generierten YAML- oder JSON-Code für das Runbook anzuzeigen, während Sie den visuellen Designer verwenden, wählen Sie Codeansicht auf der Leinwand aus. Wenn Sie die YAML oder JSON aktualisieren, werden die Änderungen automatisch im Designer-Modus generiert.
Aktionsbereich
Im Aktionsbereich können Sie Komponenten auswählen, die in den Arbeitsbereich auf der Leinwand gezogen werden sollen. Der Bereich enthält die folgenden Elemente:
Registerkarte "Komponenten"
Um eine Aufgabe hinzuzufügen, müssen Sie zuerst eine parallele oder rollierende Ressourcengruppe hinzufügen. Eine Aufgabe muss in einer Gruppe enthalten sein. Weitere Informationen zur Verwendung von Gruppentypen finden Sie unter Runbook erstellen.
- Neue Aufgabe: Mit dieser Schaltfläche können Sie Aufgaben für ein Runbook erstellen. Sie können jetzt eine Aufgabe hinzufügen, die ein Skript ausführen kann, indem Sie den Aktionstyp als Skript angeben.
- Parallele Aufgabengruppe: Alle Aufgaben, die Teil einer parallelen Aufgabengruppe sind, werden parallel auf einer Ressource (Compute- und Datenbankressourcen) ausgeführt, die Teil einer Flotte sind.
Beispiel: Wenn eine Flotte über zwei Ressourcen und zwei Aufgaben (task1 und task2) verfügt, die Teil der parallelen Aufgabengruppe sind, werden task1 und task2 parallel auf resource1 und resource2 ausgeführt.
- Parallele Ressourcengruppe: Alle Aufgaben, die Teil einer parallelen Ressourcengruppe sind, werden parallel über Ressourcen (Compute- und Datenbankressourcen) ausgeführt, die Teil einer Flotte sind. Innerhalb einer Ressource werden die Aufgaben, die Teil einer parallelen Ressourcengruppe sind, sequenziell ausgeführt.
Beispiel: Wenn eine Flotte über zwei Ressourcen und zwei Aufgaben (task1 und task2) verfügt, die Teil der parallelen Ressourcengruppe sind, werden task1 und task2 sequenziell auf resource1 und resource2 ausgeführt, und die Ausführung auf resource1 und resource2 erfolgt parallel.
- Rollierende Ressourcengruppe: Alle Aufgaben, die Teil einer rollierenden Ressourcengruppe sind, werden nacheinander über Ressourcen (Compute- und Datenbankressourcen) ausgeführt, die Teil einer Flotte sind. Innerhalb einer Ressource werden die Aufgaben, die Teil einer rollierenden Ressourcengruppe sind, nacheinander ausgeführt.
Beispiel: Wenn eine Flotte über zwei Ressourcen und zwei Aufgaben (task1 und task2) verfügt, die Teil der rollierenden Ressourcengruppe sind, werden task1 und task2 sequenziell auf resource1 ausgeführt. Nachdem die resource1-Aufgaben abgeschlossen sind, werden task1 und task2 sequenziell auf resource2 ausgeführt.
Registerkarte "Eigenschaften"
Die Registerkarte Eigenschaften enthält Einstellungen zur Steuerung der bedingten Anweisungen und zur Konfiguration der Fehlerbehandlung der Komponenten, die Sie der Leinwand hinzufügen. Nachdem Sie eine Komponente zum Arbeitsbereich auf der Leinwand unter Aufgaben oder Rollback-Aufgaben hinzugefügt haben, konfigurieren Sie sie entsprechend Ihrem Anwendungsfall. Wählen Sie das Symbol "Eigenschaften" (
) der Komponente aus, um ihre Eigenschaften und Optionen zu konfigurieren. Sie können den YAML- oder JSON-Code auch anzeigen, indem Sie Codeansicht auswählen. Die Eigenschaften sind für ein Runbook, Gruppen und Aufgaben verfügbar.
Runbook-Eigenschaften
Die folgenden beiden Eigenschaften für ein Runbook:
- Bei Ausfall von Aufgaben: Die Option, die Sie für diese Eigenschaft auswählen, ist der Standardwert für alle Gruppen und Aufgaben in einem Runbook.
- Ausführen am: Die ausgewählte Option beschreibt, wo und wie Aufgaben ausgeführt werden. Sie kann geplante Instanzen, selbst gehostete Umgebungen oder Instanzen umfassen, die basierend auf den Ergebnissen vorheriger Aufgaben ausgewählt wurden. Im Folgenden sind die Untereigenschaften von Run on aufgeführt:
- Durch Zeitplan angegebene Instanzen: Diese Eigenschaft wird für die bedingte Ausführung eines Runbooks auf einem Ziel verwendet, wenn die Bedingung "true" ist. Es eignet sich am besten für die Verwaltung von Produkt-Stack-Workflows in einem Runbook.
- Selbst gehostete Instanz: Mit dieser Eigenschaft können Sie eine selbst gehostete Instanz für Aufgaben nach dem Provisioning suchen und auswählen
- Durch vorherige Aufgabe angegebene Instanz: Diese Eigenschaft gibt an, dass die Ausführung einer Aufgabe vom Abschluss einer vorherigen Aufgabe abhängt.
Gruppeneigenschaften
Die folgenden fünf Eigenschaften einer Gruppe:
- Bei Fehler: Die Option, die Sie für diese Eigenschaft auswählen, bestimmt die nächste Gruppe von Aktionen, wenn eine der Aufgaben einer Gruppe nicht erfolgreich verläuft. Die Ausführung des Runbooks auf dem Ziel wird fortgesetzt, wenn Sie Weiter auswählen, die Ausführung des Produkt-Runbooks auf dem Ziel gestoppt wird und die Ausführung des Produkt-Stack-Runbooks in der Aktionsgruppe gestoppt wird, wenn Sie Abbrechen auswählen. Die Ausführung des Runbooks wird in den Rollback-Schritt verschoben, wenn Sie Rollback auswählen. Je nach Rollback-Geltungsbereich kann sich die Rollback-Aktion auf Ziel- oder Aktionsgruppenebene befinden.
- Voraussetzung: Gibt die Bedingung an, die Eingabevariablen der aktuellen Aufgabe und Ausgabevariablen aller vorherigen Aufgaben verwendet. Eine Aufgabe wird nur dann auf dem Ziel ausgeführt, wenn die Bedingung als wahr ausgewertet wird.
- Ausführen am: Gibt die Bedingung mit dem Zielproduktnamen (für Product Stack Runbook), den Produkteigenschaften und dem Komponentennamen sowie den Komponenteneigenschaften eines Ziels an. Eine Aufgabe wird nur auf dem Ziel ausgeführt, wenn die Bedingung als wahr ausgewertet wird.
Beispiel: Um eine Aufgabe im Runbook des Oracle WebLogic Server- und des Java-Patching-Produktstacks nur auf dem Oracle WebLogic Server-Ziel auszuführen, wenn der Eigenschaftswert java_version
1.8.0_391lautet, und wenn die Komponente ADMIN_SERVER verfügbar ist, geben Sie die folgende Bedingung ein.target.product.name == "Oracle Weblogic Server" AND target.product.properties.java_home == "1.8.0_391" AND target.product.components.ADMIN_SERVER.properties.Server == "AdminServer" - Ausführung unterbrechen: Eine Option, mit der die Ausführung des Runbooks gestoppt wird, bis Sie eingreifen oder die festgelegte Dauer abgelaufen ist. Die Unterbrechung erfolgt vor der Ausführung einer Aufgabe.
- Benachrichtigung: Benachrichtigt Sie über den OCI-Benachrichtigungsservice über den Aufgabenstatus.
Aufgabeneigenschaften
Aufgaben enthalten eine zusätzliche Eigenschaft im Vergleich zu einer Gruppe. Die Immobilie wird wie folgt beschrieben:
Zuordnung von Ausgabevariablen: Für den Aufgabentyp Skript ausführen wird die Ausgabe der Skriptlogs geparst, um den Wert der Eingabevariable mit einer Musterübereinstimmung von $$VARIABLE=VALUE$$ auszuwerten.
- Aktivieren Sie das Kontrollkästchen "Ausgabevariable", und fügen Sie eine Ausgabevariable hinzu. Die Ausführung des Flottenanwendungsmanagementskripts stellt sicher, dass die Ausgabevariable aufgefüllt ist.
- Aktivieren Sie in der nächsten Aufgabe das Kontrollkästchen für die Eingabevariable, und fügen Sie eine Eingabevariable hinzu.
- Ordnen Sie den Namen der Eingabevariablen mit Ausgabevariablenzuordnung dem Namen der vorherigen Aufgabenausgabevariablen zu.
Das Skript "Flottenanwendungsverwaltung" parst jetzt die Ausgabelogs, um ein Muster wie $$VARIABLE=VALUE$$ zu identifizieren.
Library-Register
Auf der Registerkarte Bibliothek der Aufgaben finden Sie eine Liste der einsatzbereiten wiederverwendbaren Aufgaben, die in Fleet Application Management vorhanden oder von Ihnen erstellt wurden. Sie können das Ziehpunktsymbol (
) in der rechten Ecke einer Aufgabe verwenden, um es in den Arbeitsbereich des Runbooks auf der Leinwand zu ziehen. In der Bibliothek werden nur die relevanten Aufgaben für ein Runbook basierend auf dem Produkt- oder Produktstack und dem BS-Typ angezeigt.
Rollback-Aufgaben
Um eine definierte Aufgabe zurückzusetzen, wenn sie nicht erfolgreich ist, können Sie eine Gruppe hinzufügen und dann die Aufgaben hinzufügen, die im Platzhalter Rollback-Aufgaben im Arbeitsbereich der Leinwand zurückgesetzt werden sollen. Um ein Rollback durchzuführen, stellen Sie sicher, dass Sie die Aufgabeneigenschaft Bei Fehler unter Aufgaben als Rollback für die jeweilige Aufgabe auswählen.
Sie können das Rollback auf eine Ziel- oder Aktionsgruppenebene begrenzen. Dieser Geltungsbereich bedeutet, dass Fleet Application Management die Rollback-Aufgaben auf einem bestimmten Ziel oder auf allen Zielgruppen ausführt. Die Rollback-Tasks werden auf dem Ziel ausgeführt, das nicht erfolgreich verläuft, wenn Sie einen Geltungsbereich für ein Ziel definieren, während die Rollback-Tasks auf allen Zielgruppen ausgeführt werden, wenn Sie einen Geltungsbereich für eine Aktionsgruppe definieren.
Leinwand
Nachdem Sie eine Aktion festgelegt haben, die dem visuellen Designer hinzugefügt werden soll, ziehen Sie eine Komponente in den Arbeitsbereich der Leinwand. Um die Reihenfolge der Komponenten zu ändern, verwenden Sie das Ziehpunktsymbol () in der rechten Ecke einer Komponente, um sie an eine andere Stelle im Arbeitsbereich der Arbeitsmappe zu ziehen. Diese neue Aktion wird dem Arbeitsbereich hinzugefügt, und der zugehörige Code wird automatisch generiert.
Tastaturbefehle für die Navigation
| Tastenkombination | Maßnahme |
|---|---|
| Registerkarte | Navigieren Sie zum nächsten Runbook-Element. |
| Shift+Tab | Navigieren Sie zum vorherigen Runbook-Element. |
| Pfeiltasten | Verschieben Sie eine Komponente danach auf der Leinwand. Beispiele:
|
| Leertaste oder Eingabe/Rückgabe | Wählen Sie auf der Registerkarte Komponenten oder Eigenschaften eine Komponente oder ein Runbook-Element aus. |
| ESC | Brechen Sie das Verschieben einer Komponente auf die Leinwand oder eine Aktion ab, bevor sie ausgelöst wird. |
| Leertaste oder Eingabetaste | Lösen Sie eine entsprechende Aktivität aus, wenn der Fokus auf einer der Komponenten, Eigenschaften oder Runbook-Elemente liegt. Beispiele:
|