Importer des StyleBooks personnalisés
Après avoir créé votre StyleBook, importez-le dans NetScaler ADM pour l'utiliser. NetScaler ADM vous permet d'importer un seul StyleBook au format YAML ou de nombreux fichiers StyleBook YAML sous forme de bundle dans un formulaire .zip, .tgz ou .gz. Le système NetScaler ADM valide vos StyleBooks lors de l'importation. Le StyleBook est maintenant prêt à être utilisé pour créer des configurations.
NetScaler ADM possède également un éditeur YAML intégré que vous pouvez utiliser pour composer le contenu YAML du StyleBook. L'éditeur YAML vous permet de valider vos constructions YAML à partir de l'interface graphique NetScaler ADM elle-même. Vous n'avez pas besoin d'utiliser un outil distinct pour ces vérifications de validation. Le contenu est validé par rapport aux normes YAML et tout écart est mis en évidence. Vous pouvez ensuite corriger le contenu et tenter d'importer le StyleBook dans NetScaler ADM. L'éditeur YAML intégré offre deux avantages lors de la rédaction de votre propre StyleBook.
- Code couleur. L'éditeur affiche le contenu du StyleBook analysé conformément aux directives YAML. Le code couleur vous permet de différencier facilement les clés des valeurs définies dans le contenu YAML.
- Validation YAML. Le contenu est validé pour détecter les erreurs YAML au fur et à mesure que vous le saisissez et tout écart est immédiatement mis en évidence. Cette validation vous permet de rédiger un texte conforme aux directives YAML avant même d'importer le StyleBook dans NetScaler ADM.
Remarque
Actuellement, l'éditeur valide le contenu conformément aux directives YAML. Il ne valide pas l'exactitude du code et les erreurs typographiques.
Utiliser des balises de formatage HTML dans la description et l'en-tête du StyleBook
Dans la définition du StyleBook, vous pouvez inclure un champ d'en-tête et utiliser des balises de mise en forme HTML pour le texte. Vous pouvez également inclure des images dans l'en-tête. Le contenu HTML du champ d'en-tête s'affiche en haut de la page de configuration lorsque vous créez ou mettez à jour une configuration. Cette fonctionnalité vous permet d'ajouter des infographies pour le StyleBook afin de vous aider à comprendre la configuration du StyleBook. Si vous utilisez des images dans l'en-tête, veillez à utiliser le format d'image codé en base64 dans la
<img> balise.
Pour utiliser des images dans votre contenu HTML, les images doivent être intégrées, comme indiqué dans l'exemple suivant. Vous pouvez utiliser des outils en ligne pour convertir vos images au format codé en base64.
name: cs-example namespace: com.example.stylebooks version: "1.2" display-name: Content Switching Configuration description: Example of a very simple content switching config that creates and binds an lb to a cs header: <img id="b64img" src="data:image/png;base64,…" /> <h3>Operations performed by this StyleBook:</h3> <ul> <li style="list-style-type: circle"> Creates a Server </li> <li style="list-style-type: circle"> Creates a Service Group </li> <li style="list-style-type: circle"> Creates a LBVServer </li> <li style="list-style-type: circle"> Creates a CS Policy and Action </li> </ul> schema-version: "1.0" <!--NeedCopy-->
Pour importer votre StyleBook
-
Dans NetScaler ADM, accédez àApplications>Configuration>StyleBooks, puis cliquez sur Importer un nouveau StyleBook.
-
Cliquez sur l'une des options suivantes pour importer un StyleBook.
-
Fichier : sélectionnez le fichier requis ou l'ensemble de fichiers à partir de votre stockage local.
Remarque
Dans cet exemple, importez le
lb-vserver.ymlStyleBook que vous avez créé dans StyleBook pour créer un serveur virtuel d'équilibrage de charge.
-
Bundle - NetScaler ADM vous permet d'importer de nombreux StyleBooks au format YAML. Vous pouvez importer plusieurs fichiers YAML StyleBook compressés au format zip (.zip) ou tarball (.tgz, .gz).
Un StyleBook importé dans NetScaler ADM s'affiche avec une icône par défaut sur l'interface graphique de StyleBooks. Vous pouvez personnaliser ces icônes par défaut avec vos propres images.
Pour ce faire :
- Créez un dossier nommé
resourcessous le dossier contenant vos fichiers YAML StyleBook.
- Téléchargez vos icônes
resourcesdans le dossier.
Remarque
Vous ne pouvez pas renommer le
resourcesdossier sous un autre nom.
- Si le fichier d'icône et le fichier StyleBook correspondant portent le même nom, l'icône est automatiquement mappée au StyleBook.
- Si le fichier d'icônes et le fichier StyleBook correspondant (par exemple, exchange.yaml et exch.png) ne correspondent pas, créez un fichier JSON nommé « icon_mapping.json » dans le
resourcesdossier comme suit :
<StyleBook file name> : <icon file name> <StyleBook file1 name> : <icon file1 name> <StyleBook file2 name> : <icon file2 name> <!--NeedCopy-->
Voici un exemple de pack StyleBook :
Le
resourcesdossier comporte les icônes requises.
Dans cet exemple,
sharepoint.yamlet
skype.yamlles fichiers sont automatiquement mappés à
sharepoint.jpeget
skype.pngrespectivement.
Pour
exchange.yamlmapper à
exch.png, spécifiez les éléments suivants dans le
icon_mapping.jsonfichier :
{ "exchange.yaml":"exch.png" } <!--NeedCopy-->
Si aucune icône n'est disponible dans le bundle StyleBook, l'icône par défaut s'affiche.
- Créez un dossier nommé
-
Raw - Composez le contenu de votre StyleBook dans l'éditeur YAML.
Vous pouvez valider le contenu du StyleBook pour vérifier les erreurs grammaticales du StyleBook. Pour valider le contenu du StyleBook, cliquez sur Valider le contenu.
Remarque
Lorsque vous composez un StyleBook, assurez-vous de connaître les concepts suivants :
- API NITRO
- YAML
Pour plus d'informations sur la façon d'écrire vos propres StyleBooks, consultez Comment créer vos propres StyleBooks.
Remarque
Vous pouvez également créer votre StyleBook dans votre éditeur préféré, puis copier et coller le contenu dans l'éditeur YAML pour validation et importation.
-
Référentiel de synchronisation : si vous créez et gérez vos StyleBooks dans GitHub, utilisez cette option pour que NetScaler ADM découvre des StyleBooks nouveaux ou mis à jour dans votre référentiel. Sélectionnez le référentiel que vous souhaitez synchroniser avec NetScaler ADM.
-
-
Facultatif, sélectionnez une icône pour un StyleBook.
Dans Applications > Configuration > StyleBooks, le StyleBook importé apparaît avec cette icône.
-
Cliquez sur Create.
NetScaler ADM valide désormais votre StyleBook pour toutes les erreurs syntaxiques et sémantiques conformément à la grammaire du StyleBook. Votre StyleBook n'est pas importé dans NetScaler ADM en cas d'erreur.
S'il n'y a aucune erreur, le StyleBook est correctement importé et répertorié sur la page StyleBooks . Vous pouvez identifier le StyleBook par le nom d'affichage que vous avez défini dans la section d'en-tête du StyleBook.
Remarque
Si vous importez un ensemble de fichiers, NetScaler ADM décompresse le dossier compressé et valide tous les StyleBooks. Le bundle n'est pas importé même si un fichier StyleBook échoue au test de validation.
Pour plus d'informations sur la grammaire StyleBook et la syntaxe des différentes constructions et attributs, voir Grammaire StyleBook.
-
Cliquez sur le lien Créer une configuration pour créer des configurations à partir de ce StyleBook.
La page StyleBook s'ouvre et vous pouvez saisir les valeurs de tous les paramètres définis dans ce StyleBook.
-
Spécifiez les valeurs requises pour les paramètres.
Dans l'exemple suivant,
-
Spécifiez le nom de l'application et l' adresse IP de l'équilibreur de charge.
-
Sélectionnez l' algorithme d'équilibrage de charge dans la liste. Par défaut, ROUNDROBIN est sélectionné.
-
-
Sous Instances cibles, sélectionnez l'adresse IP de l'instance NetScaler sur laquelle vous souhaitez déployer la configuration.
Vous pouvez également déployer la configuration sur plusieurs NetScaler, en spécifiant autant d'instances cibles que nécessaire.
Remarque
Pour ajouter toutes les instances NetScaler récemment découvertes dans NetScaler ADM aux instances cibles, accédez à la page StyleBooks et cliquez sur l'icône d'actualisation sur le côté droit de la page.
-
Si vous souhaitez tester les objets de configuration NetScaler (NITRO) avant de déployer la configuration, cliquez sur Dry Run.
Si la configuration est valide, les objets de configuration sont créés en fonction des valeurs spécifiées.
Dans cet exemple, le StyleBook ne crée qu'un seul objet de type
lbvserver. Ce serveur d'équilibrage de charge était le seul composant défini dans cet exemple de base StyleBook.
Cliquez ensuite sur Créer pour déployer la configuration sur les instances NetScaler sélectionnées.
Une fois la configuration déployée avec succès, un nouveau pack de configuration apparaît dans la page Configurations.