Ersetzungen
Der Abschnitt “Ersetzungen” wird verwendet, um Kurznamen für komplexe Ausdrücke zu definieren, die im Rest des StyleBook verwendet werden können, um das Lesen des StyleBooks zu erleichtern. Sie sind auch nützlich, wenn der gleiche Ausdruck oder Wert mehrmals im StyleBook wiederholt wird, z. B. ein konstanter Wert. Wenn Sie einen Ersetzungsnamen für diesen Wert verwenden, können Sie nur den Ersetzungswert aktualisieren, wenn dieser Wert geändert werden muss, anstatt ihn an jedem im StyleBook angezeigten Speicherort zu aktualisieren, was möglicherweise fehleranfällig ist.
Ersetzungen werden auch zum Definieren von Zuordnungen zwischen Werten verwendet, wie in Beispielen weiter unten in diesem Dokument beschrieben.
Jede Ersetzung in der Liste besteht aus einem Schlüssel und einem Wert. Der Wert kann ein einfacher Wert, ein Ausdruck, eine Funktion oder eine Map sein.
Im folgenden Beispiel werden zwei Substitutionen definiert. Die erste ist http-port, dass sie als Kurzform für 8181 verwendet werden kann. Wenn Sie eine Substitution verwenden, können Sie dies im Rest des StyleBook als $substitutions.http-port anstelle von 8181 verweisen.
Substitutionen:
http-port: 8181
Auf diese Weise können Sie einen mnemonischen Namen für eine Portnummer angeben und diese Portnummer an einer Stelle im StyleBook definieren, unabhängig davon, wie oft sie verwendet wird. Wenn Sie die Portnummer in 8080 ändern möchten, können Sie sie im Substitutionsabschnitt ändern, und die Änderung wird überall wirksam, wo der mnemonische Name http-port verwendet wird. Das folgende Beispiel zeigt, wie eine Substitution in einer Komponente verwendet wird.
components:
-
name: my-lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name + "-lb"
servicetype: HTTP
ipv46: $parameters.ip
port: $substitutions.http-port
lbmethod: $parameters.lb-alg
<!--NeedCopy-->
Eine Substitution kann auch ein komplexer Ausdruck sein. Das folgende Beispiel zeigt, wie zwei Ersetzungen Ausdrücke verwenden.
substitutions:
app-rule: HTTP.REQ.HEADER("X-Test-Application").EXISTS
app-name: str("acme-") + $parameters.name + str("-app")
<!--NeedCopy-->
Ein Substitutionsausdruck kann auch vorhandene Substitutionsausdrücke verwenden, wie im folgenden Beispiel gezeigt.
substitutions:
http-port: 8181
app-name: str("acme-") + $parameters.name + str($substitutions.http-port) + str("-app")
<!--NeedCopy-->
Eine weitere nützliche Funktion von Substitutionen sind Karten, mit denen Sie Schlüssel zu Werten zuordnen können. Das Folgende ist ein Beispiel für eine Kartenersetzung.
substitutions:
secure-port:
true: int("443")
false: int("80")
secure-protocol:
true: SSL
false: HTTP
<!--NeedCopy-->
Das folgende Beispiel zeigt, wie Sie die Karten Secure-Port und Secure-Protokoll verwenden.
components:
-
name: my-lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name + "-lb"
servicetype: $substitutions.secure-protocol[$parameters.is-secure]
ipv46: $parameters.ip
port: $substitutions.secure-port[$parameters.is-secure]
lbmethod: $parameters.lb-alg
<!--NeedCopy-->
Dies bedeutet, dass, wenn der Benutzer des StyleBook den booleschen Wert “true” für den Parameter ist-sicher angibt oder das diesem Parameter entsprechende Kontrollkästchen in der Citrix ADM-GUI auswählt, der Eigenschaft servicetype dieser Komponente der Wert SSL zugewiesen wird und die Eigenschaft port ist hat den Wert 443zugewiesen. Wenn der Benutzer jedoch “false” für diesen Parameter angibt oder das entsprechende Kontrollkästchen in der Citrix ADM GUI deaktiviert, wird der Eigenschaft servicetype der Wert HTTP zugewiesen, und dem Port wird der Wert 80zugewiesen.
Das folgende Beispiel zeigt, wie Substitutionen als Funktion verwendet werden. Eine Substitutionsfunktion kann ein oder mehrere Argumente annehmen. Argumente können vom einfachen Typ sein, z. B. string, number ipaddress,, boolean und andere Typen.
Substitutionen:
Form-lb-Name (Name): $name + “-lb”
In diesem Beispiel definieren wir eine Ersetzungsfunktion “form-lb-name”, die ein String-Argument namens “name” nimmt und es verwendet, um eine neue Zeichenfolge zu erstellen, die der Zeichenfolge im Argument name das Suffix “-lb” zufügt. Ein Ausdruck, der diese Substitutionsfunktion verwendet, kann wie folgt geschrieben werden:
$substitutions.form-lb-name("my")
Es kehrt zurück my-lb
Betrachten Sie ein anderes Beispiel:
Substitutionen:
cspol-priority(priority): 10100 - 100 * $priority
Die Substitution cspol-priority ist eine Funktion, die ein Argument namens Priorität verwendet und es zur Berechnung eines Werts verwendet. Im Rest des StyleBook kann diese Substitution verwendet werden, wie im folgenden Beispiel gezeigt:
components:
-
name: cspolicy-binding-comp
type: ns::csvserver_cspolicy_binding
condition: not $parameters.is-default
properties:
name: $parameters.csvserver-name
policyname: $components.cspolicy-comp.properties.policyname
priority: $substitutions.cspol-priority($parameters.pool.priority)
<!--NeedCopy-->
Die Substitution kann auch aus einem Schlüssel und einem Wert bestehen. Der Wert kann ein einfacher Wert, ein Ausdruck, eine Funktion, eine Karte, eine Liste oder ein Wörterbuch sein.
Das Folgende ist ein Beispiel für eine Substitution namens slist deren Wert eine Liste ist:
substitutions:
slist:
- a
- b
- c
<!--NeedCopy-->
Der Wert einer Substitution kann auch ein Wörterbuch von Schlüssel-Wert-Paaren sein, wie im folgenden Beispiel einer folgenden Substitution sdict gezeigt wird:
substitutions:
sdict:
a: 1
b: 2
c: 3
<!--NeedCopy-->
Sie können komplexere Attribute erstellen, indem Sie Listen und Wörterbücher kombinieren. Zum Beispiel gibt eine Substitution namens slistofdict eine Liste von Schlüssel-Wert-Paaren zurück.
slistofdict:
-
a: $parameters.cs1.lb1.port
b: $parameters.cs1.lb2.port
-
a: $parameters.cs2.lb1.port
b: $parameters.cs2.lb2.port
<!--NeedCopy-->
Im folgenden Beispiel gibt eine Substitution sdictoflist jedoch ein Schlüssel-Wert-Paar zurück, wobei der Wert selbst eine andere Liste ist.
sdictoflist:
a:
- 1
- 2
b:
- 3
- 4
<!--NeedCopy-->
In Komponenten können diese Substitutionen in Condition, Properties, repeat-condition Konstrukten verwendet werden.
Das folgende Beispiel einer Komponente zeigt, wie eine Substitution verwendet werden kann, um die Eigenschaften anzugeben:
properties:
a: $substitutions.slist
b: $substitutions.sdict
c: $substitutions.slistofdict
d: $substitutions.sdictoflist
<!--NeedCopy-->
Ein Anwendungsfall zum Definieren einer Substitution, deren Wert eine Liste oder ein Wörterbuch ist, ist, wenn Sie einen virtuellen Content Switching-Server und mehrere virtuelle Server für den Lastenausgleich konfigurieren. Da alle virtuellen Server von lb, die an denselben virtuellen CS-Server gebunden sind, möglicherweise eine identische Konfiguration haben, können Sie die Ersetzungsliste und das Wörterbuch verwenden, um diese Konfiguration zu erstellen, um zu vermeiden, dass diese Konfiguration für jeden virtuellen lb-Server wiederholt wird.
Das folgende Beispiel zeigt die Ersetzung und die Komponente in den StyleBooks cs-lb-mon, um eine virtuelle Content Switching-Serverkonfiguration zu erstellen. Bei der Erstellung der Eigenschaften von StyleBooks cs-lb-mon gibt die komplexe Substitution “lb-properties” die Eigenschaften der virtuellen lb-Server an, die mit dem virtuellen Server cs verknüpft sind. Die Substitution lb-properties ist eine Funktion, die den Namen, den Diensttyp, die virtuelle IP-Adresse, den Port und die Server als Parameter annimmt und ein Schlüssel-Wert-Paar als Wert generiert. In der Komponente cs-pools weisen wir den Wert dieser Substitution einem lb-pool-Parameter für jeden Pool zu.
substitutions:
cs-port[]:
true: int("80")
false: int("443")
lb-properties(name, servicetype, vip, port, servers):
lb-appname: $name
lb-service-type: $servicetype
lb-virtual-ip: $vip
lb-virtual-port: $port
svc-servers: $servers
svc-service-type: $servicetype
monitors:
-
monitorname: $name
type: PING
interval: $parameters.monitor-interval
interval_units: SEC
retries: 3
components:
-
name: cs-pools
type: stlb::cs-lb-mon
description: | Updates the cs-lb-mon configuration with the different pools provided. Each pool with rule result in a dummy LB vserver, cs action, cs policy, and csvserver_cspolicy_binding configuration.
condition: $parameters.server-pools
repeat: $parameters.server-pools
repeat-item: pool
repeat-condition: $pool.rule
repeat-index: ndx
properties:
appname: $parameters.appname + "-cs"
cs-virtual-ip: $parameters.vip
cs-virtual-port: $substitutions.cs-port($parameters.protocol == "HTTP")
cs-service-type: $parameters.protocol
pools:
-
lb-pool: $substitutions.lb-properties($pool.pool-name, "HTTP", "0.0.0.0", 0, $pool.servers)
rule: $pool.rule
priority: $ndx + 1
<!--NeedCopy-->
Substitutionszuordnung:
Sie können Substitutionen erstellen, die Schlüssel Werten zuordnen. Stellen Sie sich beispielsweise ein Szenario vor, in dem Sie den Standardport (Wert) definieren möchten, der für jedes Protokoll (Schlüssel) verwendet werden soll. Schreiben Sie für diese Aufgabe wie folgt eine Substitutionszuordnung.
substitutions:
port:
HTTP: 80
DNS: 53
SSL: 443
<!--NeedCopy-->
In diesem Beispiel wird HTTP auf 80, DNS auf 53 und SSL auf 443 abgebildet. Um den Port eines bestimmten Protokolls abzurufen, der als Parameter angegeben ist, verwenden Sie den Ausdruck
$substitutions.port [$parameters.protocol]
Der Ausdruck gibt einen Wert zurück, der auf dem vom Benutzer angegebenen Protokoll basiert.
- Wenn der Schlüssel HTTP ist, gibt der Ausdruck 80 zurück.
- Wenn der Schlüssel DNS ist, gibt der Ausdruck 53 zurück
- Wenn der Schlüssel SSL ist, gibt der Ausdruck 443 zurück
- Wenn der Schlüssel nicht in der Karte vorhanden ist, gibt der Ausdruck keinen Wert zurück