From e062f227fbccaeae7b51817d10b25fe0481a9d0e Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 7 Dec 2023 13:50:07 -0800 Subject: [PATCH 1/7] Fix links --- .../install-upgrade-on-a-kubernetes-cluster/rollbacks.md | 2 +- docs/getting-started/overview.md | 2 +- .../backup-restore-and-disaster-recovery.md | 2 +- .../install-upgrade-on-a-kubernetes-cluster/rollbacks.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md index de7776f5984..249cb053af3 100644 --- a/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md +++ b/docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md @@ -15,7 +15,7 @@ Follow the instructions from this page when: :::tip * Follow these steps to [migrate Rancher](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md). -* If you need to restore Rancher to its previous state at the same Rancher version, see the [restore documentation]( ../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md). +* If you need to restore Rancher to its previous state at the same Rancher version, see the [restore documentation](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md). ::: diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index b7f35276bc6..cafca0a14af 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -42,7 +42,7 @@ The Rancher API server is built on top of an embedded Kubernetes API server and - **Provisioning Kubernetes clusters:** The Rancher API server can [provision Kubernetes](../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md) on existing nodes, or perform [Kubernetes upgrades.](installation-and-upgrade/upgrade-and-roll-back-kubernetes.md) - **Catalog management:** Rancher provides the ability to use a [catalog of Helm charts](../pages-for-subheaders/helm-charts-in-rancher.md) that make it easy to repeatedly deploy applications. - **Managing projects:** A project is a group of multiple namespaces and access control policies within a cluster. A project is a Rancher concept, not a Kubernetes concept, which allows you to manage multiple namespaces as a group and perform Kubernetes operations in them. The Rancher UI provides features for [project administration](../pages-for-subheaders/manage-projects.md) and for [managing applications within projects.](../pages-for-subheaders/kubernetes-resources-setup.md) -- **Fleet Continuous Delivery:** Within Rancher, you can leverage [Fleet Continuous Delivery](../pages-for-subheaders/fleet-gitops-at-scale.md) to deploy applications from git repositories, without any manual operation, to targeted downstream Kubernetes clusters. +- **Fleet Continuous Delivery:** Within Rancher, you can leverage [Fleet Continuous Delivery](../integrations-in-rancher/fleet/fleet.md) to deploy applications from git repositories, without any manual operation, to targeted downstream Kubernetes clusters. - **Istio:** Our [integration with Istio](../pages-for-subheaders/istio.md) is designed so that a Rancher operator, such as an administrator or cluster owner, can deliver Istio to developers. Then developers can use Istio to enforce security policies, troubleshoot problems, or manage traffic for green/blue deployments, canary deployments, or A/B testing. ### Working with Cloud Infrastructure diff --git a/docs/pages-for-subheaders/backup-restore-and-disaster-recovery.md b/docs/pages-for-subheaders/backup-restore-and-disaster-recovery.md index 19feeb770d0..ffd11fb681c 100644 --- a/docs/pages-for-subheaders/backup-restore-and-disaster-recovery.md +++ b/docs/pages-for-subheaders/backup-restore-and-disaster-recovery.md @@ -48,7 +48,7 @@ The `rancher-backup` operator can be installed from the Rancher UI, or with the :::note -There is a known issue in Fleet that occurs after performing a restoration using the backup-restore-operator: Secrets used for clientSecretName and helmSecretName are not included in Fleet gitrepos. Refer [here](./fleet-gitops-at-scale.md#troubleshooting) for a workaround. +There is a known issue in Fleet that occurs after performing a restoration using the backup-restore-operator: Secrets used for clientSecretName and helmSecretName are not included in Fleet gitrepos. Refer [Fleet Troubleshooting](../integrations-in-rancher/fleet/overview.md#troubleshooting) for a workaround. ::: diff --git a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md index 58fb68d6d5a..3b6f5cfe38f 100644 --- a/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md +++ b/versioned_docs/version-2.7/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md @@ -15,7 +15,7 @@ Follow the instructions from this page when: :::tip * Follow these steps to [migrate Rancher](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md). -* If you need to restore Rancher to its previous state at the same Rancher version, see the [restore documentation]( ../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md). +* If you need to restore Rancher to its previous state at the same Rancher version, see the [restore documentation](../../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher.md). ::: From e37faaab8d8273cbef8b1cb3caf8b8bb33a2fe69 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 7 Dec 2023 13:53:41 -0800 Subject: [PATCH 2/7] Links to another version should be absolute --- .../authentication-permissions-and-global-configuration.md | 2 +- docs/pages-for-subheaders/monitoring-and-alerting.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages-for-subheaders/authentication-permissions-and-global-configuration.md b/docs/pages-for-subheaders/authentication-permissions-and-global-configuration.md index 509c7bdedec..0abc90d983c 100644 --- a/docs/pages-for-subheaders/authentication-permissions-and-global-configuration.md +++ b/docs/pages-for-subheaders/authentication-permissions-and-global-configuration.md @@ -82,4 +82,4 @@ The following features are available under **Global Configuration**: - **Global DNS Entries** - **Global DNS Providers** -As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](../../versioned_docs/version-2.0-2.4/pages-for-subheaders/helm-charts-in-rancher.md), [global DNS entries](../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details. \ No newline at end of file +As these are legacy features, please see the Rancher v2.0—v2.4 docs on [catalogs](/versioned_docs/version-2.0-2.4/pages-for-subheaders/helm-charts-in-rancher.md), [global DNS entries](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#adding-a-global-dns-entry), and [global DNS providers](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/globaldns.md#editing-a-global-dns-provider) for more details. diff --git a/docs/pages-for-subheaders/monitoring-and-alerting.md b/docs/pages-for-subheaders/monitoring-and-alerting.md index e76dba53edb..5dd758fab60 100644 --- a/docs/pages-for-subheaders/monitoring-and-alerting.md +++ b/docs/pages-for-subheaders/monitoring-and-alerting.md @@ -11,7 +11,7 @@ The `rancher-monitoring` application can quickly deploy leading open-source moni Introduced in Rancher v2.5, the application is powered by [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/grafana/), [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator), and the [Prometheus adapter.](https://github.com/DirectXMan12/k8s-prometheus-adapter) -For information on V1 monitoring and alerting, available in Rancher v2.2 up to v2.4, please see the Rancher v2.0—v2.4 docs on [cluster monitoring](../../versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-monitoring.md), [alerting](../../versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-alerts.md), [notifiers](../../versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/notifiers.md) and other [tools](../../versioned_docs/version-2.0-2.4/pages-for-subheaders/project-tools.md). +For information on V1 monitoring and alerting, available in Rancher v2.2 up to v2.4, please see the Rancher v2.0—v2.4 docs on [cluster monitoring](/versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-monitoring.md), [alerting](/versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-alerts.md), [notifiers](/versioned_docs/version-2.0-2.4/explanations/integrations-in-rancher/notifiers.md) and other [tools](/versioned_docs/version-2.0-2.4/pages-for-subheaders/project-tools.md). Using the `rancher-monitoring` application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster. From bdc318c33cd5bc9d34927e2db770bacf8a5ac19c Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 7 Dec 2023 14:02:20 -0800 Subject: [PATCH 3/7] Remove link to self --- docs/pages-for-subheaders/helm-charts-in-rancher.md | 2 +- .../version-2.6/pages-for-subheaders/helm-charts-in-rancher.md | 2 +- .../version-2.7/pages-for-subheaders/helm-charts-in-rancher.md | 2 +- .../version-2.8/pages-for-subheaders/helm-charts-in-rancher.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/pages-for-subheaders/helm-charts-in-rancher.md b/docs/pages-for-subheaders/helm-charts-in-rancher.md index 509dc5ea2b9..ecc7993c7d9 100644 --- a/docs/pages-for-subheaders/helm-charts-in-rancher.md +++ b/docs/pages-for-subheaders/helm-charts-in-rancher.md @@ -153,4 +153,4 @@ If you have a legacy app installed and want to upgrade it: ### Limitations -[Dashboard apps or Rancher feature charts](helm-charts-in-rancher.md) **cannot** be installed using the Rancher CLI. +Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI. diff --git a/versioned_docs/version-2.6/pages-for-subheaders/helm-charts-in-rancher.md b/versioned_docs/version-2.6/pages-for-subheaders/helm-charts-in-rancher.md index b53af8d8f6d..1169c0299da 100644 --- a/versioned_docs/version-2.6/pages-for-subheaders/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.6/pages-for-subheaders/helm-charts-in-rancher.md @@ -162,4 +162,4 @@ If you have a legacy app installed and want to upgrade it: ### Limitations -[Dashboard apps or Rancher feature charts](helm-charts-in-rancher.md) **cannot** be installed using the Rancher CLI. +Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI. diff --git a/versioned_docs/version-2.7/pages-for-subheaders/helm-charts-in-rancher.md b/versioned_docs/version-2.7/pages-for-subheaders/helm-charts-in-rancher.md index 509dc5ea2b9..ecc7993c7d9 100644 --- a/versioned_docs/version-2.7/pages-for-subheaders/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.7/pages-for-subheaders/helm-charts-in-rancher.md @@ -153,4 +153,4 @@ If you have a legacy app installed and want to upgrade it: ### Limitations -[Dashboard apps or Rancher feature charts](helm-charts-in-rancher.md) **cannot** be installed using the Rancher CLI. +Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI. diff --git a/versioned_docs/version-2.8/pages-for-subheaders/helm-charts-in-rancher.md b/versioned_docs/version-2.8/pages-for-subheaders/helm-charts-in-rancher.md index 509dc5ea2b9..ecc7993c7d9 100644 --- a/versioned_docs/version-2.8/pages-for-subheaders/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.8/pages-for-subheaders/helm-charts-in-rancher.md @@ -153,4 +153,4 @@ If you have a legacy app installed and want to upgrade it: ### Limitations -[Dashboard apps or Rancher feature charts](helm-charts-in-rancher.md) **cannot** be installed using the Rancher CLI. +Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI. From ccf20caf94f6dba17998db496542ffaf8fa92e85 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 7 Dec 2023 15:36:59 -0800 Subject: [PATCH 4/7] Use tab groups and fix more links --- docs/api/quickstart.md | 2 +- .../set-up-cloud-providers/amazon.md | 8 ++++---- .../migrate-to-out-of-tree-amazon.md | 10 +++++----- versioned_docs/version-2.8/api/quickstart.md | 2 +- .../set-up-cloud-providers/amazon.md | 8 ++++---- .../migrate-to-out-of-tree-amazon.md | 10 +++++----- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/api/quickstart.md b/docs/api/quickstart.md index 4529964d59a..043b889a69d 100644 --- a/docs/api/quickstart.md +++ b/docs/api/quickstart.md @@ -6,7 +6,7 @@ You can access Rancher's resources through the Kubernetes API. This guide will h 1. In the upper left corner, click **☰ > Global Settings**. 2. Find and copy the address in the `server-url` field. -3. [Create](../reference-guides/user-settings/api-keys#creating-an-api-key) a Rancher API key with no scope. +3. [Create](../reference-guides/user-settings/api-keys.md#creating-an-api-key) a Rancher API key with no scope. :::danger diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md index cf83a023df6..5e552b27450 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md @@ -9,7 +9,7 @@ weight: 1 :::note Important: -In Kubernetes 1.27 and later, you must use an out-of-tree AWS cloud provider. In-tree cloud providers have been deprecated. The Amazon cloud provider has been removed completely, and won't work after an upgrade to Kubernetes 1.27. The steps listed below are still required to set up an Amazon cloud provider. You can [set up an out-of-tree cloud provider for RKE](#using-the-out-of-tree-aws-cloud-provider-for-rke) after creating an IAM role and configuring the ClusterID. +In Kubernetes 1.27 and later, you must use an out-of-tree AWS cloud provider. In-tree cloud providers have been deprecated. The Amazon cloud provider has been removed completely, and won't work after an upgrade to Kubernetes 1.27. The steps listed below are still required to set up an Amazon cloud provider. You can [set up an out-of-tree cloud provider](#using-the-out-of-tree-aws-cloud-provider) after creating an IAM role and configuring the ClusterID. You can also [migrate from an in-tree to an out-of-tree AWS cloud provider](./migrate-to-out-of-tree-amazon.md) on Kubernetes 1.26 and earlier. All existing clusters must migrate prior to upgrading to v1.27 in order to stay functional. @@ -177,7 +177,7 @@ The kubelet component has the ability to automatically obtain ECR credentials, w ### Using the Out-of-Tree AWS Cloud Provider - + 1. [Node name conventions and other prerequisites](https://cloud-provider-aws.sigs.k8s.io/prerequisites/) must be followed for the cloud provider to find the instance correctly. @@ -329,7 +329,7 @@ Refer to the offical AWS upstream documentation for the [cloud controller manage ### Helm Chart Installation from CLI - + Official upstream docs for [Helm chart installation](https://github.com/kubernetes/cloud-provider-aws/tree/master/charts/aws-cloud-controller-manager) can be found on Github. @@ -605,7 +605,7 @@ kubectl rollout status daemonset -n kube-system aws-cloud-controller-manager ### Helm Chart Installation from UI - + 1. Click **☰**, then select the name of the cluster from the left navigation. diff --git a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md index c65bef6ec15..c2375d89f1f 100644 --- a/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md +++ b/docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md @@ -12,7 +12,7 @@ You can migrate from an in-tree to an out-of-tree AWS cloud provider on Kubernet To migrate from the in-tree cloud provider to the out-of-tree AWS cloud provider, you must stop the existing cluster's kube controller manager and install the AWS cloud controller manager. There are many ways to do this. Refer to the official AWS documentation on the [external cloud controller manager](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for details. -If it's acceptable to have some downtime, you can [switch to an external cloud provider](./amazon.md#using-the-out-of-tree-aws-cloud-provider-for-rke), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. +If it's acceptable to have some downtime, you can [switch to an external cloud provider](./amazon.md#using-the-out-of-tree-aws-cloud-provider), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. If your setup can't tolerate any control plane downtime, you must enable leader migration. This facilitates a smooth transition from the controllers in the kube controller manager to their counterparts in the cloud controller manager. Refer to the official AWS documentation on [Using leader migration](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for more details. @@ -20,7 +20,7 @@ If your setup can't tolerate any control plane downtime, you must enable leader The Kubernetes [cloud controller migration documentation](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#before-you-begin) states that it's possible to migrate with the same Kubernetes version, but assumes that the migration is part of a Kubernetes upgrade. Refer to the Kubernetes documentation on [migrating to use the cloud controller manager](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/) to see if you need to customize your setup before migrating. Confirm your [migration configuration values](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#default-configuration). If your cloud provider provides an implementation of the Node IPAM controller, you also need to [migrate the IPAM controller](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#node-ipam-controller-migration). ::: - + 1. Update the cluster config to enable leader migration: @@ -55,8 +55,8 @@ spec: kubectl cordon -l "node-role.kubernetes.io/controlplane=true" ``` -3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](./amazon.md#using-out-of-tree-aws-cloud-provider-for-rke2) -From Kubernetes 1.22 onwards, the kube-controller-manager will utilize a default configuration which will satisfy the controller-to-manager migration. +3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](./amazon.md#using-the-out-of-tree-aws-cloud-provider) +From Kubernetes 1.22 onwards, the kube-controller-manager will utilize a default configuration which will satisfy the controller-to-manager migration. Update container args of the `aws-cloud-controller-manager` under `spec.rkeConfig.additionalManifest` to enable leader migration: ```shell @@ -151,7 +151,7 @@ cloud_provider: kubectl cordon -l "node-role.kubernetes.io/controlplane=true" ``` -3. To install the AWS cloud controller manager, you must enable leader migration and follow the same steps as when installing AWS on a new cluster. To enable leader migration, add the following to the container arguments in step 7 while following the [steps to install the chart](./amazon.md#helm-chart-installation-from-ui-for-rke): +3. To install the AWS cloud controller manager, you must enable leader migration and follow the same steps as when installing AWS on a new cluster. To enable leader migration, add the following to the container arguments in step 7 while following the [steps to install the chart](./amazon.md#helm-chart-installation-from-ui): ```yaml - '--enable-leader-migration=true' diff --git a/versioned_docs/version-2.8/api/quickstart.md b/versioned_docs/version-2.8/api/quickstart.md index 4529964d59a..043b889a69d 100644 --- a/versioned_docs/version-2.8/api/quickstart.md +++ b/versioned_docs/version-2.8/api/quickstart.md @@ -6,7 +6,7 @@ You can access Rancher's resources through the Kubernetes API. This guide will h 1. In the upper left corner, click **☰ > Global Settings**. 2. Find and copy the address in the `server-url` field. -3. [Create](../reference-guides/user-settings/api-keys#creating-an-api-key) a Rancher API key with no scope. +3. [Create](../reference-guides/user-settings/api-keys.md#creating-an-api-key) a Rancher API key with no scope. :::danger diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md index cf83a023df6..5e552b27450 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md @@ -9,7 +9,7 @@ weight: 1 :::note Important: -In Kubernetes 1.27 and later, you must use an out-of-tree AWS cloud provider. In-tree cloud providers have been deprecated. The Amazon cloud provider has been removed completely, and won't work after an upgrade to Kubernetes 1.27. The steps listed below are still required to set up an Amazon cloud provider. You can [set up an out-of-tree cloud provider for RKE](#using-the-out-of-tree-aws-cloud-provider-for-rke) after creating an IAM role and configuring the ClusterID. +In Kubernetes 1.27 and later, you must use an out-of-tree AWS cloud provider. In-tree cloud providers have been deprecated. The Amazon cloud provider has been removed completely, and won't work after an upgrade to Kubernetes 1.27. The steps listed below are still required to set up an Amazon cloud provider. You can [set up an out-of-tree cloud provider](#using-the-out-of-tree-aws-cloud-provider) after creating an IAM role and configuring the ClusterID. You can also [migrate from an in-tree to an out-of-tree AWS cloud provider](./migrate-to-out-of-tree-amazon.md) on Kubernetes 1.26 and earlier. All existing clusters must migrate prior to upgrading to v1.27 in order to stay functional. @@ -177,7 +177,7 @@ The kubelet component has the ability to automatically obtain ECR credentials, w ### Using the Out-of-Tree AWS Cloud Provider - + 1. [Node name conventions and other prerequisites](https://cloud-provider-aws.sigs.k8s.io/prerequisites/) must be followed for the cloud provider to find the instance correctly. @@ -329,7 +329,7 @@ Refer to the offical AWS upstream documentation for the [cloud controller manage ### Helm Chart Installation from CLI - + Official upstream docs for [Helm chart installation](https://github.com/kubernetes/cloud-provider-aws/tree/master/charts/aws-cloud-controller-manager) can be found on Github. @@ -605,7 +605,7 @@ kubectl rollout status daemonset -n kube-system aws-cloud-controller-manager ### Helm Chart Installation from UI - + 1. Click **☰**, then select the name of the cluster from the left navigation. diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md index c65bef6ec15..c2375d89f1f 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md @@ -12,7 +12,7 @@ You can migrate from an in-tree to an out-of-tree AWS cloud provider on Kubernet To migrate from the in-tree cloud provider to the out-of-tree AWS cloud provider, you must stop the existing cluster's kube controller manager and install the AWS cloud controller manager. There are many ways to do this. Refer to the official AWS documentation on the [external cloud controller manager](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for details. -If it's acceptable to have some downtime, you can [switch to an external cloud provider](./amazon.md#using-the-out-of-tree-aws-cloud-provider-for-rke), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. +If it's acceptable to have some downtime, you can [switch to an external cloud provider](./amazon.md#using-the-out-of-tree-aws-cloud-provider), which removes in-tree components and then deploy charts to install the AWS cloud controller manager. If your setup can't tolerate any control plane downtime, you must enable leader migration. This facilitates a smooth transition from the controllers in the kube controller manager to their counterparts in the cloud controller manager. Refer to the official AWS documentation on [Using leader migration](https://cloud-provider-aws.sigs.k8s.io/getting_started/) for more details. @@ -20,7 +20,7 @@ If your setup can't tolerate any control plane downtime, you must enable leader The Kubernetes [cloud controller migration documentation](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#before-you-begin) states that it's possible to migrate with the same Kubernetes version, but assumes that the migration is part of a Kubernetes upgrade. Refer to the Kubernetes documentation on [migrating to use the cloud controller manager](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/) to see if you need to customize your setup before migrating. Confirm your [migration configuration values](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#default-configuration). If your cloud provider provides an implementation of the Node IPAM controller, you also need to [migrate the IPAM controller](https://kubernetes.io/docs/tasks/administer-cluster/controller-manager-leader-migration/#node-ipam-controller-migration). ::: - + 1. Update the cluster config to enable leader migration: @@ -55,8 +55,8 @@ spec: kubectl cordon -l "node-role.kubernetes.io/controlplane=true" ``` -3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](./amazon.md#using-out-of-tree-aws-cloud-provider-for-rke2) -From Kubernetes 1.22 onwards, the kube-controller-manager will utilize a default configuration which will satisfy the controller-to-manager migration. +3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](./amazon.md#using-the-out-of-tree-aws-cloud-provider) +From Kubernetes 1.22 onwards, the kube-controller-manager will utilize a default configuration which will satisfy the controller-to-manager migration. Update container args of the `aws-cloud-controller-manager` under `spec.rkeConfig.additionalManifest` to enable leader migration: ```shell @@ -151,7 +151,7 @@ cloud_provider: kubectl cordon -l "node-role.kubernetes.io/controlplane=true" ``` -3. To install the AWS cloud controller manager, you must enable leader migration and follow the same steps as when installing AWS on a new cluster. To enable leader migration, add the following to the container arguments in step 7 while following the [steps to install the chart](./amazon.md#helm-chart-installation-from-ui-for-rke): +3. To install the AWS cloud controller manager, you must enable leader migration and follow the same steps as when installing AWS on a new cluster. To enable leader migration, add the following to the container arguments in step 7 while following the [steps to install the chart](./amazon.md#helm-chart-installation-from-ui): ```yaml - '--enable-leader-migration=true' From 1a2c38b8bdfa58f5de23c5bfa9f3c44ecaa0e697 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Thu, 7 Dec 2023 15:43:08 -0800 Subject: [PATCH 5/7] Fix external link to keycloak installation docs --- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak.md | 2 +- .../authentication-config/configure-keycloak.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 76787538bd0..41a49bfb370 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 21dfc75e8d8..1305693266d 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 5516672eb87..ac404647800 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 17d906c51c0..efd716d13f0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 5516672eb87..ac404647800 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 17d906c51c0..efd716d13f0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 5516672eb87..ac404647800 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 17d906c51c0..efd716d13f0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 5516672eb87..ac404647800 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 17d906c51c0..efd716d13f0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/docs/latest/server_installation/)。 +- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md index 3c2a4025d4a..d2faf393bde 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md @@ -13,7 +13,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md index c70cc019c09..4689af252d2 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 76787538bd0..41a49bfb370 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 21dfc75e8d8..1305693266d 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 76787538bd0..41a49bfb370 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 21dfc75e8d8..1305693266d 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 76787538bd0..41a49bfb370 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 21dfc75e8d8..1305693266d 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server](https://www.keycloak.org/docs/latest/server_installation/) configured. +- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value From 45620086edb663441f2e6eea4aaee82277af73c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Lindh=C3=A9?= Date: Fri, 8 Dec 2023 18:17:53 +0100 Subject: [PATCH 6/7] Clarify "Linux dependencies" for vSphere (#960) * Clarify "Linux dependencies" for vSphere * Add note regarding rancher pentest reports public availability (#961) * Add note regarding rancher pentest reports public availability This PR will add a note regarding third-party penetration test reports public disclosure. * Update docs/pages-for-subheaders/rancher-security.md * versioning for 2.7, 2.8 * added back in webhook material at end of 2.8 page * corrected broken link --------- Co-authored-by: Pietro Dell'Amore Co-authored-by: Marty Hernandez Avedon * Add redirects for dashboard links * Updates to the Global roles for new 2.8 features (#898) * Updating docs to deprecate Restricted Admin * Updating GlobalRole Docs Updates the docs for GlobalRoles to include new info on the "escalate" and "bind" verbs, as well as include info on how to use the new "inheritedClusterRoles" field * Apply suggestions from code review * code review changes * merged some minor copyedits * Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md * Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md * fixed versioning for v2.8, v2.7 * Update docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md * copy/paste current version of global-permissions file in main to ensure file is correctly reverted to v2.7 --------- Co-authored-by: Marty Hernandez Avedon * #857 Add a API quickstart page under the (to be added) API section (#858) * initial engineering draft of api quickstart * spacing, headings * copyedit * note syntax added for last warning * link to create api keys page, copy edits * formating * Apply suggestions from code review Co-authored-by: Billy Tat * indentation, intro * Update docs/api/quickstart.md Co-authored-by: Billy Tat * Apply suggestions from code review Co-authored-by: Michael Bolot * Update docs/api/quickstart.md * removed commented-out line * moved text from step 5 to step 3, made into its own step, added info about not all resources offering detailed output * added sidebar entry * mv'd to version-2.8 dir * rm'd remainders in /docs dir --------- Co-authored-by: Billy Tat Co-authored-by: Michael Bolot * Fix version-2.8 broken links * Update header: More from SUSE * Fix quoting (single vs double) consistency * Fix link rendering issue * Add 2.7.9 entry to versions table * Add initial Opni landing page Signed-off-by: Mike Latimer * added color icons to /static/img * Add K8s Distro landing page content * added css + elemental icon * rm'd temp file * Update src/css/custom.css Co-authored-by: Billy Tat * rm usused icons * canonical links for single-user-nodes and user-settings * Update token setting page (#906) * Update token setting page * Remove unnecessary step * Harvester landing page: apply feedback from #940 * Rancher Desktop landing page: apply feedback from #944 * Epinio landing page: apply feedback from #945 * fixed spacing problem that ruined callout (#978) * rm mention of Rio from 2.7 & 2.8 (#980) * General FAQ copyedit (#983) * General FAQ copyedit * restored intro * Update etcd troubleshoot for etcd 3.5.7 and higher (#985) * Add session management section (#981) * Add note regarding rancher pentest reports public availability This PR will add a note regarding third-party penetration test reports public disclosure. * Add session management section to rancher security best practices This PR will create a new section inside Rancher Security Best Practices adding security recommendations for RM deployments that might need additional security controls. * Apply suggestions from code review Co-authored-by: Paulo Gomes * Update docs/reference-guides/rancher-security/rancher-security-best-practices.md * Update docs/reference-guides/rancher-security/rancher-security-best-practices.md Co-authored-by: Guilherme Macedo * versioned docs --------- Co-authored-by: Pietro Dell'Amore Co-authored-by: Marty Hernandez Avedon Co-authored-by: Paulo Gomes Co-authored-by: Guilherme Macedo * #879 Add Project Owner to 'Project Member Can't Create Namespace' doc (#894) * 879 Add Project Owner to 'Project Member Can't Create Namespace' doc * versioned doc * Update docs/reference-guides/rancher-webhook.md Co-authored-by: Billy Tat * Update docs/reference-guides/rancher-webhook.md Co-authored-by: Michael Bolot * Apply suggestions from code review Co-authored-by: Lucas Saintarbor * Update docs/reference-guides/rancher-webhook.md * page sync * added v2.8 page * merge syntax left in file, rm'd backticks from version numbers --------- Co-authored-by: Billy Tat Co-authored-by: Michael Bolot Co-authored-by: Lucas Saintarbor * 135 cloud-provider(aws): Need to correct content on cluster id in aws tagging section * versioning * Add delete permission and remove duplicate header (#989) * Apply suggestions from code review Co-authored-by: Billy Tat * Amazon only uses EC2, so 'use anything' is a moot point * Update CNI popularity chart numbers. Credit to @amitmavgupta for original PR. * Update Swagger file * Fix etcd.backup_config.retention description * Add Projects API workflow example * Add project workflow to sidebar; remove duplicate API category * Update versioned_docs/version-2.8/api/workflows/projects.md Co-authored-by: Marty Hernandez Avedon * #963 clarify documentation for read only permissions in monitoring UI (#964) * 963 - Clarify documentation around read-only permissions for monitoring. * fixed random Capitalization of Nouns * moved changes to v2.8 dir and revised capitalization again * Update docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md * copyedits, added workaround * copyedits * versioning * Update versioned_docs/version-2.8/api/workflows/projects.md * Update migrate-rancher-to-new-cluster.md (#1007) * Update migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * 2.7, 2.8 versioning * restoring bulleted links to rke/k3s * 2.5 to 2.8 synced * rm'd info about rke2/k3s from inappropriate version * reverted last commit -- done by mistake --------- Co-authored-by: Marty Hernandez Avedon * fix: update v2.7 cn sidebar * fixed typo in command (#1010) * Apply 4b2f8125 (sidebar label update) to other versions. Originally changed in #926 * Remove term from translated sidebar label to match English label * #420 Completes canonical links task (#1011) * Completes canonical links task * spacing * Updating CSP Adapter versions * embed video on aws marketplace page (#1016) * Port version-2.8 updates to latest (/docs) (#1013) * Port version-2.8 updates to latest (/docs) Includes changes from 1b6d9506 (2023-10-06) to 1f39a6ff (2023-11-30) * Fix redirects * #773: Add steps to install Rancher Extensions in an air-gapped environment (#807) * Add steps to install Rancher Extensions in an air-gapped environment * added link from install guide * added notes to import/install steps as suggested by rohitsakala * minor copyedits * updating extensions explicitly given own section * tightened up note * updated note for v2.7 * ensuring all 3 versions have same text * versioning install-rancher-ha * del extension repos + (partially) upgrade * fixed comment syntax * Apply suggestions from code review Co-authored-by: Billy Tat * Apply suggestions from code review * completed update instructions * no dropdown, text input * more explanation + delete * Apply suggestions from code review * extensions repo container image delete * versioning * revert changes to v2.7 --------- Co-authored-by: Billy Tat * Add aws out of tree cloud provider install/upgrade docs (#844) * Add aws out of tree cloud provider install/upgrade docs * Add aws out of tree cloud provider install/upgrade docs * Add info for aws cloud provider * indentation fix * Address review comments * addressing review comments * Address review comments * syntax annotations, re-org sections, copy edits * even more copy edits * copy edits to note at top * addressing suggestions from slickwarren * Address review comments * copyedits * Fix numbering * Update docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md * update helm installation steps * 2.8 versioning * rm 'new in 2.7' from 2.8 * Update versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md * revert -- change intended for other branch * typo fixes * fix headings, fix casing * apply prev commit to 2.8 * Reorganizing AWS migration pages (#1015) This partially addresses https://github.com/rancher/rancher-docs/issues/991 (rename file `migrating-from-in-tree-to-out-of-tree` to shorter and reference vsphere) and also fixes problems on the open PR: Duplicate sections (removed), difficulty navigating the file (split into two), sections with similar titles (opting for tabs instead of headings). I created this on its own working branch because moving around large blocks of text was unwieldly and I didn't want to mess up my local version of 763-document-aws-out-of-tree-v2prov. The last tab block (Helm Chart Installation through UI) contains contain that seems to be entirely the same for RKE and RKE2. --------- Co-authored-by: Kinara Shah Co-authored-by: martyav * Add 2.8 entry to versions table (#1002) * Update webhook version table (#1006) * Update webhook version table * Bump 2.8 webhook version * Sync 2.8 table with latest table * Bump webhook version * correcting capitalization: helm > Helm (#1018) * Remove preview label from 2.8 * Remove unreleased banner * rm 'add additional' phrase from docs (#1020) * rm 'add additional' phrase from docs * these > more * rm deprecation banner from v2.8 * rm deprecation banner from v2.8 (#1023) * [skip ci] Update README to reflect current versioning model (#1022) * [skip ci] Update README to reflect current versioning model * Update README.md * Update README.md --------- Co-authored-by: Marty Hernandez Avedon * Apply suggestions from code review * Update create-a-vm-template.md * Update create-a-vm-template.md * versioning --------- Signed-off-by: Mike Latimer Co-authored-by: pdellamore Co-authored-by: Pietro Dell'Amore Co-authored-by: Marty Hernandez Avedon Co-authored-by: Billy Tat Co-authored-by: Michael Bolot Co-authored-by: Mike Latimer Co-authored-by: Marty Hernandez Avedon Co-authored-by: Jonathan Crowther Co-authored-by: Sebastiaan van Steenis Co-authored-by: Paulo Gomes Co-authored-by: Guilherme Macedo Co-authored-by: Lucas Saintarbor Co-authored-by: Denise Co-authored-by: [yzeng25] <[yzeng25@wisc.edu]> Co-authored-by: Jake Hyde <33796120+jakefhyde@users.noreply.github.com> Co-authored-by: Kinara Shah --- .../vsphere/create-a-vm-template.md | 2 +- .../vsphere/create-a-vm-template.md | 2 +- .../vsphere/create-a-vm-template.md | 2 +- .../vsphere/create-a-vm-template.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md index e2974c08d3f..cfdd8da1f19 100644 --- a/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md +++ b/docs/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md @@ -23,7 +23,7 @@ If you have any specific firewall rules or configuration, you will need to add t ## Linux Dependencies -The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; some distributions ship these by default, for example. +The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; for example, some distributions ship these dependencies by default. The cluster provisioner will automatically install the dependencies required for Kubernetes. The dependencies listed below are required for the functioning of the Rancher cluster provisioner (not for Kubernetes): * curl * wget diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md index e2974c08d3f..cfdd8da1f19 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md @@ -23,7 +23,7 @@ If you have any specific firewall rules or configuration, you will need to add t ## Linux Dependencies -The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; some distributions ship these by default, for example. +The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; for example, some distributions ship these dependencies by default. The cluster provisioner will automatically install the dependencies required for Kubernetes. The dependencies listed below are required for the functioning of the Rancher cluster provisioner (not for Kubernetes): * curl * wget diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md index e2974c08d3f..cfdd8da1f19 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md @@ -23,7 +23,7 @@ If you have any specific firewall rules or configuration, you will need to add t ## Linux Dependencies -The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; some distributions ship these by default, for example. +The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; for example, some distributions ship these dependencies by default. The cluster provisioner will automatically install the dependencies required for Kubernetes. The dependencies listed below are required for the functioning of the Rancher cluster provisioner (not for Kubernetes): * curl * wget diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md index e2974c08d3f..cfdd8da1f19 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/vsphere/create-a-vm-template.md @@ -23,7 +23,7 @@ If you have any specific firewall rules or configuration, you will need to add t ## Linux Dependencies -The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; some distributions ship these by default, for example. +The packages that need to be installed on the template are listed below. These will have slightly different names based on distribution; for example, some distributions ship these dependencies by default. The cluster provisioner will automatically install the dependencies required for Kubernetes. The dependencies listed below are required for the functioning of the Rancher cluster provisioner (not for Kubernetes): * curl * wget From 65659f87d2af165360266cb0bd0e45ce00ebf319 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Fri, 8 Dec 2023 10:32:52 -0800 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Marty Hernandez Avedon --- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak.md | 2 +- .../authentication-config/configure-keycloak.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- .../authentication-config/configure-keycloak-oidc.md | 2 +- .../authentication-config/configure-keycloak-saml.md | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 41a49bfb370..2a30782e76c 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 1305693266d..4e3d9c2713c 100644 --- a/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index ac404647800..86dff79d0af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index efd716d13f0..145e327f3af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index ac404647800..86dff79d0af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index efd716d13f0..145e327f3af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index ac404647800..86dff79d0af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index efd716d13f0..145e327f3af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index ac404647800..86dff79d0af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -12,7 +12,7 @@ description: 创建 Keycloak OpenID Connect (OIDC) 客户端并配置 Rancher ## 先决条件 - 已在 Rancher 上禁用 Keycloak (SAML)。 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 OIDC 客户端](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients)。 | 设置 | 值 | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index efd716d13f0..145e327f3af 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -7,7 +7,7 @@ description: 创建 Keycloak SAML 客户端并配置 Rancher 以使用 Keycloak ## 先决条件 -- 你必须配置了 [Keycloak IdP 服务器]https://www.keycloak.org/guides#getting-started。 +- 你必须配置了 [Keycloak IdP 服务器](https://www.keycloak.org/guides#getting-started)。 - 在 Keycloak 中，使用以下设置创建一个[新的 SAML 客户端](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。如需获取帮助，请参见 [Keycloak 文档](https://www.keycloak.org/docs/latest/server_admin/#saml-clients)。 | 设置 | 值 | diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md index d2faf393bde..25d7a36258a 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md @@ -13,7 +13,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md index 4689af252d2..16653a89d43 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/authentication-config/configure-keycloak.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 41a49bfb370..2a30782e76c 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 1305693266d..4e3d9c2713c 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 41a49bfb370..2a30782e76c 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 1305693266d..4e3d9c2713c 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md index 41a49bfb370..2a30782e76c 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-oidc.md @@ -16,7 +16,7 @@ If you have an existing configuration using the SAML protocol and want to switch ## Prerequisites - On Rancher, Keycloak (SAML) is disabled. -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new OIDC client](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#oidc-clients) for help. Setting | Value diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md index 1305693266d..4e3d9c2713c 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-keycloak-saml.md @@ -11,7 +11,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Prerequisites -- You must have a [Keycloak IdP Server]https://www.keycloak.org/guides#getting-started configured. +- You must have a [Keycloak IdP Server](https://www.keycloak.org/guides#getting-started) configured. - In Keycloak, create a [new SAML client](https://www.keycloak.org/docs/latest/server_admin/#saml-clients), with the settings below. See the [Keycloak documentation](https://www.keycloak.org/docs/latest/server_admin/#saml-clients) for help. Setting | Value