Citrix Application Delivery Management service

Créer et modifier un pack de configuration

Dans Citrix Application Delivery Management (ADM), vous pouvez créer un pack de configuration à partir d’un StyleBook. Et, le pack de configuration est lié au StyleBook à partir duquel il est créé. Les mises à jour du pack de configuration sont effectuées via le StyleBook auquel il est lié.

Créer un pack de configuration

Effectuez les opérations suivantes pour créer un pack de configuration à partir d’un StyleBook :

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

  2. Cliquez sur Add.

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

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

  4. 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.

  5. 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 Citrix ADC, en spécifiant autant d’instances cibles que nécessaire.

  6. Cliquez sur Exécuter à sec.

    La page Objets affiche les objets créés, modifiés ou supprimés des instances Citrix ADC.

  7. 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 pouvez 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 StyleBook example-lb qui déploie une configuration d’équilibrage de charge de base sur une instance ADC. Et, vous créez un pack de configuration CP1 à partir de ce StyleBook.

Lorsque vous souhaitez configurer des moniteurs avec la configuration de base de l’équilibrage de charge, vous avez besoin d’un nouveau StyleBook. Par conséquent, créez exemple-lb-mon StyleBook 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 existant CP1 pour ajouter des moniteurs. Pour ce faire, effectuez les opérations suivantes :

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

  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.

    Modifier le StyleBook d'un pack de configuration

    Si de nouveaux paramètres obligatoires 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, les StyleBooks conservent 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 créés, modifiés ou supprimés des instances Citrix ADC.

  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 comporte plusieurs packs de configuration

Lorsque vous modifiez un StyleBook existant qui a plusieurs packs de configuration, procédez comme suit :

  1. Importez un nouveau StyleBook dans ADM.

    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 livre de style uniquement lorsque les packs de configuration sélectionnés sont associés au même StyleBook.

    Sélectionnez les packs de configuration associés au même StyleBook

    Pour les packs de configuration sélectionnés, l’ADM 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 ou en échec dans la page Configurations.

    État de progression du pack de configuration

  3. Supprimez l’ancien StyleBook d’ADM 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. Avec cette fonctionnalité, vous pouvez facilement partager la configuration de StyleBook à un autre serveur ADM. 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 > StyleBooks > Configurations.

  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 d’importation

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

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

  2. Sélectionnez Importer la configuration.

    Option de configuration d'importation

  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 uniquement la création d’une nouvelle configuration si tous les objets de configuration existent déjà sur ADC.

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

    Considérez que vous avez ajouté la même instance ADC dans deux serveurs ADM. Et, vous souhaitez migrer un pack de configuration d’un serveur ADM vers un autre serveur. Utilisez cette option pour importer un pack de configuration sans modifier ses objets de configuration sur une instance ADC.

    Important

    Pour utiliser cette option, vérifiez que le groupe de configuration spécifié dispose des informations sur les instances cibles. Consultez Exporter la configuration.

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

  6. Cliquez sur Importer.

Configuration d'importation

Lorsque vous importez un pack de configuration, l’ADM vérifie les éléments suivants :

  • StyleBook associé : Si le StyleBook associé n’est pas dans l’ADM, 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 ADC mentionnées sont absentes dans l’ADM, le pack de configuration est importé sans instances cibles.

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

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

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 Citrix ADC 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
Créer et modifier un pack de configuration