Configuration de StyleBook

Importer et synchroniser les StyleBooks à partir du référentiel GitHub

Envisagez un scénario dans lequel vous utilisez des processus CI/CD pour votre développement. Ou un scénario dans lequel vous gérez l’ensemble du code source de l’application et des artefacts de déploiement dans GitHub.

Dans le référentiel GitHub, vous gérez peut-être plusieurs StyleBooks pour déployer les configurations NetScaler et gérer ces StyleBooks. Vous devez télécharger ces StyleBooks sur la console NetScaler. Grâce à cette fonctionnalité, vous pouvez importer directement vos StyleBooks présents dans GitHub dans NetScaler Console. Il n’est pas nécessaire de les copier manuellement depuis GitHub, puis de les charger dans la console NetScaler. Vous pouvez également synchroniser manuellement les fichiers dans la console NetScaler et sur GitHub. Vous pouvez également importer et synchroniser des packs de configuration depuis GitHub.

Pour importer des StyleBooks et des packs de configuration, définissez un référentiel dans la console NetScaler qui représente un référentiel GitHub. Fournissez l’URL du référentiel GitHub, votre nom d’utilisateur et votre jeton d’API créés dans GitHub. Cela signifie que seuls les utilisateurs autorisés disposant d’un compte valide dans GitHub peuvent importer et synchroniser les StyleBooks.

Après avoir créé le référentiel, vous pouvez synchroniser la console NetScaler avec votre référentiel GitHub. La console NetScaler se connecte à GitHub et importe les StyleBooks et les packs de configuration trouvés dans ce référentiel. NetScaler Console valide ensuite les StyleBooks et les ajoute à la liste des StyleBooks dans NetScaler Console. Les StyleBooks ne sont pas ajoutés à la console NetScaler en cas d’échec de validation. Vous pouvez identifier et corriger les erreurs sur vos StyleBooks. Ensuite, validez les versions mises à jour dans votre référentiel GitHub. Plus tard, vous pourrez essayer de les importer ou de les synchroniser à nouveau dans la console NetScaler.

Important

  • Les fichiers StyleBooks peuvent être importés et synchronisés depuis n’importe quelle branche d’un référentiel GitHub.

  • Vous pouvez également importer et synchroniser des StyleBooks auxquels des StyleBooks dépendants sont associés. Ces StyleBooks dépendants peuvent se trouver dans le référentiel Github ou déjà présents dans la console NetScaler.

  • La synchronisation de StyleBooks à partir d’un référentiel GitHub doit être lancée manuellement à partir de l’interface graphique ou de l’API de la console NetScaler. C’est-à-dire qu’actuellement, l’importation et la synchronisation de StyleBooks ne se font pas automatiquement en fonction de votre activité de validation sur GitHub.

  • Le fichier du pack de configuration que vous souhaitez importer doit être au format JSON. De plus, le contenu du fichier de configuration doit respecter le format de configuration exporté. Dans votre référentiel GitHub, les fichiers associés au pack de configuration doivent se trouver dans le configpacks dossier.

Vous pouvez importer des fichiers StyleBook dans la console NetScaler à partir de n’importe quel dossier du référentiel GitHub. Pour importer des packs de configuration, procédez comme suit :

  1. Créez un dossier avec un nom configpacks dans le répertoire racine. Assurez-vous que tous les fichiers associés aux configurations se trouvent dans ce dossier.

  2. Dans le configpacks dossier, créez un fichier JSON contenant la charge utile du pack de configuration. Cette charge utile est utilisée pour synchroniser les packs de configuration. Voici un exemple de charge utile :

    {
        "config_key": "unique-key-for-configpack",
    
        "parameters": {
            "param-name1": "param-value1",
            "param-name": "param-value2",
            "param-namen": "param-valuen"
        },
        "stylebook": {
            "namespace": "some namespace",
            "name": "somename",
            "version": "spme-version"
        }
    }
    <!--NeedCopy-->
    
    • config_key - Un identifiant ou un nom unique permettant d’identifier un pack de configuration dans la console NetScaler. Si vous ne spécifiez pas config_key, la console NetScaler génère automatiquement l’ID lors de la création du pack de configuration.

      Si l’ID spécifié se trouve dans l’interface graphique de la console NetScaler, l’action de synchronisation met à jour le pack de configuration dans l’interface graphique de la console NetScaler. Sinon, il crée un pack de configuration avec l’ID spécifié.

    • parameters - Il contient tous les paramètres nécessaires pour créer ou mettre à jour le pack de configuration.

    • stylebook - Il s’agit d’une propriété obligatoire dans un fichier JSON. Il contient un espace de noms, une version et un nom StyleBook auxquels vous souhaitez associer le pack de configuration.

  3. Dans le configpacks dossier, conservez tous les fichiers associés au pack de configuration, tels que les certificats, les fichiers de signature et les fichiers XML.

Ajouter un dépôt

  1. Dans la console NetScaler, accédez à Applications > Configuration Référentiels. Cliquez sur Ajouter.

  2. Dans la fenêtre Ajouter un référentiel, entrez les paramètres suivants :

    • Nom  : saisissez le nom du référentiel. Ce nom peut être le même que le nom du référentiel dans GitHub ou un autre.

    • URL du référentiel - Saisissez l’URL du référentiel GitHub.

      Vous pouvez spécifier une URL d’entreprise GitHub. Il vous permet d’importer ou de synchroniser des StyleBooks et des packs de configuration à partir de comptes d’entreprise GitHub.

    • Nom d’utilisateur  : saisissez le nom d’utilisateur que vous utilisez pour accéder au compte GitHub ou au compte d’entreprise.

    • API Token - Ce jeton est utilisé pour accéder à votre référentiel GitHub. Pour plus d’informations sur la création de jetons d’API pour votre référentiel GitHub, consultez la documentation GitHub relative à la création de jetons d’accès personnels.

    Ajouter un référentiel GitHub

  3. Cliquez sur Créer.

    Le référentiel est créé dans la console NetScaler.

Options du référentiel

Les options supplémentaires pour vos référentiels sont les suivantes :

  • Modifier  : vous pouvez modifier l’URL du référentiel, le nom d’utilisateur et le jeton d’API.

  • Supprimer: vous pouvez supprimer le référentiel ainsi que tous les StyleBooks présents dans NetScaler Console qui ont été importés précédemment à partir de ce référentiel GitHub.

    Remarque

    Vous ne pouvez pas supprimer un référentiel de la console NetScaler s’il contient des StyleBooks auxquels des packs de configuration sont associés. Tout d’abord, supprimez tous les packs de configuration de ces StyleBooks. Vous pouvez ultérieurement supprimer le référentiel de NetScaler Console pour nettoyer les StyleBooks de ce référentiel.

  • Réinitialiser- Vous pouvez supprimer tous les StyleBooks de la console NetScaler synchronisés à partir de ce référentiel sans supprimer réellement l’entrée du référentiel.

  • Liste des fichiers- Vous pouvez voir une liste de tous les StyleBooks présents dans la console NetScaler qui provient du référentiel GitHub.

Étapes pour importer des StyleBooks et des packs de configuration depuis GitHub

Une fois les prérequis remplis, suivez les étapes pour importer des StyleBooks et des packs de configuration à partir d’un référentiel GitHub :

  1. Facultatif, ajoutez un référentiel si vous ne l’avez pas encore ajouté.
  2. Sélectionnez le référentiel sur la page Référentiels .
  3. Cliquez sur Synchroniser.
Importer et synchroniser les StyleBooks à partir du référentiel GitHub