[v2.10.0] Add docs for the new field RefreshInterval #1432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rohitsakala
requested review from
btat,
LucasSaintarbor,
martyav and
sunilarjun
as code owners
|
@rohitsakala is this related to an upcoming release? |
|
@martyav Yes This PR should be in Draft. I will change it to Ready to Review when it is ready. Upcoming Release ? Yes. Not sure which one since this is a cross team effort |
martyav
requested changes
Sep 12, 2024
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/oci-repositories.md
Outdated
Show resolved
Hide resolved
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/oci-repositories.md
Outdated
Show resolved
Hide resolved
...ed_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/oci-repositories.md
Outdated
Show resolved
Hide resolved
martyav
changed the title
richard-cox
reviewed
Sep 16, 2024
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md
Show resolved
Hide resolved
martyav
requested changes
Sep 19, 2024
| @@ -194,6 +194,16 @@ Non-Airgap Rancher installations upon refresh will reflect any chart repository | |||
|
|
|||
| 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 | |||
|
|
|||
| 1. A new field `refreshInterval` has been added to the `ClusterRepo` CRD. The default `refreshInterval` is set to 3600 seconds and Rancher syncs the repository every 3600 seconds for each Helm repository. | |||
There was a problem hiding this comment.
Suggested change
| 1. A new field `refreshInterval` has been added to the `ClusterRepo` CRD. The default `refreshInterval` is set to 3600 seconds and Rancher syncs the repository every 3600 seconds for each Helm repository. | |
| 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. |
|
|
||
| To modify the refresh interval of a chart repository: | ||
|
|
||
| 1. Find the repository you want to modify, and click **⋮ > Edit YAML**. |
There was a problem hiding this comment.
We should include instructions on accessing the list of repositories
|
|
||
| 1. Find the repository you want to modify, and click **⋮ > Edit YAML**. | ||
| 1. Set the `refreshInterval` field under `Spec` to the desired value in seconds. | ||
| 1. Click on **Save**. |
There was a problem hiding this comment.
Suggested change
| 1. Click on **Save**. | |
| 1. Click **Save**. |
Style guide advises against "Click on"
| To modify the refresh interval of a chart repository: | ||
|
|
||
| 1. Find the repository you want to modify, and click **⋮ > Edit YAML**. | ||
| 1. Set the `refreshInterval` field under `Spec` to the desired value in seconds. |
There was a problem hiding this comment.
Suggested change
| 1. Set the `refreshInterval` field under `Spec` to the desired value in seconds. | |
| 1. Set the **refreshInterval** field under **Spec** to the desired value in seconds. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Targeted for 2.10.0 release