For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mandanten-Rezepte

Wie man Tenant-Rezepte in VergeOS erstellt und verwendet, um komplette Tenant-Bereitstellungen zu automatisieren, einschließlich Netzwerken, VMs, Einstellungen und benutzerdefinierten Konfigurationsfragen.

Mandanten-Rezepte ermöglichen die Automatisierung der Mandantenbereitstellung. Ein Mandanten-Rezept kann alles enthalten, was zum Erstellen einer vollständig funktionsfähigen neuen Mandanteninstanz benötigt wird, einschließlich: Mandanteneinstellungen, Netzwerkkonfiguration, enthaltene virtuelle Maschinen und Automatisierung für Aufgaben wie das Erstellen zufälliger Passwörter, das Festlegen eindeutiger Hostnamen/Passwörter/Benutzernamen, das Registrieren von DHCP- und DNS-Einträgen, das Senden von Benachrichtigungen und mehr. Diese Seite führt Sie durch den grundlegenden Prozess zum Erstellen und Verwenden von Mandanten-Rezepten.

Vorteile der Verwendung von Mandanten-Rezepten:

  • Schnelle Bereitstellung ganzer Mandanten

  • Konsistenz über Mandantenkonfigurationen hinweg

  • Reduzierter manueller Einrichtungsaufwand, wodurch wiederum die Wahrscheinlichkeit menschlicher Fehler sinkt

  • Goldene Images für Compliance

Ein Mandanten-Rezept erstellen

  1. Erstellen Sie einen Mandanten, der als Basismodell dient. Ein Mandanten-Rezept basiert auf einem Mandanten, der als Ausgangsvorlage dient. Erstellen Sie den Mandanten so, dass er Einstellungen, VMs und Netzwerke enthält, die Teil der generischen Konfiguration sein sollen. Der Mandant muss vor dem Erstellen des Rezepts ausgeschaltet sein.

  1. Navigieren Sie zum Mandanten-Rezepte-Dashboard (Repositories > Mandanten-Rezepte).

  2. Klicken Sie auf Neu im linken Menü.

  3. Mandanten-Rezept konfigurieren Felder:

    • Name: Verwenden Sie einen Namen, der das Rezept ausreichend identifiziert, um Benutzern das Auffinden geeigneter Rezepte zu erleichtern.

    • Beschreibung: (optional) Hier können Sie zusätzliche Informationen zum Rezept speichern. Dies kann ein guter Ort sein, um eine grundlegende Dokumentation über den vorgesehenen Zweck und allgemeine Richtlinien bereitzustellen.

    • Symbol: (optional) Ein Font-Awesome-Symbol kann dem Rezept zugeordnet werden. Symbole können Benutzern helfen, verschiedene Rezepte/Rezepttypen leichter zu identifizieren. Eine Liste verfügbarer Symbole finden Sie unter FontAwesome .

    • Katalog: Wählen Sie einen Katalog aus, in dem das Rezept gespeichert werden soll. Kataloge helfen, Rezepte übersichtlich zu organisieren. Siehe Rezeptorganisation für weitere Informationen über Kataloge.

    • Mandant: Wählen Sie den Mandanten aus, der als Basis für das Rezept dienen soll.

    • Version: Dieses Feld wird bei jeder Änderung des Rezepts automatisch hochgezählt, um Änderungen nachzuverfolgen. Der Standard ist 1.0.0, kann aber geändert werden, wenn Sie die Versionierung mit einer anderen Zahl beginnen möchten.

    Versionsnummerierung

    Eine Versionsnummer von 1.0.0 würde auf 1.0.0-1 und dann auf 1.0.0-2 usw. erhöht. Zusätzlich können Sie die Versionsnummer manuell bearbeiten, um größere Versionsänderungen widerzuspiegeln, z. B. die Version nach erheblichen Rezeptänderungen auf 2.0.0 zu ändern.

    • SSL-Zertifikate beibehalten: Wenn ausgewählt, werden im Basis-Mandanten installierte SSL-Zertifikate in die mit dem Rezept erstellten Mandanteninstanzen kopiert.

    • Versionsabhängigkeiten: (nicht zutreffend für Rezepte, die nur auf dem lokalen System und dessen eigenen Mandanten verwendet werden). Abhängigkeiten können angegeben werden, wenn für das korrekte Funktionieren des Rezepts VergeOS-Funktionen erforderlich sind (um zu verhindern, dass ein Remotesystem ein Rezept verwendet, das es nicht verarbeiten kann).

  4. Klicken Sie auf Absenden um das Rezept zu speichern. Das Mandanten-Rezept-Dashboard zeigt an, wo Rezeptfragen angepasst werden können.

Fragen

