public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/main' into move-pages-for-subheaders-2.8

Browse Source
This commit is contained in:
Billy Tat
2024-01-19 13:50:40 -08:00
parent 5a344c33f7 83bf367f00
commit 8aee26bddc
246 changed files with 2098 additions and 483 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/test-deploy.yml
+4 -2
View File
@@ -18,8 +18,10 @@ jobs:
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Check links
run: yarn run remark --quiet --use remark-validate-links --use remark-lint-no-dead-urls ./docs
- name: Check Markdown links
run: yarn run remark --quiet --use remark-validate-links ./docs
- name: Check External links
run: yarn run remark --quiet --use remark-lint-no-dead-urls ./docs
- name: Test build website
env:
NODE_OPTIONS: "--max_old_space_size=4096"
README.md
+1 -1
View File
@@ -83,7 +83,7 @@ Subsequent executions will check for updated dependencies, if there are none, it
License
=======
Copyright (c) 2014-2023 [Rancher Labs, Inc.](https://rancher.com)
Copyright (c) 2014-2024 [Rancher Labs, Inc.](https://rancher.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
docs/api/api-reference.mdx
+6
View File
@@ -2,6 +2,12 @@
title: API Reference
---
:::note
At this time, not all Rancher resources are available through the Rancher Kubernetes API.
:::
import ApiDocMdx from '@theme/ApiDocMdx';
<ApiDocMdx id="rancher-api" />
docs/api/quickstart.md
+11 -3
View File
@@ -4,7 +4,7 @@ title: API Quick Start Guide
You can access Rancher's resources through the Kubernetes API. This guide will help you get started on using this API as a Rancher user.
1. In the upper left corner, click **☰ > Global Settings**.
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.md#creating-an-api-key) a Rancher API key with no scope.
@@ -38,7 +38,7 @@ You can access Rancher's resources through the Kubernetes API. This guide will h
current-context: "rancher"
```
You can use this file with any compatible tool, such as kubectl or [client-go](https://github.com/kubernetes/client-go). For a quick demo, see the [kubectl example](#api-kubectl-example).
You can use this file with any compatible tool, such as kubectl or [client-go](https://github.com/kubernetes/client-go). For a quick demo, see the [kubectl example](#api-kubectl-example).
For more information on handling more complex certificate setups, see [Specifying CA Certs](#specifying-ca-certs).
@@ -46,6 +46,14 @@ For more information on available kubeconfig options, see the [upstream document
## API kubectl Example
In this example, we'll show how to use kubectl to create a project, followed by deleting it. For a list of other Rancher resources available, refer to the [API Reference](./api-reference.mdx) page.
:::note
At this time, not all Rancher resources are available through the Rancher Kubernetes API.
:::
1. Set your KUBECONFIG environment variable to the kubeconfig file you just created:
```bash
@@ -109,7 +117,7 @@ Not all resources may have detailed output.
To ensure that your tools can recognize Rancher's CA certificates, most setups require additional modifications to the above template.
1. In the upper left corner, click **☰ > Global Settings**.
1. In the upper left corner, click **☰ > Global Settings**.
2. Find and copy the value in the `ca-certs` field.
3. Save the value in a file named `rancher.crt`.
docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrade-a-hardened-cluster-to-k8s-v1-25.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Upgrade a Hardened Custom/Imported Cluster to Kubernetes v1.25
title: Upgrading a Hardened Custom/Imported Cluster to Kubernetes v1.25
---
<head>
docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Certificate Troubleshooting
title: Troubleshooting Certificates
---
<head>
docs/getting-started/installation-and-upgrade/resources/bootstrap-password.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Bootstrap Password
title: Setting up the Bootstrap Password
---
<head>
docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---
<head>
docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md
+2 -2
View File
@@ -24,7 +24,7 @@ The usage below defines rules about what the audit log should record and what da
| Parameter | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="audit-level"></a>`AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LOG_PATH` | Log path for Rancher Server API. Default path is `/var/log/auditlog/rancher-api-audit.log`. You can mount the log directory to host. <br/><br/>Usage Example: `AUDIT_LOG_PATH=/my/custom/path/`<br/> |
| `AUDIT_LOG_MAXAGE` | Defined the maximum number of days to retain old audit log files. Default is 10 days. |
| `AUDIT_LOG_MAXBACKUP` | Defines the maximum number of audit log files to retain. Default is 10. |
@@ -34,7 +34,7 @@ The usage below defines rules about what the audit log should record and what da
### Audit Log Levels
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#audit-level) setting.
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#api-audit-log-options) setting.
| `AUDIT_LEVEL` Setting | Request Metadata | Request Body | Response Metadata | Response Body |
| --------------------- | ---------------- | ------------ | ----------------- | ------------- |
docs/how-to-guides/advanced-user-guides/enable-experimental-features/unsupported-storage-drivers.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Allow Unsupported Storage Drivers
title: Allowing Unsupported Storage Drivers
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---
<head>
docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---
<head>
docs/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Applying Pod Security Policies to Projects
---
<head>
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Template Enforcement
title: Enforcing Templates
---
<head>
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-azure-ad.md
+1 -3
View File
@@ -33,7 +33,6 @@ Before you start, open two browser tabs: one for Rancher, and one for the Azure
:::
#### 1. Register Rancher with Azure
Before enabling Azure AD within Rancher, you must register Rancher with Azure.
@@ -47,7 +46,6 @@ Before enabling Azure AD within Rancher, you must register Rancher with Azure.
![New App Registration](/img/new-app-registration.png)
1. Enter a **Name** (something like `Rancher`).
<a id="3.2"></a>
1. From **Supported account types**, select "Accounts in this organizational directory only (AzureADTest only - Single tenant)" This corresponds to the legacy app registration options.
@@ -264,7 +262,7 @@ Admins should create a [Rancher backup](../../../new-user-guides/backup-restore-
#### Air-Gapped Environments
In air-gapped environments, admins should ensure that their endpoints are [whitelisted](#3.2) since the Graph Endpoint URL is changing.
In air-gapped environments, admins should ensure that their endpoints are whitelisted (see note on [Step 3.2 of Register Rancher with Azure](#1-register-rancher-with-azure)) since the Graph Endpoint URL is changing.
#### Rolling Back the Migration
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md
+2 -7
View File
@@ -41,18 +41,13 @@ After you complete [Configuring Microsoft AD FS for Rancher](configure-ms-adfs-f
| UID Field | An AD attribute that is unique to every user. <br/><br/>Example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn` |
| Groups Field | Make entries for managing group memberships. <br/><br/>Example: `http://schemas.xmlsoap.org/claims/Group` |
| Rancher API Host | The URL for your Rancher Server. |
| Private Key / Certificate | This is a key-certificate pair to create a secure shell between Rancher and your AD FS. Ensure you set the Common Name (CN) to your Rancher Server URL.<br/><br/>[Certificate creation command](#cert-command) |
| Private Key / Certificate | This is a key-certificate pair to create a secure shell between Rancher and your AD FS. Ensure you set the Common Name (CN) to your Rancher Server URL.<br/><br/>[Certificate creation command](#example-certificate-creation-command) |
| Metadata XML | The `federationmetadata.xml` file exported from your AD FS server. <br/><br/>You can find this file at `https://<AD_SERVER>/federationmetadata/2007-06/federationmetadata.xml`. |
<a id="cert-command"></a>
:::tip
### Example Certificate Creation Command
You can generate a certificate using an openssl command. For example:
```
openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com"
```
:::
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Creating Pod Security Policies
---
<head>
docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/pod-security-standards.md
+4 -4
View File
@@ -19,12 +19,12 @@ Ensure that you migrate all PSPs to another workload security mechanism. This in
You must add your new policy enforcement mechanisms _before_ you remove the PodSecurityPolicy objects. If you don't, you may create an opportunity for privilege escalation attacks within the cluster.
:::
### Removing PodSecurityPolicies from Rancher-Maintained Apps & Marketplace Workloads {#remove-psp-rancher-workloads}
### Removing PodSecurityPolicies from Rancher-Maintained Apps & Marketplace Workloads
Rancher v2.7.2 offers a new major version of Rancher-maintained Helm charts. v102.x.y allows you to remove PSPs that were installed with previous versions of the chart. This new version replaces non-standard PSPs switches with the standardized `global.cattle.psp.enabled` switch, which is turned off by default.
You must perform the following steps _while still in Kubernetes v1.24_:
1. Configure the PSA controller to suit your needs. You can use one of Rancher's built-in [PSA Configuration Templates](#psa-config-templates), or create a custom template and apply it to the clusters that you are migrating.
1. Configure the PSA controller to suit your needs. You can use one of Rancher's built-in [PSA Configuration Templates](#pod-security-admission-configuration-templates), or create a custom template and apply it to the clusters that you are migrating.
1. Map your active PSPs to Pod Security Standards:
1. See which PSPs are still active in your cluster:
@@ -112,14 +112,14 @@ After you install the `helm-mapkubeapis` plugin, clean up the releases that beca
#### Upgrading Charts to a Version That Supports Kubernetes v1.25
You can proceed with your upgrade once any releases that had lingering PSPs are cleaned up. For Rancher-maintained workloads, follow the steps outlined in the [Removing PodSecurityPolicies from Rancher-maintained Apps & Marketplace workloads](#remove-psp-rancher-workloads) section of this document.
You can proceed with your upgrade once any releases that had lingering PSPs are cleaned up. For Rancher-maintained workloads, follow the steps outlined in the [Removing PodSecurityPolicies from Rancher-maintained Apps & Marketplace workloads](#removing-podsecuritypolicies-from-rancher-maintained-apps--marketplace-workloads) section of this document.
For workloads not maintained by Rancher, refer to the vendor documentation.
:::caution
Do not skip this step. Applications incompatible with Kubernetes v1.25 aren't guaranteed to work after a cleanup.
:::
## Pod Security Admission Configuration Templates {#psa-config-templates}
## Pod Security Admission Configuration Templates
Rancher offers PSA configuration templates. These are pre-defined security configurations that you can apply to a cluster. Rancher admins (or those with the right permissions) can [create, manage, and edit](./psa-config-templates.md) PSA templates.
docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md
+3 -6
View File
@@ -11,7 +11,7 @@ If you are migrating Rancher to a new Kubernetes cluster, you don't need to inst
### Prerequisites
These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application.
These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application.
:::caution
@@ -21,12 +21,9 @@ It is required to use the same hostname that was set as the server URL in the fi
Rancher version must be v2.5.0 and up
Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used:
Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used.
- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/)
- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/)
Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version.
Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version.
### 1. Install the rancher-backup Helm chart
docs/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability K3s Kubernetes Cluster
title: Setting up Infrastructure for a High Availability K3s Kubernetes Cluster
---
<head>
docs/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability RKE Kubernetes Cluster
title: Setting up Infrastructure for a High Availability RKE Kubernetes Cluster
---
<head>
docs/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability RKE2 Kubernetes Cluster
title: Setting up Infrastructure for a High Availability RKE2 Kubernetes Cluster
---
<head>
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon.md → docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon.md
+4 -6
View File
@@ -3,7 +3,7 @@ title: Migrating Amazon In-tree to Out-of-tree
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon"/>
</head>
Kubernetes is moving away from maintaining cloud providers in-tree. In Kubernetes 1.27 and later, the in-tree cloud providers have been removed.
@@ -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), 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](../set-up-cloud-providers/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.
@@ -55,9 +55,7 @@ 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-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:
3. To install the AWS cloud controller manager with leader migration enabled, follow Steps 1-3 for [deploying the cloud controller manager chart](../set-up-cloud-providers/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
- '--enable-leader-migration=true'
@@ -151,7 +149,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):
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](../set-up-cloud-providers/amazon.md#helm-chart-installation-from-ui):
```yaml
- '--enable-leader-migration=true'
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-vsphere.md → docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere.md
+1 -1
View File
@@ -3,7 +3,7 @@ title: Migrating vSphere In-tree to Out-of-tree
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-from-in-tree-to-out-of-tree"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere"/>
</head>
Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins.
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
+1 -1
View File
@@ -11,7 +11,7 @@ weight: 1
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.
You can also [migrate from an in-tree to an out-of-tree AWS cloud provider](../migrate-to-an-out-of-tree-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.
Starting with Kubernetes 1.23, you must deactivate the `CSIMigrationAWS` feature gate to use the in-tree AWS cloud provider. You can do this by setting `feature-gates=CSIMigrationAWS=false` as an additional argument for the cluster's Kubelet, Controller Manager, API Server and Scheduler in the advanced cluster configuration.
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: How to Configure an In-tree vSphere Cloud Provider
title: Setting Up an In-tree vSphere Cloud Provider
---
<head>
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: How to Configure an Out-of-tree vSphere Cloud Provider
title: Setting Up an Out-of-tree vSphere Cloud Provider
---
<head>
docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/use-windows-clusters/azure-storageclass-configuration.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Configuration for Storage Classes in Azure
title: Configuring Storage Classes in Azure
---
<head>
docs/how-to-guides/new-user-guides/kubernetes-resources-setup/load-balancer-and-ingress-controller/ingress-configuration.md
+2 -2
View File
@@ -1,6 +1,6 @@
---
title: Ingress Configuration
description: Ingress configuration
title: Configuring an Ingress
description: Configuring an Ingress
---
<head>
docs/integrations-in-rancher/fleet/fleet.md
+1 -1
View File
@@ -12,7 +12,7 @@ Many users often manage over 10 clusters at a time. Given the proliferation of c
- I need to deploy my monitoring stack (e.g., Grafana, Prometheus) across geographical regions, each with different retention policies.
- I am a platform operator and want to provision clusters with all components using a scalable and safe operating model (GitOps).
- I am an application developer and want to get my latest changes to automatically into my development environment.
- I am an application developer and want my latest changes to automatically go into my development environment.
## Fleet with Rancher Prime
docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md
+9 -3
View File
@@ -112,7 +112,13 @@ Monitoring also creates additional `ClusterRoles` that aren't assigned to users
| Role | Purpose |
| ------------------------------| ---------------------------|
| monitoring-ui-view | <a id="monitoring-ui-view"></a>_Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Grafana, and Alertmanager UIs through the Rancher proxy. |
| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ This ClusterRole allows users with write access to the project to view metrics graphs for the specified cluster in the Rancher UI. This is done by granting Read-only access to external Monitoring UIs. Users with this role have permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Alertmanager, and Grafana UIs through the Rancher proxy. |
:::note
A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project.
:::
### Assigning Roles and ClusterRoles with kubectl
@@ -208,9 +214,9 @@ In addition to these default roles, the following Rancher project roles can be a
| Rancher Role | Kubernetes ClusterRole | Available In Rancher From | Available in Monitoring v2 From |
|--------------------------|-------------------------------|-------|------|
| View Monitoring* | [monitoring-ui-view](#monitoring-ui-view) | 2.4.8+ | 9.4.204+ |
| View Monitoring* | [monitoring-ui-view](#additional-monitoring-clusterroles) | 2.4.8+ | 9.4.204+ |
\* A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project.
\* A user bound to the **View Monitoring** Rancher role and read-only project permissions can't view links in the Monitoring UI. They can still access external monitoring UIs if provided links to those UIs. If you wish to grant access to users with the **View Monitoring** role and read-only project permissions, move the `cattle-monitoring-system` namespace into the project.
### Differences in 2.5.x
docs/pages-for-subheaders/about-provisioning-drivers.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Provisioning Drivers
title: About Provisioning Drivers
---
<head>
docs/pages-for-subheaders/about-the-api.md
+9
View File
@@ -82,3 +82,12 @@ You can use browser developer tools to capture how the Rancher API is called. Fo
1. In the Rancher UI, click **Create**. In the developer tools, you should see a new network request with the name `cluster?_replace=true`.
1. Right-click `cluster?_replace=true` and click **Copy > Copy as cURL.**
1. Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials.
### Enable View in API
You can also view captured Rancher API calls for your respective clusters and resources. This feature is not enabled by default. To enable it:
1. Click on your **User Tile** in the top right corner of the UI and select **Preferences** from the dropdown menu.
2. Under the **Advanced Features** section, click **Enable "View in API"**
Once checked, the **View in API** link will now appear under the **⋮** sub-menu on resource pages in the UI.
docs/pages-for-subheaders/authentication-config.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Authentication Config
title: Configuring Authentication
weight: 10
---
docs/pages-for-subheaders/deploy-apps-across-clusters.md
+7 -3
View File
@@ -6,12 +6,16 @@ title: Deploying Applications across Clusters
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/deploy-apps-across-clusters"/>
</head>
Rancher uses Fleet to deploy applications across clusters.
Rancher offers several ways to deploy applications across clusters, depending on version.
## Fleet
Rancher v2.5 and later uses Fleet to deploy applications across clusters.
Continuous Delivery with Fleet is GitOps at scale. For more information, refer to the [Fleet section](../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md).
### Multi-cluster Apps
## Multi-cluster Apps
In Rancher before v2.5, the multi-cluster apps feature was used to deploy applications across clusters. The multi-cluster apps feature is deprecated, but still available in Rancher v2.5.
In Rancher before v2.5, the multi-cluster apps feature was used to deploy applications across clusters. The multi-cluster apps feature is deprecated, but still available as a legacy feature.
See the [multi-cluster app documentation](../how-to-guides/new-user-guides/deploy-apps-across-clusters/multi-cluster-apps.md) for more details.
docs/pages-for-subheaders/manage-role-based-access-control-rbac.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Role-Based Access Control (RBAC)
title: Managing Role-Based Access Control (RBAC)
---
<head>
docs/pages-for-subheaders/monitoring-alerting-guides.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Monitoring Guides
title: Monitoring/Alerting Guides
---
<head>
docs/reference-guides/backup-restore-configuration/examples.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Examples
title: Backup and Restore Examples
---
<head>
docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md
+29 -1
View File
@@ -13,7 +13,7 @@ This section covers the configuration options that are available in Rancher for
You can configure the Kubernetes options one of two ways:
- [Rancher UI](#configuration-options-in-the-rancher-ui): Use the Rancher UI to select options that are commonly customized when setting up a Kubernetes cluster.
- [Cluster Config File](#cluster-config-file): Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create a K3s config file. Using a config file allows you to set any of the [options](https://rancher.com/docs/k3s/latest/en/installation/install-options/) available in an K3s installation.
- [Cluster Config File](#cluster-config-file-reference): Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create a K3s config file. Using a config file allows you to set any of the [options](https://rancher.com/docs/k3s/latest/en/installation/install-options/) available in an K3s installation.
## Editing Clusters in the Rancher UI
@@ -231,6 +231,7 @@ spec:
kubernetesVersion: v1.26.7+k3s1
localClusterAuthEndpoint: {}
rkeConfig:
additionalManifest: ""
chartValues: {}
etcd:
snapshotRetention: 5
@@ -307,10 +308,37 @@ spec:
```
</details>
### additionalManifest
Specify additional manifests to deliver to the control plane nodes.
The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes.
Example:
```yaml
additionalManifest: |-
apiVersion: v1
kind: Namespace
metadata:
name: name-xxxx
```
:::note
If you want to customize system charts, you should use the `chartValues` field as described below.
Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart.
:::
### chartValues
Specify the values for the system charts installed by K3s.
For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components).
Example:
```yaml
docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md
+34 -3
View File
@@ -115,7 +115,7 @@ For more details on the different networking providers and how to configure them
[Dual-stack](https://docs.rke2.io/install/network_options#dual-stack-configuration) networking is supported for all CNI providers. To configure RKE2 in dual-stack mode, set valid IPv4/IPv6 CIDRs for your [Cluster CIDR](#cluster-cidr) and/or [Service CIDR](#service-cidr).
###### Additional Configuration {#dual-stack-additional-config}
###### Dual-stack Additional Configuration
When using `cilium` or `multus,cilium` as your container network interface provider, ensure the **Enable IPv6 Support** option is also enabled.
@@ -191,7 +191,7 @@ IPv4 and/or IPv6 network CIDRs to use for pod IPs (default: 10.42.0.0/16).
To configure [dual-stack](https://docs.rke2.io/install/network_options#dual-stack-configuration) mode, enter a valid IPv4/IPv6 CIDR. For example `10.42.0.0/16,2001:cafe:42:0::/56`.
[Additional configuration](#dual-stack-additional-config) is required when using `cilium` or `multus,cilium` as your [container network](#container-network-provider) interface provider.
[Additional configuration](#dual-stack-additional-configuration) is required when using `cilium` or `multus,cilium` as your [container network](#container-network-provider) interface provider.
##### Service CIDR
@@ -201,7 +201,7 @@ IPv4/IPv6 network CIDRs to use for service IPs (default: 10.43.0.0/16).
To configure [dual-stack](https://docs.rke2.io/install/network_options#dual-stack-configuration) mode, enter a valid IPv4/IPv6 CIDR. For example `10.42.0.0/16,2001:cafe:42:0::/56`.
[Additional configuration](#dual-stack-additional-config) is required when using `cilium ` or `multus,cilium` as your [container network](#container-network-provider) interface provider.
[Additional configuration](#dual-stack-additional-configuration) is required when using `cilium ` or `multus,cilium` as your [container network](#container-network-provider) interface provider.
##### Cluster DNS
@@ -280,6 +280,7 @@ spec:
kubernetesVersion: v1.25.12+rke2r1
localClusterAuthEndpoint: {}
rkeConfig:
additionalManifest: ""
chartValues:
rke2-calico: {}
etcd:
@@ -337,10 +338,37 @@ spec:
```
</details>
### additionalManifest
Specify additional manifests to deliver to the control plane nodes.
The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes.
Example:
```yaml
additionalManifest: |-
apiVersion: v1
kind: Namespace
metadata:
name: name-xxxx
```
:::note
If you want to customize system charts, you should use the `chartValues` field as described below.
Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart.
:::
### chartValues
Specify the values for the system charts installed by RKE2.
For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm).
Example:
```yaml
@@ -362,6 +390,9 @@ machineGlobalConfig:
- key2=value2
```
There are some configuration options that can't be changed when provisioning via Rancher:
- data-dir (folder to hold state), which defaults to `/var/lib/rancher/rke2`.
To make it easier to put files on nodes beforehand, Rancher expects the following values to be included in the configuration, while RKE2 expects the values to be entered as file paths:
- audit-policy-file
- cloud-provider-config
docs/reference-guides/cluster-configuration/rancher-server-configuration/sync-clusters.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Syncing
title: Syncing Hosted Clusters
---
<head>
docs/reference-guides/monitoring-v2-configuration/examples.md
+7 -7
View File
@@ -1,5 +1,5 @@
---
title: Examples
title: Monitoring V2 Configuration Examples
---
<head>
@@ -8,20 +8,20 @@ title: Examples
### ServiceMonitor
An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml)
See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML.
### PodMonitor
An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.
### PrometheusRule
For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources.
For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources.
An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule.
### Alertmanager Config
For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs).
See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs).
docs/reference-guides/rancher-security/selinux-rpm/about-rancher-selinux.md
+17 -3
View File
@@ -16,7 +16,7 @@ The `rancher-selinux` GitHub repository is [here.](https://github.com/rancher/ra
:::note Requirement:
The rancher-selinux RPM was tested with CentOS 7 and 8.
The rancher-selinux RPM was tested with CentOS 7, 8 and 9.
:::
@@ -49,6 +49,20 @@ gpgcheck=1
gpgkey=https://rpm.rancher.io/public.key
EOF
```
In order to use the RPM repository, on a CentOS 9 or RHEL 9 system, run the following bash snippet:
```
# cat << EOF > /etc/yum.repos.d/rancher.repo
[rancher]
name=Rancher
baseurl=https://rpm.rancher.io/rancher/production/centos/9/noarch
enabled=1
gpgcheck=1
gpgkey=https://rpm.rancher.io/public.key
EOF
```
### 2. Installing the RPM
Install the RPM:
@@ -61,10 +75,10 @@ yum -y install rancher-selinux
:::note Requirement:
Logging v2 was tested with SELinux on RHEL/CentOS 7 and 8.
Logging v2 was tested with SELinux on RHEL/CentOS 7, 8 and 9.
:::
Applications do not automatically work once the `rancher-selinux` RPM is installed on the host. They need to be configured to run in an allowed SELinux container domain provided by the RPM.
To configure the `rancher-logging` chart to be SELinux aware, change `global.seLinux.enabled` to true in the `values.yaml` when installing the chart.
To configure the `rancher-logging` chart to be SELinux aware, change `global.seLinux.enabled` to true in the `values.yaml` when installing the chart.
docusaurus.config.js
+10 -2
View File
@@ -913,6 +913,10 @@ module.exports = {
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/amazon'
},
{
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon'
},
{
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/azure'
@@ -930,10 +934,14 @@ module.exports = {
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere'
},
{
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-vsphere',
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree'
},
{ to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-vsphere',
{
to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-vsphere',
},
{ to: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere',
from: '/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-from-in-tree-to-out-of-tree'
},
{
i18n/zh/docusaurus-plugin-content-docs/version-2.0-2.4.json
+8 -8
View File
@@ -64,7 +64,7 @@
"description": "The label for category Advanced Options in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Enable Experimental Features": {
"message": "Enable Experimental Features",
"message": "Enabling Experimental Features",
"description": "The label for category Enable Experimental Features in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Advanced Use Cases": {
@@ -144,15 +144,15 @@
"description": "The label for category Checklist for Production-Ready Clusters in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Set Up Clusters from Hosted Kubernetes Providers": {
"message": "Set Up Clusters from Hosted Kubernetes Providers",
"message": "Setting up Clusters from Hosted Kubernetes Providers",
"description": "The label for category Set Up Clusters from Hosted Kubernetes Providers in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Launch Kubernetes with Rancher": {
"message": "Launch Kubernetes with Rancher",
"message": "Launching Kubernetes with Rancher",
"description": "The label for category Launch Kubernetes with Rancher in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Use New Nodes in an Infra Provider": {
"message": "Use New Nodes in an Infra Provider",
"message": "Launching New Nodes in an Infra Provider",
"description": "The label for category Use New Nodes in an Infra Provider in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.vSphere": {
@@ -160,11 +160,11 @@
"description": "The label for category vSphere in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Use Windows Clusters": {
"message": "Use Windows Clusters",
"message": "Launching Kubernetes on Windows Clusters",
"description": "The label for category Use Windows Clusters in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Set Up Cloud Providers": {
"message": "Set Up Cloud Providers",
"message": "Setting up Cloud Providers",
"description": "The label for category Set Up Cloud Providers in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Other Cloud Providers": {
@@ -260,11 +260,11 @@
"description": "The label for category Provisioning Storage Examples in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manage Projects": {
"message": "Manage Projects",
"message": "Project Administration",
"description": "The label for category Manage Projects in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manage Project Resource Quotas": {
"message": "Manage Project Resource Quotas",
"message": "Project Resource Quotas",
"description": "The label for category Manage Project Resource Quotas in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Istio Setup Guide": {
i18n/zh/docusaurus-plugin-content-docs/version-2.5.json
+8 -8
View File
@@ -64,7 +64,7 @@
"description": "The label for category Advanced Options in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Enable Experimental Features": {
"message": "Enable Experimental Features",
"message": "Enabling Experimental Features",
"description": "The label for category Enable Experimental Features in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Advanced Use Cases": {
@@ -96,15 +96,15 @@
"description": "The label for category Checklist for Production-Ready Clusters in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Set Up Clusters from Hosted Kubernetes Providers": {
"message": "Set Up Clusters from Hosted Kubernetes Providers",
"message": "Setting up Clusters from Hosted Kubernetes Providers",
"description": "The label for category Set Up Clusters from Hosted Kubernetes Providers in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Launch Kubernetes with Rancher": {
"message": "Launch Kubernetes with Rancher",
"message": "Launching Kubernetes with Rancher",
"description": "The label for category Launch Kubernetes with Rancher in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Use New Nodes in an Infra Provider": {
"message": "Use New Nodes in an Infra Provider",
"message": "Launching New Nodes in an Infra Provider",
"description": "The label for category Use New Nodes in an Infra Provider in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.vSphere": {
@@ -112,11 +112,11 @@
"description": "The label for category vSphere in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Use Windows Clusters": {
"message": "Use Windows Clusters",
"message": "Launching Kubernetes on Windows Clusters",
"description": "The label for category Use Windows Clusters in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Set Up Cloud Providers": {
"message": "Set Up Cloud Providers",
"message": "Setting up Cloud Providers",
"description": "The label for category Set Up Cloud Providers in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Other Cloud Providers": {
@@ -208,11 +208,11 @@
"description": "The label for category Provisioning Storage Examples in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manage Projects": {
"message": "Manage Projects",
"message": "Project Administration",
"description": "The label for category Manage Projects in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manage Project Resource Quotas": {
"message": "Manage Project Resource Quotas",
"message": "Project Resource Quotas",
"description": "The label for category Manage Project Resource Quotas in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Monitoring/Alerting Guides": {
sidebars.js
+25 -19
View File
@@ -35,7 +35,7 @@ const sidebars = {
items: [
{
type: 'category',
label: 'Deploy Rancher',
label: 'Deploying Rancher',
link: {
type: 'doc',
id: "pages-for-subheaders/deploy-rancher-manager",
@@ -57,7 +57,7 @@ const sidebars = {
"getting-started/quick-start-guides/deploy-rancher-manager/prime",
{
type: 'category',
label: 'Deploy Workloads',
label: 'Deploying Workloads',
link: {
type: 'doc',
id: "pages-for-subheaders/deploy-rancher-workloads",
@@ -219,7 +219,7 @@ const sidebars = {
items: [
{
type: 'category',
label: 'Authentication Config',
label: 'Configuring Authentication',
link: {
type: 'doc',
id: "pages-for-subheaders/authentication-config",
@@ -240,7 +240,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Configure OpenLDAP',
label: 'Configuring OpenLDAP',
link: {
type: 'doc',
id: "pages-for-subheaders/configure-openldap",
@@ -251,7 +251,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Configure Microsoft AD Federation Service (SAML)',
label: 'Configuring Microsoft AD Federation Service (SAML)',
link: {
type: 'doc',
id: "pages-for-subheaders/configure-microsoft-ad-federation-service-saml",
@@ -263,7 +263,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Configure Shibboleth (SAML)',
label: 'Configuring Shibboleth (SAML)',
link: {
type: 'doc',
id: "pages-for-subheaders/configure-shibboleth-saml",
@@ -274,7 +274,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Manage Role-Based Access Control (RBAC)',
label: 'Managing Role-Based Access Control (RBAC)',
link: {
type: 'doc',
id: "pages-for-subheaders/manage-role-based-access-control-rbac",
@@ -326,7 +326,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Manage Clusters',
label: 'Cluster Administration',
link: {
type: 'doc',
id: "pages-for-subheaders/manage-clusters",
@@ -456,7 +456,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Set Up Clusters from Hosted Kubernetes Providers',
label: 'Setting up Clusters from Hosted Kubernetes Providers',
link: {
type: 'doc',
id: "pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers",
@@ -472,7 +472,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Use Windows Clusters',
label: 'Launching Kubernetes on Windows Clusters',
link: {
type: 'doc',
id: "pages-for-subheaders/use-windows-clusters",
@@ -486,19 +486,25 @@ const sidebars = {
},
{
type: 'category',
label: 'Set Up Cloud Providers',
label: 'Setting up Cloud Providers',
link: {
type: 'doc',
id: "pages-for-subheaders/set-up-cloud-providers",
},
items: [
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-amazon",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/google-compute-engine",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-to-out-of-tree-vsphere",
]
},
{
type: 'category',
label: 'Migrate to an Out-of-tree Cloud Provider',
items: [
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-amazon",
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere",
]
},
"how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters",
@@ -506,7 +512,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Launch Kubernetes with Rancher',
label: 'Launching Kubernetes with Rancher',
link: {
type: 'doc',
id: "pages-for-subheaders/launch-kubernetes-with-rancher",
@@ -514,7 +520,7 @@ const sidebars = {
items: [
{
type: 'category',
label: 'Use New Nodes in an Infra Provider',
label: 'Launching New Nodes in an Infra Provider',
link: {
type: 'doc',
id: "pages-for-subheaders/use-new-nodes-in-an-infra-provider",
@@ -629,7 +635,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Deploy Apps Across Clusters',
label: 'Deploying Apps Across Clusters',
link: {
type: 'doc',
id: "pages-for-subheaders/deploy-apps-across-clusters",
@@ -672,7 +678,7 @@ const sidebars = {
items: [
{
type: 'category',
label: 'Manage Projects',
label: 'Project Administration',
link: {
type: 'doc',
id: "pages-for-subheaders/manage-projects",
@@ -681,7 +687,7 @@ const sidebars = {
"how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies",
{
type: 'category',
label: 'Manage Project Resource Quotas',
label: 'Project Resource Quotas',
link: {
type: 'doc',
id: "pages-for-subheaders/manage-project-resource-quotas",
@@ -786,7 +792,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Enable Experimental Features',
label: 'Enabling Experimental Features',
link: {
type: 'doc',
id: "pages-for-subheaders/enable-experimental-features",
static/img/install-rancher-prime-basics-create-new.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

static/img/install-rancher-prime-basics.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

static/img/install-rancher-prime-bootstrap-password.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

static/img/install-rancher-prime-global-settings.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 101 KiB

static/img/install-rancher-prime-home.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 582 KiB

versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/air-gap-helm2/prepare-nodes.md
+2 -2
View File
@@ -83,8 +83,8 @@ You will need to configure a load balancer as a basic Layer 4 TCP forwarder to d
**Load Balancer Configuration Samples:**
- For an example showing how to set up an NGINX load balancer, refer to [this page.](../../../../../how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md)
- For an example showing how to set up an Amazon NLB load balancer, refer to [this page.](../../../../../how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md)
- For an example showing how to set up an NGINX load balancer, refer to [this page.](../../../../../how-to-guides/new-user-guides/infrastructure-setup/nginx-load-balancer.md)
- For an example showing how to set up an Amazon NLB load balancer, refer to [this page.](../../../../../how-to-guides/new-user-guides/infrastructure-setup/amazon-elb-load-balancer.md)
</TabItem>
<TabItem value="Docker Install">
versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md
+2 -2
View File
@@ -20,7 +20,7 @@ The usage below defines rules about what the audit log should record and what da
| Parameter | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="audit-level"></a>`AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LOG_PATH` | Log path for Rancher Server API. Default path is `/var/log/auditlog/rancher-api-audit.log`. You can mount the log directory to host. <br/><br/>Usage Example: `AUDIT_LOG_PATH=/my/custom/path/`<br/> |
| `AUDIT_LOG_MAXAGE` | Defined the maximum number of days to retain old audit log files. Default is 10 days. |
| `AUDIT_LOG_MAXBACKUP` | Defines the maximum number of audit log files to retain. Default is 10. |
@@ -30,7 +30,7 @@ The usage below defines rules about what the audit log should record and what da
### Audit Log Levels
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#audit-level) setting.
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#api-audit-log-options) setting.
| `AUDIT_LEVEL` Setting | Request Metadata | Request Body | Response Metadata | Response Body |
| --------------------- | ---------------- | ------------ | ----------------- | ------------- |
versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Allow Unsupported Storage Drivers
title: Allowing Unsupported Storage Drivers
---
This feature allows you to use types for storage providers and provisioners that are not enabled by default.
versioned_docs/version-2.0-2.4/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Certificate Troubleshooting
title: Troubleshooting Certificates
---
<head>
versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Template Enforcement
title: Enforcing Templates
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Creating Pod Security Policies
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 7. Generate and View Traffic
title: Generate and View Traffic
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 3. Select the Nodes Where Istio Components Will be Deployed
title: Select the Nodes Where Istio Components Will be Deployed
---
> **Prerequisite:** Your cluster needs a worker node that can designated for Istio. The worker node should meet the [resource requirements.](../../../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md)
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 5. Set up the Istio Gateway
title: Set up the Istio Gateway
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 6. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 4. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Applying Pod Security Policies to Projects
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/tutorial.md
+1 -1
View File
@@ -47,7 +47,7 @@ You can fill your custom catalogs with either Helm Charts or Rancher Charts, alt
questions:
- variable: persistence.enabled
default: "false"
description: "Enable persistent volume for WordPress"
description: "Enabling persistent volume for WordPress"
type: boolean
required: true
label: WordPress Persistent Volume Enabled
versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability K3s Kubernetes Cluster
title: Setting up Infrastructure for a High Availability K3s Kubernetes Cluster
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability RKE Kubernetes Cluster
title: Setting up Infrastructure for a High Availability RKE Kubernetes Cluster
---
<head>
versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Configuration for Storage Classes in Azure
title: Configuring Storage Classes in Azure
---
<head>
versioned_docs/version-2.0-2.4/pages-for-subheaders/about-provisioning-drivers.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Provisioning Drivers
title: About Provisioning Drivers
---
<head>
versioned_docs/version-2.0-2.4/pages-for-subheaders/authentication-config.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Authentication Config
title: Configuring Authentication
---
<head>
versioned_docs/version-2.0-2.4/pages-for-subheaders/manage-role-based-access-control-rbac.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Role-Based Access Control (RBAC)
title: Managing Role-Based Access Control (RBAC)
---
<head>
versioned_docs/version-2.5/explanations/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md
+2 -2
View File
@@ -75,7 +75,7 @@ Monitoring also creates additional `ClusterRoles` that are not assigned to users
| Role | Purpose |
| ------------------------------| ---------------------------|
| monitoring-ui-view | <a id="monitoring-ui-view"></a>_Available as of Monitoring v2 14.5.100+_ Provides read-only access to external Monitoring UIs by giving a user permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Grafana, and Alertmanager UIs through the Rancher proxy. |
| monitoring-ui-view | _Available as of Monitoring v2 14.5.100+_ Provides read-only access to external Monitoring UIs by giving a user permission to list the Prometheus, Alertmanager, and Grafana endpoints and make GET requests to Prometheus, Grafana, and Alertmanager UIs through the Rancher proxy. |
### Assigning Roles and ClusterRoles with kubectl
@@ -124,7 +124,7 @@ In addition to these default Roles, the following additional Rancher project rol
| Cluster Manager Role | Kubernetes ClusterRole | Available In Rancher From | Available in Monitoring v2 From |
|--------------------------|-------------------------------|-------|------|
| View Monitoring* | [monitoring-ui-view](#monitoring-ui-view) | 2.4.8+ | 9.4.204+ |
| View Monitoring* | [monitoring-ui-view](#additional-monitoring-clusterroles) | 2.4.8+ | 9.4.204+ |
\* A User bound to the **View Monitoring** Rancher Role only has permissions to access external Monitoring UIs if provided links to those UIs. In order to access the Monitoring Pane on Cluster Explorer to get those links, the User must be a Project Member of at least one Project.
versioned_docs/version-2.5/getting-started/installation-and-upgrade/advanced-options/advanced-use-cases/enable-api-audit-log.md
+2 -2
View File
@@ -20,7 +20,7 @@ The usage below defines rules about what the audit log should record and what da
| Parameter | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="audit-level"></a>`AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LEVEL` | `0` - Disable audit log (default setting).<br/>`1` - Log event metadata.<br/>`2` - Log event metadata and request body.<br/>`3` - Log event metadata, request body, and response body. Each log transaction for a request/response pair uses the same `auditID` value.<br/><br/>See [Audit Level Logging](#audit-log-levels) for a table that displays what each setting logs. |
| `AUDIT_LOG_PATH` | Log path for Rancher Server API. Default path is `/var/log/auditlog/rancher-api-audit.log`. You can mount the log directory to host. <br/><br/>Usage Example: `AUDIT_LOG_PATH=/my/custom/path/`<br/> |
| `AUDIT_LOG_MAXAGE` | Defined the maximum number of days to retain old audit log files. Default is 10 days. |
| `AUDIT_LOG_MAXBACKUP` | Defines the maximum number of audit log files to retain. Default is 10. |
@@ -30,7 +30,7 @@ The usage below defines rules about what the audit log should record and what da
### Audit Log Levels
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#audit-level) setting.
The following table displays what parts of API transactions are logged for each [`AUDIT_LEVEL`](#api-audit-log-options) setting.
| `AUDIT_LEVEL` Setting | Request Metadata | Request Body | Response Metadata | Response Body |
| --------------------- | ---------------- | ------------ | ----------------- | ------------- |
versioned_docs/version-2.5/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/unsupported-storage-drivers.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Allow Unsupported Storage Drivers
title: Allowing Unsupported Storage Drivers
---
This feature allows you to use types for storage providers and provisioners that are not enabled by default.
versioned_docs/version-2.5/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/certificate-troubleshooting.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Certificate Troubleshooting
title: Troubleshooting Certificates
---
<head>
versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-rke1-templates/enforce-templates.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Template Enforcement
title: Enforcing Templates
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Creating Pod Security Policies
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---
<head>
versioned_docs/version-2.5/how-to-guides/advanced-user-guides/manage-projects/manage-pod-security-policies.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Pod Security Policies
title: Applying Pod Security Policies to Projects
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md
+1 -4
View File
@@ -16,10 +16,7 @@ It is required to use the same hostname that was set as the server URL in the fi
Rancher version must be v2.5.0 and up
Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used:
- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/)
- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/)
Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used.
Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version.
versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability K3s Kubernetes Cluster
title: Setting up Infrastructure for a High Availability K3s Kubernetes Cluster
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability RKE Kubernetes Cluster
title: Setting up Infrastructure for a High Availability RKE Kubernetes Cluster
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Set up Infrastructure for a High Availability RKE2 Kubernetes Cluster
title: Setting up Infrastructure for a High Availability RKE2 Kubernetes Cluster
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-in-tree-vsphere.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: How to Configure an In-tree vSphere Cloud Provider
title: Configuring an In-tree vSphere Cloud Provider
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/configure-out-of-tree-vsphere.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: How to Configure an Out-of-tree vSphere Cloud Provider
title: Configuring an Out-of-tree vSphere Cloud Provider
---
<head>
versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/vsphere/migrate-from-in-tree-to-out-of-tree.md
+1 -1
View File
@@ -3,7 +3,7 @@ title: Migrating vSphere In-tree Volumes to Out-of-tree
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/migrate-from-in-tree-to-out-of-tree"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/migrate-to-an-out-of-tree-cloud-provider/migrate-to-out-of-tree-vsphere"/>
</head>
_Available as of v2.5+_
versioned_docs/version-2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: Configuration for Storage Classes in Azure
title: Configuring Storage Classes in Azure
---
<head>

Some files were not shown because too many files have changed in this diff Show More