Export et import dans la console
Sur cette page
La console d’administration (/tosiam/console) a un écran Export / import, dans la section Configuration globale du menu. Il produit et lit les mêmes fichiers que la commande tosiam-config, dans une archive zip. Il est réservé aux administrateurs globaux.
Exporter#
- Cochez les royaumes à exporter (le royaume racine par défaut), au besoin Configuration globale, et les types d’objets (tous par défaut).
- Cliquez sur Télécharger l’archive.
L’archive tosiam-config.zip contient tosiam.yaml, un répertoire par royaume sous realms/ et, si elle est cochée, la configuration globale sous global/. Comme avec la commande, les secrets ne sont jamais exportés : ils sont écrits sous forme de références ${secret:…}.
Importer#
- Choisissez une archive zip. Elle contient le répertoire de configuration lui-même, ou un dossier unique qui le contient : un dossier compressé par le gestionnaire de fichiers convient.
- Cochez au besoin Supprimer les objets du périmètre géré, l’équivalent de
--prune=managed. - Cliquez sur Prévisualiser les changements.
Le serveur compare l’archive à sa configuration et n’écrit rien. Les changements s’affichent en arbre, royaume par royaume puis type par type, avec pour chaque objet sa nature (création, modification, suppression) et, pour une modification, les différences. Les objets présents sur le serveur seulement sont montrés sans pouvoir être cochés.
La configuration globale de l’archive (global/) apparaît en premier, sous Configuration globale, et s’applique avant les royaumes.
Un royaume de l’archive que le serveur n’a pas apparaît en tête de son arbre, comme une création de type Realm : laissez-la cochée, les objets du royaume en dépendent.
Tous les changements applicables sont cochés par défaut. Décochez ceux que vous ne voulez pas appliquer, objet par objet ou par branche entière, puis cliquez sur Appliquer la sélection et confirmez.
La console applique alors les changements cochés un objet après l’autre, dans l’ordre des dépendances, avec votre session. Chaque objet appliqué est marqué comme tel. Sur une erreur, l’application s’arrête : ce qui a été appliqué le reste, et l’objet en erreur est signalé avec le message du serveur.
Secrets et références#
L’archive ne contient aucun secret : l’export les écrit sous forme de références ${secret:…}. Quand la prévisualisation trouve des secrets que les fichiers ne donnent pas, elle affiche un cadre Secrets, avec un champ masqué par secret. Chaque secret est marqué :
- obligatoire : l’objet est à créer et son schéma exige ce secret, par exemple le secret d’un client OAuth2 confidentiel. Tant qu’il est vide, le royaume affiche le problème et rien ne peut y être coché ;
- facultatif : laissé vide, il est conservé par le serveur pour un objet qui existe, ou omis à la création. Rempli, il est réécrit, et la modification est annoncée par
secret rewritten.
Après avoir saisi ou vidé des secrets, cliquez sur Mettre à jour le plan : le bouton Appliquer la sélection reste inactif tant que le plan affiché n’a pas été recalculé avec ces secrets.
Le serveur ne résout pas les références ${env:…} et ${file:…} d’une archive envoyée par la console : il n’a pas d’environnement à fournir, et ne lit pas ses propres fichiers pour un document reçu. Une telle référence portée par un secret est demandée dans le cadre Secrets, comme un ${secret:…}. Une référence portée par une autre valeur est un problème : le royaume ne peut pas être appliqué tant que la valeur n’est pas écrite dans les fichiers.
Pour promouvoir une configuration avec des secrets fournis par l’environnement, sans saisie, utilisez plutôt la commande ou l’import au démarrage.
Mis à jour le