Aller au contenu principal

Gabarits de manifestes

Disponible

Fonctionnalité déployée et prise en charge. Les champs et commandes décrits ici sont stables au sein de la version v1alpha1.

Le catalogue de gabarits fournit, pour chaque kind courant, un manifeste d'exemple commenté, valide tel quel. C'est la façon la plus rapide de démarrer une ressource et de découvrir ses champs.

Parcourir​

sng template list
apps  Applications
  App                Application
secrets  Secrets
  SSMSecret          …
iam  Identité
  IAMApplication     Application IAM
  IAMRole            Rôle IAM
  IAMGroup           Groupe IAM
cdn  CDN
  CDNSite            Site CDN
registry  Registre
  RegistryRepository      Dépôt du registre
  RegistryAccessKey  Clé d'accès au registre
sng template search access

Générer​

sng template gen App api
créé /home/jane/projet/api.yml (kind=App)

Le fichier contient un manifeste complet, avec metadata.name: api, des valeurs de départ raisonnables et des commentaires. Le nom est aussi celui du fichier ; -o en choisit un autre.

Adapter​

  1. Lisez les commentaires : ils signalent les champs à renseigner et ceux à supprimer.
  2. Supprimez ce dont vous n'avez pas besoin plutôt que de laisser des valeurs d'exemple.
  3. Vérifiez avec sng validate : il nomme le champ fautif.
  4. Pour chaque champ, la référence du kind donne type, bornes et règles croisées.

Ce qu'un gabarit ne contient jamais : un tenant, un label, une annotation, ou une valeur secrète. N'en ajoutez pas : metadata ne contient que name, apply refuserait le reste, et une valeur secrète a sa place dans un secret.

Kinds sans gabarit​

Les kinds absents du catalogue (DNSZone, DNSRecord, Monitor, NotificationChannel, StatusPage) se créent :

  • depuis l'« Exemple minimal » de leur page de référence ;
  • ou avec la commande dédiée, qui écrit le manifeste pour vous : sng dns record set …, sng monitor create … --dry-run ;
  • ou à partir d'une ressource existante : sng kind get DNSRecord api > dns-api.yml.

Garder vos propres gabarits​

Rien n'empêche de versionner dans votre dépôt un dossier templates/ adapté à votre organisation (image de base, taille par défaut, canal d'alerte). sng template gen reste la source pour découvrir un nouveau kind ou un nouveau champ.

Voir aussi​