Helm Docker Generate Doc

Helm Docker Generate Doc is a Shell/Bash script that generates documentation for Docker images deployed using Helm charts. It extracts the image information and metadata from the Helm charts and generates a detailed and easy-to-read documentation file in markdown format.

How it Works

The Helm Docker Generate Doc script searches for all the Helm charts in a specified location and extracts the Docker image information from the values.yaml file. It then queries the Docker registry to retrieve the image metadata and generates a markdown file with detailed documentation about the Docker images.

The generated documentation file includes information such as:

• Docker image name and tag
• Release name and date
• Image size and layers
• Image creation date and creator
• Image labels and environment variables
• Dependencies and related images
• Security vulnerabilities and compliance status

Usage

To use the Helm Docker Generate Doc script, simply clone the GitHub repository and run the following command:

helm docker generate doc -f <charts-folder> -o <doc-file>

Where <charts-folder> is the path to the Helm chart folder containing the values.yaml file, and <doc-file> is the desired output file for the generated documentation (e.g., README.md).

Requirements

The Helm Docker Generate Doc script requires the following tools:

• Helm (v3 or later)
• Docker
• JQ (JSON query tool)
• tr (Unix translate utility)

Conclusion

Helm Docker Generate Doc is a powerful and easy-to-use tool for generating documentation for Docker images deployed using Helm charts. It saves developers time and effort by automatically extracting and organizing image information and metadata, making it easy to understand and maintain Docker images.