public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-24 20:18:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3103 from alexarnoldy/aarnoldy-Rancher-Charts-tree

Browse Source 
Adjust Chart Directory Structure
This commit is contained in:
Billy Tat
2021-07-02 15:50:00 -07:00
committed by GitHub
parent 60203446ff 3f2a371ad0
commit 85456170c8
2 changed files with 25 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.0-v2.4/en/helm-charts/creating-apps/_index.md
+13 -11
View File
@@ -45,18 +45,20 @@ Advantages of Rancher charts include:
# 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 specific to Rancher charts, but are optional for chart customization.
```
charts/<APPLICATION>/<APP_VERSION>/
|--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.
<Repository-Base>/
│
├── charts/
│ ├── <Application Name>/ # This directory name will be surfaced in the Rancher UI as the chart name
│ │ ├── <App Version>/ # Each directory at this level provides different app versions that will be selectable within the chart in the Rancher UI
│ │ │ ├── Chart.yaml # Required Helm chart information file.
│ │ │ ├── questions.yaml # 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.
│ │ │ ├── templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML.
```
# Additional Files for Rancher Charts
@@ -126,4 +128,4 @@ This reference contains variables that you can use in `questions.yml` nested und
# Tutorial: Example Custom Chart Creation
For a tutorial on adding a custom Helm chart to a custom catalog, refer to [this page.]({{<baseurl>}}/rancher/v2.0-v2.4/en/catalog/tutorial)
For a tutorial on adding a custom Helm chart to a custom catalog, refer to [this page.]({{<baseurl>}}/rancher/v2.x/en/catalog/tutorial)
content/rancher/v2.x/en/helm-charts/legacy-catalogs/creating-apps/_index.md
+12 -10
View File
@@ -44,18 +44,20 @@ Advantages of Rancher charts include:
# 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 specific to Rancher charts, but are optional for chart customization.
```
charts/<APPLICATION>/<APP_VERSION>/
|--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.
<Repository-Base>/
│
├── charts/
│ ├── <Application Name>/ # This directory name will be surfaced in the Rancher UI as the chart name
│ │ ├── <App Version>/ # Each directory at this level provides different app versions that will be selectable within the chart in the Rancher UI
│ │ │ ├── Chart.yaml # Required Helm chart information file.
│ │ │ ├── questions.yaml # 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.
│ │ │ ├── templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML.
```
# Additional Files for Rancher Charts