StyleBook-Konfiguration

StyleBook, um eine grundlegende Lastausgleichskonfiguration zu erstellen

In diesem Abschnitt entwerfen Sie ein StyleBook, das eine Lastausgleichskonfiguration erstellt, die einen virtuellen Lastausgleichsserver, eine Dienstgruppe und eine Liste von Diensten umfasst. Das StyleBook bindet die Dienste an die Dienstgruppe und bindet die Dienstgruppe an den virtuellen Server.

Um eine grundlegende Lastausgleichskonfiguration zu erstellen, verwenden Sie das Beispiel StyleBook,lb-vserver, das Sie inStyleBook erstellt haben, um einen virtuellen Lastausgleichsserverzu erstellen, und speichern Sie es alsbasic-lb-config.yaml.

Um dieses StyleBook zu erstellen, aktualisieren Sie den Header-Abschnitt. Dieser Abschnitt ähnelt dem Header-Abschnitt, den Sie inStyleBook erstellt haben, um einen virtuellen Lastausgleichsserver zu erstellen.

Ändern Sie den Wert vonnamein basic-lb-config. Aktualisieren Sie dieBeschreibungund denAnzeigenamen, um das StyleBook zu beschreiben. Sie müssen denNamespaceund dieVersionswertenicht ändern. Da Sie den Namen geändert haben, wird im System eine eindeutige Kennung für dieses StyleBook erstellt.

name:basic-lb-confignamespace:com.example.stylebooksversion:"0.1"display-name:Load Balancing Configurationdescription:This StyleBook defines a simple load balancing configuration.schema-version:"1.0"

StyleBooks importieren

Der Abschnitt Import-StyleBooks bleibt unverändert. Es bezieht sich auf den Namespace netscaler.nitro.config, um die NITRO-Konfigurationsobjekte zu verwenden.

import-stylebooks:-namespace:netscaler.nitro.configprefix:nsversion:"10.5"

Parameter

Aktualisieren Sie den Parameterbereich, um zwei weitere Parameter hinzuzufügen.

Die Parameter definieren die Liste der Dienste oder Server und den Port, auf dem die Dienste zuhören. Die ersten drei Parametername,ipundlb-algbleiben gleich.

parameters:-name:nametype:stringlabel:Application Namedescription:Give a name to the application configuration.required:true-name:iptype:ipaddresslabel:Application Virtual IP (VIP)description:The Application VIP that clients accessrequired:true-name:lb-algtype:stringlabel:LoadBalancing Algorithmdescription:Choose the loadbalancing algorithm (method) used for loadbalancing client requests between the application servers.allowed-values:-ROUNDROBIN-LEASTCONNECTIONdefault:ROUNDROBIN-name:svc-serverstype:ipaddress[]label:Application Server IPsdescription:The IP addresses of all the servers of this applicationrequired:true-name:svc-porttype:tcp-portlabel:Server Portdescription:The TCP port open on the application servers to receive requests.default:80

Der Parametersvc-serverswird hinzugefügt, um eine Liste von IP-Adressen der Backend-Server der Anwendung zu akzeptieren.svc-serversist ein obligatorischer Parameter, wie durchrequired: trueangegeben.

Der zweite Parameter,svc-port, gibt die Portnummer an, auf die die Server lauschen. Die Standardportnummer ist 80, sofern nicht vom Benutzer angegeben.

Komponenten

Sie müssen auch den Komponentenbereich aktualisieren, um weitere Komponenten so zu definieren, dass sie die beiden neuen Parameter verwenden und die vollständige Lastausgleichskonfiguration erstellen.

Für dieses Beispiel müssen Sie den Komponentenabschnitt wie folgt schreiben:

components:-name:lbvserver-comptype:ns::lbvserverproperties:name:$parameters.name + "-lb"servicetype:HTTPipv46:$parameters.ipport:80lbmethod:$parameters.lb-algcomponents:-name:svcg-comptype:ns::servicegroupproperties:name:$parameters.name + "-svcgrp"servicetype:HTTPcomponents:-name:lbvserver-svg-binding-comptype:ns::lbvserver_servicegroup_bindingproperties:name:$parent.parent.properties.nameservicegroupname:$parent.properties.name-name:members-svcg-comptype:ns::servicegroup_servicegroupmember_bindingrepeat:$parameters.svc-serversrepeat-item:srvproperties:ip:$srvport:str($parameters.svc-port)servicegroupname:$parent.properties.name

In diesem Beispiel hat die ursprüngliche Komponentelbvserver-comp(aus dem vorherigen Beispiel) jetzt eine untergeordnete Komponente namenssvcg-comp. Diesvcg-comp-Komponenteenthält auch zwei untergeordnete Komponenten. Durch das Verschachteln einer Komponente innerhalb einer anderen Komponente kann die verschachtelte Komponente Konfigurationsobjekte erstellen, indem sie auf Attribute in der übergeordneten Komponente verweist. Die verschachtelte Komponente kann für jedes Objekt, das in der übergeordneten Komponente erstellt wurde, ein oder mehrere Objekte erstellen.

