CloudFormation a diagrama

Cómo funciona

1. 01

   Pega o suelta tu plantilla

   Un template.yaml o template.json tal como lo despliegas, con etiquetas cortas como !Ref y !Sub, o la plantilla que genera cdk synth. Los comentarios y las formas largas Fn:: no son problema.

2. 02

   Mira tu stack

   Cada recurso se convierte en una tarjeta de su servicio de AWS. Las VPC y subredes se convierten en marcos alrededor de lo que se ejecuta en ellas, y las referencias entre recursos, en conexiones.

3. 03

   Ábrelo en Archboard

   Guárdalo como un diagrama nuevo para reorganizar las tarjetas, añadir notas, compartir un enlace o exportarlo en SVG y PNG. Para registrarte basta una cuenta de Google o GitHub.

Qué se dibuja a partir de una plantilla de CloudFormation

El diagrama se construye con la sección Resources de tu plantilla y con estas propiedades:

• ResourcesType

  Las entradas de Resources, como tarjetas según su Type, por ejemplo AWS::Lambda::Function o AWS::RDS::DBInstance. Los tipos de enlace, como los event source mappings, las suscripciones de SNS y las reglas de entrada de los grupos de seguridad, se convierten en conexiones, y los recursos personalizados aparecen como tarjetas genéricas.

• !Ref!GetAtt!Sub

  Una conexión allí donde una propiedad apunta a otro recurso con Ref, Fn::GetAtt o un nombre dentro de Fn::Sub, en forma corta o larga. Las referencias dentro de Fn::If se dibujan discontinuas, porque las decide una condición.

• DependsOn

  Las entradas de DependsOn, tanto si nombran un solo recurso como si enumeran varios, como conexiones discontinuas, salvo que una referencia ya conecte esos dos recursos. Un DependsOn hacia un recurso que no se dibuja, como AWS::EC2::VPCGatewayAttachment, no añade ninguna conexión.

• VpcIdSubnetId

  Las VPC como marcos que contienen sus subredes, y los recursos ubicados mediante VpcId, SubnetId, SubnetIds o VpcConfig: dentro de su subred, o en el marco de la VPC si abarcan varias subredes.

• EventsConnectors

  Los eventos de las funciones SAM, como conexiones desde la ruta de la API, etiquetada por ejemplo POST /orders, o desde la cola, el bucket, el stream o la regla que inicia la función. Las programaciones se convierten en tarjetas de disparador, y los Connectors, en conexiones Read o Write.

• aws:cdk:path

  En la salida de cdk synth, las tarjetas toman nombres legibles de aws:cdk:path en lugar de los ID lógicos generados, los constructs con dos o más recursos se convierten en marcos, y CDKMetadata y los recursos auxiliares propios de CDK se ocultan.

• AWS::CloudFormation::Stack

  Cada stack anidado como una sola tarjeta, conectado desde los recursos que recibe como parámetros y hacia los recursos que leen sus salidas.

Plantillas de AWS SAM

Una plantilla con Transform: AWS::Serverless-2016-10-31 se lee tal como está escrita, sin ejecutar sam build. Las funciones, API, API HTTP, tablas simples, máquinas de estado y aplicaciones anidadas tienen su propia tarjeta, una API que SAM crea a partir de un evento de función también aparece como tarjeta, y los recursos referenciados en Policies se conectan con su función. Globals solo contiene ajustes comunes, así que no se dibuja.

Qué deja fuera un diagrama de CloudFormation

• Los valores de los parámetros y sus valores por defecto, Mappings, Outputs y el resultado de Conditions: se dibujan todos los recursos, incluso los que una condición omitiría, y no se muestran los valores de las propiedades.
• Los recursos dentro de un stack anidado o de una aplicación SAM, porque no se descarga la plantilla hija indicada en TemplateURL o Location. Los valores importados de otros stacks con Fn::ImportValue se cuentan, pero no se dibujan.
• Las macros y transformaciones distintas de SAM, y los bucles Fn::ForEach: no se expande nada, así que un bucle ForEach aparece como una sola tarjeta de marcador de posición.
• El estado del stack, la deriva, los costes o qué servicios se llaman entre sí en tiempo de ejecución. El diagrama muestra cómo la plantilla conecta los recursos, no el tráfico real.