Fragen bieten Anpassungswerte für einzelne Mandanten, die mit einem Rezept erstellt werden, indem Eingaben des Benutzers erfasst oder mit der VergeOS-Datenbank interagiert wird. Ein Mandanten-Rezept enthält automatisch Systemfragen. Einige dieser Fragen sind standardmäßig deaktiviert und müssen aktiviert werden, wenn Sie sie verwenden möchten.

(Optional) Standardmäßig deaktivierte Frage(n) aktivieren: Klicken Sie auf Fragen (linkes Menü oder Dashboard-Karte), wählen Sie die Frage(n) ausund klicken Sie auf Aktivieren im linken Menü.

Um weitere Fragen zu konfigurieren, klicken Sie auf Fragen im linken Menü und dann Neu.

Fragenfelder:

  • Abschnitt: Abschnitte ermöglichen es Ihnen, Ihre Fragen auf dem Eingabeformular zu gruppieren. Einige Abschnitte werden automatisch erstellt, und Sie können vom Mandanten-Rezept-Dashboard aus zusätzliche Abschnitte für Ihre Fragen erstellen.

  • Name: dient als Variablenname, der in Skripten referenziert werden kann; verwenden Sie einen aussagekräftigen Namen, um die Wartung und Fehlerbehebung von Skripten zu erleichtern; nur alphanumerische Zeichen, keine Leerzeichen oder Sonderzeichen.

  • Typ: bestimmt, wie die Daten erfasst werden: über Benutzereingaben, Interaktion mit der VergeOS-Datenbank usw.

  • Reihenfolge-ID: wird verwendet, um die Reihenfolge zu bestimmen, in der die Fragen innerhalb des ausgewählten Abschnitts angezeigt werden.

  • Anzeige: die Textbezeichnung, die im Benutzereingabeformular für die Frage angezeigt wird

  • Standardwert: (optional) definiert einen anfänglichen Antwortwert für die Frage

  • Regex-Validierung: (optional) regulärer Ausdruck, der zur Validierung der Eingabe verwendet wird (Standard-Regex-Syntax)

  • Platzhaltertext: (optional) ausgegrauter Text, der als Beispiel für die erwartete Eingabe angezeigt wird

  • Tooltip-Text: (optional) Hilfetext für Benutzer, der in einem Popup angezeigt wird, wenn das Feld mit der Maus darübergefahren wird

  • Hinweistext: (optional) Hilfetext für Benutzer, der direkt unter dem Eingabefeld angezeigt wird, um zusätzliche Hinweise zu geben.

  • Bei Änderung: ermöglicht das Aus- und Einblenden anderer Fragen, wenn dieses Feld geändert wird. (Beispielcode wird in diesem Feld angezeigt, wenn eine neue Frage erstellt wird.)

Zusätzliche Konfigurationsoptionen können je nach ausgewähltem Typ verfügbar sein.

Interaktion mit der VergeOS-Datenbank

Einige Fragetypen ermöglichen es Ihnen, Datenbankinformationen nachzuschlagen oder Datenbankeinträge zu erstellen/bearbeiten. Beachten Sie Platzhaltertext (ausgegrauter Text mit Beispiel-Eingaben), wenn Sie Fragen zur Datenbankinteraktion konfigurieren, als Hinweise. Diese Knowledge-Base-Artikel bieten zusätzliche Informationen zur Arbeit mit der VergeOS-Datenbank: Die Beschreibung der API-Tabellen und Der API-Leitfaden

Datenbankkontext

Die Datenbankkontext Feld ermöglicht es Ihnen, festzulegen, ob Sie mit der lokalen Datenbank (dem übergeordneten System) oder mit der Datenbank des neu erstellten Mandanten interagieren möchten. Dies gilt für die Fragetypen: Datenbank erstellen, Datenbank bearbeiten und Datenbank suchen.

Referenz der Systemfragen

Wenn ein Mandanten-Rezept erstellt wird, generiert das System automatisch eine Reihe integrierter Fragen, die in Abschnitte organisiert sind. Viele dieser Fragen sind standardmäßig deaktiviert und müssen aktiviert werden, wenn Sie sie verwenden möchten. Systemfragen können nicht gelöscht, aber aktiviert oder deaktiviert werden.

Um eine deaktivierte Systemfrage zu aktivieren: Navigieren Sie zu Fragen (linkes Menü oder Dashboard-Karte), wählen Sie die Frage(n) ausund klicken Sie auf Aktivieren im linken Menü.

Mandantenabschnitt

Diese Fragen steuern zentrale Mandanteneinstellungen wie Identität, Admin-Zugangsdaten und SSL-Konfiguration.

Namen
Anzeigen
Typ
Standard
Standardmäßig aktiviert

YB_URL

URL

Zeichenkette

Ja

YB_DESCRIPTION

Beschreibung

