Schritte & Variablen
Schritte und Variablen sind die Bausteine jeder Vorlagenversion. Schritte definieren, was getan werden muss, während Variablen eine Parametrisierung ermöglichen, sodass dieselbe Vorlage in verschiedenen Kontexten wiederverwendet werden kann.
Schritthierarchie
Abschnitt betitelt „Schritthierarchie“RAMP-Schritte unterstützen hierarchische Verschachtelung, sodass Sie komplexe Verfahren in logische Gruppen organisieren können.
Struktur
Abschnitt betitelt „Struktur“- Root-Schritte — Schritte der obersten Ebene, die auf der ersten Einrückungsebene erscheinen.
- Untergeordnete Schritte — Schritte, die unter einem übergeordneten Schritt verschachtelt sind und Teilverfahren bilden.
- Unbegrenzte Tiefe — Schritte können beliebig tief verschachtelt werden, wobei 2-3 Ebenen für die Lesbarkeit typisch sind.
Virtuelle Schritte (Gruppen)
Abschnitt betitelt „Virtuelle Schritte (Gruppen)“Ein Schritt, der untergeordnete Schritte enthält, fungiert als virtueller Schritt oder Gruppenüberschrift. Virtuelle Schritte:
- Dienen als organisatorische Container für ihre untergeordneten Schritte.
- Können einen eigenen Titel und Inhalt haben (werden häufig für Anweisungen auf Abschnittsebene verwendet).
- Verfolgen den Abschluss auf Basis des Fortschritts ihrer untergeordneten Schritte.
- Können so konfiguriert werden, dass sie automatisch abgeschlossen werden, wenn alle untergeordneten Schritte fertig sind, oder sie können manuellen Abschluss erfordern.
Ausführungstypen
Abschnitt betitelt „Ausführungstypen“Übergeordnete Schritte definieren, wie ihre untergeordneten Schritte ausgeführt werden:
| Modus | Verhalten |
|---|---|
| Sequenziell | Untergeordnete Schritte müssen in der Reihenfolge ausgeführt werden. Der nächste Schritt ist erst verfügbar, nachdem der vorherige abgeschlossen wurde. |
| Parallel | Alle untergeordneten Schritte sind gleichzeitig verfügbar und können in beliebiger Reihenfolge ausgeführt werden. |
Schrittinhalt
Abschnitt betitelt „Schrittinhalt“Rich-Text-Editor
Abschnitt betitelt „Rich-Text-Editor“Jeder Schritt hat einen Rich-Text-Inhaltsbereich, der von TipTap unterstützt wird. Der Editor unterstützt:
- Textformatierung — Fett, Kursiv, Unterstrichen, Durchgestrichen
- Überschriften — H1 bis H6
- Listen — Geordnete und ungeordnete Listen, Aufgabenlisten
- Code — Inline-Code und umrahmte Codeblöcke mit Syntaxhervorhebung
- Tabellen — Vollständige Tabellenunterstützung mit Spalten-/Zeilenoperationen
- Links — Hyperlinks zu externen Ressourcen
- Blockzitate — Für Callouts und wichtige Hinweise
- Horizontale Trennlinien — Visuelle Trennelemente
Schritttitel
Abschnitt betitelt „Schritttitel“Jeder Schritt hat ein optionales Titelfeld, das im Schrittbaum und in den Ausführungsansichten erscheint. Titel sollten kurz und aussagekräftig sein:
- “Anwendungsdienste stoppen”
- “Datenbankverbindung überprüfen”
- “Konfigurationsdateien bereitstellen”
Schrittnotizen
Abschnitt betitelt „Schrittnotizen“Das Notizen-Feld bietet Platz für interne Dokumentation, die im Editor und in den Schrittausführungs-Detailansichten sichtbar ist, aber nicht in der Hauptausführungsvorschau angezeigt wird. Verwenden Sie Notizen für:
- Implementierungsdetails für den Ausführenden
- Links zu zugehöriger Dokumentation
- Tipps zur Fehlerbehebung
- Kontaktinformationen
Variablen
Abschnitt betitelt „Variablen“Variablen ermöglichen die Parametrisierung von Vorlagen, sodass eine einzelne Vorlage in verschiedenen Umgebungen, auf verschiedenen Servern oder mit verschiedenen Konfigurationen wiederverwendet werden kann.
Variablensyntax
Abschnitt betitelt „Variablensyntax“Referenzieren Sie Variablen im Schrittinhalt mit doppelten geschweiften Klammern:
Connect to server {{ServerName}} on port {{Port}}.Wenn eine Instanz erstellt wird, füllt der Ausführende die tatsächlichen Werte aus (z. B. prod-db-01 und 5432), und der Schrittinhalt zeigt den aufgelösten Text an.
Variablendatentypen
Abschnitt betitelt „Variablendatentypen“| Typ | Beschreibung | Beispiel |
|---|---|---|
| String | Freiformtext | Servername, URL, Beschreibung |
| Number | Numerischer Wert | Portnummer, Timeout |
| Date | Datumswert | Bereitstellungsdatum, Umstellungsfenster |
| Boolean | Wahr/Falsch-Umschalter | Feature-Flag, Probelaufmodus |
| List | Vordefinierte Liste von Optionen | Umgebungs-Dropdown |
| StringList | Durch Trennzeichen getrennte Zeichenkette von Werten | Durch Komma getrennte Servernamen |
Variableneigenschaften
Abschnitt betitelt „Variableneigenschaften“| Eigenschaft | Beschreibung |
|---|---|
| Name | Der Platzhalternamen, der in der {{Name}}-Syntax verwendet wird |
| Beschreibung | Hilfetext, der dem Benutzer beim Ausfüllen des Werts angezeigt wird |
| Datentyp | Der Wertetyp (siehe Tabelle oben) |
| Standardwert | Vorausgefüllter Wert, der überschrieben werden kann |
| Erforderlich | Ob ein Wert angegeben werden muss, bevor die Instanz fortfahren kann |
| Validierungsmuster | Ein Regex-Muster zur Validierung der Benutzereingabe |
| Trennzeichen | Für den StringList-Typ das Zeichen zum Aufteilen von Werten (Standard: Komma) |
Iterationsmodi
Abschnitt betitelt „Iterationsmodi“List- und StringList-Variablen unterstützen spezielle Iterationsmodi, die während der Instanzausführung virtuelle Schritte generieren:
| Modus | Verhalten |
|---|---|
| Keine | Variable wird als Einzelwert verwendet. Es werden keine virtuellen Schritte generiert. |
| Parallel | Erstellt einen virtuellen Schritt pro Listenelement. Alle virtuellen Schritte sind für die gleichzeitige Ausführung verfügbar. |
| Sequenziell | Erstellt einen virtuellen Schritt pro Listenelement. Virtuelle Schritte müssen in der Reihenfolge ausgeführt werden. |
| Concat | Verbindet alle Listenwerte mit einem Trennzeichen zu einer einzelnen Zeichenkette. Referenziert mit der {{*variableName}}-Syntax. |
Beispiel: Server-Bereitstellung mit Iteration
Abschnitt betitelt „Beispiel: Server-Bereitstellung mit Iteration“Betrachten Sie einen Vorlagenschritt: “Anwendung auf {{ServerName}} bereitstellen”
Wenn ServerName eine StringList-Variable mit den Werten web01, web02, web03 ist und der Iterationsmodus auf Parallel gesetzt ist, erstellt RAMP während der Instanzausführung drei virtuelle Schritte:
- “Anwendung auf web01 bereitstellen”
- “Anwendung auf web02 bereitstellen”
- “Anwendung auf web03 bereitstellen”
Alle drei können von verschiedenen Teammitgliedern parallel ausgeführt werden.
Multi-Target-Schritte
Abschnitt betitelt „Multi-Target-Schritte“Schritte können mit Zieltypen konfiguriert werden, um mit Variablen zu arbeiten:
| Zieltyp | Beschreibung |
|---|---|
| Keine | Standardschritt, kein Targeting |
| Liste | Schritt zielt auf eine feste Liste von Elementen |
| Variable | Schritt zielt auf Werte einer benannten Variable |
Variablen synchronisieren
Abschnitt betitelt „Variablen synchronisieren“Die Funktion Variablen synchronisieren durchsucht den gesamten Schrittinhalt nach {{VariablenName}}-Mustern und:
- Erstellt Variablen für alle referenzierten Namen, die noch nicht existieren.
- Meldet Variablen, die definiert sind, aber in keinem Schritt referenziert werden.
Dies hilft dabei, Variablendefinitionen konsistent mit dem Schrittinhalt zu halten.
Schritteigenschaften-Referenz
Abschnitt betitelt „Schritteigenschaften-Referenz“Ausführungssteuerung
Abschnitt betitelt „Ausführungssteuerung“| Eigenschaft | Beschreibung | Standard |
|---|---|---|
| Ausführungstyp | Sequenzielle oder parallele Ausführung untergeordneter Schritte | Sequenziell |
| Automatisch abschließen | Übergeordneter Schritt wird automatisch abgeschlossen, wenn alle untergeordneten fertig sind | Ja |
| Geschätzte Dauer | Erwartete Zeit für den Abschluss | Keine |
Überspringen und Nachweise
Abschnitt betitelt „Überspringen und Nachweise“| Eigenschaft | Beschreibung | Standard |
|---|---|---|
| Überspringbar | Ob der Schritt übersprungen werden kann | Nein |
| Überspringen erfordert Kommentar | Wenn überspringbar, ob ein Grund erforderlich ist | Nein |
| Nachweis erforderlich | Ob ein Dateianhang beim Abschluss erforderlich ist | Nein |
Verantwortung
Abschnitt betitelt „Verantwortung“| Eigenschaft | Beschreibung | Standard |
|---|---|---|
| Verantwortungsmodus | Wer ausführen kann: Alle Teammitglieder, Bestimmte Mitglieder oder Nicht zugewiesen | Alle Teammitglieder |
| Verantwortliche Benutzer | Bestimmte Benutzer (wenn Modus “Bestimmte Mitglieder” ist) | Keine |
| Verantwortliche Gruppen | Bestimmte Gruppen (wenn Modus “Bestimmte Mitglieder” ist) | Keine |
| Ansprechpartner | Ein bestimmter Ansprechpartner für Fragen zu diesem Schritt | Keine |
| Erforderliche Rolle | Eine Rollenbezeichnung, die angibt, wer diesen Schritt bearbeiten soll | Keine |
Identitätsverfolgung
Abschnitt betitelt „Identitätsverfolgung“Jeder Schritt hat eine Schrittkennung und eine Schrittversion, die über Vorlagenversionen hinweg bestehen bleiben. Wenn Sie einen neuen Entwurf aus einer veröffentlichten Version erstellen, behält jeder Schritt seine Kennung, sodass RAMP folgendes kann:
- Schrittänderungen über Versionen hinweg für die Vergleichsansicht verfolgen.
- Instanz-Upgrades ermöglichen, die den Ausführungsstatus der Schritte erhalten.
- Genaue Änderungsdiffs in der Historienansicht bereitstellen.
Wiederholbare Schritte
Abschnitt betitelt „Wiederholbare Schritte“Schritte können als Wiederholbar markiert werden, was bedeutet, dass sie während einer Instanz mehrmals ausgeführt werden können. Wenn ein Schritt wiederholbar ist:
- Eine Wiederholungsvariable kann verknüpft werden, um die Anzahl der Wiederholungen zu steuern.
- Der Wiederholungsmodus bestimmt, ob Wiederholungen sequenziell oder parallel ablaufen.
Schrittabhängigkeiten
Abschnitt betitelt „Schrittabhängigkeiten“Schritte können explizite Abhängigkeiten von anderen Schritten haben, die eine Ausführungsreihenfolge über die natürliche Baumhierarchie hinaus erzwingen. Abhängigkeiten werden getrennt von Eltern-Kind-Beziehungen verfolgt und können bei Bedarf auf Instanzebene überschrieben werden.