mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-27 13:38:07 +00:00
Adjust Chart Directory Structure
This commit is contained in:
@@ -44,18 +44,20 @@ Advantages of Rancher charts include:
|
|||||||
|
|
||||||
# Chart Directory Structure
|
# 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 Rancher Chart. The "charts" directory is the top level directory under the repository base. Adding the repository to Rancher will expose all charts contained within it. This information is helpful when customizing charts for a custom catalog. The questions.yaml, README.md, and requirements.yml files are Rancher Specific are specific to Rancher charts, but are optional for chart customization.
|
||||||
|
|
||||||
```
|
```
|
||||||
charts/<APPLICATION>/<APP_VERSION>/
|
<Repository-Base>/
|
||||||
|--charts/ # Directory containing dependency charts.
|
│
|
||||||
|--templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML.
|
├── charts/
|
||||||
|--app-readme.md # Text displayed in the charts header within the Rancher UI.*
|
│ ├── <Application Name>/ # This directory name will be surfaced in the Rancher UI as the chart name
|
||||||
|--Chart.yml # Required Helm chart information file.
|
│ │ ├── <App Version>/ # Each directory at this level provides different app versions that will be selectable within the chart in the Rancher UI
|
||||||
|--questions.yml # Form questions displayed within the Rancher UI. Questions display in Configuration Options.*
|
│ │ │ ├── Chart.yaml # Required Helm chart information file.
|
||||||
|--README.md # Optional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions.
|
│ │ │ ├── questions.yaml # Form questions displayed within the Rancher UI. Questions display in Configuration Options.*
|
||||||
|--requirements.yml # Optional: YAML file listing dependencies for the chart.
|
│ │ │ ├── README.md # Optional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions.
|
||||||
|--values.yml # Default configuration values for the chart.
|
│ │ │ ├── requirements.yml # Optional: YAML file listing dependencies for the chart.
|
||||||
|
│ │ │ ├── values.yml # Default configuration values for the chart.
|
||||||
|
│ │ │ ├── templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML.
|
||||||
```
|
```
|
||||||
|
|
||||||
# Additional Files for Rancher Charts
|
# Additional Files for Rancher Charts
|
||||||
|
|||||||
Reference in New Issue
Block a user