Configuration de StyleBook

Créer et modifier un pack de configuration

Dans la console NetScaler, vous pouvez créer un pack de configuration à partir d’un StyleBook. Le pack de configuration est lié au StyleBook à partir duquel il est créé. Toutes les mises à jour du pack de configuration sont effectuées via le StyleBook auquel il est lié.

Créer un pack de configuration

Pour créer un pack de configuration à partir d’un StyleBook, procédez comme suit :

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

  2. Cliquez sur Ajouter.

  3. Dans Choisir des StyleBooks, sélectionnez les StyleBooks requis à partir desquels vous souhaitez créer un pack de configuration.

    Cette page classe les StyleBooks en StyleBooks par défaut, professionnels et personnalisés. Sélectionnez les onglets respectifs pour trouver les StyleBooks requis.

  4. Facultatif, spécifiez une clé de configuration unique pour votre pack de configuration. Cette clé apparaît en tant que clé d’affichage pour ce pack de configuration.

    • Si vous spécifiez une clé de configuration existante, NetScaler Console ne peut pas créer le pack de configuration.

    • Si vous ne spécifiez pas de clé de configuration , NetScaler Console attribue automatiquement l’ID Configpack. Toutefois, cette valeur n’apparaît pas sous forme de clé d’affichage.

    • Si vous ne spécifiez pas de clé de configuration et que l’un des paramètres StyleBook a défini l’attribut key, cette valeur de paramètre apparaît sous la forme de clé d’affichage. Pour plus d’informations, voir Paramètres.

  5. Spécifiez les détails requis, tels que le nom de l’application, l’adresse IP, le port ou le type de protocole.

    Les champs de l’interface graphique diffèrent d’un StyleBook à un autre StyleBook.

  6. Dans Instances cibles, sélectionnez les instances ou les groupes d’instances dans lesquels vous souhaitez exécuter la configuration.

    Remarque :

    Vous pouvez déployer la configuration sur plusieurs NetScaler, en spécifiant autant d’instances cibles que nécessaire.

  7. Cliquez sur Exécuter à sec.

    La page Objets affiche les objets qui sont créés, modifiés ou supprimés des instances NetScaler.

  8. Cliquez sur Créer.

    Le pack de configuration apparaît dans la page StyleBook > Configurations.

Si vous souhaitez modifier les packs de configuration existants, sélectionnez-le et cliquez sur Modifier .

Modifier le StyleBook d’un pack de configuration

Parfois, vous devez mettre à jour le StyleBook pour ajouter des fonctionnalités ou résoudre un problème. Si vous avez déjà créé des packs de configuration à l’aide de l’ancien StyleBook, vous souhaiterez peut-être les mettre à jour pour utiliser le nouveau StyleBook mis à jour. Pour utiliser un nouveau StyleBook, modifiez le StyleBook existant du pack de configuration.

Prenons un exemple de StyleBook example-lb qui déploie une configuration d’équilibrage de charge de base sur une instance NetScaler. Et, vous créez un pack de configuration CP1 à partir de ce StyleBook.

Pour configurer les moniteurs avec la configuration de base de l’équilibreur de charge, vous avez besoin d’un nouveau StyleBook. Pour ce faire, créez un exemple de StyleBook lb-mon qui inclut la possibilité de configurer des moniteurs ainsi que la configuration de base de l’équilibreur de charge.

