Configuration de StyleBook

Catégories de StyleBook

Dans la console NetScaler, il existe deux catégories de StyleBook : par défaut et personnalisé, qui peuvent être publiques ou privées. La console NetScaler vous permet de visualiser tous les StyleBooks présents dans le système et la manière dont ils sont connectés les uns aux autres.

Ce document explique les différents types de StyleBooks et les actions suivantes que vous pouvez effectuer sur les StyleBooks à partir de la console NetScaler :

  • Téléchargez un StyleBook personnalisé et apportez des modifications, ou créez un StyleBook basé sur un livre existant.
  • Masquer les StyleBooks par défaut de la console NetScaler.
  • Supprimez un StyleBook personnalisé de la console NetScaler.
  • Ajoutez des balises aux StyleBooks.

StyleBooks personnalisés et par défaut

  • Les StyleBookspar défaut sont les StyleBooks fournis avec la console NetScaler. Ils vous permettent de créer des configurations que vous pouvez déployer sur vos instances NetScaler. Vous ne pouvez pas supprimer les StyleBooks par défaut, mais vous pouvez les masquer dans l’interface graphique de la console NetScaler.
  • Les StyleBookspersonnalisés sont vos propres StyleBooks que vous avez importés dans NetScaler Console.

Les StyleBooks par défaut et personnalisés peuvent être publics ou privés.

StyleBooks publics et privés

Les StyleBooks à partir desquels vous pouvez créer des packs de configuration peuvent être classés dans la catégorie des StyleBooks publics . En d’autres termes, ils sont tous disponibles pour que vous puissiez les utiliser directement pour créer des configurations à partir de l’interface graphique et des API de la console NetScaler.

Mais certains StyleBooks sont utilisés comme blocs de construction pour d’autres StyleBooks. De tels StyleBooks sont marqués comme privés. Les StyleBooks privés ne peuvent pas être utilisés directement pour créer des packs de configuration à partir de l’interface graphique de la console NetScaler. Cependant, vous pouvez toujours afficher et visualiser ces StyleBooks sur la console NetScaler. Pour marquer l’un de vos StyleBooks personnalisés comme privé, définissez l’attribut private dans le StyleBook sur true. Vous pouvez toujours utiliser des StyleBooks privés pour créer des packs de configuration à l’aide des API de la console NetScaler.

Exemple d’un StyleBook marqué comme privé

name: basic-lb-config
namespace: com.example.stylebooks
version: "0.1"
display-name: Load Balancing Configuration
description: |
    This StyleBook defines a simple load balancing configuration and is a building block to build other load balancing configurations.
schema-version: "1.0"
private: true
<!--NeedCopy-->

Voir StyleBooks

Le nombre de StyleBooks (par défaut et privés) augmente dans NetScaler Console. Vous pouvez rechercher le StyleBook particulier auquel vous souhaitez accéder. Vous pouvez également afficher les deux types de StyleBooks séparément.

Dans la console NetScaler, lorsque vous accédez à Applications > Configuration StyleBooks, vous pouvez afficher la liste des StyleBooks présents dans le système.

Un StyleBook public par défaut comporte l’icône suivante dans son panneau :

StyleBooks publics par défaut

Alors qu’un StyleBook privé par défaut possède une icône qui le déclare en tant que StyleBook privé :

Icône privée

Bien que vous puissiez consulter la définition et les dépendances d’un StyleBook privé, vous ne pouvez pas créer de pack de configuration à partir d’un StyleBook privé à l’aide de l’interface graphique. Le but principal d’un StyleBook privé est de l’utiliser comme bloc de construction pour un autre StyleBook. L’utilisation de Building-blocks-Stylebooks encourage la réutilisation des modèles de configuration courants.

Un StyleBook public personnalisé a une icône différente, comme indiqué dans l’image suivante :

Icône publique par défaut

Alors qu’un StyleBook privé personnalisé apparaît avec cette icône :

Icône privée par défaut

En haut à droite de la page, vous pouvez voir une option permettant de sélectionner le type de StyleBooks à afficher. Il y a trois options - toutes, publiques ou privées StyleBooks. Cliquez sur l’une des options.

Filtrer les StyleBooks par public et privé

Vous pouvez également rechercher un StyleBook particulier en cliquant sur l’icône de recherche. Vous pouvez effectuer une recherche par nom, espace de noms et attributs de version ou une combinaison de ces options. L’opération de recherche n’est pas sensible à la casse.

Rechercher des livres stylebooks

Télécharger des StyleBooks personnalisés

Pour télécharger les StyleBooks personnalisés depuis la console NetScaler, accédez à Applications > Configuration Confg Packs. Dans la liste des StyleBooks affichés dans le panneau de droite, cochez l’option permettant de télécharger les StyleBooks personnalisés. Cliquez sur Download (Télécharger). Si le StyleBook a des StyleBooks personnalisés dépendants, vous pouvez inclure les StyleBooks dépendants dans le bundle téléchargé.

