Fix formats and change tab indentation to space indentation

2026-04-30 18:23:11 +00:00 · 2022-09-07 16:12:30 +08:00
parent 38da4eb019
commit b9436d71e6
41 changed files with 130 additions and 133 deletions
@@ -38,11 +38,11 @@ A restore is performed by creating a Restore custom resource.
 1. Click **☰ > Cluster Management**.
 1. Go to the local cluster and click **Explore**.
 1. In the left navigation bar, click **Rancher Backups > Restore**.
-	:::note
+    :::note

-	If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps & Marketplace**. Refer [here](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information.
+    If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps & Marketplace**. Refer [here](../../../pages-for-subheaders/helm-charts-in-rancher.md#charts) for more information.

-	:::
+    :::

 1. Click **Create**.
 1. Create the Restore with the form or with YAML. For help creating the Restore resource using the online form, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md)
@@ -50,22 +50,22 @@ A restore is performed by creating a Restore custom resource.

    ```yaml
    apiVersion: resources.cattle.io/v1
-	kind: Restore
-	metadata:
-	  name: restore-migration
-	spec:
-	  backupFilename: backup-b0450532-cee1-4aa1-a881-f5f48a007b1c-2020-09-15T07-27-09Z.tar.gz
-	  encryptionConfigSecretName: encryptionconfig
-	  storageLocation:
-	    s3:
-	      credentialSecretName: s3-creds
-	      credentialSecretNamespace: default
-	      bucketName: rancher-backups
-	      folder: rancher
-	      region: us-west-2
-	      endpoint: s3.us-west-2.amazonaws.com
-      ```
-	For help configuring the Restore, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md)
+    kind: Restore
+    metadata:
+      name: restore-migration
+    spec:
+      backupFilename: backup-b0450532-cee1-4aa1-a881-f5f48a007b1c-2020-09-15T07-27-09Z.tar.gz
+      encryptionConfigSecretName: encryptionconfig
+      storageLocation:
+        s3:
+          credentialSecretName: s3-creds
+          credentialSecretNamespace: default
+          bucketName: rancher-backups
+          folder: rancher
+          region: us-west-2
+          endpoint: s3.us-west-2.amazonaws.com
+    ```
+    For help configuring the Restore, refer to the [configuration reference](../../../reference-guides/backup-restore-configuration/restore-configuration.md) and to the [examples.](../../../reference-guides/backup-restore-configuration/examples.md)

 1. Click **Create**.

@@ -62,9 +62,9 @@ To install Rancher on your Equinix Metal host, connect to it and then use a shel

 2.  From your shell, enter the following command:

-	```
+    ```
    sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 --privileged rancher/rancher
-  ```
+    ```

 **Result:** Rancher is installed.

@@ -129,7 +129,6 @@ helm install rancher rancher-latest/rancher `
  --set replicas=1 `
  --set bootstrapPassword=<PASSWORD_FOR_RANCHER_ADMIN>
 ```
-```

 Now if you navigate to `<IP_OF_LINUX_NODE>.sslip.io` in a web browser, you should see the Rancher UI.

@@ -87,9 +87,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1. Go to the [**Domain-wide Delegation** page.](https://admin.google.com/ac/owl/domainwidedelegation)
 1. Add the Unique ID obtained in the previous step in the **Client Name** field.
 1. In the **One or More API Scopes** field, add the following scopes:
-	```
-	openid,profile,email,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly
-	```
+    ```
+    openid,profile,email,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.group.readonly
+    ```
 1. Click **Authorize**.

 **Result:** The service account is registered as an OAuth client in your G Suite account.
@@ -100,9 +100,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1.	In the top left corner, click **☰ > Users & Authentication**.
 1. In the left navigation menu, click **Auth Provider**.
 1. Click **Google**. The instructions in the UI cover the steps to set up authentication with Google OAuth.
-	1. Admin Email: Provide the email of an administrator account from your GSuite setup. In order to perform user and group lookups, google apis require an administrator's email in conjunction with the service account key.
-	1. Domain: Provide the domain on which you have configured GSuite. Provide the exact domain and not any aliases.
-	1. Nested Group Membership: Check this box to enable nested group memberships. Rancher admins can disable this at any time after configuring auth.
+    1. Admin Email: Provide the email of an administrator account from your GSuite setup. In order to perform user and group lookups, google apis require an administrator's email in conjunction with the service account key.
+    1. Domain: Provide the domain on which you have configured GSuite. Provide the exact domain and not any aliases.
+    1. Nested Group Membership: Check this box to enable nested group memberships. Rancher admins can disable this at any time after configuring auth.
   - **Step One** is about adding Rancher as an authorized domain, which we already covered in [this section.](#1-adding-rancher-as-an-authorized-domain)
   - For **Step Two,** provide the OAuth credentials JSON that you downloaded after completing [this section.](#2-creating-oauth2-credentials-for-the-rancher-server) You can upload the file or paste the contents into the **OAuth Credentials** field.
   - For **Step Three,** provide the service account credentials JSON that downloaded at the end of [this section.](#3-creating-service-account-credentials) The credentials will only work if you successfully [registered the service account key](#4-register-the-service-account-key-as-an-oauth-client) as an OAuth client in your G Suite account.
@@ -24,8 +24,8 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati
      `Client Protocol` | `SAML`
      `Valid Redirect URI` | `https://yourRancherHostURL/v1-saml/keycloak/saml/acs`

