| title | type |
|---|---|
Provide documentation for your addon |
Details |
Using Helm Broker, you can provide documentation for your addon and display it in the Console UI. There are two cases in which you may want to use this feature:
- Providing documentation for your addon
- Providing documentation for objects that appear after provisioning your addon
NOTE: Deliver documentation for your addons in Markdown files with specified metadata. For more information, read about metadata and content of the Markdown files, and see the supported types of assets.
To provide documentation for your addon, create the docs folder inside your addon's directory. Your docs folder must contain a meta.yaml file with metadata information about how documentation for the addon is uploaded. You can either provide your own documents or point to the external URL with the source documentation:
Provide your own documentation
Store your documents and assets in the docs folder inside your addon's directory. Each Markdown file appears in the Documentation tab in the Console UI. Point the filter parameter of your meta.yaml file to the docs directory that contains the documentation.
Use external documentation
In the meta.yaml file, provide the url parameter with a value that points to the address of the documentation repository.
To provide documentation for objects that appear after provisioning your addon, create the docs.yaml file inside the addon's chart. This file contains ClusterAssetGroup or AssetGroup custom resources. Each ClusterAssetGroup or AssetGroup corresponds to a single object with the same ID as the name of the specified object. Your docs.yaml file can contain many ClusterAssetGroups or AssetGroups.
Provide your own documentation
Store documentation for each object in the docs/{object_name} directory. In the docs.yaml file, set the url parameter to the {{ .Values.addonsRepositoryURL }} variable, which points to your addon compressed to a .tgz file. During the provisioning process, Helm Broker pushes this variable into the chart. The filter parameter in the ClusterAssetGroup or AssetGroup definition must point to the docs/{object_name} directory that contains the documentation.
Use external documentation
In your docs.yaml file, specify the url parameter of every ClusterAssetGroup or AssetGroup custom resource with the URL that points to the location containing the documentation for the given object.