Merge pull request #1462 from rohitsakala/enable-disable-function-for-custom-helm-chart-repos

[v2.10.0] Add docs about enable/disable functionality in clusterrepo
This commit is contained in:
Billy Tat
2024-10-29 17:07:44 -07:00
committed by GitHub
3 changed files with 69 additions and 17 deletions

View File

@@ -207,6 +207,29 @@ To modify the refresh interval of a chart repository:
1. Set the **refreshInterval** field under **Spec** to the desired value in seconds.
1. Click **Save**.
### Enable/Disable Helm Chart Repositories
Rancher v2.10.0 adds the ability to enable and disable Helm repositories. Helm repositories are enabled by default.
To disable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **false**.
1. Click **Save**.
1. When you disable a repository, updates are disabled and new changes to the clusterRepo are not applied.
To enable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **true**.
1. Click **Save**.
## Deploy and Upgrade Charts
To install and deploy a chart:

View File

@@ -175,23 +175,6 @@ Helm v3 introduced storing Helm charts as [Open Container Initiative (OCI)](http
仅支持 Helm 3 兼容 Chart 。
### Refresh Chart Repositories
The **Refresh** button can be used to sync changes from selected Helm chart repositories on the **Repositories** page.
To refresh a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Use the toggle next to the **State** field to select all repositories, or toggle specified chart repositories to sync changes.
1. Click **Refresh**.
1. The **⋮** at the end of each chart repository row also includes a **Refresh** option, which can be clicked to refresh the respective repository.
Non-Airgap Rancher installations upon refresh will reflect any chart repository changes immediately and you will see the **State** field for updated repositories move from `In Progress` to `Active` once the action is completed.
Airgap installations where Rancher is configured to use the packaged copy of Helm system charts ([`useBundledSystemChart=true`](../../../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md#helm-chart-options-for-air-gap-installations)) will only refer to the [system-chart](https://github.com/rancher/system-charts) repository that comes bundled and will not be able to be refreshed or synced.
#### Refresh Interval
Rancher v2.10.0 adds the `refreshInterval` field to the `ClusterRepo` CRD. The default value is 3600 seconds, meaning that Rancher syncs each Helm repository every 3600 seconds.
@@ -205,6 +188,29 @@ To modify the refresh interval of a chart repository:
1. Set the **refreshInterval** field under **Spec** to the desired value in seconds.
1. Click **Save**.
### Enable/Disable Helm Chart Repositories
Rancher v2.10.0 adds the ability to enable and disable Helm repositories. Helm repositories are enabled by default.
To disable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **false**.
1. Click **Save**.
1. When you disable a repository, updates are disabled and new changes to the clusterRepo are not applied.
To enable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **true**.
1. Click **Save**.
### 部署和升级 Chart
安装和部署 chart:

View File

@@ -207,6 +207,29 @@ To modify the refresh interval of a chart repository:
1. Set the **refreshInterval** field under **Spec** to the desired value in seconds.
1. Click **Save**.
### Enable/Disable Helm Chart Repositories
Rancher v2.10.0 adds the ability to enable and disable Helm repositories. Helm repositories are enabled by default.
To disable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **false**.
1. Click **Save**.
1. When you disable a repository, updates are disabled and new changes to the clusterRepo are not applied.
To enable a chart repository:
1. Click **☰ > Cluster Management**.
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
1. Find the repository you want to disable, and click **⋮ > Edit YAML**.
1. Set the **Enabled** field under **Spec** to **true**.
1. Click **Save**.
## Deploy and Upgrade Charts
To install and deploy a chart: