From d497641fa577633d688947268084982d83ef2e46 Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Tue, 1 Apr 2025 18:51:58 +0200 Subject: [PATCH 01/27] Discourage third party software on the upstream cluster Signed-off-by: Silvio Moioli --- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 28 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +----------- 18 files changed, 168 insertions(+), 120 deletions(-) diff --git a/docs/reference-guides/best-practices/rancher-server/rancher-server.md b/docs/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/docs/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/docs/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 55deb80c8d3..a760bbebff1 100644 --- a/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/docs/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts diff --git a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 07dd8265986..d7b6707b679 100644 --- a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts diff --git a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 55deb80c8d3..a760bbebff1 100644 --- a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 07dd8265986..d7b6707b679 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 07dd8265986..d7b6707b679 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..ce612a63ba7 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,32 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. + +Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. + +The following applications and components generally do not interfere with Rancher or Kubernetes system performance: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs + * Cloud controller managers + * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) + * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + +Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. + +In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. + +In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. + +The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 07dd8265986..d7b6707b679 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts From 674ef8b72573f5469b85c0e1550b6de978759d0c Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Thu, 10 Apr 2025 12:36:37 +0200 Subject: [PATCH 02/27] Recommended Harbor for community uses, reworded for clarity Signed-off-by: Silvio Moioli --- .../tips-for-running-rancher.md | 20 ++++++++++--------- .../tips-for-running-rancher.md | 20 ++++++++++--------- .../tips-for-running-rancher.md | 20 ++++++++++--------- .../tips-for-running-rancher.md | 20 ++++++++++--------- .../tips-for-running-rancher.md | 20 ++++++++++--------- .../tips-for-running-rancher.md | 20 ++++++++++--------- 6 files changed, 66 insertions(+), 54 deletions(-) diff --git a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) diff --git a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) diff --git a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index ce612a63ba7..f5e651016f6 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -16,26 +16,28 @@ When you set up your high-availability Rancher installation, consider the follow ### Minimize Third-Party Software on the Upstream Cluster -Running Rancher, especially as the number of managed clusters, nodes, and workloads increases, can place a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher itself, potentially causing issues. +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. -Every third-party application introduces a risk of interference. To minimize performance and incompatibility issues on the upstream cluster, avoid deploying any applications or components other than essential Kubernetes system components and Rancher. +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. -The following applications and components generally do not interfere with Rancher or Kubernetes system performance: +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: * Rancher internal components, such as Fleet * Rancher extensions * Cluster API components - * CNIs + * CNIs, CPIs, CSIs * Cloud controller managers * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [SUSE Private Registry](https://documentation.suse.com/cloudnative/suse-private-registry/html/private-registry/index.html) + * the [Harbor](https://goharbor.io/) container registry -Remember that each of these has its own minimum resource requirements, which must be met in addition to Rancher's requirements. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. -In particular, SUSE Private Registry can require significant bandwidth for serving images. Ensure sufficient bandwidth is available (and ideally, reserved using Quality of Service mechanisms) for Rancher. +Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. -In high-scale scenarios, consider dedicating separate nodes to non-Rancher software to minimize interference. +For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -The following software has been found to interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) From 2a9af4d13aa3960149959e5db30c55ef823487d4 Mon Sep 17 00:00:00 2001 From: Silvio Moioli Date: Wed, 4 Jun 2025 14:18:45 +0200 Subject: [PATCH 03/27] rewording after feedback from Support about registries Signed-off-by: Silvio Moioli --- .../tips-for-running-rancher.md | 25 ++++++++++++------- .../tips-for-running-rancher.md | 25 ++++++++++++------- .../tips-for-running-rancher.md | 25 ++++++++++++------- .../tips-for-running-rancher.md | 1 - .../tips-for-running-rancher.md | 25 ++++++++++++------- .../tips-for-running-rancher.md | 25 ++++++++++++------- .../tips-for-running-rancher.md | 25 ++++++++++++------- 7 files changed, 96 insertions(+), 55 deletions(-) diff --git a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/docs/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.10/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.11/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 5ff66fd8201..f70de4b2cce 100644 --- a/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.6/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -40,4 +40,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.7/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.8/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index f5e651016f6..c8e12b81efe 100644 --- a/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.9/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -28,20 +28,28 @@ The following applications and components generally do not interfere with Ranche * Cluster API components * CNIs, CPIs, CSIs * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - * the [Harbor](https://goharbor.io/) container registry + * Observability and monitoring tools (except prometheus-rancher-exporter) -Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. -Container registries, in particular, can require significant bandwidth for serving images. Ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms, for Rancher. - -For high-scale deployments, consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. - -The following software can interfere with Rancher performance at scale and is therefore discouraged on the upstream cluster: +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: * [CrossPlane](https://www.crossplane.io/) * [Argo CD](https://argoproj.github.io/cd/) * [Flux](https://fluxcd.io/) * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -63,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - From 294f6a0337de629c54c1baa07d8bded1421df340 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 14:49:00 -0700 Subject: [PATCH 04/27] [2.11.3] versions update Signed-off-by: Sunil Singh --- src/pages/versions.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/pages/versions.md b/src/pages/versions.md index c87184ca185..f3807d4a03b 100644 --- a/src/pages/versions.md +++ b/src/pages/versions.md @@ -17,9 +17,9 @@ Here you can find links to supporting documentation for the current released ver Community - v2.11.2 + v2.11.3 Documentation - Release Notes + Release Notes
N/A
✓
✓
@@ -102,6 +102,14 @@ Here you can find links to supporting documentation for previous versions of Ran Prime Community + + v2.11.2 + Documentation + Release Notes +
Support Matrix
+
✓
+
✓
+ v2.11.1 Documentation From e132f13396c1cb02a31e131ca5ee5a745dee66ef Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 14:52:13 -0700 Subject: [PATCH 05/27] [2.11.3] webhook update Signed-off-by: Sunil Singh --- docs/reference-guides/rancher-webhook.md | 1 + .../current/reference-guides/rancher-webhook.md | 1 + .../version-2.11/reference-guides/rancher-webhook.md | 1 + versioned_docs/version-2.11/reference-guides/rancher-webhook.md | 1 + 4 files changed, 4 insertions(+) diff --git a/docs/reference-guides/rancher-webhook.md b/docs/reference-guides/rancher-webhook.md index 27c9b2b2e12..760e51bd32d 100644 --- a/docs/reference-guides/rancher-webhook.md +++ b/docs/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Each Rancher version is designed to be compatible with a single version of the w | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | |-----------------|-----------------|-----------------------|---------------------------| +| v2.11.3 | v0.7.3 | ✓ | ✓ | | v2.11.2 | v0.7.2 | ✓ | ✓ | | v2.11.1 | v0.7.1 | ✓ | ✓ | | v2.11.0 | v0.7.0 | ✗ | ✓ | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference-guides/rancher-webhook.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference-guides/rancher-webhook.md index 00d96b58a38..a4cadfd26a9 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference-guides/rancher-webhook.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | |-----------------|-----------------|-----------------------|---------------------------| +| v2.11.3 | v0.7.3 | ✓ | ✓ | | v2.11.2 | v0.7.2 | ✓ | ✓ | | v2.11.1 | v0.7.1 | ✓ | ✓ | | v2.11.0 | v0.7.0 | ✗ | ✓ | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/reference-guides/rancher-webhook.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/reference-guides/rancher-webhook.md index 00d96b58a38..a4cadfd26a9 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/reference-guides/rancher-webhook.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | |-----------------|-----------------|-----------------------|---------------------------| +| v2.11.3 | v0.7.3 | ✓ | ✓ | | v2.11.2 | v0.7.2 | ✓ | ✓ | | v2.11.1 | v0.7.1 | ✓ | ✓ | | v2.11.0 | v0.7.0 | ✗ | ✓ | diff --git a/versioned_docs/version-2.11/reference-guides/rancher-webhook.md b/versioned_docs/version-2.11/reference-guides/rancher-webhook.md index 27c9b2b2e12..760e51bd32d 100644 --- a/versioned_docs/version-2.11/reference-guides/rancher-webhook.md +++ b/versioned_docs/version-2.11/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Each Rancher version is designed to be compatible with a single version of the w | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | |-----------------|-----------------|-----------------------|---------------------------| +| v2.11.3 | v0.7.3 | ✓ | ✓ | | v2.11.2 | v0.7.2 | ✓ | ✓ | | v2.11.1 | v0.7.1 | ✓ | ✓ | | v2.11.0 | v0.7.0 | ✗ | ✓ | From 50ad16cd11215d8edcf4d8dc716cdcd8f4656d62 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 14:54:35 -0700 Subject: [PATCH 06/27] [2.11.3] CSP adapter update Signed-off-by: Sunil Singh --- .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + 4 files changed, 4 insertions(+) diff --git a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 1f1d6335a21..9d6fd0b1876 100644 --- a/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/docs/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -19,6 +19,7 @@ In order to deploy and run the adapter successfully, you need to ensure its vers | Rancher Version | Adapter Version | |-----------------|------------------| +| v2.11.3 | v106.0.0+up6.0.0 | | v2.11.2 | v106.0.0+up6.0.0 | | v2.11.1 | v106.0.0+up6.0.0 | | v2.11.0 | v106.0.0+up6.0.0 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index e883536a6ad..c7f256a912f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -15,6 +15,7 @@ title: 安装 Adapter | Rancher 版本 | Adapter 版本 | |-----------------|:----------------:| +| v2.11.3 | v106.0.0+up6.0.0 | | v2.11.2 | v106.0.0+up6.0.0 | | v2.11.1 | v106.0.0+up6.0.0 | | v2.11.0 | v106.0.0+up6.0.0 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index e883536a6ad..c7f256a912f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -15,6 +15,7 @@ title: 安装 Adapter | Rancher 版本 | Adapter 版本 | |-----------------|:----------------:| +| v2.11.3 | v106.0.0+up6.0.0 | | v2.11.2 | v106.0.0+up6.0.0 | | v2.11.1 | v106.0.0+up6.0.0 | | v2.11.0 | v106.0.0+up6.0.0 | diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/versioned_docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 1f1d6335a21..9d6fd0b1876 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -19,6 +19,7 @@ In order to deploy and run the adapter successfully, you need to ensure its vers | Rancher Version | Adapter Version | |-----------------|------------------| +| v2.11.3 | v106.0.0+up6.0.0 | | v2.11.2 | v106.0.0+up6.0.0 | | v2.11.1 | v106.0.0+up6.0.0 | | v2.11.0 | v106.0.0+up6.0.0 | From 010c4740780c44f21b6dd3bfa702e2fb6b2b1976 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 14:57:22 -0700 Subject: [PATCH 07/27] [2.11.3] deprecated features update Signed-off-by: Sunil Singh --- docs/faq/deprecated-features.md | 1 + .../current/faq/deprecated-features.md | 1 + .../version-2.11/faq/deprecated-features.md | 1 + versioned_docs/version-2.11/faq/deprecated-features.md | 1 + 4 files changed, 4 insertions(+) diff --git a/docs/faq/deprecated-features.md b/docs/faq/deprecated-features.md index 221a39ae343..959e3edf1d2 100644 --- a/docs/faq/deprecated-features.md +++ b/docs/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher will publish deprecated features as part of the [release notes](https:// | Patch Version | Release Date | |---------------|---------------| +| [2.11.3](https://github.com/rancher/rancher/releases/tag/v2.11.3) | June 25, 2025 | | [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | May 22, 2025 | | [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | Apr 24, 2025 | | [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | Mar 31, 2025 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/faq/deprecated-features.md b/i18n/zh/docusaurus-plugin-content-docs/current/faq/deprecated-features.md index e604fde7528..18fd39792ad 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/faq/deprecated-features.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/ | Patch 版本 | 发布时间 | | ----------------------------------------------------------------- | ------------------ | +| [2.11.3](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 6 月 25 日 | | [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 5 月 22 日 | | [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | 2025 年 4 月 24 日 | | [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | 2025 年 3 月 31 日 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/faq/deprecated-features.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/faq/deprecated-features.md index 77858e42886..9a7fa36c80e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/faq/deprecated-features.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/ | Patch 版本 | 发布时间 | | --------------------------------------------------------------- | ------------------ | +| [2.11.3](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 6 月 25 日 | | [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 5 月 22 日 | | [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | 2025 年 4 月 24 日 | | [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | 2025 年 3 月 31 日 | diff --git a/versioned_docs/version-2.11/faq/deprecated-features.md b/versioned_docs/version-2.11/faq/deprecated-features.md index 221a39ae343..959e3edf1d2 100644 --- a/versioned_docs/version-2.11/faq/deprecated-features.md +++ b/versioned_docs/version-2.11/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher will publish deprecated features as part of the [release notes](https:// | Patch Version | Release Date | |---------------|---------------| +| [2.11.3](https://github.com/rancher/rancher/releases/tag/v2.11.3) | June 25, 2025 | | [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | May 22, 2025 | | [2.11.1](https://github.com/rancher/rancher/releases/tag/v2.11.1) | Apr 24, 2025 | | [2.11.0](https://github.com/rancher/rancher/releases/tag/v2.11.0) | Mar 31, 2025 | From 697e8ab17826e86504f94ee41c8370295852a0f7 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 15:01:30 -0700 Subject: [PATCH 08/27] [2.11.3] CNI update Signed-off-by: Sunil Singh --- shared-files/_cni-popularity.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/shared-files/_cni-popularity.md b/shared-files/_cni-popularity.md index b7b40658ee8..24d97463128 100644 --- a/shared-files/_cni-popularity.md +++ b/shared-files/_cni-popularity.md @@ -1,10 +1,10 @@ -The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity levels. This data was collected in May 2025. +The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity levels. This data was collected in June 2025. | Provider | Project | Stars | Forks | Contributors | | ---- | ---- | ---- | ---- | ---- | -| Canal | https://github.com/projectcalico/canal | 719 | 99 | 20 | -| Flannel | https://github.com/flannel-io/flannel | 9.1k | 2.9k | 238 | -| Calico | https://github.com/projectcalico/calico | 6.4k | 1.4k | 375 | -| Weave | https://github.com/weaveworks/weave | 6.6k | 680 | 84 | -| Cilium | https://github.com/cilium/cilium | 21.6k | 3.2k | 931 | +| Canal | https://github.com/projectcalico/canal | 720 | 99 | 20 | +| Flannel | https://github.com/flannel-io/flannel | 9.2k | 2.9k | 239 | +| Calico | https://github.com/projectcalico/calico | 6.5k | 1.4k | 378 | +| Weave | https://github.com/weaveworks/weave | 6.6k | 681 | 84 | +| Cilium | https://github.com/cilium/cilium | 21.9k | 3.3k | 948 | From 74c82af2caa70f2e5ab04a337cd7101952ad592f Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 15:07:58 -0700 Subject: [PATCH 09/27] [2.10.7] versions update Signed-off-by: Sunil Singh --- src/pages/versions.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/pages/versions.md b/src/pages/versions.md index c87184ca185..8a52da8be69 100644 --- a/src/pages/versions.md +++ b/src/pages/versions.md @@ -38,9 +38,9 @@ Here you can find links to supporting documentation for the current released ver Community - v2.10.6 + v2.10.7 Documentation - Release Notes + Release Notes
N/A
✓
N/A
@@ -131,6 +131,14 @@ Here you can find links to supporting documentation for previous versions of Ran Prime Community + + v2.10.6 + Documentation + Release Notes +
Support Matrix
+
✓
+
N/A
+ v2.10.5 Documentation From cb0c444f01916a7ce6b9f7563e8d2ed9038240ba Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 15:09:43 -0700 Subject: [PATCH 10/27] [2.10.7] webhook update Signed-off-by: Sunil Singh --- .../version-2.10/reference-guides/rancher-webhook.md | 1 + versioned_docs/version-2.10/reference-guides/rancher-webhook.md | 1 + 2 files changed, 2 insertions(+) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/reference-guides/rancher-webhook.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/reference-guides/rancher-webhook.md index 46790712049..62a649ba021 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/reference-guides/rancher-webhook.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | | --------------- | --------------- | --------------------- | ------------------------- | +| v2.10.7 | v0.6.8 | ✓ | ✗ | | v2.10.6 | v0.6.7 | ✓ | ✗ | | v2.10.5 | v0.6.6 | ✓ | ✗ | | v2.10.4 | v0.6.5 | ✓ | ✗ | diff --git a/versioned_docs/version-2.10/reference-guides/rancher-webhook.md b/versioned_docs/version-2.10/reference-guides/rancher-webhook.md index 5dac037bdc1..bbfe2df7cdf 100644 --- a/versioned_docs/version-2.10/reference-guides/rancher-webhook.md +++ b/versioned_docs/version-2.10/reference-guides/rancher-webhook.md @@ -20,6 +20,7 @@ Each Rancher version is designed to be compatible with a single version of the w | Rancher Version | Webhook Version | Availability in Prime | Availability in Community | |-----------------|-----------------|-----------------------|---------------------------| +| v2.10.7 | v0.6.8 | ✓ | ✗ | | v2.10.6 | v0.6.7 | ✓ | ✗ | | v2.10.5 | v0.6.6 | ✓ | ✗ | | v2.10.4 | v0.6.5 | ✓ | ✗ | From 195bf9e1b05a49353321e3f297eb552b5d230682 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 15:11:37 -0700 Subject: [PATCH 11/27] [2.10.7] CSP adapter update Signed-off-by: Sunil Singh --- .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + .../cloud-marketplace/aws-cloud-marketplace/install-adapter.md | 1 + 2 files changed, 2 insertions(+) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index 7faa08ef4cf..9297a847e3a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -15,6 +15,7 @@ title: 安装 Adapter | Rancher 版本 | Adapter 版本 | |-----------------|:---------------:| +| v2.10.7 | v105.0.0+up5.0.1 | | v2.10.6 | v105.0.0+up5.0.1 | | v2.10.5 | v105.0.0+up5.0.1 | | v2.10.4 | v105.0.0+up5.0.1 | diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md b/versioned_docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md index f94111410eb..3e33e726550 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md @@ -19,6 +19,7 @@ In order to deploy and run the adapter successfully, you need to ensure its vers | Rancher Version | Adapter Version | |-----------------|------------------| +| v2.10.7 | v105.0.0+up5.0.1 | | v2.10.6 | v105.0.0+up5.0.1 | | v2.10.5 | v105.0.0+up5.0.1 | | v2.10.4 | v105.0.0+up5.0.1 | From 919a0c4128fb60bd3526a0d328341b1a0323da99 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 23 Jun 2025 15:13:16 -0700 Subject: [PATCH 12/27] [2.10.7] deprecated features update Signed-off-by: Sunil Singh --- .../version-2.10/faq/deprecated-features.md | 1 + versioned_docs/version-2.10/faq/deprecated-features.md | 1 + 2 files changed, 2 insertions(+) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/faq/deprecated-features.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/faq/deprecated-features.md index 8e377548af2..3e6b264b54c 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/faq/deprecated-features.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/ | Patch 版本 | 发布时间 | | --------------------------------------------------------------- | -------------------- | +| [2.10.7](https://github.com/rancher/rancher/releases/tag/v2.10.7) | 2025 年 6 月 25 日 | | [2.10.6](https://github.com/rancher/rancher/releases/tag/v2.10.6) | 2025 年 5 月 22 日 | | [2.10.5](https://github.com/rancher/rancher/releases/tag/v2.10.5) | 2025 年 4 月 24 日 | | [2.10.4](https://github.com/rancher/rancher/releases/tag/v2.10.4) | 2025 年 3 月 31 日 | diff --git a/versioned_docs/version-2.10/faq/deprecated-features.md b/versioned_docs/version-2.10/faq/deprecated-features.md index 80fc9a9f985..81984e43a7a 100644 --- a/versioned_docs/version-2.10/faq/deprecated-features.md +++ b/versioned_docs/version-2.10/faq/deprecated-features.md @@ -16,6 +16,7 @@ Rancher will publish deprecated features as part of the [release notes](https:// | Patch Version | Release Date | |---------------|---------------| +| [2.10.7](https://github.com/rancher/rancher/releases/tag/v2.10.7) | June 25, 2025 | | [2.10.6](https://github.com/rancher/rancher/releases/tag/v2.10.6) | May 22, 2025 | | [2.10.5](https://github.com/rancher/rancher/releases/tag/v2.10.5) | Apr 24, 2025 | | [2.10.4](https://github.com/rancher/rancher/releases/tag/v2.10.4) | Mar 31, 2025 | From 93177e4d06024fb31116e1f9ba958a9ca91d1d5a Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 5 Jun 2025 09:31:54 +0200 Subject: [PATCH 13/27] Fix #1736 --- .../helm-charts-in-rancher.md | 24 ++---------------- .../helm-charts-in-rancher.md | 24 ++---------------- .../helm-charts-in-rancher.md | 24 ++---------------- .../helm-charts-in-rancher.md | 25 ++----------------- .../helm-charts-in-rancher.md | 23 +---------------- 5 files changed, 9 insertions(+), 111 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 a9d3807722f..6754c04a747 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 @@ -42,26 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-istio | 105.0.0+up1.19.6 | 105.4.0+up1.23.2 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov[1](#sriov-chart-deprecation-and-migration) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: @@ -236,7 +216,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. @@ -295,4 +275,4 @@ To migrate, follow these steps: - When determining the most recent version to display for the **Upgradable** column on the **Apps > Installed Apps** page, rather than only considering versions of the Helm chart from the repository it was installed from, Rancher considers versions of the Helm chart from all repositories on the cluster. For example, suppose you install `cert-manager` v1.13.0 from repository A, where v1.14.0 is now the most recent version available. In this case, you expect **Upgradable** to display v1.14.0. However, if the cluster also has access to repository B where v1.15.0 of `cert-manager` is available, then **Upgradable** displays v1.15.0 even though the original installation used repository A. - \ No newline at end of file + diff --git a/versioned_docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 3d5025a8c43..f39f88b765d 100644 --- a/versioned_docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,26 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-istio | 105.0.0+up1.19.6 | 105.4.0+up1.23.2 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov[1](#sriov-chart-deprecation-and-migration) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: @@ -242,7 +222,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. @@ -301,4 +281,4 @@ To migrate, follow these steps: - When determining the most recent version to display for the **Upgradable** column on the **Apps > Installed Apps** page, rather than only considering versions of the Helm chart from the repository it was installed from, Rancher considers versions of the Helm chart from all repositories on the cluster. For example, suppose you install `cert-manager` v1.13.0 from repository A, where v1.14.0 is now the most recent version available. In this case, you expect **Upgradable** to display v1.14.0. However, if the cluster also has access to repository B where v1.15.0 of `cert-manager` is available, then **Upgradable** displays v1.15.0 even though the original installation used repository A. - \ No newline at end of file + diff --git a/versioned_docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index a9d3807722f..6754c04a747 100644 --- a/versioned_docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,26 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-istio | 105.0.0+up1.19.6 | 105.4.0+up1.23.2 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov[1](#sriov-chart-deprecation-and-migration) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: @@ -236,7 +216,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. @@ -295,4 +275,4 @@ To migrate, follow these steps: - When determining the most recent version to display for the **Upgradable** column on the **Apps > Installed Apps** page, rather than only considering versions of the Helm chart from the repository it was installed from, Rancher considers versions of the Helm chart from all repositories on the cluster. For example, suppose you install `cert-manager` v1.13.0 from repository A, where v1.14.0 is now the most recent version available. In this case, you expect **Upgradable** to display v1.14.0. However, if the cluster also has access to repository B where v1.15.0 of `cert-manager` is available, then **Upgradable** displays v1.15.0 even though the original installation used repository A. - \ No newline at end of file + 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 e327cbdf0f2..eb05ef8fb30 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 @@ -42,27 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: @@ -196,7 +175,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. @@ -230,4 +209,4 @@ To upgrade legacy multi-cluster apps: ## Limitations -Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI. \ No newline at end of file +Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI. diff --git a/versioned_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index d8aa27ea085..1946832b71a 100644 --- a/versioned_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov[1](#sriov-chart-deprecation-and-migration) (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: @@ -207,7 +186,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. From efdba08345aa2b6b1fbf452ab754cd8dcc338b0a Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 26 Jun 2025 21:36:06 +0200 Subject: [PATCH 14/27] Update zh --- .../helm-charts-in-rancher.md | 21 ------------------- .../helm-charts-in-rancher.md | 21 ------------------- .../helm-charts-in-rancher.md | 21 ------------------- .../helm-charts-in-rancher.md | 21 ------------------- .../helm-charts-in-rancher.md | 21 ------------------- 5 files changed, 105 deletions(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2d1a8dd374c..05f76f3769f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index c90a84dd62f..70343fb6891 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2d1a8dd374c..05f76f3769f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2d1a8dd374c..05f76f3769f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2d1a8dd374c..05f76f3769f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： From 676c90c9f2f36607e733c90a31e82dfab6ac7078 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 5 Jun 2025 11:00:47 +0200 Subject: [PATCH 15/27] Fix #1648 --- .../psa-config-templates.md | 1 + .../psa-config-templates.md | 1 + .../psa-config-templates.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index 67949dbbff4..0ea24911d5a 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -120,6 +120,7 @@ When you run Rancher on a Kubernetes cluster that enforces a restrictive securit - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` diff --git a/versioned_docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/versioned_docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index 67949dbbff4..0ea24911d5a 100644 --- a/versioned_docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/versioned_docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -120,6 +120,7 @@ When you run Rancher on a Kubernetes cluster that enforces a restrictive securit - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` diff --git a/versioned_docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/versioned_docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index 67949dbbff4..0ea24911d5a 100644 --- a/versioned_docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/versioned_docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -120,6 +120,7 @@ When you run Rancher on a Kubernetes cluster that enforces a restrictive securit - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` From 3d9acd5b6b07f01df7cd7b2a53267d522391d12c Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 26 Jun 2025 21:24:18 +0200 Subject: [PATCH 16/27] Update zh --- .../psa-config-templates.md | 1 + .../psa-config-templates.md | 1 + .../psa-config-templates.md | 1 + 3 files changed, 3 insertions(+) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index e38b0fd3113..22d7033980d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -113,6 +113,7 @@ The policies shipped by default in Rancher aim to provide a trade-off between se - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index e38b0fd3113..22d7033980d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.10/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -113,6 +113,7 @@ The policies shipped by default in Rancher aim to provide a trade-off between se - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index e38b0fd3113..22d7033980d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.11/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -113,6 +113,7 @@ The policies shipped by default in Rancher aim to provide a trade-off between se - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` From afcecfc7665358162de980cf7cf8b80f2fc5893c Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 26 Jun 2025 22:25:26 +0200 Subject: [PATCH 17/27] Update version-2.12 --- .../helm-charts-in-rancher.md | 21 ------------------- .../helm-charts-in-rancher.md | 20 ------------------ 2 files changed, 41 deletions(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2d1a8dd374c..05f76f3769f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,27 +42,6 @@ Rancher chart 的版本设计方案主要围绕 charts 的主要版本以及与 2. 点击 **Preferences**. 3. 在 **Helm Charts** 下, 选择 **Include Prerelease Versions**. -### 版本控制方案 - -| **Name** | **支持的最低版本** | **支持的最高版本** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-gatekeeper | 100.0.0+up3.6.0 | 100.1.0+up3.7.1 | -| rancher-istio | 100.0.0+up1.10.4 | 100.3.0+up1.13.3 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov (experimental) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## 访问 Charts **Charts** 页面包含所有 Rancher、Rancher 合作伙伴和自定义 Chart。你可以通过选择左侧的下拉菜单来筛选 Chart： diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index a9d3807722f..2e36ff1c010 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -42,26 +42,6 @@ To display prerelease versions: 1. Click **Preferences**. 1. Under **Helm Charts**, select **Include Prerelease Versions**. -### Feature Charts - -| **Name** | **Supported Minimum Version** | **Supported Maximum Version** | -| ---------------- | ------------ | ------------ | -| external-ip-webhook | 100.0.0+up1.0.0 | 100.0.1+up1.0.1 | -| harvester-cloud-provider | 100.0.2+up0.1.12 | 100.0.2+up0.1.12 | -| harvester-csi-driver | 100.0.2+up0.1.11 | 100.0.2+up0.1.11 | -| neuvector | 100.0.0+up2.2.0 | 100.0.0+up2.2.0 | -| rancher-alerting-drivers | 100.0.0 | 100.0.2 | -| rancher-backup | 2.0.1 | 2.1.2 | -| rancher-cis-benchmark | 2.0.1 | 2.0.4 | -| rancher-istio | 105.0.0+up1.19.6 | 105.4.0+up1.23.2 | -| rancher-logging | 100.0.0+up3.12.0 | 100.1.2+up3.17.4 | -| rancher-longhorn | 100.0.0+up1.1.2 | 100.1.2+up1.2.4 | -| rancher-monitoring | 100.0.0+up16.6.0 | 100.1.2+up19.0.3 | -| rancher-sriov[1](#sriov-chart-deprecation-and-migration) | 100.0.0+up0.1.0 | 100.0.3+up0.1.0 | -| rancher-vsphere-cpi | 100.3.0+up1.2.1 | 100.3.0+up1.2.1 | -| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 | -| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 | - ## Access Charts The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu: From a6fd173efd734ba9fc937f4be8be6fd93a2ee529 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 26 Jun 2025 22:31:10 +0200 Subject: [PATCH 18/27] Update version-2.12 --- .../psa-config-templates.md | 1 + .../psa-config-templates.md | 1 + 2 files changed, 2 insertions(+) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index e38b0fd3113..22d7033980d 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -113,6 +113,7 @@ The policies shipped by default in Rancher aim to provide a trade-off between se - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md index 67949dbbff4..0ea24911d5a 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md @@ -120,6 +120,7 @@ When you run Rancher on a Kubernetes cluster that enforces a restrictive securit - `cert-manager` - `cis-operator-system` - `fleet-default` +- `fleet-local` - `ingress-nginx` - `istio-system` - `kube-node-lease` From 0dcc69bb062071bc3bf1f544e92301f857f6ba3a Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Wed, 2 Jul 2025 17:01:17 -0700 Subject: [PATCH 19/27] Fix typo --- .../new-user-guides/deploy-apps-across-clusters/fleet.md | 2 +- .../fleet-gitops-at-scale/fleet-gitops-at-scale.md | 2 +- .../fleet-gitops-at-scale/fleet-gitops-at-scale.md | 2 +- docs/integrations-in-rancher/fleet/overview.md | 2 +- .../version-2.10/integrations-in-rancher/fleet/overview.md | 2 +- .../version-2.11/integrations-in-rancher/fleet/overview.md | 2 +- .../version-2.12/integrations-in-rancher/fleet/overview.md | 2 +- .../version-2.8/integrations-in-rancher/fleet/overview.md | 2 +- .../version-2.9/integrations-in-rancher/fleet/overview.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/archived_docs/en/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md b/archived_docs/en/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md index 29de0d33870..df2edc18752 100644 --- a/archived_docs/en/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md +++ b/archived_docs/en/version-2.6/how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md @@ -20,7 +20,7 @@ For information about how Fleet works, see [this page.](../../../integrations-in ## Accessing Fleet in the Rancher UI -Fleet comes preinstalled in Rancher and is managed by the **Continous Delivery** option in the Rancher UI. For additional information on Continuous Delivery and other Fleet troubleshooting tips, refer [here](https://fleet.rancher.io/troubleshooting). +Fleet comes preinstalled in Rancher and is managed by the **Continuous Delivery** option in the Rancher UI. For additional information on Continuous Delivery and other Fleet troubleshooting tips, refer [here](https://fleet.rancher.io/troubleshooting). Users can leverage continuous delivery to deploy their applications to the Kubernetes clusters in the git repository without any manual operation by following **gitops** practice. diff --git a/archived_docs/en/version-2.6/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md b/archived_docs/en/version-2.6/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md index 6cbe1839d46..7e4e13f553b 100644 --- a/archived_docs/en/version-2.6/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md +++ b/archived_docs/en/version-2.6/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/archived_docs/en/version-2.7/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md b/archived_docs/en/version-2.7/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md index 0175bee24fa..65b4a493787 100644 --- a/archived_docs/en/version-2.7/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md +++ b/archived_docs/en/version-2.7/integrations-in-rancher/fleet-gitops-at-scale/fleet-gitops-at-scale.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/docs/integrations-in-rancher/fleet/overview.md b/docs/integrations-in-rancher/fleet/overview.md index a490bf14dad..efe2f2fd2f4 100644 --- a/docs/integrations-in-rancher/fleet/overview.md +++ b/docs/integrations-in-rancher/fleet/overview.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/versioned_docs/version-2.10/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.10/integrations-in-rancher/fleet/overview.md index c2787aaa421..02718af54d3 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/fleet/overview.md @@ -23,7 +23,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/versioned_docs/version-2.11/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.11/integrations-in-rancher/fleet/overview.md index a490bf14dad..efe2f2fd2f4 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/fleet/overview.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/versioned_docs/version-2.12/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.12/integrations-in-rancher/fleet/overview.md index a490bf14dad..efe2f2fd2f4 100644 --- a/versioned_docs/version-2.12/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.12/integrations-in-rancher/fleet/overview.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md index a490bf14dad..efe2f2fd2f4 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/overview.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: diff --git a/versioned_docs/version-2.9/integrations-in-rancher/fleet/overview.md b/versioned_docs/version-2.9/integrations-in-rancher/fleet/overview.md index 78b79c878f5..b16bad0b64f 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/fleet/overview.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/fleet/overview.md @@ -26,7 +26,7 @@ Users can leverage continuous delivery to deploy their applications to the Kuber Follow the steps below to access Continuous Delivery in the Rancher UI: -1. Click **☰ > Continous Delivery**. +1. Click **☰ > Continuous Delivery**. 1. Select your namespace at the top of the menu, noting the following: From 6fa671800bbbd910f26054ae469425bbfeff579f Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 3 Jul 2025 15:41:24 -0700 Subject: [PATCH 20/27] Add additional tasks to release checklist --- .github/ISSUE_TEMPLATE/release-maintenance-checklist.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release-maintenance-checklist.md b/.github/ISSUE_TEMPLATE/release-maintenance-checklist.md index c61d1df02f1..cbbc503fd15 100644 --- a/.github/ISSUE_TEMPLATE/release-maintenance-checklist.md +++ b/.github/ISSUE_TEMPLATE/release-maintenance-checklist.md @@ -6,10 +6,13 @@ title: ' - Rancher Manager Release Maintenance Task Checklist' This issue is to track tasks that need to be done every release regardless of whether the release has new feature content or not. +- [ ] Create a new branch for the release. Release-specific updates should use this branch as its base - [ ] Update the [versions table](https://ranchermanager.docs.rancher.com/versions) - [ ] Update the [Rancher:webhook version mapping table](https://ranchermanager.docs.rancher.com/reference-guides/rancher-webhook) - [ ] Update the [CNI popularity table](https://ranchermanager.docs.rancher.com/faq/container-network-interface-providers#cni-community-popularity) -- [ ] Update the [CSP adapter compatibility matrix](https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter#rancher-vs-adapter-compatibility-matrix): -- [ ] Update the [deprecated features table](https://ranchermanager.docs.rancher.com/faq/deprecated-features): +- [ ] Update the [CSP adapter compatibility matrix](https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter#rancher-vs-adapter-compatibility-matrix) +- [ ] Update the [deprecated features table](https://ranchermanager.docs.rancher.com/faq/deprecated-features) +- [ ] Update the swagger-.json file +- [ ] Create a PR merging the release branch back into the main branch - [ ] Create a new [release](https://github.com/rancher/rancher-docs/releases) - [ ] Update Algolia search index From c92719e7156dba45cf3628f42bec09779f7460fa Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Fri, 4 Jul 2025 19:23:58 -0700 Subject: [PATCH 21/27] Apply to version-2.12 --- .../rancher-server/rancher-server.md | 2 +- .../tips-for-running-rancher.md | 39 +++++++++++++++++-- ...and-best-practices-for-rancher-at-scale.md | 18 +-------- 3 files changed, 38 insertions(+), 21 deletions(-) diff --git a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/rancher-server.md b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/rancher-server.md index 8babb9636fd..3ebebc02958 100644 --- a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/rancher-server.md +++ b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/rancher-server.md @@ -10,7 +10,7 @@ This guide contains our recommendations for running the Rancher server, and is i ### Recommended Architecture and Infrastructure -Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server on a high-availability Kubernetes cluster. +Refer to this [guide](tips-for-running-rancher.md) for our general advice for setting up the Rancher server for a production installation. ### Deployment Strategies diff --git a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md index 9dbf6d903c6..c8e12b81efe 100644 --- a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md +++ b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tips-for-running-rancher.md @@ -14,8 +14,42 @@ If you are installing Rancher in a vSphere environment, refer to the best practi When you set up your high-availability Rancher installation, consider the following: -### Run Rancher on a Separate Cluster -Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on. +### Minimize Third-Party Software on the Upstream Cluster + +We generally recommend running Rancher on a dedicated cluster, free of other workloads, to avoid potential performance and compatibility issues. + +Rancher, especially when managing a growing number of clusters, nodes, and workloads, places a significant load on core Kubernetes components like `etcd` and `kube-apiserver` on the upstream cluster. Third-party software can interfere with the performance of these components and Rancher, potentially leading to instability. + +Furthermore, third-party software can functionally interfere with Rancher. To minimize compatibility risks, deploy only essential Kubernetes system components and Rancher on the upstream cluster. + +The following applications and components generally do not interfere with Rancher or the Kubernetes system: + * Rancher internal components, such as Fleet + * Rancher extensions + * Cluster API components + * CNIs, CPIs, CSIs + * Cloud controller managers + * Observability and monitoring tools (except prometheus-rancher-exporter) + +Note that each of these components has its own minimum resource requirements, which must be met in addition to Rancher's. For high-scale deployments, also consider dedicating separate nodes to non-Rancher software using [taints and tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) to minimize interference. + +The following software can interfere with Rancher performance and is therefore discouraged on the upstream cluster: + * [CrossPlane](https://www.crossplane.io/) + * [Argo CD](https://argoproj.github.io/cd/) + * [Flux](https://fluxcd.io/) + * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) + * Container registries such as [Harbor](https://goharbor.io/), which can require significant bandwidth for serving images + +### Guidance for Container Registries + +Container registries, such as [Harbor](https://goharbor.io/), can consume significant network bandwidth when serving images. This demand increases with the number of images, the frequency of image pulls, and the quantity of clusters and container runtimes they serve. Due to this potential for interference with Rancher UI and API traffic, we recommend against running container registries on the same cluster as the Rancher management server. + +Regardless of your deployment strategy for a container registry, ensure sufficient bandwidth is available, ideally reserved using Quality of Service (QoS) mechanisms. + +Consider the following recommendations based on your needs: + +* **Simple Setups (HA Not a Primary Concern):** A container registry deployed as a single Virtual Machine (VM) can be a viable solution. +* **High Availability (HA) Requirements:** We recommend running the registry in a dedicated Kubernetes cluster. All other clusters should then be configured to pull images from this centralized, HA registry. +* **Very Large-Scale or Complex Network Topologies:** Multiple registry clusters might be necessary. These can be deployed in a hierarchical or federated model to efficiently distribute images and manage traffic. ### Make sure nodes are configured correctly for Kubernetes It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.5/op-guide/performance/). @@ -37,4 +71,3 @@ However, metrics-driven capacity planning analysis should be the ultimate guidan Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. After you [enable monitoring](../../../integrations-in-rancher/monitoring-and-alerting/monitoring-and-alerting.md) in the cluster, you can set up alerts to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. - diff --git a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md index 55deb80c8d3..a760bbebff1 100644 --- a/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md +++ b/versioned_docs/version-2.12/reference-guides/best-practices/rancher-server/tuning-and-best-practices-for-rancher-at-scale.md @@ -23,23 +23,7 @@ When scaling up Rancher, one typical bottleneck is resource growth in the upstre ### Minimizing Third-Party Software on the Upstream Cluster -Running Rancher at scale can put significant load on internal Kubernetes components, such as `etcd` or `kubeapiserver`. Issues may arise if third-party software interferes with the performance of those components or with Rancher. - -Every third-party piece of software carries a risk of interference. To prevent performance issues on the upstream cluster, you should avoid running any other apps or components, beyond Kubernetes system components and Rancher itself. - -Software in the following categories generally won't interfere with Rancher or Kubernetes system performance: - * Rancher internal components, such as Fleet - * Rancher extensions - * Cluster API components - * CNIs - * Cloud controller managers - * Observability and monitoring tools (with the exception of prometheus-rancher-exporter) - -On the other hand, the following software are found to interfere with Rancher performance at scale: - * [CrossPlane](https://www.crossplane.io/) - * [Argo CD](https://argoproj.github.io/cd/) - * [Flux](https://fluxcd.io/) - * [prometheus-rancher-exporter](https://github.com/David-VTUK/prometheus-rancher-exporter) (see [issue 33](https://github.com/David-VTUK/prometheus-rancher-exporter/issues/33)) +Recommendations outlined in the [general Rancher recommendations](./tips-for-running-rancher.md#minimize-third-party-software-on-the-upstream-cluster) are particularly important in a high scale context. ### Managing Your Object Counts From 9002cec58fc1b26e9d97685ece72bdc55e2fe3c4 Mon Sep 17 00:00:00 2001 From: Alessio Greggi Date: Mon, 7 Jul 2025 17:26:36 +0200 Subject: [PATCH 22/27] docs: updatepsa for project level (#1832) Signed-off-by: Alessio Greggi Co-authored-by: Petr Kovar --- .../cluster-and-project-roles.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md index 22aab5d5cac..c68dcec6148 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md @@ -196,6 +196,34 @@ As previously mentioned, custom roles can be defined for use at the cluster or p When defining a custom role, you can grant access to specific resources or specify roles from which the custom role should inherit. A custom role can be made up of a combination of specific grants and inherited roles. All grants are additive. This means that defining a narrower grant for a specific resource **will not** override a broader grant defined in a role that the custom role is inheriting from. +#### UpdatePSA For Project Level + +About defining custom roles, you can grant permission to a user to create or update *PSA* policies when defining namespaces within projects. +To do so, you can use the following `RoleTemplate` to be applied on the cluster: + +```yaml +apiVersion: management.cattle.io/v3 +builtin: false +context: project +description: '' +displayName: Manage PSA Labels +external: false +hidden: false +kind: RoleTemplate +metadata: + name: namespaces-psa +rules: + - apiGroups: + - management.cattle.io + resources: + - projects + verbs: + - updatepsa +``` + +When creating a new project (from the **Members** tab), click **Add** to add the user and select **Custom** > **Create Namespaces** (to allow the user to create namespaces). +Then click **Add** again and select `UpdatePSA` project role template from the list of **Project Permissions**. + ### Default Cluster and Project Roles By default, when a standard user creates a new cluster or project, they are automatically assigned an ownership role: either [cluster owner](#cluster-roles) or [project owner](#project-roles). However, in some organizations, these roles may overextend administrative access. In this use case, you can change the default role to something more restrictive, such as a set of individual roles or a custom role. From 60e4c3cd400c0263cc63b758b1cb3fa7c169b243 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Mon, 12 May 2025 17:51:35 +0200 Subject: [PATCH 23/27] Fix broken links See also https://github.com/rancher/rancher-product-docs/pull/267. Signed-off-by: Petr Kovar --- docs/integrations-in-rancher/cluster-api/cluster-api.md | 2 +- docs/integrations-in-rancher/cluster-api/overview.md | 6 +++--- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 6 +++--- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 6 +++--- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 4 ++-- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/integrations-in-rancher/cluster-api/cluster-api.md b/docs/integrations-in-rancher/cluster-api/cluster-api.md index 275ffd0a6b7..f2db5ca151a 100644 --- a/docs/integrations-in-rancher/cluster-api/cluster-api.md +++ b/docs/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html#cluster-api-operator-values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/docs/integrations-in-rancher/cluster-api/overview.md b/docs/integrations-in-rancher/cluster-api/overview.md index f0f0b5c9489..38aad06a16d 100644 --- a/docs/integrations-in-rancher/cluster-api/overview.md +++ b/docs/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/next/en/contributing/install_capi_operator.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/next/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md index 275ffd0a6b7..89fc019a81f 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html#cluster-api-operator-values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md index dfda7cada6e..1f38251b447 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/next/en/contributing/install_capi_operator.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md index 275ffd0a6b7..cb3808f0b1c 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html#cluster-api-operator-values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md index f0f0b5c9489..b81aa6b950d 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/next/en/contributing/install_capi_operator.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/cluster-api.md index 275ffd0a6b7..809798d3b5a 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html#cluster-api-operator-values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.15/en/reference-guides/rancher-turtles-chart/values.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md index e3f81897887..11503d11ea4 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.15/en/reference-guides/rancher-turtles-chart/values.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.15/en/reference-guides/rancher-turtles-chart/values.html). ::: From 0f6e0df7b60fb30e267f694d0eb11d104732b106 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Mon, 30 Jun 2025 17:49:45 +0200 Subject: [PATCH 24/27] Apply suggestions from code review Co-authored-by: Billy Tat --- docs/integrations-in-rancher/cluster-api/cluster-api.md | 2 +- docs/integrations-in-rancher/cluster-api/overview.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/integrations-in-rancher/cluster-api/cluster-api.md b/docs/integrations-in-rancher/cluster-api/cluster-api.md index f2db5ca151a..cb3808f0b1c 100644 --- a/docs/integrations-in-rancher/cluster-api/cluster-api.md +++ b/docs/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/docs/integrations-in-rancher/cluster-api/overview.md b/docs/integrations-in-rancher/cluster-api/overview.md index 38aad06a16d..b81aa6b950d 100644 --- a/docs/integrations-in-rancher/cluster-api/overview.md +++ b/docs/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/next/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: From 6bb29c88cc78194ba04882d3a8d14777b52aef7c Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Mon, 30 Jun 2025 18:15:58 +0200 Subject: [PATCH 25/27] Update API versions --- docs/integrations-in-rancher/cluster-api/cluster-api.md | 2 +- docs/integrations-in-rancher/cluster-api/overview.md | 8 ++++---- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 8 ++++---- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 8 ++++---- .../helm-charts-in-rancher/helm-charts-in-rancher.md | 2 +- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 8 ++++---- .../integrations-in-rancher/cluster-api/overview.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 2 +- 11 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/integrations-in-rancher/cluster-api/cluster-api.md b/docs/integrations-in-rancher/cluster-api/cluster-api.md index cb3808f0b1c..fd714d13f00 100644 --- a/docs/integrations-in-rancher/cluster-api/cluster-api.md +++ b/docs/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/docs/integrations-in-rancher/cluster-api/overview.md b/docs/integrations-in-rancher/cluster-api/overview.md index b81aa6b950d..6af309932d9 100644 --- a/docs/integrations-in-rancher/cluster-api/overview.md +++ b/docs/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md index 89fc019a81f..cb3808f0b1c 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md index 1f38251b447..a198b3882b0 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.17/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md index cb3808f0b1c..fd714d13f00 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md index b81aa6b950d..6af309932d9 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 2e36ff1c010..bc515e5c671 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -216,7 +216,7 @@ Rancher and Partner charts may have extra configurations available through custo To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs. -After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation. +After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during initial installation. Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information. diff --git a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md index 275ffd0a6b7..fd714d13f00 100644 --- a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html#cluster-api-operator-values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md index f0f0b5c9489..3fa07cb40e6 100644 --- a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/next/en/reference-guides/rancher-turtles-chart/values.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html) ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/next/en/contributing/install_capi_operator.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.8/integrations-in-rancher/cluster-api/overview.md index dfda7cada6e..6755049c5af 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/cluster-api/overview.md @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. diff --git a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md index 11503d11ea4..adc53dda580 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md @@ -219,7 +219,7 @@ The previous commands tell Helm to ignore installing `cluster-api-operator` as a When installing Rancher Turtles in your Rancher environment, by default, Rancher Turtles enables the CAPI Operator cleanup. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning. -To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that that removes the following: +To simplify uninstalling Rancher Turtles (via Rancher or Helm command), the official Rancher Turtles Helm chart includes a `post-delete` hook that removes the following: - Deletes the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed. - Deletes the CAPI `deployments` that are no longer needed. From 9621d62fedf431fdc27e228d8192611658d12c95 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Fri, 11 Jul 2025 17:29:23 +0200 Subject: [PATCH 26/27] Update API versions again --- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- docs/integrations-in-rancher/cluster-api/overview.md | 10 +++++----- .../integrations-in-rancher/cluster-api/overview.md | 4 ++-- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 10 +++++----- .../integrations-in-rancher/cluster-api/cluster-api.md | 2 +- .../integrations-in-rancher/cluster-api/overview.md | 10 +++++----- .../integrations-in-rancher/cluster-api/overview.md | 6 +++--- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/integrations-in-rancher/cluster-api/cluster-api.md b/docs/integrations-in-rancher/cluster-api/cluster-api.md index fd714d13f00..d570c52539f 100644 --- a/docs/integrations-in-rancher/cluster-api/cluster-api.md +++ b/docs/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/docs/integrations-in-rancher/cluster-api/overview.md b/docs/integrations-in-rancher/cluster-api/overview.md index 6af309932d9..e2e4a661ce0 100644 --- a/docs/integrations-in-rancher/cluster-api/overview.md +++ b/docs/integrations-in-rancher/cluster-api/overview.md @@ -16,7 +16,7 @@ Below is a visual representation of the key components of Rancher Turtles and th As defined by [Supply-chain Levels for Software Artifacts (SLSA)](https://slsa.dev/spec/v1.0/about), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package. -Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/next/en/security/slsa.html) document. +Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/stable/en/security/slsa.html) document. ## Prerequisites @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -115,7 +115,7 @@ There are two ways to install Rancher Turtles with Helm, depending on whether yo The CAPI Operator is required for installing Rancher Turtles. You can choose whether you want to take care of this dependency yourself or let the Rancher Turtles Helm chart manage it for you. [Installing Turtles as a dependency](#installing-rancher-turtles-with-cluster-api-capi-operator-as-a-helm-dependency) is simpler, but your best option depends on your specific configuration. -The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/installing_core_provider.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). +The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). #### Installing Rancher Turtles with `Cluster API (CAPI) Operator` as a Helm dependency @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md index a198b3882b0..ff0f84b4a26 100644 --- a/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.10/integrations-in-rancher/cluster-api/overview.md @@ -16,7 +16,7 @@ Below is a visual representation of the key components of Rancher Turtles and th As defined by [Supply-chain Levels for Software Artifacts (SLSA)](https://slsa.dev/spec/v1.0/about), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package. -Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/next/en/security/slsa.html) document. +Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/v0.18/en/security/slsa.html) document. ## Prerequisites @@ -115,7 +115,7 @@ There are two ways to install Rancher Turtles with Helm, depending on whether yo The CAPI Operator is required for installing Rancher Turtles. You can choose whether you want to take care of this dependency yourself or let the Rancher Turtles Helm chart manage it for you. [Installing Turtles as a dependency](#installing-rancher-turtles-with-cluster-api-capi-operator-as-a-helm-dependency) is simpler, but your best option depends on your specific configuration. -The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/installing_core_provider) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). +The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/v0.18/en/operator/manual.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). #### Installing Rancher Turtles with `Cluster API (CAPI) Operator` as a Helm dependency diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md index fd714d13f00..d570c52539f 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md index 6af309932d9..e2e4a661ce0 100644 --- a/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.11/integrations-in-rancher/cluster-api/overview.md @@ -16,7 +16,7 @@ Below is a visual representation of the key components of Rancher Turtles and th As defined by [Supply-chain Levels for Software Artifacts (SLSA)](https://slsa.dev/spec/v1.0/about), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package. -Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/next/en/security/slsa.html) document. +Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/stable/en/security/slsa.html) document. ## Prerequisites @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -115,7 +115,7 @@ There are two ways to install Rancher Turtles with Helm, depending on whether yo The CAPI Operator is required for installing Rancher Turtles. You can choose whether you want to take care of this dependency yourself or let the Rancher Turtles Helm chart manage it for you. [Installing Turtles as a dependency](#installing-rancher-turtles-with-cluster-api-capi-operator-as-a-helm-dependency) is simpler, but your best option depends on your specific configuration. -The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/installing_core_provider.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). +The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). #### Installing Rancher Turtles with `Cluster API (CAPI) Operator` as a Helm dependency @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html). ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [manual installation guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md index fd714d13f00..d570c52539f 100644 --- a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md +++ b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/cluster-api.md @@ -9,6 +9,6 @@ title: Cluster API (CAPI) with Rancher Turtles [Rancher Turtles](https://turtles.docs.rancher.com/) is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes) that manages the lifecycle of provisioned Kubernetes clusters, by providing integration between your Cluster API (CAPI) and Rancher. With Rancher Turtles, you can: - Import CAPI clusters into Rancher, by installing the Rancher Cluster Agent in CAPI provisioned clusters. -- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html#_cluster_api_operator_values). +- Configure the [CAPI Operator](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html#_cluster_api_operator_values). The [Overview](./overview.md) section outlines installation options, Rancher Turtles architecture, and a brief demo. For more details, see the [Rancher Turtles documentation](https://turtles.docs.rancher.com/). diff --git a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md index 3fa07cb40e6..53ac9ce4068 100644 --- a/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.12/integrations-in-rancher/cluster-api/overview.md @@ -16,7 +16,7 @@ Below is a visual representation of the key components of Rancher Turtles and th As defined by [Supply-chain Levels for Software Artifacts (SLSA)](https://slsa.dev/spec/v1.0/about), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package. -Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/next/en/security/slsa.html) document. +Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/stable/en/security/slsa.html) document. ## Prerequisites @@ -92,7 +92,7 @@ By adding the Turtles repository via the Rancher UI, Rancher can process the ins 1. Click **Rancher Turtles - the Cluster API Extension**. 1. Click **Install > Next > Install**. -This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html). +This process uses the default values for the Helm chart, which are good for most installations. If your configuration requires overriding some of these defaults, you can either specify the values during installation from the Rancher UI or you can [manually install the chart via Helm](#installing-via-helm). For details about available values, see the Rancher Turtles [Helm chart reference guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html). The installation may take a few minutes and after completing you can see the following new deployments in the cluster: @@ -115,7 +115,7 @@ There are two ways to install Rancher Turtles with Helm, depending on whether yo The CAPI Operator is required for installing Rancher Turtles. You can choose whether you want to take care of this dependency yourself or let the Rancher Turtles Helm chart manage it for you. [Installing Turtles as a dependency](#installing-rancher-turtles-with-cluster-api-capi-operator-as-a-helm-dependency) is simpler, but your best option depends on your specific configuration. -The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/installing_core_provider.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). +The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). #### Installing Rancher Turtles with `Cluster API (CAPI) Operator` as a Helm dependency @@ -177,7 +177,7 @@ stringData: :::info -For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/chart.html) +For detailed information on the values supported by the chart and their usage, refer to [Helm chart options](https://turtles.docs.rancher.com/turtles/stable/en/operator/chart.html) ::: @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/v0.20/en/operator/manual.html) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/stable/en/operator/manual.html) in the Rancher Turtles documentation for assistance. ::: diff --git a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md index adc53dda580..63a0e46c2fe 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/cluster-api/overview.md @@ -16,7 +16,7 @@ Below is a visual representation of the key components of Rancher Turtles and th As defined by [Supply-chain Levels for Software Artifacts (SLSA)](https://slsa.dev/spec/v1.0/about), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package. -Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/next/en/security/slsa.html) document. +Rancher Turtles meets [SLSA Level 3](https://slsa.dev/spec/v1.0/levels#build-l3) requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the [Rancher Turtles Security](https://turtles.docs.rancher.com/turtles/v0.15/en/security/slsa.html) document. ## Prerequisites @@ -115,7 +115,7 @@ There are two ways to install Rancher Turtles with Helm, depending on whether yo The CAPI Operator is required for installing Rancher Turtles. You can choose whether you want to take care of this dependency yourself or let the Rancher Turtles Helm chart manage it for you. [Installing Turtles as a dependency](#installing-rancher-turtles-with-cluster-api-capi-operator-as-a-helm-dependency) is simpler, but your best option depends on your specific configuration. -The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/installing_core_provider) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). +The CAPI Operator allows for handling the lifecycle of [CAPI providers](https://turtles.docs.rancher.com/turtles/v0.15/en/tasks/capi-operator/installing_core_provider) using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to [Cluster API Operator book](https://cluster-api-operator.sigs.k8s.io/). #### Installing Rancher Turtles with `Cluster API (CAPI) Operator` as a Helm dependency @@ -185,7 +185,7 @@ For detailed information on the values supported by the chart and their usage, r :::note -Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/next/en/tasks/capi-operator/intro) in the Rancher Turtles documentation for assistance. +Remember that if you opt for this installation option, you must manage the CAPI Operator installation yourself. You can follow the [CAPI Operator guide](https://turtles.docs.rancher.com/turtles/v0.15/en/tasks/capi-operator/basic_cluster_api_provider_installation.html) in the Rancher Turtles documentation for assistance. ::: From 399d9683d0f48f79159a9db46f914b11ab625e4f Mon Sep 17 00:00:00 2001 From: Lucas Saintarbor Date: Fri, 11 Jul 2025 13:39:15 -0700 Subject: [PATCH 27/27] Revert "docs: updatepsa for project level (#1832)" (#1859) This reverts commit 9002cec58fc1b26e9d97685ece72bdc55e2fe3c4. --- .../cluster-and-project-roles.md | 28 ------------------- 1 file changed, 28 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md index c68dcec6148..22aab5d5cac 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md @@ -196,34 +196,6 @@ As previously mentioned, custom roles can be defined for use at the cluster or p When defining a custom role, you can grant access to specific resources or specify roles from which the custom role should inherit. A custom role can be made up of a combination of specific grants and inherited roles. All grants are additive. This means that defining a narrower grant for a specific resource **will not** override a broader grant defined in a role that the custom role is inheriting from. -#### UpdatePSA For Project Level - -About defining custom roles, you can grant permission to a user to create or update *PSA* policies when defining namespaces within projects. -To do so, you can use the following `RoleTemplate` to be applied on the cluster: - -```yaml -apiVersion: management.cattle.io/v3 -builtin: false -context: project -description: '' -displayName: Manage PSA Labels -external: false -hidden: false -kind: RoleTemplate -metadata: - name: namespaces-psa -rules: - - apiGroups: - - management.cattle.io - resources: - - projects - verbs: - - updatepsa -``` - -When creating a new project (from the **Members** tab), click **Add** to add the user and select **Custom** > **Create Namespaces** (to allow the user to create namespaces). -Then click **Add** again and select `UpdatePSA` project role template from the list of **Project Permissions**. - ### Default Cluster and Project Roles By default, when a standard user creates a new cluster or project, they are automatically assigned an ownership role: either [cluster owner](#cluster-roles) or [project owner](#project-roles). However, in some organizations, these roles may overextend administrative access. In this use case, you can change the default role to something more restrictive, such as a set of individual roles or a custom role.