From ebfad686388990c65275eade0c8b64bd008f22e3 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 17 Apr 2024 16:13:38 -0700 Subject: [PATCH 1/3] Adding information into the Helm Charts and Apps page to describe the Refresh button functionality and its location for latest 2.8 and 2.7 Rancher versions. Signed-off-by: Sunil Singh --- .../helm-charts-in-rancher.md | 17 +++++++++++++++++ .../helm-charts-in-rancher.md | 17 +++++++++++++++++ .../helm-charts-in-rancher.md | 17 +++++++++++++++++ 3 files changed, 51 insertions(+) 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 b5c95f85af0..9ca499975d2 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 @@ -167,6 +167,23 @@ spec: Only Helm 3 compatible charts are supported. +### 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 **⋮** attached to the end of respective chart repositories also have 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. + ## Deploy and Upgrade Charts To install and deploy a chart: 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 6bd70830564..60b6a9618fd 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 @@ -167,6 +167,23 @@ spec: Only Helm 3 compatible charts are supported. +### 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 **⋮** attached to the end of respective chart repositories also have 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. + ## Deploy and Upgrade Charts To install and deploy a chart: 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 3508daf41a6..2f98e919880 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 @@ -166,6 +166,23 @@ spec: Only Helm 3 compatible charts are supported. +### 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 **⋮** attached to the end of respective chart repositories also have 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. + ## Deploy and Upgrade Charts To install and deploy a chart: From 69adb955325bcefebd8a11c52df390537c47e439 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Wed, 17 Apr 2024 16:37:23 -0700 Subject: [PATCH 2/3] Updating phrasing. Signed-off-by: Sunil Singh --- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- 3 files changed, 3 insertions(+), 3 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 9ca499975d2..50c06da9756 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 @@ -178,7 +178,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also have a **Refresh** option which can be clicked to refresh the respective repository. +1. The **⋮** attached to the end of respective chart repositories also include 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. 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 60b6a9618fd..18068aacbbf 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 @@ -178,7 +178,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also have a **Refresh** option which can be clicked to refresh the respective repository. +1. The **⋮** attached to the end of respective chart repositories also include 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. 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 2f98e919880..2c4818f31bf 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 @@ -177,7 +177,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also have a **Refresh** option which can be clicked to refresh the respective repository. +1. The **⋮** attached to the end of respective chart repositories also include 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. From 5e7a9839108fc74c7feabe1886af718cb6bc9af9 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 18 Apr 2024 08:08:00 -0700 Subject: [PATCH 3/3] Updating phrasing for final step after review. Signed-off-by: Sunil Singh --- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- 3 files changed, 3 insertions(+), 3 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 50c06da9756..00895b17689 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 @@ -178,7 +178,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also include a **Refresh** option which can be clicked to refresh the respective repository. +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. 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 18068aacbbf..f7fe1f5ffea 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 @@ -178,7 +178,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also include a **Refresh** option which can be clicked to refresh the respective repository. +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. 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 2c4818f31bf..50a231aecf5 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 @@ -177,7 +177,7 @@ To refresh a chart repository: 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 **⋮** attached to the end of respective chart repositories also include a **Refresh** option which can be clicked to refresh the respective repository. +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.