-      ><sup>1</sup>: Optionally, you can enable either one or both of these settings.
-      ><sup>2</sup>: Rancher SAML metadata won't be generated until a SAML provider is configured and saved.
+    ><sup>1</sup>: Optionally, you can enable either one or both of these settings.
+    ><sup>2</sup>: Rancher SAML metadata won't be generated until a SAML provider is configured and saved.

  ![](/img/keycloak/keycloak-saml-client-configuration.png)

@@ -21,7 +21,7 @@ Note that these URLs will not return valid data until the authentication configu

    1. **Display Name Field**: Enter the AD attribute that contains the display name of users (example: `displayName`).

-	1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `givenName`).
+    1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `givenName`).

    1. **UID Field**: Enter an AD attribute that is unique to every user (example: `sAMAccountName`, `distinguishedName`).

@@ -31,7 +31,7 @@ Note that these URLs will not return valid data until the authentication configu

    1. **Rancher API Host**: Enter the URL for your Rancher Server.

-	1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your IdP.
+    1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your IdP.

        You can generate one using an openssl command. For example:

@@ -130,7 +130,7 @@ Note that the RBAC roles exposed by the Monitoring chart to add Grafana Dashboar
    data:
      <dashboard-name>.json: |-
        <copied-json>
-	```
+    ```

 **Result:** After the ConfigMap is created, it should show up on the Grafana UI and be persisted even if the Grafana pod is restarted.

@@ -28,10 +28,9 @@ For this example, we would like to get the CPU usage for the Alertmanager contai

 The **Data** tab shows the underlying data as a time series, with the time in first column and the PromQL query result in the second column. Copy the PromQL query.
    
-    ```
-	(1 - (avg(irate({__name__=~"node_cpu_seconds_total|windows_cpu_time_total",mode="idle"}[5m])))) * 100
-
-	```
+```
+(1 - (avg(irate({__name__=~"node_cpu_seconds_total|windows_cpu_time_total",mode="idle"}[5m])))) * 100
+```

 You can then modify the query in the Grafana panel or create a new Grafana panel using the query. 