Après avoir créé un StyleBook, mettez à jour le pack de configuration CP1 existant pour ajouter des moniteurs. Pour mettre à jour le pack de configuration, procédez comme suit :

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

  2. Sélectionnez le pack de configuration pour lequel vous souhaitez modifier le StyleBook.

    Dans cet exemple, sélectionnez CP1 dans la liste.

  3. Cliquez sur Modifier le livre de style.

  4. Sélectionnez le StyleBook requis dans la liste. Cliquez ensuite sur Enregistrer la sélection.

  5. Cliquez sur Change.

    Dans cet exemple, sélectionnez exemple-lb-mon dans la liste.

    Lorsque vous modifiez le StyleBook d’un pack de configuration, les paramètres du nouveau StyleBook peuvent avoir une structure différente de celle du StyleBook existant. Si la structure des paramètres est similaire à la précédente StyleBook, les valeurs des paramètres sont automatiquement conservées dans leurs champs respectifs. Sinon, seuls les paramètres ayant la même structure entre les deux StyleBooks sont transférés. Par exemple, le même nom de paramètre, le même type, le même paramètre parent, et plus encore.

    Remarque :

    La page de compatibilité de StyleBook affiche les différences entre les paramètres. Cette page vous aide à décider si vous souhaitez modifier le StyleBook ou continuer avec le StyleBook existant. Si vous souhaitez modifier le StyleBook, passez en revue les modifications, puis cliquez sur Suivant.

    Si de nouveaux paramètres sont ajoutés dans le nouveau StyleBook, après avoir modifié le StyleBook, vous devez spécifier manuellement les valeurs de ces paramètres.

    Dans cet exemple, les paramètres qui apparaissent sur la page de configuration de l’ example-lb StyleBook sont les suivants :

    Exemple de pack de configuration d'équilibrage de charge

    Les paramètres qui apparaissent sur la page de configuration du nouveau styleBook example-lb-mon sont les suivants :

    Exemple de paramètres après la migration du pack de configuration

    Dans ce cas, le StyleBooks conserve les anciennes valeurs pour la configuration de base de l’équilibreur de charge car le nouveau StyleBook n’a pas modifié les paramètres existants. Et, il ajoute seulement les nouveaux paramètres. Pour les paramètres du moniteur, spécifiez manuellement les valeurs requises.

  6. Dans les instances cibles, passez en revue les instances sélectionnées et mettez à jour la liste si nécessaire.

  7. Cliquez sur Exécuter à sec.

    La page Objets affiche les objets qui sont créés, modifiés ou supprimés des instances NetScaler.

  8. Cliquez sur OK.

    Dans la page StyleBook > Configurations, la colonne Nom du livre StyleBook affiche le nouveau nom de StyleBook pour le pack de configuration sélectionné. Dans ce cas, il affiche exemple-lb-mon.

Modifier le StyleBook qui contient plusieurs packs de configuration

Lorsque vous souhaitez modifier un StyleBook existant contenant plusieurs packs de configuration, procédez comme suit :

  1. Importez un nouveau StyleBook dans la console NetScaler.

    Généralement, le nouveau StyleBook a le même nom et l’espace de noms avec une version supérieure à celle du StyleBook existant. Toutefois, vous pouvez ignorer cette étape si le nom, l’espace de noms ou la version sont différents.

  2. Modifiez le StyleBook pour les packs de configuration associés au StyleBook existant.

    Vous pouvez sélectionner Modifier le StyleBook uniquement lorsque les packs de configuration sélectionnés sont associés au même StyleBook.

    Pour les packs de configuration sélectionnés, la console NetScaler modifie correctement le StyleBook lorsque les conditions suivantes sont remplies :

    • Tous les paramètres de configuration du StyleBook existant doivent être présents dans le StyleBook sélectionné.

    • Les nouveaux paramètres du StyleBook sélectionné sont facultatifs.

    Pour voir la progression des packs de configuration sélectionnés, sélectionnez Configurations en cours/Échec sur la page Configurations.

  3. Supprimez l’ancien StyleBook de la console NetScaler une fois que tous les packs de configuration sont liés au nouveau StyleBook.

Exporter ou importer des packs de configuration

Vous pouvez exporter ou importer un pack de configuration tel que StyleBooks. Grâce à cette fonctionnalité, vous pouvez facilement partager la configuration de StyleBook avec un autre serveur NetScaler Console. Lorsque vous exportez un pack de configuration, un tgz ou zip bundle se télécharge sur votre ordinateur local. Ce bundle inclut un fichier JSON avec tous les paramètres définis dans un pack de configuration.

Exporter la configuration

Pour exporter un pack de configuration, procédez comme suit :

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

  2. Sélectionnez un pack de configuration que vous souhaitez exporter.

  3. Dans Sélectionner une action, sélectionnez Exporter la configuration.

    Option de configuration d'exportation

  4. Dans le volet Configuration d’exportation, spécifiez les éléments suivants :

    • Informations sur l’instance cible sur laquelle la configuration est déployée : sélectionnez cette option pour inclure les informations des instances cibles dans le bundle d’exportation.

    • StyleBook associé à Configuration : sélectionnez cette option pour inclure le StyleBook dans l’offre groupée d’exportation.

    • phrase secrète pour protéger les données de configuration d’exportation : spécifiez une phrase secrète pour chiffrer le bundle d’exportation. Cette phrase secrète sécurise les données sensibles d’un pack de configuration.

    • Compresser le type de fichier : sélectionnez le type de fichier ZIP ou TGZ .

    Exporter le pack de configuration

  5. Cliquez sur Exporter.

    Enregistrez l’offre groupée d’exportation sur votre ordinateur local.

Configuration de l’importation

Vous pouvez importer un pack de configuration depuis votre ordinateur local vers un autre serveur NetScaler Console. Pour importer un pack de configuration, procédez comme suit :

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

  2. Sélectionnez Importer la configuration.

  3. Choisissez le lot de fichiers d’importation à partir de votre ordinateur.

  4. Utilisez la phrase secrète que vous avez spécifiée lors de l’exportation.

  5. Facultatif, dans Options avancées, sélectionnez Autoriser la création d’une nouvelle configuration uniquement si tous les objets de configuration existent déjà sur NetScaler.

    Cette option ne modifie pas les objets déjà créés sur l’instance NetScaler.

    Supposons que vous avez ajouté la même instance NetScaler sur deux serveurs NetScaler Console. Vous souhaitez également migrer un pack de configuration d’un serveur NetScaler Console vers un autre serveur. Utilisez cette option pour importer un pack de configuration sans modifier ses objets de configuration sur une instance NetScaler.

    Important :

    Pour utiliser cette option, assurez-vous que le bundle de configuration spécifié contient les informations relatives aux instances cibles. Consultez la section Configuration de l’exportation.

    Cette option migre la configuration uniquement si tous les objets sont présents sur l’instance cible.

  6. Cliquez sur Importer.

Configuration de l'importation

Lorsque vous importez un pack de configuration, la console NetScaler vérifie les éléments suivants :

  • StyleBookassocié : si le StyleBook associé ne se trouve pas dans la console NetScaler, il importe le StyleBook avec le pack de configuration.

  • Instances cibles : recherchez les instances cibles et déploie la configuration sur les instances cibles spécifiées. Si les instances NetScaler mentionnées sont absentes de la console NetScaler, le pack de configuration est importé sans les instances cibles.

  • ConsoleNetScaler source : si vous importez un pack de configuration sur le même serveur NetScaler Console, le bundle sélectionné met à jour le pack de configuration existant.

Enregistrer un pack de configuration en tant que projet

L’option Enregistrer en tant que projet des packs de configuration vous permet d’enregistrer vos modifications de configuration en tant que projets. Cette fonctionnalité enregistre les modifications sans les déployer immédiatement sur une instance NetScaler.

Pour enregistrer un pack de configuration en tant que projet, procédez comme suit :

  1. Accédez à Applications > Configuration > Config Packs.
  2. Sur la page Configurations, cliquez sur Ajouter.
  3. Sélectionnez le stylebook de votre choix et cliquez sur Sélectionner.
  4. Sur la page Créer une configuration, cliquez sur Enregistrer en tant que projet.

Enregistrer en tant que projet

Une fois le pack de configuration enregistré en tant que projet, vos modifications de configuration ne sont pas déployées directement sur l’instance NetScaler. Au lieu de cela, les packs de configuration sont stockés sous forme de projets dans l’onglet Projets de configuration sous Configurations en attente.

Dans l’onglet Projets de configuration, sélectionnez le pack de configuration pour effectuer les opérations suivantes :

  • Modifier la configuration du projet.
  • Déployer la configuration sur une instance NetScaler.
  • Supprimer le projet.

Projets de configurations

Vous pouvez également planifier le déploiement de vos projets enregistrés.

Pour plus d’informations, consultez Créer un calendrier pour un pack de configuration.

Créer un calendrier de déploiement de pack de configuration

Lorsque vous créez un pack de configuration, celui-ci est automatiquement déployé sur une instance NetScaler par défaut. Grâce à cette fonctionnalité, vous pouvez planifier le déploiement des packs de configuration.

Pour créer un calendrier pour un pack de configuration, procédez comme suit :

  1. Accédez à Applications > Configuration > Config Packs.
  2. Sur la page Configurations, cliquez sur Ajouter.
  3. Sélectionnez le StyleBook et cliquez sur Sélectionner.
  4. Sur la page Créer une configuration, sous Exécution, sélectionnez Plus tard dans la liste des modes d’exécution.
  5. Sélectionnez l’heure et la date souhaitées pour la planification et cliquez sur Soumettre.

Mode d'exécution