Remarque

Vous pouvez télécharger des StyleBooks personnalisés marqués comme publics ou privés.

Télécharger StyleBooks

Remarque

Vous ne pouvez pas télécharger les StyleBooks par défaut de la console NetScaler. Vous pouvez afficher leurs définitions et dépendances. Pour ce faire, cliquez sur les liensAfficher la définitionet Afficher les dépendances dans le panneau StyleBook.

Mettre à jour le StyleBook personnalisé

Vous pouvez mettre à jour les définitions personnalisées de StyleBook à partir de l’interface graphique de la console NetScaler elle-même. Ainsi, vous pouvez modifier le StyleBook sans changer sa version. Vous pouvez également mettre à jour les définitions importées depuis un bundle StyleBook.

Important

Avant de mettre à jour la définition de StyleBook à partir de l’interface graphique de la console NetScaler, assurez-vous que la définition de StyleBook ne possède aucun StyleBooks dépendant.

Vous pouvez mettre à jour une définition de StyleBook contenant des packs de configuration. Assurez-vous que la définition du StyleBook est rétrocompatible. Ainsi, tous les paramètres sont conservés dans le StyleBook mis à jour et les paramètres nouvellement ajoutés apparaissent comme facultatifs.

  1. Accédez à Applications > Configuration > StyleBooks.

  2. Sélectionnez l’onglet StyleBooks personnalisés.

  3. Sélectionnez Mettre à jour la définition dans le StyleBook que vous souhaitez mettre à jour.

  4. Mettez à jour la définition selon les besoins et cliquez sur Mettre à jour.

    Mettre à jour le StyleBook personnalisé

  5. Actualisez la page pour afficher les dernières modifications.

Supprimer des StyleBooks personnalisés

Vous pouvez également supprimer un StyleBook personnalisé en cliquant sur le bouton Supprimer. Une fenêtre contextuelle vous invite à confirmer si vous souhaitez supprimer le StyleBook de la console NetScaler. Si le StyleBook utilise d’autres StyleBooks personnalisés, vous pouvez choisir de supprimer ces StyleBooks en cochant la case.

Supprimer les StyleBooks

Remarque :

Ne supprimez pas un StyleBook personnalisé s’il possède des StyleBooks dépendants dans la NetScaler Console. Cette action peut endommager les StyleBooks existants.

Afficher les dépendances StyleBook

Une caractéristique importante et puissante de StyleBooks est qu’ils peuvent être utilisés comme blocs de construction pour d’autres StyleBooks.

Vous pouvez :

  • Importer un StyleBook dans un autre StyleBook - Un StyleBook importé est déclaré en tant que type et est utilisé par les composants ou les paramètres du second StyleBook. Consultez les StyleBooks par défaut existants dans la console NetScaler pour découvrir comment créer un StyleBook par-dessus un autre StyleBook.

  • Afficher un affichage graphique de la façon dont les StyleBooks sont connectés les uns aux autres - Cette représentation est utile pour les StyleBooks complexes qui sont créés à l’aide d’autres StyleBooks comme éléments de construction. Le graphique des dépendances vous permet de voir les relations et les dépendances entre les StyleBooks.

Remarque :

Vous ne pouvez pas supprimer un StyleBook utilisé par d’autres StyleBooks car cette action peut endommager les StyleBooks existants. Utilisez l’affichage du graphique de dépendance pour identifier les StyleBooks qui empêchent la suppression d’un StyleBook.

Pour afficher les dépendances de StyleBook

Dans la console NetScaler, accédez à Applications > Configuration > StyleBooks. La page StyleBooks affiche tous les StyleBooks disponibles pour votre utilisation dans NetScaler Console. Faites défiler vers le bas et trouvez votre StyleBook. Cliquez sur Afficher les dépendances pour afficher les StyleBooks dépendants.

Dépendances directes

L’onglet Forward Dependencies vous permet de visualiser les différents StyleBooks par défaut que votre StyleBook utilise. Suivez les flèches pour trouver le StyleBook utilisé par un StyleBook. Lorsque vous pointez votre souris sur l’une des flèches, la flèche et les StyleBooks connectés les uns aux autres sont surlignés. Vous pouvez également cliquer sur un StyleBook pour afficher la définition de ce StyleBook.

Dépendances directes

Dépendances inversées

L’onglet Dépendances inversées vous permet d’afficher graphiquement les StyleBooks qui utilisent votre StyleBook. Si vous suivez les flèches, vous pouvez voir que tous les StyleBooks dans l’affichage pointent vers votre StyleBook. Certains StyleBooks utilisent directement le StyleBook et certains StyleBook peuvent l’utiliser via un autre StyleBook.

Dépendances inversées

Vérifiez la configuration de NetScaler par rapport aux packs de configuration