Die Komponentesvcg-compwird verwendet, um eine Dienstgruppe auf der NetScaler-Instanz zu erstellen, indem die für die Attribute der Ressource angegebenen Werte verwendet werdenservicegroup. In diesem Beispiel geben Sie den statischen Wert fürservicetypean, währendName青年社温特来自民主党Eingabeparameter bezieht。Verweisen Sie auf den im Parameterabschnitt definiertenParameternamen, indem Sie die Notation$parameters.name + “-svcgrp”verwenden, wobei “-svcgrp” an den benutzerdefinierten Namen angehängt (verkettet) wird.

Die Komponentesvcg-comphat zwei untergeordnete Komponenten,lbvserver-svg-binding-compundmembers-svcg-comp.

Die erste untergeordnete Komponente,lbvserver-svg-binding-comp, wird verwendet, um ein Konfigurationsobjekt zwischen der von ihrer übergeordneten Komponente erstellten Servicegruppe und dem virtuellen Lastausgleichsserver (lbvserver) zu binden, der von der übergeordneten Komponente des Elternteils erstellt wurde. Die $parent Notation, auch übergeordnete Referenz genannt, wird verwendet, um auf Entitäten in den übergeordneten Komponenten zu verweisen. Beispielsweise bezieht sichservicegroupname: $parent.properties.nameauf die Dienstgruppe, die von der übergeordneten Komponentesvcg-comperstellt wurde, undname: $parent.parent.properties.namebezieht sich auf den virtuellen Server, der von der übergeordneten Komponentelbvserver-compdes übergeordneten Elements erstellt wurde.

Diemembers-svcg-Komponentewird verwendet, um Konfigurationsobjekte zwischen der Liste der Dienste an die von der übergeordneten Komponente erstellte Dienstgruppe zu binden. Die Erstellung mehrerer Bindungskonfigurationsobjekte wird erreicht, indem dasrepeat-Konstrukt von StyleBook verwendet wird, um über die Liste der Server zu iterieren, die im Parametersvc-serversangegeben ist. Während der Iteration erstellt diese StyleBook-Komponente ein NITRO-Konfigurationsobjekt vom Typservicegroup_servicegroupmember_binding毛皮jeden死nst (wiesrvimrepeat-Item-Konstrukt bezeichnet) in der Servicegruppe und legt dasip-Attributin jeder NITRO-Konfigurationsobjekt der IP-Adresse des entsprechenden Servers.

Im Allgemeinen verwenden Sie die Konstrukterepeatundrepeat-itemin einer Komponente, damit diese Komponente mehrere Konfigurationsobjekte desselben Typs erstellt. Sie können demrepeat-item-Konstrukteinen Variablennamen zuweisen, z. B.srv, um den aktuellen Wert in der Iteration zu bestimmen. Dieser Variablenname wird in den Eigenschaften derselben Komponente oder in untergeordneten Komponenten wie$, z. B. $srv bezeichnet.

Im vorherigen Beispiel hilft die Verschachtelung von Komponenten dabei, die Konfiguration einfach zu erstellen. Sie können die Konfiguration auch ohne Verschachtelung erstellen, wie im folgenden Beispiel gezeigt:

components:-name:lbvserver-comptype:ns::lbvserverproperties:name:$parameters.name + "-lb"servicetype:HTTPipv46:$parameters.ipport:80lbmethod:$parameters.lb-alg-name:svcg-comptype:ns::servicegroupproperties:servicegroupname:$parameters.name + "-svcgrp"servicetype:HTTP-name:lbvserver-svg-binding-comptype:ns::lbvserver_servicegroup_bindingproperties:name:$components.lbvserver-comp.properties.nameservicegroupname:$components.svcg-comp.properties.servicegroupname-name:members-svcg-comptype:ns::servicegroup_servicegroupmember_bindingrepeat:$parameters.svc-serversrepeat-item:srvproperties:ip:$srvport:80servicegroupname:$components.svcg-comp.properties.servicegroupname

Auch wenn die Komponenten nicht verschachtelt sind, entspricht die generierte NetScaler-Konfiguration der zuvor verwendeten verschachtelten Komponenten.

Die Reihenfolge, in der die Komponenten im StyleBook deklariert werden, hat keinen Einfluss auf die Reihenfolge der Erstellung der Konfigurationsobjekte. In diesem Beispiel müssen die Komponentensvcg-compundlbvserver-comp, obwohl sie zuletzt deklariert wurden, vor dem Erstellen der zweiten Komponentelbvserver-svg-binding-comperstellt werden, da in der zweiten Komponente Weiterleitungsverweise auf diese Komponenten vorhanden sind.

Hinweis