Toutes les configurations planifiées sont stockées dans l’onglet Configurations planifiées sous Configurations en attente. Vous pouvez sélectionner le calendrier créé pour modifier les paramètres de configuration, déployer ou annuler le calendrier.

Remarque :

Le déploiement d’un pack de configuration planifié annule la planification et exécute immédiatement la configuration.

Configuration planifiée

Pour un pack de configuration déployé

Vous pouvez également créer un calendrier afin de modifier et de supprimer un pack de configuration déployé.

Planifier une opération de modification pour un pack de configuration

Pour créer un calendrier afin de modifier le pack de configuration déployé, procédez comme suit :

  1. Accédez à Applications > Configuration > Config Packs.
  2. Sur la page Configurations, sélectionnez un StyleBook et cliquez sur Modifier.
  3. Sur la page Modifier la configuration, modifiez le pack de configuration.
  4. Dans la liste Mode d’exécution, sélectionnez Plus tard.
  5. Sélectionnez l’heure et la date souhaitées pour la planification et cliquez sur Soumettre.

Planifier une opération de suppression pour un pack de configuration

Pour créer un calendrier de suppression du pack de configuration déployé, procédez comme suit :

  1. Accédez à Applications > Configuration > Config Packs.
  2. Sur la page Configurations, sélectionnez un StyleBook et cliquez sur Supprimer.
  3. Dans la liste Mode d’exécution, sélectionnez Plus tard.
  4. Sélectionnez l’heure et la date souhaitées pour la planification et cliquez sur OK.

Supprimer le calendrier du pack de configuration

Détacher une instance cible d’un pack de configuration

Pour détacher une instance cible d’un pack de configuration, procédez comme suit :

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

  2. Sélectionnez le pack de configuration contenant une instance cible que vous souhaitez supprimer.

  3. Dans Sélectionner une action, sélectionnez Détacher les cibles.

  4. Dans le volet Détacher les cibles, sélectionnez l’instance cible que vous souhaitez supprimer du pack de configuration.

    Détacher les cibles

  5. Cliquez sur OK.

Un message s’affiche, confirmant la création d’un pack de configuration dupliqué, l’instance cible étant désormais supprimée.

Créez vos StyleBooks

Le contenu complet de example-lb StyleBook est fourni à titre de référence comme suit :

name: example-lb
namespace: examples.stylebooks
version: "1.0"
display-name: Basic Load Balancer App
description: This is an example StyleBook that creates a load balancer application
schema-version: "1.0"
import-stylebooks:
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
parameters-default-sources:
  - stlb::lb
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters
<!--NeedCopy-->

Le contenu complet de example-lb-mon StyleBook est fourni à titre de référence comme suit :

name: example-lb-mon
namespace: examples.stylebooks
version: "1.0"
description: This is an example StyleBook that creates a load balancer application with monitors
display-name: Basic Load Balancer App with Monitors
schema-version: "1.0"
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"
  -
    namespace: com.citrix.adc.stylebooks
    prefix: stlb
    version: "1.0"
  -
    namespace: com.citrix.adc.commontypes
    prefix: cmtypes
    version: "1.0"
parameters-default-sources:
  - stlb::lb
parameters:
  -
    name: monitors
    label: "List of Monitors"
    description: "List of Monitors to monitor Application Servers"
    type: cmtypes::monitor[]
substitutions:
  mon-name(appname, monname): $appname + "-mon-" + $monname
components:
  -
    name: lb-comp
    type: stlb::lb
    description: Uses the default lb StyleBook to build the typical lb configuration objects
    properties-default-sources:
      - $parameters
  -
    name: monitors-comp
    type: cmtypes::monitor
    condition: $parameters.monitors
    repeat: $parameters.monitors
    repeat-item: mon
    repeat-index: ndx
    description: Builds a list of NetScaler monitor objects and binds them to the servicegroup of this LB config
    properties-default-sources:
      - $mon
    properties:
        monitorname: $substitutions.mon-name($parameters.lb-appname, $mon.monitorname)
    components:
      -
        name: monitor-svcg-binding-comp
        condition:  $parameters.svc-servers
        type: ns::servicegroup_lbmonitor_binding
        properties:
          servicegroupname: $components.lb-comp.outputs.servicegroup.properties.servicegroupname
          monitor_name: $parent.properties.monitorname
<!--NeedCopy-->
Créer et modifier un pack de configuration