Vous pouvez comparer les modifications apportées par un pack de configuration StyleBook à la configuration NetScaler actuelle. Avec cette comparaison, vous pouvez effectuer les opérations suivantes :

  • Détectez la dérive de configuration entre le pack de configuration StyleBook et la configuration NetScaler.

  • Identifiez tous les objets modifiés et supprimés du NetScaler qui n’affichent pas les modifications apportées par le pack de configuration.

Pour comparer les modifications du pack de configuration à la configuration de l’instance NetScaler, procédez comme suit :

  1. Accédez à Applications > Configuration > Config Packs.

  2. Cliquez sur Audit de configuration.

    La page Audit de configuration affiche les objets créés et audités.

    Auditer la configuration de NetScaler par rapport au pack de configuration

Remarque :

lors de la mise à jour d’un pack de configuration StyleBook déployé sur une instance NetScaler, il peut présenter des différences par rapport à son état déployé. Et la mise à jour du pack de configuration échoue. Le moteur StyleBook réconcilie automatiquement ces différences et met à jour le pack de configuration.

Téléchargez le pack de support d’un pack de configuration

Le pack de support d’un pack de configuration permet à l’équipe de support technique de Citrix de visualiser, d’analyser et de résoudre les problèmes liés au pack de configuration. Pour télécharger le pack de support, procédez comme suit :

  1. Accédez à Applications > Configuration > Packs de configuration.

  2. Sélectionnez le pack de configuration dans lequel vous souhaitez télécharger le pack de support.

  3. Dans Select Action, cliquez sur Support Bundle.

    Vous pouvez compresser le bundle au format de fichier Zip ou TGZ.

  4. Facultatif, spécifiez la phrase secrète pour crypter le fichier de bundle.

  5. Cliquez sur Download (Télécharger).

Bundle de support

Créer une balise pour le StyleBook

Vous pouvez ajouter des balises à n’importe quel StyleBook dans NetScaler Console. Les balises sont des paires clé-valeur qui vous permettent de regrouper des StyleBooks à l’aide de critères différents. Vous pouvez utiliser ces balises lors de la recherche ou du filtrage de StyleBooks dans NetScaler Console.

Pour ajouter une balise au StyleBook :

  1. Accédez à Applications > Configuration > StyleBooks.

  2. Sélectionnez Balises dans le StyleBook pour lequel vous souhaitez ajouter des balises.

    Tags pour un StyleBook

    Vous pouvez ajouter des balises à tous les types de StyleBooks.

  3. Spécifiez les informations de clé et de valeur requises qui vous aident à filtrer le StyleBook.

    Par exemple, key=Team et Value=BizData

    Créer une balise pour un StyleBook

    Pour ajouter d’autres balises, cliquez sur +.

  4. Cliquez sur Créer.

Pour filtrer StyleBooks à l’aide de balises, cliquez sur Tags dans la barre de recherche et sélectionnez une clé et une valeur dans la liste. Les StyleBooks correspondant à la balise spécifiée sont affichés.

Comment utiliser les balises

Voici un exemple de recherche pour les StyleBooks qui ont une balise où key=team et value=bizdata :

Exemple pour une balise

Vous pouvez associer les balises StyleBook à son pack de configuration. Ainsi, vous pouvez rechercher les packs de configuration à l’aide des balises StyleBook elles-mêmes.

Lorsque vous créez un pack de configuration, utilisez l’une des options suivantes dans la section Tag Association :

  • Associer toutes les balises StyleBook présentes et futures à la configuration — Cette option associe toutes les balises StyleBook à un pack de configuration. Il veille également à associer les nouvelles balises que vous pourriez ajouter aux StyleBooks à l’avenir.

  • Sélectionner les balises  : cette option affiche les balises du StyleBook sélectionné. Vous pouvez sélectionner les balises StyleBook requises et les associer à un pack de configuration.

Associer les balises StyleBook à son pack de configuration

Cloner un StyleBook

En tant qu’administrateurs, vous pouvez créer une copie d’un StyleBook, ainsi que des StyleBooks qui en dépendent. Vous pouvez ensuite utiliser cet ensemble à des fins de personnalisation, telles que la mise à jour des sections parameters et components.

Pour cloner un StyleBook :

  1. Accédez à Applications > Configuration > StyleBooks.

  2. Sélectionnez Cloner sur le StyleBook par défaut ou personnalisé que vous souhaitez dupliquer.

    Cloner un StyleBook

  3. Sur la page Clone StyleBook , entrez un espace de noms et une version pour le StyleBook et les StyleBooks dépendants. Vous pouvez également choisir les espaces de noms et les versions suggérés.

    Cloner un StyleBook

    Remarque :

    Le StyleBook cloné et ses StyleBooks dépendants doivent avoir des espaces de noms et des versions différents pour les différencier des StyleBooks existants. Vous ne pouvez utiliser aucun espace de noms réservé de la console NetScaler pour les StyleBooks clonés.

  4. Cliquez sur Cloner. Le package StyleBook cloné est importé dans la console NetScaler et apparaît sur la page StyleBooks.