Benutzerdefinierte StyleBooks erstellen und verwenden
Sie können Ihr eigenes StyleBook für Ihre Bereitstellung schreiben, es in NetScaler® Application Delivery Management (ADM) importieren und Konfigurationsobjekte erstellen. Sie können auch die API verwenden, um Konfigurationen aus Ihren StyleBooks zu erstellen.
Dieses Dokument enthält die folgenden Informationen:
Bevor Sie beginnen
Bevor Sie mit der Erstellung von StyleBooks beginnen, stellen Sie sicher, dass Sie über Kenntnisse in den folgenden Bereichen verfügen:
- NITRO API. Weitere Informationen finden Sie in der Nitro API-Dokumentation
- YAML
StyleBook-Dateien verwenden das YAML-Format. Weitere Informationen zum YAML-Format finden Sie unter YAML-Syntax.
Im Folgenden finden Sie eine Liste von YAML-Richtlinien, die Sie beim Erstellen von StyleBooks beachten müssen:
- YAML ist Groß- und Kleinschreibung-sensitiv.
- YAML erfordert eine korrekte Einrückung.
- Verwenden Sie die
<Leertaste>, um eine korrekte Einrückung zu erstellen. Verwenden Sie nicht die<Tabulatortaste>. Die Verwendung der<Tabulatortaste>führt zu einem Kompilierungsfehler beim Importieren Ihres StyleBooks in den MA-Dienst. - Verwenden Sie keine Zeichenfolgen in Anführungszeichen. Fügen Sie die Zeichenfolge nur dann in Anführungszeichen ein, wenn eine Zeichenfolge Satzzeichen (Bindestriche, Doppelpunkte usw.) enthält. Wenn Sie eine Zahl als Zeichenfolge interpretieren möchten, schließen Sie die Zahl entweder in Anführungszeichen ein oder verwenden Sie die integrierte Funktion
str()von StyleBooks. -
Literale wie YES/Yes/yes/Y/y/NO/no/No/n/N, ON/On/on/OFF/Off/off und TRUE/true/truthy/FALSE/False/false/falsely werden als Booleans betrachtet und entsprechen jeweils
trueundfalse. Um sie als Zeichenfolgen zu interpretieren, schließen Sie sie in Anführungszeichen ein. Zum Beispiel:- “YES”
- “No”
- “True”
- “False” und so weiter.
Hinweis
Bevor Sie Ihre StyleBook-Datei in NetScaler ADM importieren, wird empfohlen, zu überprüfen, ob Ihre Datei dem YAML-Format entspricht. Citrix empfiehlt, den integrierten YAML-Validator in StyleBooks zu verwenden, um den YAML-Inhalt zu validieren und zu importieren.
Beim Konfigurieren von StyleBooks können Sie nur Nitro-Konfigurationsressourcen verwenden, die die Operationen Erstellen und Löschen (HTTP-Methoden POST und DELETE) unterstützen. Weitere Informationen finden Sie in der Nitro APIs-Dokumentation.
Aufbau eines StyleBooks
Das Schreiben von StyleBooks erfordert, dass Sie die Grammatik, Syntax und Struktur von StyleBooks verstehen. Ein typisches StyleBook besteht aus den folgenden Abschnitten:
- Header: Dieser Abschnitt ermöglicht es Ihnen, die Identität eines StyleBooks zu definieren und zu beschreiben, was es tut. Dies ist ein obligatorischer Abschnitt.
- StyleBooks importieren: Dieser Abschnitt ermöglicht es Ihnen, zu deklarieren, auf welche anderen StyleBooks Sie von Ihrem aktuellen StyleBook aus verweisen möchten. Das Importieren von NetScaler NITRO-Konfigurations-StyleBooks oder anderen StyleBooks ist erforderlich, um ein StyleBook zu schreiben. Dies ist ein obligatorischer Abschnitt.
- Parameter: Dieser Abschnitt ermöglicht es Ihnen, die Parameter zu definieren, die Sie in Ihrem StyleBook benötigen, um eine Konfiguration zu erstellen. Er beschreibt die Eingabe, die Ihr StyleBook entgegennimmt. Dies ist ein optionaler Abschnitt.
-
Komponenten: Dieser Abschnitt ermöglicht es Ihnen, die Entitäten (Konfigurationsobjekte) zu definieren, die vom StyleBook für eine bestimmte Konfiguration erstellt werden. Dieser Abschnitt wird als Kern eines StyleBooks betrachtet. Komponenten verwenden im Allgemeinen die im Parameterabschnitt bereitgestellten Eingaben, um die vom StyleBook generierte Konfiguration anzupassen. Dies ist ein optionaler Abschnitt.
Ein StyleBook kann einen Parameterabschnitt, einen Komponentenabschnitt oder beides enthalten. Ein StyleBook, das nur den Parameterabschnitt enthält, ist nützlich, um eine Liste von Parametern zu definieren, die von anderen StyleBooks verwendet werden können. Dies fördert die Wiederverwendbarkeit von Parametergruppen über eine Reihe von StyleBooks hinweg. Ein StyleBook, das nur einen Komponentenabschnitt enthält, kann verwendet werden, wenn Sie die Werte für Attribute im StyleBook angeben möchten, anstatt Parameter zur Aufnahme von Benutzereingaben zu definieren.
- Ausgaben: Während der Parameterabschnitt die Eingaben des StyleBooks definiert, definiert dieser optionale Abschnitt seine Ausgaben. In diesem optionalen Ausgabeabschnitt können Sie die Komponenten angeben, die Sie Benutzern, die eine Konfiguration aus diesem StyleBook erstellen, und anderen StyleBooks, die dieses StyleBook importieren, zugänglich machen möchten. Benutzer und importierende StyleBooks können dann auf die Eigenschaften der exponierten Komponenten verweisen.
- Operationen: Ein StyleBook kann einen optionalen Abschnitt enthalten, um Analytics in NetScaler ADM für jeden virtuellen Server zu aktivieren, der Teil des StyleBooks ist.
Die folgende Abbildung zeigt eine einfache Gliederung eines StyleBooks.
Die folgenden Beispiele helfen Ihnen, die Grammatik und Struktur eines StyleBooks zu verstehen und StyleBooks mit zunehmendem Komplexitätsgrad zu schreiben.