mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-27 05:28:22 +00:00
moving around catalog stuff
This commit is contained in:
Denise Schannon
+19
-9
@@ -1,8 +1,18 @@
|
|||||||
---
|
---
|
||||||
title: Catalogs and Charts
|
title: Catalogs and Charts
|
||||||
weight: 2250
|
weight: 4000
|
||||||
|
aliases:
|
||||||
|
- /rancher/v2.x/en/concepts/global-configuration/catalog/
|
||||||
|
- /rancher/v2.x/en/tasks/global-configuration/catalog/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
This section includes step-by-step instruction on how to configure default and custom catalogs.
|
||||||
|
|
||||||
|
- [Enabling Default Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/enabling-default-catalogs)
|
||||||
|
- [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs)
|
||||||
|
- [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts)
|
||||||
|
|
||||||
|
|
||||||
_Catalogs_ are GitHub repositories filled with applications that are ready-made for deployment. Applications are bundled in objects called _charts_.
|
_Catalogs_ are GitHub repositories filled with applications that are ready-made for deployment. Applications are bundled in objects called _charts_.
|
||||||
|
|
||||||
_Charts_ 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:
|
||||||
@@ -18,7 +28,7 @@ Within Rancher, you can access several different catalogs either by default or t
|
|||||||
- **Library**
|
- **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.
|
This catalog features Rancher Charts, which include some [notable advantages](#chart-types) over native Helm charts.
|
||||||
|
|
||||||
- **Helm Stable**
|
- **Helm Stable**
|
||||||
@@ -32,9 +42,9 @@ Within Rancher, you can access several different catalogs either by default or t
|
|||||||
- **Custom**
|
- **Custom**
|
||||||
|
|
||||||
Finally, you have the option of building your own catalogs. Custom catalogs are useful when you have a handful of apps that you deploy regularly in a specific configuration.
|
Finally, you have the option of building your own catalogs. Custom catalogs are useful when you have a handful of apps that you deploy regularly in a specific configuration.
|
||||||
|
|
||||||
### Custom Catalog Creation
|
### Custom Catalog Creation
|
||||||
|
|
||||||
Creating a custom catalog for Rancher is straightforward. Create a Git repo and then direct Rancher toward the repo.
|
Creating a custom catalog for Rancher is straightforward. Create a Git repo and then direct Rancher toward the repo.
|
||||||
|
|
||||||
Custom catalog requirements include:
|
Custom catalog requirements include:
|
||||||
@@ -42,7 +52,7 @@ Custom catalog requirements include:
|
|||||||
- A unique name.
|
- A unique name.
|
||||||
- A URL that `git clone` can handle.
|
- 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/catalog-and-charts/adding-custom-catalogs).
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
@@ -132,15 +142,15 @@ The following table demonstrates the directory structure for a chart, which can
|
|||||||
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.
|
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`
|
- `app-readme.md`
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
<small>Rancher Chart with <code>app-readme.md</code> (left) vs. Helm Chart without (right)</small>
|
<small>Rancher Chart with <code>app-readme.md</code> (left) vs. Helm Chart without (right)</small>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- `questions.yml`
|
- `questions.yml`
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|
||||||
@@ -153,6 +163,6 @@ Before you create your own custom catalog, you should have a basic understanding
|
|||||||
|
|
||||||
You can fill your custom catalogs with either Helm Charts or Rancher Charts, although we recommend Rancher Charts due to their enhanced user experience.
|
You can fill your custom catalogs with either Helm Charts or Rancher Charts, although we recommend Rancher Charts due to their enhanced user experience.
|
||||||
|
|
||||||
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).
|
For information on how to add and customize charts for a custom catalog, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts).
|
||||||
|
|
||||||
>**Note:** For a complete walkthrough 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/).
|
||||||
+5
-3
@@ -1,6 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: Adding Custom Catalogs
|
title: Adding Custom Catalogs
|
||||||
weight: 50
|
weight: 4015
|
||||||
|
aliases:
|
||||||
|
- /rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs/
|
||||||
---
|
---
|
||||||
|
|
||||||
You can create custom catalogs of charts for use in Rancher. Custom catalogs are helpful for fast deployment of applications unique to your environment.
|
You can create custom catalogs of charts for use in Rancher. Custom catalogs are helpful for fast deployment of applications unique to your environment.
|
||||||
@@ -23,8 +25,8 @@ You can create custom catalogs of charts for use in Rancher. Custom catalogs are
|
|||||||
2. Click **Add Catalog**.
|
2. Click **Add Catalog**.
|
||||||
3. Complete the form and click **Create**.
|
3. Complete the form and click **Create**.
|
||||||
|
|
||||||
**Result**: Your catalog is added to Rancher.
|
**Result**: Your catalog is added to Rancher.
|
||||||
|
|
||||||
## What's Next?
|
## 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/catalog/customizing-charts/).
|
Add native Helm charts, Rancher charts, or both to your repository. For more information, see [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/customizing-charts/).
|
||||||
+5
-3
@@ -1,6 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: Customizing Charts
|
title: Customizing Charts
|
||||||
weight: 75
|
weight: 4020
|
||||||
|
aliases:
|
||||||
|
- /rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts/
|
||||||
---
|
---
|
||||||
|
|
||||||
Before you can deploy customized catalog apps using Rancher, you must add charts to the GitHub repository serving as your custom catalog.
|
Before you can deploy customized catalog apps using Rancher, you must add charts to the GitHub repository serving as your custom catalog.
|
||||||
@@ -11,7 +13,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).
|
>- Recommended: Read [Catalogs and Charts]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs).
|
||||||
>- Create a GitHub repository to serve as your custom catalog.
|
>- Create a GitHub repository to serve as your custom catalog.
|
||||||
>- Complete [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs).
|
>- Complete [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs).
|
||||||
|
|
||||||
>**Note:** Customization of Helm charts takes place outside of the Rancher UI.
|
>**Note:** Customization of Helm charts takes place outside of the Rancher UI.
|
||||||
|
|
||||||
@@ -19,7 +21,7 @@ The custom catalog can contain native Helm charts, Rancher charts, or a combinat
|
|||||||
|
|
||||||
Rancher requires this directory structure, although `app-readme.md` and `questions.yml` are optional.
|
Rancher requires this directory structure, although `app-readme.md` and `questions.yml` are optional.
|
||||||
|
|
||||||
>**Tip:**
|
>**Tip:**
|
||||||
>
|
>
|
||||||
>- To begin customizing a chart, copy one from either the [Rancher Library](https://github.com/rancher/charts) or the [Helm Stable](https://github.com/kubernetes/charts/tree/master/stable).
|
>- To begin customizing a chart, copy one from either the [Rancher Library](https://github.com/rancher/charts) or the [Helm Stable](https://github.com/kubernetes/charts/tree/master/stable).
|
||||||
>- For a complete walk through of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
|
>- For a complete walk through of developing charts, see the upstream Helm chart [developer reference](https://docs.helm.sh/developing_charts/).
|
||||||
+7
-5
@@ -1,21 +1,23 @@
|
|||||||
---
|
---
|
||||||
title: Enabling Default Catalogs
|
title: Enabling Default Catalogs
|
||||||
weight: 25
|
weight: 4005
|
||||||
|
aliases:
|
||||||
|
- /rancher/v2.x/en/tasks/global-configuration/catalog/enabling-default-catalogs/
|
||||||
---
|
---
|
||||||
|
|
||||||
Out-of-the-box, you can enable several different catalog repositories to simplify deployment of applications.
|
Out-of-the-box, you can enable several different catalog repositories to simplify deployment of applications.
|
||||||
|
|
||||||
1. From the **Global** view, choose **Catalogs** from the main menu.
|
1. From the **Global** view, choose **Catalogs** from the main menu.
|
||||||
2. Toggle the default catalogs that you want use to a setting of **Enabled**. The [default catalogs]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs/#catalog-types) are:
|
2. Toggle the default catalogs that you want use to a setting of **Enabled**. The [default catalogs]({{< baseurl >}}/rancher/v2.x/en/concepts/catalogs/#catalog-types) are:
|
||||||
|
|
||||||
- **Library**
|
- **Library**
|
||||||
- **Helm Stable**
|
- **Helm Stable**
|
||||||
- **Helm Incubator**
|
- **Helm Incubator**
|
||||||
|
|
||||||
>**Note:** If you want to use a custom catalog, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs) instead of this topic.
|
>**Note:** If you want to use a custom catalog, see [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/catalog-and-charts/adding-custom-catalogs) instead of this topic.
|
||||||
|
|
||||||
**Result:** The chosen catalogs are enabled. Wait a few minutes for Rancher to replicate the catalog charts. When replication completes, you'll be able to see them in any of your projects by selecting **Catalog Apps** from the main menu.
|
**Result:** The chosen catalogs are enabled. Wait a few minutes for Rancher to replicate the catalog charts. When replication completes, you'll be able to see them in any of your projects by selecting **Catalog Apps** from the main menu.
|
||||||
|
|
||||||
## What's Next?
|
## What's Next?
|
||||||
|
|
||||||
Deploy catalog applications to your cluster nodes. For more information, see [Launching a Catalog App]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/launch-a-catalog-app).
|
Deploy catalog applications to your cluster nodes. For more information, see [Launching a Catalog App]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/launch-a-catalog-app).
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: Catalogs and Charts
|
||||||
|
weight: 4010
|
||||||
|
---
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: Catalogs and Charts
|
|
||||||
weight: 3026
|
|
||||||
---
|
|
||||||
|
|
||||||
This section includes step-by-step instruction on how to configure default and custom catalogs.
|
|
||||||
|
|
||||||
- [Enabling Default Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/enabling-default-catalogs)
|
|
||||||
- [Adding Custom Catalogs]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/adding-custom-catalogs)
|
|
||||||
- [Customizing Charts]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/catalog/customizing-charts)
|
|
||||||
Reference in New Issue
Block a user