Konventionell werden die Namen von StyleBooks, Parametern, Substitutionen, Komponenten und Ausgaben in Kleinbuchstaben geschrieben. Wenn sie viele Wörter enthalten, werden sie durch ein “-“-Zeichen getrennt. Zum Beispiellb-bindings,app-name,rewrite-configund so weiter. Eine andere Konvention besteht darin, an Komponentennamen als Suffix die Zeichenfolge-companzuhängen.

Ausgaben

In diesem Abschnitt müssen Sie angeben, was das StyleBook den Benutzern (oder anderen StyleBooks) zur Verfügung stellt, nachdem es eine Konfiguration erstellt hat. Sie können beispielsweise angeben, dass die Konfigurationsobjektelbvserverundservicegroup, die von diesem StyleBook erstellt werden, verfügbar gemacht werden sollen.

outputs:-name:lbvserver-compvalue:$components.lbvserver-compdescription:The component that builds the Nitro lbvserver configuration object-name:servicegroup-compvalue:$components.svcg-compdescription:The component that builds the Nitro servicegroup configuration object

Der Ausgabebereich eines StyleBook ist optional. Ein StyleBook muss keine Ausgaben zurückgeben. Durch die Rückgabe einiger interner Komponenten als Ausgaben erhalten alle StyleBooks, die dieses StyleBook importieren, jedoch mehr Flexibilität. Diese Funktion ist nützlich, wenn Sie ein zusammengesetztes StyleBook erstellen.

Hinweis

Es empfiehlt sich, eine gesamte Komponente des StyleBook im Ausgabeabschnitt verfügbar zu machen und nicht nur eine einzelne Eigenschaft einer Komponente verfügbar zu machen (z. B. die gesamte$components.lbvserver-compund nicht nur den Namen$components.lbvserver-comp.properties.name). Fügen Sie der Ausgabe auch eine Beschreibung hinzu, die erklärt, was die spezifische Ausgabe darstellt.

Erstellen Sie Ihr StyleBook

Nachdem Sie alle erforderlichen Abschnitte dieses StyleBooks definiert haben, fügen Sie sie alle zusammen, um Ihr zweites StyleBook zu erstellen. Sie haben diese StyleBook-Datei bereits alsbasic-lb-config.yamlgespeichert. Citrix empfiehlt, den integrierten YAML-Validator in StyleBooks zu verwenden, um den YAML-Inhalt zu validieren und zu importieren.

Der vollständige Inhalt der Dateibasic-lb-config.yamlwird wie folgt wiedergegeben:

name:basic-lb-confignamespace:com.example.stylebooksversion:"0.1"display-name:Load Balancing Configurationdescription:This StyleBook defines a simple load balancing configuration.schema-version:"1.0"import-stylebooks:-namespace:netscaler.nitro.configversion:"10.5"prefix:nsparameters:-name:nametype:stringlabel:Application Namedescription:Give a name to the application configuration.required:true-name:iptype:ipaddresslabel:Application Virtual IP (VIP)description:The Application VIP that clients accessrequired:true-name:lb-algtype:stringlabel:LoadBalancing Algorithmdescription:Choose the loadbalancing algorithm (method) used for loadbalancing client requests between the application servers.allowed-values:-ROUNDROBIN-LEASTCONNECTIONdefault:ROUNDROBIN-name:svc-serverstype:ipaddress[]label:Application Server IPsdescription:The IP addresses of all the servers of this applicationrequired:true-name:svc-porttype:tcp-portlabel:Server Portdescription:The TCP port open on the application servers to receive requests.default:80components:-name:lbvserver-comptype:ns::lbvserverproperties:name:$parameters.name + "-lb"servicetype:HTTPipv46:$parameters.ipport:80lbmethod:$parameters.lb-alg-name:svcg-comptype:ns::servicegroupproperties:servicegroupname:$parameters.name + "-svcgrp"servicetype:HTTP-name:lbvserver-svg-binding-comptype:ns::lbvserver_servicegroup_bindingproperties:name:$components.lbvserver-comp.properties.nameservicegroupname:$components.svcg-comp.properties.servicegroupname-name:members-svcg-comptype:ns::servicegroup_servicegroupmember_bindingrepeat:$parameters.svc-serversrepeat-item:srvproperties:ip:$srvport:80servicegroupname:$components.svcg-comp.properties.servicegroupnameoutputs:-name:lbvserver-compvalue:$components.lbvserver-compdescription:The component that builds the Nitro lbvserver configuration object-name:servicegroup-compvalue:$components.svcg-compdescription:The component that builds the Nitro servicegroup configuration object

Um mit dem StyleBook Konfigurationen zu erstellen, müssen Sie es in NetScaler ADM importieren und es dann verwenden. WeitereInformationen finden Sie unter Verwenden von benutzerdefinierten StyleBooks.

Sie können dieses StyleBook auch in andere StyleBooks importieren und seine Eigenschaften wie im nächsten Abschnitt beschrieben verwenden.

StyleBook, um eine grundlegende Lastausgleichskonfiguration zu erstellen