diff --git a/content/rancher/v2.x/en/catalog/custom/_index.md b/content/rancher/v2.x/en/catalog/custom/_index.md index f438ba9a0df..b553ec9d658 100644 --- a/content/rancher/v2.x/en/catalog/custom/_index.md +++ b/content/rancher/v2.x/en/catalog/custom/_index.md @@ -37,56 +37,19 @@ Rancher supports two different types of charts: ## Chart Directory Structure -The following table demonstrates the directory structure for a chart, which can be found in a chart directory: `charts/%application%/%app version%/`. This information is helpful when customizing charts for a custom catalog. Files denoted with **Rancher Specific** are specific to Rancher charts, but are optional for chart customization. +The following table demonstrates the directory structure for a chart, which can be found in a chart directory: `charts///`. This information is helpful when customizing charts for a custom catalog. Files denoted with **Rancher Specific** are specific to Rancher charts, but are optional for chart customization. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Sub-Directory FileDescription
app-readme.md Rancher Specific: Text displayed in the charts header within the Rancher UI.
charts/Directory containing dependency charts.
Chart.ymlRequired Helm chart information file.
questions.ymlRancher Specific: File containing form questions displayed within the Rancher UI. Questions display in Configuration Options.
README.mdOptional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions.
requirements.ymlOptional YAML file listing dependencies for the chart.
templates/A directory of templates that, when combined with values.yml, generates Kubernetes YAML.
values.ymlThe default configuration values for the chart.
+``` +charts/// +|--charts/ # Directory containing dependency charts. +|--templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML. +|--app-readme.md # Text displayed in the charts header within the Rancher UI.* +|--Chart.yml # Required Helm chart information file. +|--questions.yml # Form questions displayed within the Rancher UI. Questions display in Configuration Options.* +|--README.md # Optional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions. +|--requirements.yml # Optional: YAML file listing dependencies for the chart. +|--values.yml # Default configuration values for the chart. +``` ## Rancher Chart Additional Files @@ -96,7 +59,7 @@ Before you create your own custom catalog, you should have a basic understanding A file that provides descriptive text in the chart's UI header. The following image displays the difference between a Rancher chart (which includes `app-readme.md`) and a native Helm chart (which does not). - Rancher Chart with app-readme.md (left) vs. Helm Chart without (right) +
Rancher Chart with app-readme.md (left) vs. Helm Chart without (right)
![app-readme.md]({{< baseurl >}}/img/rancher/app-readme.png) @@ -105,7 +68,7 @@ Before you create your own custom catalog, you should have a basic understanding A file that contains questions for a form. These form questions simplify deployment of a chart. Without it, you must configure the deployment using key value pairs, which is more difficult. The following image displays the difference between a Rancher chart (which includes `questions.yml`) and a native Helm chart (which does not). - Rancher Chart with questions.yml (left) vs. Helm Chart without (right) +
Rancher Chart with questions.yml (left) vs. Helm Chart without (right)
![questions.yml]({{< baseurl >}}/img/rancher/questions.png)