From e18bb7cc04434b9efd791d22ea31b6e175f6af4c Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 7 Mar 2024 11:10:55 -0800 Subject: [PATCH] Adding in rephrasing after review/citing sources. Signed-off-by: Sunil Singh --- .../helm-charts-in-rancher.md | 18 +++++++++++------- .../helm-charts-in-rancher/adding-catalogs.md | 4 ++-- .../new-user-guides/helm-charts-in-rancher.md | 18 +++++++++++------- .../helm-charts-in-rancher.md | 18 +++++++++++------- .../helm-charts-in-rancher.md | 18 +++++++++++------- .../helm-charts-in-rancher.md | 18 +++++++++++------- 6 files changed, 57 insertions(+), 37 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index e8dbcf88af2..ba159df89cf 100644 --- a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -74,27 +74,31 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s From the left sidebar select _"Repositories"_. -These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. +These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. #### Add Custom Git Repositories -Click the `Create` button and be sure to select the target `Git repository containing Helm chart...` to add a custom Git repository that contains your Helm charts or cluster template definitions. The branch name can be specified here if necessary, and if no branch name is provided the main branch will be used by default. At minimum a name and Git repository URL will be needed to finalize creation. An optional field for describing the chart repository is also available. Whenever you add a chart repository to Rancher, it will be available immediately. +Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions. + +You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`. + +Whenever you add a chart repository to Rancher, it becomes available immediately. #### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). -In Rancher, you can add the custom Helm chart repository by clicking the `Create` button and having the target `http(s) URL to an index generated by Helm` selected. You will need to input at minimum a repo name and the index URL address of the chart repository. +To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository. #### Add Private Git/Helm Chart Repositories -Private Git or Helm chart repositories can be added into Rancher using either SSH key credentials or an HTTP basic auth secret, i.e. Username and Password. +You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password. #### Add a Private CA to Repositories -To add a private CA for Helm Chart repositories: +To add a private CA to Helm chart repositories: - **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:
``` diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs.md b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs.md index 9ff124e1e7e..bb727efa14d 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/adding-catalogs.md @@ -15,9 +15,9 @@ The Git URL needs to be one that `git clone` [can handle](https://git-scm.com/do ### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). In Rancher, you can add the custom Helm chart repository with only a catalog name and the URL address of the chart repository. diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md index c0254ebf887..80fe5d50471 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md @@ -34,27 +34,31 @@ All three types are deployed and managed in the same way. From the left sidebar select _"Repositories"_. -These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. +These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. #### Add Custom Git Repositories -Click the `Create` button and be sure to select the target `Git repository containing Helm chart...` to add a custom Git repository that contains your Helm charts or cluster template definitions. The branch name can be specified here if necessary, and if no branch name is provided the main branch will be used by default. At minimum a name and Git repository URL will be needed to finalize creation. An optional field for describing the chart repository is also available. Whenever you add a chart repository to Rancher, it will be available immediately. +Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions. + +You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`. + +Whenever you add a chart repository to Rancher, it becomes available immediately. #### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). -In Rancher, you can add the custom Helm chart repository by clicking the `Create` button and having the target `http(s) URL to an index generated by Helm` selected. You will need to input at minimum a repo name and the index URL address of the chart repository. +To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository. #### Add Private Git/Helm Chart Repositories -Private Git or Helm chart repositories can be added into Rancher using either SSH key credentials or an HTTP basic auth secret, i.e. Username and Password. +You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password. #### Add a Private CA to Repositories -To add a private CA for Helm Chart repositories: +To add a private CA to Helm chart repositories: - **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:
``` diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 7cef3610279..691c25eb268 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -82,27 +82,31 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s From the left sidebar select _"Repositories"_. -These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. +These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. #### Add Custom Git Repositories -Click the `Create` button and be sure to select the target `Git repository containing Helm chart...` to add a custom Git repository that contains your Helm charts or cluster template definitions. The branch name can be specified here if necessary, and if no branch name is provided the main branch will be used by default. At minimum a name and Git repository URL will be needed to finalize creation. An optional field for describing the chart repository is also available. Whenever you add a chart repository to Rancher, it will be available immediately. +Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions. + +You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`. + +Whenever you add a chart repository to Rancher, it becomes available immediately. #### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). -In Rancher, you can add the custom Helm chart repository by clicking the `Create` button and having the target `http(s) URL to an index generated by Helm` selected. You will need to input at minimum a repo name and the index URL address of the chart repository. +To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository. #### Add Private Git/Helm Chart Repositories -Private Git or Helm chart repositories can be added into Rancher using either SSH key credentials or an HTTP basic auth secret, i.e. Username and Password. +You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password. #### Add a Private CA to Repositories -To add a private CA for Helm Chart repositories: +To add a private CA to Helm chart repositories: - **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:
``` diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index e8dbcf88af2..ba159df89cf 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -74,27 +74,31 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s From the left sidebar select _"Repositories"_. -These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. +These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. #### Add Custom Git Repositories -Click the `Create` button and be sure to select the target `Git repository containing Helm chart...` to add a custom Git repository that contains your Helm charts or cluster template definitions. The branch name can be specified here if necessary, and if no branch name is provided the main branch will be used by default. At minimum a name and Git repository URL will be needed to finalize creation. An optional field for describing the chart repository is also available. Whenever you add a chart repository to Rancher, it will be available immediately. +Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions. + +You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`. + +Whenever you add a chart repository to Rancher, it becomes available immediately. #### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). -In Rancher, you can add the custom Helm chart repository by clicking the `Create` button and having the target `http(s) URL to an index generated by Helm` selected. You will need to input at minimum a repo name and the index URL address of the chart repository. +To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository. #### Add Private Git/Helm Chart Repositories -Private Git or Helm chart repositories can be added into Rancher using either SSH key credentials or an HTTP basic auth secret, i.e. Username and Password. +You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password. #### Add a Private CA to Repositories -To add a private CA for Helm Chart repositories: +To add a private CA to Helm chart repositories: - **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:
``` diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index e8dbcf88af2..ba159df89cf 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -74,27 +74,31 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s From the left sidebar select _"Repositories"_. -These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. +These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository. #### Add Custom Git Repositories -Click the `Create` button and be sure to select the target `Git repository containing Helm chart...` to add a custom Git repository that contains your Helm charts or cluster template definitions. The branch name can be specified here if necessary, and if no branch name is provided the main branch will be used by default. At minimum a name and Git repository URL will be needed to finalize creation. An optional field for describing the chart repository is also available. Whenever you add a chart repository to Rancher, it will be available immediately. +Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions. + +You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`. + +Whenever you add a chart repository to Rancher, it becomes available immediately. #### Add Custom Helm Chart Repositories -A Helm chart repository is an HTTP server that houses one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server. +You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives. -Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like [ChartMuseum](https://github.com/helm/chartmuseum). +For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/). -In Rancher, you can add the custom Helm chart repository by clicking the `Create` button and having the target `http(s) URL to an index generated by Helm` selected. You will need to input at minimum a repo name and the index URL address of the chart repository. +To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository. #### Add Private Git/Helm Chart Repositories -Private Git or Helm chart repositories can be added into Rancher using either SSH key credentials or an HTTP basic auth secret, i.e. Username and Password. +You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password. #### Add a Private CA to Repositories -To add a private CA for Helm Chart repositories: +To add a private CA to Helm chart repositories: - **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:
```