Importer et synchroniser des StyleBooks depuis un référentiel externe
Imaginez un scénario où vous utilisez des processus CI/CD pour votre développement. Ou un scénario où vous gérez tout le code source de l’application et les artefacts de déploiement dans GitHub/GitLab.
Dans le référentiel GitHub/GitLab, vous pourriez maintenir plusieurs StyleBooks pour déployer les configurations NetScaler et gérer ces StyleBooks. Vous devez télécharger ces StyleBooks vers NetScaler Console. Grâce à cette fonctionnalité, vous pouvez importer directement vos StyleBooks présents dans GitHub/GitLab vers NetScaler Console. Vous n’avez pas besoin de les copier manuellement depuis GitHub/GitLab, puis de les télécharger vers NetScaler Console. Ou de synchroniser manuellement les fichiers entre NetScaler Console et GitHub/GitLab. De plus, vous pouvez importer et synchroniser des packs de configuration depuis GitHub/GitLab.
Pour importer des StyleBooks et des packs de configuration, définissez un référentiel dans NetScaler Console qui représente un référentiel GitHub/GitLab. Fournissez l’URL du référentiel GitHub/GitLab, votre nom d’utilisateur et le jeton API ou d’accès personnel (PA) créé dans GitHub/GitLab. Cela signifie que seuls les utilisateurs autorisés disposant d’un compte valide dans GitHub/GitLab peuvent importer et synchroniser des StyleBooks.
Vous pouvez importer et synchroniser les types de référentiels suivants :
- Référentiels accessibles publiquement - Les référentiels qui sont ouverts au public et peuvent être consultés via Internet.
- Référentiels GitLab/GitHub sur site ou privés - Les référentiels qui sont hébergés en privé et sont généralement accessibles uniquement au sein de l’intranet d’une entreprise. Pour ces référentiels, vous devez sélectionner un agent NetScaler pendant le processus d’enregistrement. L’agent NetScaler agit comme un proxy pour accéder aux référentiels au sein de l’intranet de l’entreprise.
Après avoir créé le référentiel, vous pouvez synchroniser votre référentiel GitHub/GitLab avec NetScaler Console. NetScaler Console se connecte à GitHub/GitLab 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 à NetScaler Console s’ils échouent à la validation. Vous pouvez identifier et corriger les erreurs sur vos StyleBooks. Ensuite, validez les versions mises à jour dans votre référentiel GitHub/GitLab. Plus tard, vous pourrez essayer de les importer ou de les synchroniser à nouveau dans NetScaler Console.
Si vous rencontrez l’erreur suivante lors de la création d’un référentiel, cela indique que NetScaler Console ne peut pas vérifier le certificat SSL du référentiel en raison d’un certificat d’autorité de certification (CA) manquant ou non reconnu :
certificate verify failed: unable to get local issuer certificate
Pour résoudre ce problème, vous pouvez ajouter manuellement le certificat CA requis à l’agent NetScaler Console utilisé pour accéder au référentiel. L’ajout du certificat CA requis garantit que les connexions sécurisées au référentiel externe sont correctement validées.
Connectez-vous à l’agent NetScaler Console utilisé pour accéder au référentiel et ajoutez votre certificat CA au bundle de certificats de confiance /var/mps/ca_certs/cacert.pem
.
Important
Les fichiers StyleBooks peuvent être importés et synchronisés depuis n’importe quelle branche d’un référentiel GitHub/GitLab.
Vous pouvez également importer et synchroniser des StyleBooks qui ont des StyleBooks dépendants associés. Ces StyleBooks dépendants peuvent se trouver dans le référentiel GitHub/GitLab ou être déjà présents dans NetScaler Console.
La synchronisation des StyleBooks depuis un référentiel GitHub/GitLab doit être initiée manuellement depuis l’interface graphique ou l’API de NetScaler Console. C’est-à-dire que, actuellement, l’importation et la synchronisation des StyleBooks ne se produisent pas automatiquement en fonction de votre activité de validation GitHub/GitLab.
Le fichier de pack de configuration que vous souhaitez importer doit être au format JSON. De plus, le contenu du fichier de configuration doit suivre le format de configuration exporté. Dans votre référentiel GitHub/GitLab, les fichiers associés au pack de configuration doivent se trouver dans le dossier
configpacks
.
Vous pouvez importer des fichiers StyleBook dans NetScaler Console depuis n’importe quel dossier du référentiel GitHub/GitLab. Pour importer des packs de configuration, procédez comme suit :
-
Créez un dossier nommé
configpacks
sous le répertoire racine. Assurez-vous que tous les fichiers associés aux configurations se trouvent dans ce dossier. -
Dans le dossier
configpacks
, créez un fichier JSON qui contient la charge utile pour le 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 ID ou un nom unique pour identifier un pack de configuration dans NetScaler Console. Si vous ne spécifiez pas deconfig_key
, NetScaler Console génère automatiquement l’ID lors de la création du pack de configuration.Si l’ID spécifié est trouvé dans l’interface graphique de NetScaler Console, l’action de synchronisation met à jour le pack de configuration dans l’interface graphique de NetScaler Console. Sinon, elle 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
- C’est une propriété obligatoire dans un fichier JSON. Elle contient un espace de noms, une version et le nom du StyleBook avec lequel vous souhaitez associer le pack de configuration.
-
-
Dans le dossier
configpacks
, conservez tous les fichiers associés au pack de configuration, tels que les certificats, les fichiers de signature et les fichiers XML.
Ajouter un référentiel
-
Dans NetScaler Console, accédez à Applications > Configuration > Référentiels. Cliquez sur Ajouter.
-
Dans la fenêtre Ajouter un référentiel, saisissez 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/GitLab ou un nom différent.
-
URL du référentiel - Saisissez l’URL du référentiel GitHub/GitLab.
Vous pouvez spécifier une URL d’entreprise GitHub/GitLab. Cela vous aide à importer ou synchroniser des StyleBooks et des packs de configuration depuis des comptes d’entreprise GitHub/GitLab.
-
Est-ce une URL privée ? - Si le référentiel est un référentiel GitLab/GitHub sur site ou privé, cochez cette case, puis sélectionnez un Agent.
-
Nom d’utilisateur - Saisissez le nom d’utilisateur que vous utilisez pour accéder au compte GitHub/GitLab ou au compte d’entreprise.
-
Jeton API/PA - Ce jeton est utilisé pour accéder à votre référentiel GitHub/GitLab. Pour plus d’informations sur la création de jetons API/PA pour votre référentiel GitHub/GitLab, consultez la documentation GitHub/GitLab sur la création de jetons d’accès personnels.
-
-
Cliquez sur Créer.
Le référentiel est créé dans NetScaler Console.
Options du référentiel
Voici les options supplémentaires pour vos référentiels :
-
Modifier - Vous pouvez modifier l’URL du référentiel, le nom d’utilisateur et le jeton 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 depuis ce référentiel GitHub/GitLab.
Remarque
Vous ne pouvez pas supprimer un référentiel de NetScaler Console s’il contient des StyleBooks auxquels des packs de configuration sont associés. Supprimez d’abord tous les packs de configuration de ces StyleBooks. Vous pourrez ensuite 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 NetScaler Console synchronisés depuis ce référentiel sans réellement supprimer l’entrée du référentiel.
-
Lister les fichiers - Vous pouvez voir une liste de tous les StyleBooks présents dans NetScaler Console qui proviennent du référentiel GitHub/GitLab.
Étapes pour importer des StyleBooks et des packs de configuration depuis GitHub/GitLab
Après avoir rempli les prérequis, suivez les étapes pour importer des StyleBooks et des packs de configuration depuis un référentiel GitHub/GitLab :
- Facultatif, ajoutez un référentiel si vous ne l’avez pas déjà fait.
- Sélectionnez le référentiel dans la page Référentiels.
- Cliquez sur Synchroniser.