cfn-docgen 0.2.0

Document generator from cfn template files.

cfn-docgen

---

cfn-docgen is a command line tool that generates the table formatted CloudFormation(cfn) definition file from the original, yaml or json formatted template file.

---

Example

If you have a yaml cfn template file like below,

AWSTemplateFormatVersion: 2010-09-09
Description: sample vpc template
Parameters:
  EnvType:
    Description: env type
    Type: String
    Default: dev
Resources: 
  VPC:
    Type: AWS::EC2::VPC
    Metadata:
      UserNotes:
        ResourceNote: This is a note for VPC resource
        PropNotes:
          CidrBlock: This is a note for CidrBlock prop
          Tags[1].Value: This is a note for Value prop of 2nd Tags list prop
    Properties:
      CidrBlock: 10.0.0.0/16
      EnableDnsSupport: true
      Tags:
        - Key: ENV
          Value: !Ref EnvType
        - Key: Name
          Value: SampleVpc

you can generate a content like below.

ResourceId	ResourceType	ResourceNote	Property	Value	UserNote	Required	Type	UpdateType	Description	IsOmittable	Filename
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	CidrBlock	10.0.0.0/16	これはCidrBlockプロパティに対するユーザ独自のコメントです	False	String	Immutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	False	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	EnableDnsHostnames			False	Boolean	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	True	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	EnableDnsSupport			False	Boolean	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	True	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	InstanceTenancy			False	String	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	True	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Ipv4IpamPoolId			False	String	Immutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	True	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Ipv4NetmaskLength			False	Integer	Immutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	True	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Tags			False	List of Tag	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html	False	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Tags[0].Key	ENV		True	String	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html	False	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Tags[0].Value	DEV		True	String	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html	False	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Tags[1].Key	DEPARTMENT	これはTagsプロパティ配列の2番目のKeyプロパティに対するユーザ独自のコメントです	True	String	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html	False	cfn.yaml
VPC	AWS::EC2::VPC	これはVPCリソースに対するユーザ独自のコメントです	Tags[1].Value	DTBD		True	String	Mutable	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html	False	cfn.yaml

The key features of this tool are,

• All of the properties of each resource, including ones you omit to define, are listed in generated file.
  • In the example above, properties EnableDnsHostnames, InstanceTenancy, Ipv4IpamPoolId, and Ipv4NetmaskLength are omitted in original cfn template file, but listed in generated file.
• References for each resource and property listed at official User Guide are merged in generated file as columns Required, Type, UpdateType, and Description.
• You can add custom notes for each resource and property at Metadata section in each resource.
  • You can add custom note for a resource at Metadata.UserNotes.ResourceNote
  • You can add custom notes for properties at Metadata.UserNotes.PropNotes.{PropertyName}
    • For nested or list properties, you can specify PropertyName like Tags[1].Value .
• Not only Resources section in cfn template, this tool can also generate definitions of other sections, including Parameters, Mappings, and Outputs and resource policies like CreationPolicy, UpdatePolicy, UpdateReplacePlocy, DeletionPolicy, and DependsOn.
• You can generate files as excel, md, csv, or html format.
  • In excel format, all of definitions are separated by sheets.
  • In other format, all of definitions are separated by files.

Full example is in sample directory.

---

Requirements(CLI)

• python3.8
• AWS CLI

---

Installation(CLI)

$ pip install cfn-docgen

---

Installation(GUI)

We also provide cfn-docgen as GUI application here.

---

Installation(serverless)

You can also use cfn-docgen on AWS Cloud as serverless application.

You can deploy resources at AWS Serverless Application Repository. Once deployed, tha S3 bucket named cfn-docgen-${AWS::AccountId}-${AWS::Region} is created on your account. When you upload cfn template json/yaml files at templates/ folder of the bucket, cfn-docgen-serverless automatically will be triggered and generates excel docments for them.

---

Command usage

$ cfn-docgen --help
Usage: cfn-docgen [OPTIONS]

  Document generator from cfn template files

Options:
  --in TEXT                 Input cfn template file path (yaml/json)
                            [required]
  --fmt [xlsx|md|csv|html]  Output file format.  [default: xlsx]
  --omit                    If set, optional properties whose actual values
                            are not set in input template file will not be
                            written in output file.
  --refresh                 If set, fristly remove all existing cache files
                            and download them again.
  --region TEXT             AWS region name for referencing resource specs. If
                            not set, the value set as environment variable
                            `CFN_DOCGEN_AWS_REGION` is used. If the
                            environment variable is not set, use the value of
                            AWS CLI default profile
  --verbose                 If set, stdout DEBUG level logs
  --help                    Show this message and exit.


# example command usage
$ cfn-docgen --in sample/sample-template.json --fmt html