@@ -30,7 +30,7 @@ The additional preparations:
 1. Follow these [instructions](https://github.com/rancherlabs/support-tools/blob/master/rancher-cleanup/README.md) to run the scripts.
 1. Follow these [instructions](https://rancher.com/docs/rancher/v2.6/en/backups/migrating-rancher/) to install the rancher-backup Helm chart on the existing cluster and restore the previous state.
    1. Omit Step 3.
-	1. When Step 4 is reached, install the required Rancher v2.6.x version on the local cluster you intend to roll back to.
+    1. When Step 4 is reached, install the required Rancher v2.6.x version on the local cluster you intend to roll back to.

 ### Create the Restore Custom Resource

@@ -41,9 +41,9 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
 1. Fill out the required vCenter details.
 1. vSphere CPI initializes all nodes with ProviderID which is needed by the vSphere CSI driver. Check if all nodes are initialized with the ProviderID before installing CSI driver with the following command:

-	```
-	kubectl describe nodes | grep "ProviderID"
-	```
+    ```
+    kubectl describe nodes | grep "ProviderID"
+    ```

 ### 3. Installing the CSI plugin

@@ -90,10 +90,10 @@ kubectl describe nodes | grep "ProviderID"
 1. While editing the cluster, if the Kubernetes version is less than 1.19, select Kubernetes version 1.19 or higher from the **Kubernetes Version** dropdown.
 2. For enabling feature flags, click on "Edit as YAML", and add the following under kube-controller and kubelet:

-	```yaml
-	  extra_args:
-	    feature-gates: "CSIMigration=true,CSIMigrationvSphere=true" 
-	```
+    ```yaml
+      extra_args:
+        feature-gates: "CSIMigration=true,CSIMigrationvSphere=true" 
+    ```

 ### 4. Drain worker nodes

@@ -93,7 +93,7 @@ $ curl -sfL https://get.k3s.io | K3S_KUBECONFIG_MODE="644" sh -s -

 You should define **only** the minimum fields that Rancher requires when importing an EKS cluster with Terraform. This is important as Rancher will overwrite what was in the EKS cluster with any config that the user has provided.

-::caution
+:::caution

 Even a small difference between the current EKS cluster and a user-provided config could have unexpected results.

@@ -43,7 +43,7 @@ If your organization uses Shibboleth for user authentication, you can configure

    1. **Display Name Field**: Enter the AD attribute that contains the display name of users (example: `displayName`).

-	1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `givenName`).
+    1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `givenName`).

    1. **UID Field**: Enter an AD attribute that is unique to every user (example: `sAMAccountName`, `distinguishedName`).

@@ -51,7 +51,7 @@ If your organization uses Shibboleth for user authentication, you can configure

    1. **Rancher API Host**: Enter the URL for your Rancher Server.

-	1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your IdP.
+    1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your IdP.

        You can generate one using an openssl command. For example:

@@ -22,7 +22,7 @@ This section covers the following topics:
 - [Registering Existing Clusters](#registering-existing-clusters)
 - [Programmatically Creating Clusters](#programmatically-creating-clusters)

-  <!-- /TOC -->
+<!-- /TOC -->

 ### Cluster Management Capabilities by Cluster Type

@@ -26,7 +26,7 @@ This guide covers the following topics:
 - [Requirements](#requirements-for-windows-clusters)
 - [Tutorial: How to Create a Cluster with Windows Support](#tutorial-how-to-create-a-cluster-with-windows-support)
 - [Configuration for Storage Classes in Azure](#configuration-for-storage-classes-in-azure)
-  <!-- /TOC -->
+<!-- /TOC -->

 # Changes in Rancher v2.6

@@ -164,7 +164,7 @@ To set up a cluster with support for Windows nodes and containers, you will need
 1. [Create the Cluster on Existing Nodes](#2-create-the-cluster-on-existing-nodes)
 1. [Add Nodes to the Cluster](#3-add-nodes-to-the-cluster)
 1. [Optional: Configuration for Azure Files](#4-optional-configuration-for-azure-files)
-   <!-- /TOC -->
+<!-- /TOC -->

 # 1. Provision Hosts

@@ -14,7 +14,7 @@ When you set up your high-availability Rancher installation, consider the follow
 ### Run Rancher on a Separate Cluster
 Don't run other workloads or microservices in the Kubernetes cluster that Rancher is installed on.

-### Make sure nodes are configured correctly for Kubernetes ###
+### Make sure nodes are configured correctly for Kubernetes
 It's important to follow K8s and etcd best practices when deploying your nodes, including disabling swap, double checking you have full network connectivity between all machines in the cluster, using unique hostnames, MAC addresses, and product_uuids for every node, checking that all correct ports are opened, and deploying with ssd backed etcd. More details can be found in the [kubernetes docs](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#before-you-begin) and [etcd's performance op guide](https://etcd.io/docs/v3.4/op-guide/performance/).

 ### When using RKE: Back up the Statefile
@@ -1,7 +1,7 @@
 ---
 title: DigitalOcean Node Template Configuration
 weight: 1
----
+---

 Account access information is stored as a cloud credential. Cloud credentials are stored as Kubernetes secrets. Multiple node templates can use the same cloud credential. You can use an existing cloud credential or create a new one.