mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-24 20:18:18 +00:00
typo fixes
This commit is contained in:
Mark Bishop
Mark Bishop
@@ -3,9 +3,9 @@ title: Catalogs and Charts
|
||||
weight: 2250
|
||||
---
|
||||
|
||||
_Catalogs_ are GitHub repositories filled with applications that are ready-made for deployment.
|
||||
_Catalogs_ are GitHub repositories filled with applications that are ready-made for deployment. Applications are bundled in objects called _charts_.
|
||||
|
||||
Applications are bundled in objects called _charts_, which are a packaging format popularized by [Helm](https://docs.helm.sh/). Think of them as templates for deployments. Per Helm, charts are:
|
||||
_Charts_ are a packaging format popularized by [Helm](https://docs.helm.sh/). Think of them as templates for deployments. Per Helm, charts are:
|
||||
|
||||
>A collection of files that describe a related set of Kubernetes resources. A single chart might be used to deploy something simple, like a memcached pod, or something complex, like a full web app stack with HTTP servers, databases, caches, and so on.
|
||||
|
||||
@@ -17,13 +17,13 @@ Within Rancher, you can access several different catalogs either by default or t
|
||||
|
||||
- **Library**
|
||||
|
||||
The Library Catalog includes charts curated by Rancher. Rancher stores charts in a git repository to expedite the fetch and update of charts. In Rancher 2.0, only global catalogs are supported. Support for cluster-level and project-level charts will be added in the future.
|
||||
The Library Catalog includes charts curated by Rancher. Rancher stores charts in a Git repository to expedite the fetch and update of charts. In Rancher 2.0, only global catalogs are supported. Support for cluster-level and project-level charts will be added in the future.
|
||||
|
||||
This catalog features Rancher Charts, which include some [notable advantages](#chart-types) over native Helm charts.
|
||||
|
||||
- **Helm Stable**
|
||||
|
||||
This catalog includes native [Helm charts](https://github.com/kubernetes/helm/blob/master/docs/chart_template_guide/getting_started.md), both of which are maintained by the Kubernetes community. This catalog features the largest pool of apps, but is also the most complex way to deploy charts within Rancher.
|
||||
This catalog, , which is maintained by the Kubernetes community, includes native [Helm charts](https://github.com/kubernetes/helm/blob/master/docs/chart_template_guide/getting_started.md). This catalog features the largest pool of apps, but is also the most complex way to deploy charts within Rancher.
|
||||
|
||||
- **Helm Incubator**
|
||||
|
||||
@@ -42,9 +42,9 @@ Custom catalog requirements include:
|
||||
- A unique name.
|
||||
- A URL that `git clone` can handle.
|
||||
|
||||
For step-by-step directions, see [Adding Custom Catalogs]({{< baseurl >}}rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
|
||||
For step-by-step directions, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
|
||||
|
||||
When you're done creating the catalog, populate it charts. Custom catalogs can support native Helm charts or Rancher charts. See [Custom Chart Creation](#custom-chart-creation).
|
||||
When you're done creating the catalog, populate it with charts. Custom catalogs can support both native Helm charts and Rancher charts. See [Custom Chart Creation](#custom-chart-creation).
|
||||
|
||||
## Chart Types
|
||||
|
||||
@@ -88,7 +88,7 @@ The following table demonstrates the directory structure for a chart, which can
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td> <code>app-readme.md</code></td>
|
||||
<td> Rancher Specific: Text displayed within Rancher.</td>
|
||||
<td> <strong>Rancher Specific:</strong> Text displayed in the charts header within the Rancher UI.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>charts/</code></td>
|
||||
@@ -103,12 +103,12 @@ The following table demonstrates the directory structure for a chart, which can
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td><code>questions.yml</code></td>
|
||||
<td><strong>Rancher Specific:</strong> File containing questions displayed within Rancher.</td>
|
||||
<td><strong>Rancher Specific:</strong> File containing form questions displayed within the Rancher UI. Questions display in <strong>Configuration Options</strong>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td><code>README.md</code></td>
|
||||
<td>Optional: Helm Readme file displayed within Rancher.</td>
|
||||
<td>Optional: Helm Readme file displayed within Rancher UI. This test displays in <strong>Detailed Descriptions</strong>.</td>
|
||||
</tr>
|
||||
<td></td>
|
||||
<td><code>requirements.yml</code></td>
|
||||
@@ -129,7 +129,7 @@ The following table demonstrates the directory structure for a chart, which can
|
||||
|
||||
### Rancher Chart Additional Files
|
||||
|
||||
Before you create your own custom catalog, you should have a basic understanding about how a Rancher chart differs from a native Helm chart. Rancher charts differ slightly from native Helm charts in their directory structures. Rancher charts include two files that native Helm charts do not.
|
||||
Before you create your own custom catalog, you should have a basic understanding about how a Rancher chart differs from a native Helm chart. Rancher charts differ slightly from Helm charts in their directory structures. Rancher charts include two files that Helm charts do not.
|
||||
|
||||
- `app-readme.md`
|
||||
|
||||
@@ -141,7 +141,7 @@ Before you create your own custom catalog, you should have a basic understanding
|
||||
|
||||
- `questions.yml`
|
||||
|
||||
A file that containing 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).
|
||||
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).
|
||||
|
||||
|
||||
<small>Rancher Chart with <code>question.yml</code> (left) vs. Helm Chart without (right)</small>
|
||||
@@ -155,4 +155,4 @@ Before you create your own custom catalog, you should have a basic understanding
|
||||
|
||||
For information on how to add and customize charts for a custom catalog, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts).
|
||||
|
||||
>**Note:** For a complete walk through of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
|
||||
>**Note:** For a complete walkthrough of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
|
||||
|
||||
+2
-2
@@ -16,7 +16,7 @@ You can create custom catalogs of charts for use in Rancher. Custom catalogs are
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- Recommended: Read [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs).
|
||||
>- Create a GitHub respository to serve as your custom catalog.
|
||||
>- Create a GitHub repository to serve as your custom catalog.
|
||||
|
||||
|
||||
1. From the **Global** view, choose **Catalogs** from the main menu.
|
||||
@@ -27,4 +27,4 @@ You can create custom catalogs of charts for use in Rancher. Custom catalogs are
|
||||
|
||||
## What's Next?
|
||||
|
||||
Add native Helm charts, Rancher charts, or both to your repository. For more information, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalogs).
|
||||
Add native Helm charts, Rancher charts, or both to your repository. For more information, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts/).
|
||||
+20
-20
@@ -11,7 +11,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat
|
||||
|
||||
>- Recommended: Read [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs).
|
||||
>- Create a GitHub repository to serve as your custom catalog.
|
||||
>- Complete [Adding Custom Catalogs]({{< baseurl >}}/Users/markbishop/Documents/GitHub/docs/content/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
|
||||
>- Complete [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
|
||||
|
||||
>**Note:** Customization of Helm charts takes place outside of the Rancher UI.
|
||||
|
||||
@@ -39,7 +39,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat
|
||||
|
||||
3. **Recommended:** Create a `questions.yml` file.
|
||||
|
||||
This file creates a form for users to specify deployment parameters when they deploy the custom chart. Without this file, users will have to specify the parameters manually using key value pairs, which isn't user-friendly.
|
||||
This file creates a form for users to specify deployment parameters when they deploy the custom chart. Without this file, users **must** specify the parameters manually using key value pairs, which isn't user-friendly.
|
||||
<br/>
|
||||
<br/>
|
||||
The example below creates a form that prompts users for persistent volume size and a storage class.
|
||||
@@ -73,7 +73,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat
|
||||
label: Default StorageClass for WordPress
|
||||
</pre>
|
||||
|
||||
4. Check the customized chart into your GitHub repo.
|
||||
4. Check the customized chart into your GitHub repo.
|
||||
|
||||
**Result:** Your custom chart is added to the repo. Your Rancher Server will replicate the chart within a few minutes.
|
||||
|
||||
@@ -87,22 +87,22 @@ This reference contains variables that you can use in `questions.yml`.
|
||||
|
||||
| Variable | Type | Required | Description |
|
||||
| ------------- | ------------- | --- |------------- |
|
||||
| variable | string | true | define the variable name specified in the `values.yml` file, using `foo.bar` for nested object. |
|
||||
| label | string | true | define the UI label. |
|
||||
| description | string | false | specify the description of the variable.|
|
||||
| type | string | false | default to `string` if not specified (current supported types are string, boolean, int, enum, password, storageclass and hostname).|
|
||||
| required | bool | false | define if the variable is required or not (true \| false)|
|
||||
| default | string | false | specify the default value. |
|
||||
| group | string | false | group questions by input value. |
|
||||
| min_length | int | false | min character length.|
|
||||
| max_length | int | false | max character length.|
|
||||
| min | int | false | min integer length. |
|
||||
| max | int | false | max integer length. |
|
||||
| options | []string | false | specify the options when the vriable type is `enum`, for example: options:<br> - "ClusterIP" <br> - "NodePort" <br> - "LoadBalancer"|
|
||||
| valid_chars | string | false | regular expression for input chars validation. |
|
||||
| invalid_chars | string | false | regular expression for invalid input chars validation.|
|
||||
| subquestions | []subquestion | false| add an array of subquestions.|
|
||||
| show_if | string | false | show current variable if conditional variable is true, for example `show_if: "serviceType=Nodeport"` |
|
||||
| show\_subquestion_if | string | false | show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
|
||||
| variable | string | true | Define the variable name specified in the `values.yml` file, using `foo.bar` for nested objects. |
|
||||
| label | string | true | Define the UI label. |
|
||||
| description | string | false | Specify the description of the variable.|
|
||||
| type | string | false | Default to `string` if not specified (current supported types are string, boolean, int, enum, password, storageclass and hostname).|
|
||||
| required | bool | false | Define if the variable is required or not (true \| false)|
|
||||
| default | string | false | Specify the default value. |
|
||||
| group | string | false | Group questions by input value. |
|
||||
| min_length | int | false | Min character length.|
|
||||
| max_length | int | false | Max character length.|
|
||||
| min | int | false | Min integer length. |
|
||||
| max | int | false | Max integer length. |
|
||||
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br> - "ClusterIP" <br> - "NodePort" <br> - "LoadBalancer"|
|
||||
| valid_chars | string | false | Regular expression for input chars validation. |
|
||||
| invalid_chars | string | false | Regular expression for invalid input chars validation.|
|
||||
| subquestions | []subquestion | false| Add an array of subquestions.|
|
||||
| show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
|
||||
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
|
||||
|
||||
>**Note:** `subquestions[]` cannot contain `subquestions` or `show_subquestions_if` keys, but all other keys in the above table are supported.
|
||||
|
||||
@@ -5,7 +5,7 @@ draft: true
|
||||
---
|
||||
After you've enabled default catalogs or setup a custom catalog, you can launch apps using a catalog instead of a standard deployment.
|
||||
|
||||
>**Prerequiste:** Enable a catalog. For more information, see [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs)
|
||||
>**Prerequisite:** Enable a catalog. For more information, see [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs).
|
||||
|
||||
1. From the **Global** view, open the project that you want to deploy to.
|
||||
|
||||
@@ -15,7 +15,7 @@ After you've enabled default catalogs or setup a custom catalog, you can launch
|
||||
|
||||
4. Under **Configuration Options** enter a **Name**. By default, this name is also used to create a Kubernetes namespace for the application.
|
||||
|
||||
* If you would like to change the **Namespace**, click **Customize** and enter a new name
|
||||
* If you would like to change the **Namespace**, click **Customize** and enter a new name.
|
||||
* If you want to use a different namespace that already exists, click **Customize**, and then click **Use an existing namespace**. Choose a namespace from the list.
|
||||
|
||||
5. Select a **Template Version**.
|
||||
|
||||
Reference in New Issue
Block a user