Créer et utiliser des StyleBooks personnalisés
Vous pouvez écrire votre propre StyleBook pour votre déploiement, l’importer dans NetScaler® Application Delivery Management (ADM) et créer des objets de configuration. Vous pouvez également utiliser l’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 d’avoir des connaissances sur 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 la syntaxe YAML.
Voici une liste de directives YAML dont vous devez tenir compte lors de la création de StyleBooks :
- YAML est sensible à la casse.
- YAML nécessite une indentation correcte.
- Utilisez la touche
<espace>pour créer une indentation correcte. N’utilisez pas la touche<tabulation>. L’utilisation de la touche<tabulation>génère une erreur de compilation lors de l’importation de votre StyleBook dans le service MA. - N’utilisez pas de chaînes de caractères entre guillemets. N’incluez la chaîne de caractères entre guillemets que si elle contient des signes de ponctuation (tirets, deux-points, etc.). Si vous souhaitez interpréter un nombre comme une chaîne de caractères, incluez le nombre entre guillemets ou utilisez la fonction intégrée
str()des 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 à vrai et faux respectivement. Pour les interpréter comme des chaînes de caractères, incluez-les entre guillemets. Par exemple :
- « YES »
- « No »
- « True »
- « False » et ainsi de suite.
Remarque
Avant d’importer votre fichier StyleBook dans NetScaler ADM, il est recommandé de vérifier s’il est conforme au format YAML. Citrix vous recommande d’utiliser le validateur YAML intégré aux StyleBooks pour valider et importer le contenu YAML.
Lors de la configuration des StyleBooks, vous ne pouvez utiliser que les ressources de configuration Nitro qui prennent en charge les opérations de création et de suppression (méthodes HTTP POST et DELETE). Pour plus d’informations, consultez la documentation des API Nitro.
Anatomie d’un StyleBook
La rédaction de StyleBooks nécessite une compréhension de la grammaire, de la syntaxe et de la structure des StyleBooks. Un StyleBook typique comporte les sections suivantes :
- En-tête : Cette section vous permet de définir l’identité d’un StyleBook et de décrire sa fonction. Il s’agit d’une section obligatoire.
- Importer des StyleBooks : Cette section vous permet de déclarer les autres StyleBooks auxquels vous souhaitez faire référence depuis votre StyleBook actuel. L’importation de StyleBooks de configuration NetScaler NITRO ou d’autres StyleBooks est nécessaire 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. Elle décrit les entrées que votre StyleBook accepte. 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 les entrées fournies 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 avec 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éutilisabilité des groupes de paramètres à travers un ensemble de StyleBooks. Un StyleBook avec uniquement une section de composants peut être utilisé lorsque vous souhaitez spécifier les valeurs des attributs dans le StyleBook au lieu de définir des paramètres pour prendre les entrées de l’utilisateur.
- Sorties : Alors 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 facultative, vous pouvez spécifier les composants que vous souhaitez exposer aux utilisateurs créant une configuration à partir de ce StyleBook et aux autres StyleBooks qui importent ce StyleBook. Les utilisateurs et les StyleBooks importateurs peuvent alors référencer les propriétés des composants exposés.
- Opérations : Un StyleBook peut contenir une section facultative pour activer l’analyse dans NetScaler ADM sur tout serveur virtuel faisant partie du StyleBook.
La figure suivante présente un aperçu simple d’un StyleBook.
Les exemples suivants vous aident à comprendre la grammaire et la structure d’un StyleBook, et à apprendre à écrire des StyleBooks avec des niveaux de complexité croissants.