Frigate

Frigate is a tool for automatically generating documentation for your Helm charts.

It will use the chart’s Chart.yaml and values.yaml files in order to generate the content in a markup language of your choice.

Features

• Render documentation from your Chart.yaml and values.yaml files.

• Supports outputting as markdown, reStructuredText and HTML.

• Sphinx extension for including in Python documentation.

Installation

$ pip install frigate

Example

Create an example hello-world Helm chart with helm create.

$ helm create hello-world
Creating hello-world

Run Frigate to generate markdown documentation for your new hello-world chart.

$ frigate gen hello-world
Simple
===========

A Helm chart for Kubernetes


## Configuration

The following table lists the configurable parameters of the Simple chart and their default values.

| Parameter                | Description             | Default        |
| ------------------------ | ----------------------- | -------------- |
| `replicaCount` |  | `1` |
| `image.repository` |  | `"nginx"` |
| `image.tag` |  | `"stable"` |
| `image.pullPolicy` |  | `"IfNotPresent"` |
| `imagePullSecrets` |  | `[]` |
| `nameOverride` |  | `""` |
| `fullnameOverride` |  | `""` |
| `service.type` |  | `"ClusterIP"` |
| `service.port` |  | `80` |
| `ingress.enabled` |  | `false` |
| `ingress.annotations` |  | `{}` |
| `ingress.hosts` |  | `[{"host": "chart-example.local", "paths": []}]` |
| `ingress.tls` |  | `[]` |
| `resources` |  | `{}` |
| `nodeSelector` |  | `{}` |
| `tolerations` |  | `[]` |
| `affinity` |  | `{}` |



---
_Documentation generated by [Frigate](https://frigate.readthedocs.io)._

Your documentation will be piped into your stdout. You could redirect this into a file like README.md.

$ frigate gen hello-world > README.md