StyleBook pour créer un serveur virtuel d’équilibrage de charge
Dans cet exemple, vous concevez un StyleBook de base qui crée un serveur virtuel d’équilibrage de charge de type protocole HTTP et écoutant sur le port 80. Les paramètres du nom du serveur virtuel, de l’adresse IP et de la méthode d’équilibrage de charge acceptent des valeurs définies par l’utilisateur, c’est-à-dire qu’ils constituent les paramètres du StyleBook.
En-tête
Les six premières lignes d’un StyleBook constituent la section d’en-tête. Dans cet exemple, la section d’en-tête est rédigée comme suit :
name: lb-vserver
description: This StyleBook defines a load balancing virtual server configuration.
display-name: Load Balancing Virtual Server (HTTP)
namespace: com.example.stylebooks
schema-version: "1.0"
version: "0.1"
<!--NeedCopy-->
La section d’en-tête comprend les détails suivants :
-
name : Nom de ce StyleBook.
-
description : Description définissant la fonction de ce StyleBook. Cette description apparaît sur NetScaler® ADM.
-
display-name : Nom descriptif du StyleBook qui apparaît sur NetScaler ADM.
-
namespace : Un espace de noms fait partie d’un identifiant unique pour un StyleBook afin d’éviter les conflits de noms.
-
schema-version : Prend toujours la valeur « 1.0 » dans cette version.
-
version : Numéro de version du StyleBook. Vous pouvez modifier le numéro de version lorsque vous mettez à jour le StyleBook.
La combinaison de name, namespace et version identifie de manière unique un StyleBook dans le système. Vous ne pouvez pas avoir deux StyleBooks avec la même combinaison de nom, d’espace de noms et de version dans NetScaler ADM. Cependant, vous pouvez avoir deux StyleBooks avec le même nom et la même version mais des espaces de noms différents, ou avec le même espace de noms et la même version mais des noms différents.
Remarque
Si vous avez mis à jour votre StyleBook et que vous disposez d’un numéro de version mis à jour, et que vous faites référence (c’est-à-dire que vous importez) à ce StyleBook dans d’autres StyleBooks, assurez-vous de mettre à jour le numéro de version dans ces autres StyleBooks également, afin qu’ils utilisent la version correcte du StyleBook importé.
Importer des StyleBooks
La section après l’en-tête est appelée « import-stylebooks ». Dans cette section, vous devez déclarer l’espace de noms et le numéro de version de tout autre StyleBook auquel vous souhaitez faire référence dans votre StyleBook actuel. Cela vous permet d’importer et de réutiliser d’autres StyleBooks au lieu de reconstruire la même configuration dans votre propre StyleBook.
Dans cet exemple, la section import-stylebooks est rédigée comme suit :
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
<!--NeedCopy-->
Chaque StyleBook doit faire référence à l’espace de noms netscaler.nitro.config s’il utilise directement l’un des objets de configuration NITRO. Cet espace de noms contient tous les types NetScaler NITRO, tels que lbvserver. Les versions logicielles 10.5 et ultérieures étant prises en charge, vous pouvez utiliser votre StyleBook pour créer et exécuter des configurations sur toute instance NetScaler exécutant la version 10.5 et ultérieure.
Le préfixe utilisé dans la section import-stylebooks est un raccourci pour faire référence à la combinaison de l’espace de noms et de la version. Dans ce cas, ns fait référence à netscaler.nitro.config de la version 10.5. Dans les sections ultérieures de votre StyleBook, au lieu d’utiliser l’espace de noms et la version pour faire référence au StyleBook importé, vous pouvez utiliser la chaîne de préfixe choisie, par exemple, ns, dans l’exemple ci-dessus.
La version utilisée dans les StyleBooks est la version NetScaler NITRO. Un StyleBook basé sur la version X de Nitro peut être utilisé pour configurer tout NetScaler de version X ou supérieure.
Remarque
Pour vous assurer que vos StyleBooks peuvent être utilisés pour configurer toute instance NetScaler de version 10.5 ou ultérieure, Citrix recommande, pour une compatibilité maximale, d’importer l’espace de noms Nitro 10.5 dans vos StyleBooks qui utilisent directement les StyleBooks intégrés de Nitro (espace de noms : netscaler.nitro.config, version : 10.5).
Il est important qu’un StyleBook qui importe d’autres StyleBooks soit basé sur une version Nitro égale ou supérieure à celle des StyleBooks qu’il importe. Par exemple, un StyleBook basé sur la version 10.5 de Nitro ne peut pas dépendre, utiliser ou importer un StyleBook basé sur la version 11.1. Cependant, un StyleBook basé sur la version 11.1 peut importer un StyleBook basé sur toute version inférieure à 11.1.
Il est également possible qu’un StyleBook n’importe pas du tout l’espace de noms Nitro. Cela signifie qu’un StyleBook n’a pas besoin de définir directement des composants Nitro, mais peut importer (dépendre de) des StyleBooks qui définissent des composants Nitro. Le StyleBook qui importe d’autres StyleBooks acquiert toujours la version Nitro la plus élevée dans la hiérarchie de ses dépendances et pourrait donc être utilisé pour configurer des NetScalers de cette version ou d’une version supérieure.
Paramètres
La section des paramètres vous permet de déclarer tous les paramètres dont vous avez besoin dans votre StyleBook. En tant que développeur de StyleBook, vous devez décider quelle est l’entrée que vous souhaitez que les utilisateurs de votre StyleBook spécifient. Dans cet exemple, vous avez construit votre StyleBook de manière à ce que ses utilisateurs doivent fournir le nom du serveur virtuel, son adresse IP et la méthode d’équilibrage de charge.
La section des paramètres se présenterait comme suit :
parameters:
-
name: name
type: string
label: Application Name
description: Name of the application configuration.
required: true
-
name: ip
type: ipaddress
label: Application Virtual IP (VIP)
description: Application VIP that the clients access.
required: true
-
name: lb-alg
type: string
label: LoadBalancing Algorithm
description: Choose the load balancing algorithm (method) used for load balancing client request between the application servers.
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
<!--NeedCopy-->
Remarque
Si vous ne fournissez pas l’étiquette d’un paramètre, NetScaler ADM utilise l’attribut name lors de l’affichage de ce paramètre. Vous devez toujours définir une étiquette pour vos paramètres afin de pouvoir contrôler leur affichage dans NetScaler ADM.
Lors de l’utilisation des API, cependant, le paramètre est désigné par son nom.
Dans cette section, vous avez déclaré trois paramètres indiqués par les valeurs de leur attribut name : name pour le nom du serveur virtuel, ip pour l’adresse IP du serveur virtuel et lb-alg pour la méthode d’équilibrage de charge.
- type. Type de valeur que ces paramètres peuvent prendre. Par exemple, name et lb-alg peuvent prendre une valeur de chaîne de caractères et la valeur ip doit être de type adresse IP. Les paramètres d’un StyleBook peuvent être de l’un des types intégrés suivants :
- string. Un tableau de caractères. Si une longueur n’est pas spécifiée, la valeur de la chaîne peut prendre n’importe quel nombre de caractères. Cependant, vous pouvez limiter la longueur d’un type de chaîne en utilisant les attributs min-length et max-length.
- number. Un nombre entier. Vous pouvez spécifier le nombre minimum et maximum que ce type peut prendre en utilisant les attributs min-value et max-value.
- boolean. Peut être vrai ou faux. Notez également que tous les littéraux sont considérés par YAML comme des booléens (par exemple, Yes ou No).
- ipaddress. Une chaîne qui représente une adresse IPv4 ou IPv6 valide.
- tcp-port. Un nombre entre 0 et 65535 qui représente un port TCP ou UDP.
- password. Une valeur de chaîne opaque/secrète. Lorsque NetScaler ADM affiche une valeur pour ce paramètre, elle est représentée par des astérisques (*****).
- certfile. Fichier de certificat.
- keyfile. Fichier de clé privée de certificat.
- file. Un paramètre de ce type exige que l’utilisateur télécharge un fichier, par exemple, un fichier de certificat ou de clé.
- object. Se compose de plusieurs éléments et chacun de ces éléments est un paramètre. Ce type peut être utilisé pour regrouper plusieurs paramètres liés sous un seul paramètre parent.
- required. Indique si un paramètre est obligatoire ou facultatif. S’il est défini sur true, le paramètre est obligatoire et l’utilisateur doit fournir une valeur pour ce paramètre lors de la création de configurations à l’aide de ce StyleBook. Par défaut, tous les paramètres sont facultatifs. Dans cet exemple, name et ip sont des paramètres obligatoires, tandis que lb-alg est un paramètre facultatif, dont la valeur par défaut est « ROUNDROBIN ».
Utilisez l’attribut default pour attribuer une valeur par défaut à un paramètre facultatif. Lors de la création d’une configuration, si un utilisateur ne spécifie pas de valeur, la valeur par défaut est utilisée. Par exemple, pour le paramètre lb-alg, la valeur par défaut est ROUNDROBIN.
Utilisez l’attribut allowed-values pour définir des valeurs spécifiques qu’un utilisateur peut choisir lors de la création d’une configuration. Dans cet exemple, vous avez spécifié deux valeurs pour le paramètre lb-alg : ROUNDROBIN et LEASTCONNECTION.
Lorsque vous importez votre StyleBook et l’utilisez, NetScaler ADM affiche un formulaire avec ces trois paramètres. Les champs affichés pour name et ip permettent de saisir une valeur de type chaîne de caractères et adresse IP, et le champ lb-alg est affiché sous forme de liste déroulante avec ROUNDROBIN sélectionné comme valeur par défaut.
Remarque
En plus des types intégrés, un paramètre peut avoir un autre StyleBook comme type. C’est un moyen de réutiliser les paramètres définis dans d’autres StyleBooks.
Composants
La dernière section de ce StyleBook est appelée la section des composants et est considérée comme la section la plus importante du StyleBook. Dans cette section, vous définissez les objets de configuration qui doivent être créés par le StyleBook.
Pour cet exemple, vous devez rédiger la section des composants comme suit :
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name
servicetype: HTTP
ipv46: $parameters.ip
port: 80
lbmethod: $parameters.lb-alg
<!--NeedCopy-->
Cet exemple ne contient qu’un seul composant. Les attributs principaux d’un composant sont name, type et properties. Le type d’un composant détermine les propriétés que ce composant fournit. Les composants sont de deux types :
-
Type intégré. Ce type est fourni par le système et vous n’avez pas à le définir, par exemple, les types d’entités NITRO « lbvserver » ou « servicegroup ». Dans cet exemple, vous utilisez un type de composant intégré.
-
Type composite. Ce type est le StyleBook que vous avez créé et importé dans NetScaler ADM, ou le StyleBook par défaut fourni avec NetScaler ADM. Vous pouvez en savoir plus sur les StyleBooks composites dans Créer un StyleBook composite.
Dans cet exemple, vous avez défini un composant appelé lbvserver-comp. Ce composant est de type ns::lbvserver (un type Nitro intégré), où « ns » est le préfixe qui fait référence à l’espace de noms netscaler.nitro.config et à la version 10.5 que vous aviez spécifiés dans la section import-stylebooks, et « lbvserver » est une ressource Nitro dans cet espace de noms.
Les properties définies ici sont les attributs de la ressource « lbvserver ». Pour en savoir plus sur toutes les ressources NetScaler NITRO disponibles et leurs attributs, consultez la documentation de l’API REST NetScaler NITRO.
Les propriétés de cette section incluent les attributs obligatoires de la ressource « lbvserver » et vous permettent de spécifier des valeurs pour ces attributs. Dans cet exemple, vous spécifiez des valeurs statiques pour servicetype et port, tandis que les propriétés name, ipv46 et lbmethod obtiennent leurs valeurs des paramètres d’entrée. Dans le reste du StyleBook, vous pouvez faire référence aux noms de paramètres définis dans la section des paramètres en utilisant l’expression $parameters.<parameter-name>, par exemple, $parameters.ip.
Remarque
Par convention, le préfixe « ns » est toujours utilisé pour désigner un espace de noms NetScaler Nitro dans la section « import-stylebooks ». Bien que cela ne soit pas obligatoire, Citrix recommande d’utiliser la même convention dans vos propres StyleBooks pour des raisons de cohérence.
Construire votre StyleBook
Maintenant que vous avez défini toutes les sections requises de ce StyleBook, rassemblez-les toutes pour construire votre premier StyleBook. Copiez et collez le contenu du StyleBook dans un éditeur de texte, puis enregistrez le fichier sous le nom lb-vserver.yaml. Citrix recommande d’utiliser le validateur YAML intégré dans StyleBooks pour valider et importer le contenu YAML.
Le contenu complet du fichier lb-vserver.yaml est reproduit ci-dessous :
name: lb-vserver
namespace: com.example.stylebook
version: "1.0"
display-name: Load Balancing Virtual Server (HTTP)
description: "This stylebook defines a very simple load balancing HTTP virtual server configuration"
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
version: "10.5"
prefix: ns
-
namespace: com.citrix.adc.stylebooks
version: "1.0"
prefix: stlb
parameters:
-
name: name
label: "Application Name"
description: "Give a name to the application configuration."
type: string
required: true
-
name: vip-ipaddress
label: "Load Balancer IP Address"
description: "The Application VIP that clients access"
type: ipaddress
required: true
-
name: lb-alg
label: LB Algorithm
description: Load Balancing Algorithm
type: string
default: ROUNDROBIN
allowed-values:
- ROUNDROBIN
- LEAST-CONNECTION
components:
-
name: lbvserver-comp
description: This StyleBook component (a Builtin Nitro StyleBook) builds a NetScaler load balancing virtual server configuration object.
type: ns::lbvserver
properties:
name: $parameters.name
ipv46: $parameters.vip-ipaddress
lbmethod: $parameters.lb-alg
servicetype: HTTP
port: 80
<!--NeedCopy-->
Pour commencer à utiliser votre StyleBook pour créer des configurations, vous devez l’importer dans NetScaler ADM, puis l’utiliser. Pour plus d’informations, consultez Comment utiliser les StyleBooks définis par l’utilisateur.
Vous pouvez également importer ce StyleBook dans d’autres StyleBooks (en utilisant la construction import-stylebooks). Ou, vous pouvez modifier ce StyleBook pour inclure plus de paramètres et de composants, comme décrit dans la section suivante.