Créer et utiliser des StyleBooks personnalisés

Vous pouvez écrire votre propre StyleBook pour votre déploiement, l’importer dans Citrix 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 renseignements suivants :

Avant de commencer

Avant de commencer à créer StyleBooks, assurez-vous d’avoir connaissance des éléments suivants :

Les fichiers StyleBook utilisent le format YAML. Pour plus d’informations sur le format YAML, reportez-vous à la section Syntaxe YAML.

Voici une liste des instructions YAML dont vous devez tenir compte lors de la création de StyleBooks :

  • YAML est sensible à la casse.
  • YAML nécessite une indentation appropriée
  • Utilisez la touche <spacebar> pour créer une indentation appropriée. N’utilisez pas la clé <tab>. L’utilisation de la clé <tab> crée une erreur de compilation lors de l’importation de votre StyleBook vers MA Service.
  • N’utilisez pas de chaînes entre guillemets. Inclure 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.
  • Des littéraux comme 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 booléens, et sont équivalents à true et false respectivement. 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 Citrix ADM, il est recommandé de valider 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.

Lors de la configuration de StyleBooks, vous ne pouvez utiliser que les ressources Nitro Configuration qui prennent en charge les opérations de création et de suppression (méthodes POST et DELETE HTTP). Pour de plus amples informations, consultez la section Documentation des API Nitro.

Anatomie d’un styleBook

Pour écrire StyleBooks, vous devez comprendre la grammaire, la syntaxe et la structure de 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 ce qu’il fait. Il s’agit d’une section obligatoire.
  • Importer StyleBooks : cette section vous permet de déclarer les autres StyleBook auxquels vous souhaitez faire référence à partir de votre StyleBook actuel. L’importation de la configuration Citrix ADC NITRO StyleBooks 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. Il décrit l’entrée prise par votre StyleBook. 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 contenant 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 l’entrée de l’utilisateur.
  • Sorties : alors que la section 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 à d’autres StyleBooks qui importent ce StyleBook. Les utilisateurs et l’importation de StyleBooks 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 Citrix ADM sur n’importe quel serveur virtuel faisant partie du StyleBook.

La figure suivante montre un contour simple d’un StyleBook.

image localisée

Les exemples suivants vous aident à en apprendre davantage sur la grammaire et la structure d’un StyleBook et à écrire des StyleBooks avec des niveaux de complexité croissants.

Créer et utiliser des StyleBooks personnalisés