Textbereich

Ja

YB_USER_NAME

Admin-Benutzer

Zeichenkette

admin

Ja

YB_USER_PASSWORD

Passwort

Passwort

Ja

YB_USER_EMAIL

E-Mail

Zeichenkette

Nein

YB_USER_CHANGE_PASSWORD

Passwortänderung erforderlich

Boolesch

false

Nein

YB_EXPOSE_CLOUD_SNAPSHOTS

System-Snapshots anzeigen

Boolesch

true

Nein

YB_HELP_URL

Hilfe-URL

Zeichenkette

Standard

Nein

YB_THEME_ACCESS

Designzugriff

Liste

host_only

Ja

YB_SPECIFIED_THEME

Design

Zeilenauswahl

Ja

YB_CLUSTER

Cluster

Cluster

Nein

YB_CERT_TYPE

SSL-Zertifikatstyp

Versteckt

manuell

Nein

YB_CERT_DOMAIN

SSL-Zertifikatsdomäne

Zeichenkette

Nein

YB_CERT_PUBLIC

Öffentliches SSL-Zertifikat

Textbereich

Nein

YB_CERT_PRIVATE

Privates SSL-Zertifikat

Textbereich

Nein

YB_CERT_CHAIN

SSL-Zertifikatskette

Textbereich

Nein

Abschnitt Knoten

Diese Fragen definieren die Rechenressourcen, die dem/den Knoten des Mandanten zugewiesen werden.

Namen
Anzeigen
Typ
Standard
Standardmäßig aktiviert

YB_NODE_1_CPU_CORES

Kerne von Knoten 1

Zahl

8

Ja

YB_NODE_1_RAM

RAM von Knoten 1

RAM

16384

Ja

YB_NODE_1_INSTANCES

Instanzen von Knoten 1

Zahl

1

Nein

YB_NODE_1_CLUSTER

Cluster von Knoten 1

Cluster

Nein

YB_NODE_1_CLUSTER_FAILOVER

Failover-Cluster von Knoten 1

Cluster

Nein

Abschnitt Netzwerk

Diese Fragen konfigurieren die Netzwerkadressen des Mandanten.

Namen
Anzeigen
Typ
Standard
Standardmäßig aktiviert

YB_NET_1_IP

UI-IP-Adresse

Virtuelle IP-Adresse

Ja

YB_NET_2_IP

IP-Adresse

Virtuelle IP-Adresse

Ja

Ein Rezept bearbeiten

Wenn an einem Rezept Änderungen vorgenommen werden, muss es erneut veröffentlicht werden, damit diese Änderungen verfügbar werden. Oben im Rezept-Dashboard wird eine Meldung angezeigt, die darauf hinweist, dass das Rezept erneut veröffentlicht werden muss, damit die Änderungen wirksam werden. Sie können den Erneut veröffentlichen -Link in dieser Meldung verwenden oder im linken Menü auf Erneut veröffentlichen klicken.

Ein Mandanten-Rezept verwenden

Einen Mandanten aus einem Rezept erstellen

  1. Navigieren Sie im oberen Menü zu Mandanten > + Neuer Mandant.

  2. Klicken Sie auf das gewünschte catalog im Abschnitt Kataloge links.

  3. Die einzelnen im ausgewählten Katalog verfügbaren Mandanten-Rezepte werden auf der rechten Seite angezeigt. Wählen Sie das gewünschte Rezept aus und klicken Sie auf Weiter am unteren Rand des Bildschirms.

  4. Eingabefelder werden gemäß den im Rezept definierten Fragen angezeigt.

  5. Geben Sie die Felder ein bzw. konfigurieren Sie sie und klicken Sie auf Absenden um den neuen Mandanten zu erstellen. Die Konfiguration der Rezeptfragen bestimmt die erforderlichen Felder und andere Feldvalidierungen.

Rezeptinstanzen

Eine Instanz bezieht sich auf einen bestimmten Mandanten, der mit einem Mandanten-Rezept verknüpft ist. Wenn ein Mandant aus einem Rezept erstellt wird, gilt er als Instanz des Rezepts, bis er gelöscht oder vom Rezept getrennt wird.

Klicken Sie auf Instanzen im linken Menü eines Mandanten-Rezept-Dashboards, um schnell auf eine Liste der zugehörigen Mandanten zuzugreifen. Ein Rezept kann nicht gelöscht werden, wenn es zugehörige Instanzen gibt.

Rezepte ermöglichen eine Vielzahl potenzieller Lösungen. Wenden Sie sich an den VergeOS-Support, wenn Sie zusätzliche Hilfe bei der Automatisierung Ihrer Mandantenbereitstellungen mithilfe von Rezepten benötigen.

Zuletzt aktualisiert

War das hilfreich?