Exporter et importer l'architecture
Exportez l'architecture d'une application en JSON portable, puis importez-la dans une application vierge après validation et simulation.
- Accès requis
- Accès à l'infrastructure de l'application (profil Infra)
- Durée
- 10 min
L'architecture d'une application s'exporte en un document JSON versionné, sans aucun identifiant propre à l'application. Vous pouvez le relire, le modifier, le conserver dans Git, ou le réimporter dans une autre application pour en reproduire la structure.
Avant de commencer
- Pour exporter : les dépôts gérés par Wakastart de l'application doivent être provisionnés (statut Provisionné).
- Pour importer : l'application cible doit être vierge, c'est-à-dire sans dépôt, service, définition de base ou de bucket, URL, route, domaine racine ni redirection. Les environnements existants ne comptent pas.
- Lisez le format de l'architecture JSON si vous comptez modifier le document.
Exporter l'architecture
- Dans le menu de l'application, cliquez sur Architecture, puis sur Exporter.
- Lisez l'encart Transformations appliquées de la fenêtre Exporter l'architecture. Il rappelle ce que l'export retire ou modifie :
- l'identifiant de l'application et les chemins qui en dérivent sont retirés ;
- les dépôts gérés deviennent des dépôts importés, avec leur URL
.git; - les URLs sont détachées de leur domaine ;
- les domaines personnalisés et les exigences de secrets ne sont pas inclus.
- Cliquez sur Télécharger pour enregistrer le fichier
architecture-<nom court>-<date>.json, ou utilisez le bouton de copie pour le placer dans le presse-papiers.
Résultat : le message « Téléchargement » (« Fichier architecture-… téléchargé. ») ou « Copié » s'affiche. Si l'export produit des remarques, elles apparaissent dans un encart Avertissements.
Versionnez votre architecture
Conservez le fichier exporté dans le dépôt de votre application. Vous gardez ainsi une trace de chaque évolution de l'architecture, relisible en revue de code.
Préparer le document à importer
Partez d'un export ou écrivez le document à la main. Points d'attention :
- chaque bloc se référence par sa clé
ref, jamais par un identifiant : un service désigne son dépôt parrepoRef; - un dépôt avec
"isManaged": truesera créé sur GitHub par Wakastart ; un dépôt avec"isManaged": falseest une référence à un dépôt existant et exigefullNameethtmlUrl; - le bloc
environmentsest facultatif. Nous recommandons de le laisser vide et de créer vos environnements depuis la console, où vous choisissez leur nom et leur référence Git.
Importer dans une application vierge
Ouvrir la fenêtre d'import
Dans Architecture de l'application cible, cliquez sur Importer. Si le bouton est grisé, survolez-le : « L'import nécessite une app vierge — supprimez d'abord l'architecture existante. »
Coller et valider
À l'étape Coller & valider, collez le document JSON, puis cliquez sur Valider.
La console vérifie la structure du document et les références entre blocs, puis simule l'import sans rien écrire. En cas d'erreur, l'encart « N erreurs de validation » indique pour chacune le chemin dans le document et le message, par exemple /serviceDefinitions/0 et Unknown repo ref "monorepo". Corrigez le document et cliquez de nouveau sur Valider.
Relire le récapitulatif
À l'étape Récapitulatif & importer, l'encart Prêt à importer liste les ressources qui seront créées : dépôts, services, bases de données, buckets de stockage, URLs publiques, routes HTTP, environnements. Il précise aussi :
- si les URLs seront rattachées automatiquement au domaine de la plateforme, ou créées détachées ;
- combien de dépôts gérés seront créés sur GitHub. En attendant leur création, quelques secondes à quelques minutes, les services rattachés ont une URL de dépôt vide.
Importer
Cliquez sur Importer.
Résultat : le bandeau Architecture importée apparaît en haut de la page Architecture, avec les étapes restantes.
Finaliser après l'import
Le bandeau Architecture importée liste ce que l'import ne fait pas :
- Créer les instances : déployez les services et créez les bases et les buckets dans chaque environnement.
- Rattacher les routes détachées à un domaine, depuis Architecture > URLs.
- Renseigner les valeurs de secrets par environnement, depuis l'onglet Configuration de chaque environnement.
- Déployer : lancez un premier build de chaque service, puis déployez l'image.
Cliquez sur Masquer ce rappel une fois ces étapes faites.
Vérifier le résultat
- Architecture > Repositories liste les dépôts ; les dépôts gérés passent de En attente à Provisionné.
- Architecture > Services liste les définitions de service importées.
- Le résumé de chaque environnement indique les services non instanciés : c'est attendu tant que vous ne les avez pas déployés.
Dépannage
- « Import bloqué — app non vierge » : l'application cible contient déjà des éléments d'architecture. Voir Résoudre les problèmes d'environnement.
Cannot export architecture: repo "…" (name: "…") has no htmlUrl.: un dépôt géré est encore en cours de création. Attendez qu'il soit Provisionné, puis relancez l'export.