CloudFormation en diagramme

Comment ça marche

1. 01

   Collez ou déposez votre modèle

   Un template.yaml ou template.json tel que vous le déployez, avec les balises courtes comme !Ref et !Sub, ou le modèle produit par cdk synth. Les commentaires et les formes longues Fn:: sont acceptés.

2. 02

   Voyez votre stack

   Chaque ressource devient une carte pour son service AWS. Les VPC et sous-réseaux deviennent des cadres autour de ce qui s’y exécute, et les références entre ressources deviennent des liens.

3. 03

   Ouvrez-le dans Archboard

   Enregistrez-le comme nouveau diagramme pour réorganiser les cartes, ajouter des notes, partager un lien ou l’exporter en SVG et PNG. Un compte Google ou GitHub suffit pour s’inscrire.

Ce qui est dessiné à partir d’un modèle CloudFormation

Le diagramme provient de la section Resources de votre modèle et de ces propriétés :

• ResourcesType

  Les entrées de Resources, sous forme de cartes selon leur Type, comme AWS::Lambda::Function ou AWS::RDS::DBInstance. Les types de liaison comme les event source mappings, les abonnements SNS et les règles d’entrée des groupes de sécurité deviennent des liens, et les ressources personnalisées apparaissent comme des cartes génériques.

• !Ref!GetAtt!Sub

  Un lien partout où une propriété pointe vers une autre ressource avec Ref, Fn::GetAtt ou un nom dans Fn::Sub, en forme courte ou longue. Les références dans Fn::If sont en pointillés, car une condition en décide.

• DependsOn

  Les entrées DependsOn, qu’elles nomment une seule ressource ou en listent plusieurs, sous forme de liens en pointillés, sauf si une référence relie déjà les deux mêmes ressources. Un DependsOn vers une ressource non dessinée, comme AWS::EC2::VPCGatewayAttachment, n’ajoute aucun lien.

• VpcIdSubnetId

  Les VPC sous forme de cadres contenant leurs sous-réseaux, et les ressources placées via VpcId, SubnetId, SubnetIds ou VpcConfig : dans leur sous-réseau, ou dans le cadre du VPC lorsqu’elles s’étendent sur plusieurs sous-réseaux.

• EventsConnectors

  Les événements des fonctions SAM, sous forme de liens depuis la route d’API, étiquetée par exemple POST /orders, ou depuis la file, le bucket, le flux ou la règle qui déclenche la fonction. Les planifications deviennent des cartes de déclenchement, et les Connectors des liens Read ou Write.

• aws:cdk:path

  Pour la sortie de cdk synth, les cartes prennent des noms lisibles tirés de aws:cdk:path au lieu des identifiants logiques générés, les constructs de deux ressources ou plus deviennent des cadres, et CDKMetadata ainsi que les ressources auxiliaires propres à CDK sont masquées.

• AWS::CloudFormation::Stack

  Chaque stack imbriquée sous forme d’une seule carte, reliée depuis les ressources passées en paramètres et vers les ressources qui lisent ses sorties.

Modèles AWS SAM

Un modèle avec Transform: AWS::Serverless-2016-10-31 est lu tel qu’il est écrit, sans lancer sam build. Les fonctions, API, API HTTP, tables simples, machines à états et applications imbriquées ont leur propre carte, une API que SAM crée à partir d’un événement de fonction apparaît aussi comme une carte, et les ressources référencées dans Policies sont reliées à leur fonction. Globals ne contient que des réglages communs, il n’est donc pas dessiné.

Ce qu’un diagramme CloudFormation laisse de côté

• Les valeurs et valeurs par défaut des paramètres, Mappings, Outputs et le résultat des Conditions : chaque ressource est dessinée, même celle qu’une condition ferait sauter, et les valeurs des propriétés ne sont pas affichées.
• Les ressources d’une stack imbriquée ou d’une application SAM, car le modèle enfant indiqué par TemplateURL ou Location n’est pas récupéré. Les valeurs importées d’autres stacks avec Fn::ImportValue sont comptées, pas dessinées.
• Les macros et transformations autres que SAM, ainsi que les boucles Fn::ForEach : rien n’est développé, donc une boucle ForEach apparaît comme une seule carte d’espace réservé.
• L’état de la stack, la dérive, les coûts, ou quels services s’appellent entre eux à l’exécution. Le diagramme montre comment le modèle relie les ressources, pas le trafic réel.