Créer et utiliser des StyleBooks personnalisés
Vous pouvez écrire votre propre StyleBook pour votre déploiement, l’importer dans NetScaler Console et créer des objets de configuration. Vous pouvez également utiliser des API pour créer des configurations à partir de vos StyleBooks.
Ce document contient les informations suivantes :
Avant de commencer
Avant de commencer à créer des StyleBooks, assurez-vous de connaître les points suivants :
-
API NITRO. Pour plus d’informations, consultez la documentation de l’API NITRO.
-
YAML
Les fichiers StyleBook utilisent le format YAML. Pour plus d’informations sur le format YAML, consultez Syntaxe YAML.
Voici une liste des instructions YAML dont vous devez tenir compte lors de la création de StyleBooks :
- YAML fait la distinction entre majuscules et minuscules.
- YAML nécessite une indentation appropriée
- Utilisez la
<spacebar>touche pour créer une empreinte appropriée. N’utilisez pas la<tab>clé. L’utilisation de la<tab>clé crée une erreur de compilation lors de l’importation de votre StyleBook vers MA Service. - N’utilisez pas de chaînes entre guillemets. Incluez la chaîne entre guillemets uniquement si une chaîne contient des signes de ponctuation (tirets, deux-points, etc.) Si vous souhaitez interpréter un nombre comme une chaîne, incluez le nombre entre guillemets ou utilisez la fonction intégrée str () de StyleBooks.
-
Les littéraux tels que YES/Yes/yes/Y/y/NO/no/No/n/N, ON/On/on/OFF/Off/off et TRUE/true/truthy/FALSE/False/false/falsely sont considérés comme des booléens et sont équivalents respectivement à true et false. Pour les interpréter comme des chaînes, incluez-les entre guillemets. Par exemple :
- “YES”
- “No”
- “True”
- “False” et ainsi de suite.
Remarque
Avant d’importer votre fichier StyleBook dans la console NetScaler, il est recommandé de vérifier si votre fichier est conforme au format YAML. Citrix vous recommande d’utiliser le validateur YAML intégré dans StyleBooks pour valider et importer le contenu YAML.
Pour plus d’informations, consultez la documentation des API NITRO.
Anatomie d’un StyleBook
Pour écrire des StyleBooks, vous devez comprendre la grammaire, la syntaxe et la structure des StyleBooks. Un StyleBook classique comporte les sections suivantes :
- En-tête : Cette section vous permet de définir l’identité d’un StyleBook et de décrire son rôle. Il s’agit d’une section obligatoire.
- Importer des StyleBooks : cette section vous permet de déclarer à quel autre StyleBook vous souhaitez faire référence depuis votre StyleBook actuel. L’importation de StyleBooks de configuration NetScaler NITRO ou d’autres StyleBooks est requise pour écrire un StyleBook. Il s’agit d’une section obligatoire.
- Paramètres : Cette section vous permet de définir les paramètres dont vous avez besoin dans votre StyleBook pour créer une configuration. Il décrit l’entrée que votre StyleBook prend. Il s’agit d’une section facultative.
-
Composants : Cette section vous permet de définir les entités (objets de configuration) créées par le StyleBook pour une configuration spécifique. Cette section est considérée comme le cœur d’un StyleBook. Les composants utilisent généralement l’entrée fournie dans la section des paramètres pour adapter la configuration générée par le StyleBook. Il s’agit d’une section facultative.
Un StyleBook peut avoir une section de paramètres, une section de composants, ou les deux. Un StyleBook contenant uniquement la section des paramètres est utile pour définir une liste de paramètres pouvant être utilisés par d’autres StyleBooks. Cela favorise la réutilisation des groupes de paramètres dans un ensemble de StyleBooks. Un StyleBook avec uniquement une section de composants peut être utilisé lorsque vous souhaitez spécifier les valeurs des attributs du StyleBook au lieu de définir des paramètres pour prendre en compte les entrées de l’utilisateur. - Sorties : tandis que la section des paramètres définit les entrées du StyleBook, cette section facultative définit ses sorties. Dans cette section de sorties facultatives, vous pouvez spécifier les composants que vous souhaitez exposer aux utilisateurs qui créent une configuration à partir de ce StyleBook et aux autres StyleBooks qui importent ce StyleBook. Les utilisateurs et les StyleBooks qui importent peuvent ensuite référencer les propriétés des composants exposés.
- Opérations: un StyleBook peut contenir une section facultative permettant d’activer Analytics dans la console NetScaler sur tout serveur virtuel faisant partie du StyleBook.
La figure suivante montre un contour simple d’un StyleBook.
Les exemples suivants vous aident à connaître la grammaire et la structure d’un StyleBook et à écrire des StyleBooks avec des niveaux de complexité croissants.