Fix formats and change tab indentation to space indentation

2026-09-25 20:48:11 +00:00 · 2022-09-09 11:56:17 +08:00
parent 38da4eb019
commit b9436d71e6
41 changed files with 130 additions and 133 deletions
@@ -50,9 +50,9 @@ To install Rancher on your host, connect to it and then use a shell to install.

 2.  From your shell, enter the following command:

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

 **Result:** Rancher is installed.

@@ -83,9 +83,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1. Go to the [**Manage OAuth Client Access** page.](https://admin.google.com/AdminHome?chromeless=1#OGX:ManageOauthClients)
 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.
@@ -94,9 +94,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1. Sign into Rancher using a local user assigned the [administrator](../../manage-role-based-access-control-rbac/global-permissions.md) role. This user is also called the local principal.
 1.	From the **Global** view, click **Security > Authentication** from the main menu.
 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.
@@ -23,7 +23,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`).

@@ -33,7 +33,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:

@@ -30,9 +30,9 @@ The Istio CNI plugin removes the need for each application pod to have a privile
 1. Select the **Project: System** project.
 1. Choose **Tools > Catalogs** in the navigation bar.
 1. Add a catalog with the following:
-	1. Name: istio-cni
-	1. Catalog URL: https://github.com/istio/cni
-	1. Branch: The branch that matches your current release, for example: `release-1.4`.
+    1. Name: istio-cni
+    1. Catalog URL: https://github.com/istio/cni
+    1. Branch: The branch that matches your current release, for example: `release-1.4`.
 1. From the main menu select **Apps**
 1. Click Launch and select istio-cni
 1. Update the namespace to be "kube-system"
@@ -100,9 +100,9 @@ The steps to enable recurring snapshots differ based on the version of RKE.
 4. Save and close `rancher-cluster.yml`.
 5. Open **Terminal** and change directory to the location of the RKE binary. Your `rancher-cluster.yml` file must reside in the same directory.
 6. Run the following command:
-	```
-	rke up --config rancher-cluster.yml
-	```
+    ```
+    rke up --config rancher-cluster.yml
+    ```

 **Result:** RKE is configured to take recurring snapshots of `etcd` on all nodes running the `etcd` role. Snapshots are saved locally to the following directory: `/opt/rke/etcd-snapshots/`. If configured, the snapshots are also uploaded to your S3 compatible backend.

@@ -122,9 +122,9 @@ The steps to enable recurring snapshots differ based on the version of RKE.
 4. Save and close `rancher-cluster.yml`.
 5. Open **Terminal** and change directory to the location of the RKE binary. Your `rancher-cluster.yml` file must reside in the same directory.
 6. Run the following command:
-	```
-	rke up --config rancher-cluster.yml
-	```
+    ```
+    rke up --config rancher-cluster.yml
+    ```

 **Result:** RKE is configured to take recurring snapshots of `etcd` on all nodes running the `etcd` role. Snapshots are saved locally to the following directory: `/opt/rke/etcd-snapshots/`.

@@ -142,11 +142,11 @@ When you're about to upgrade Rancher or restore it to a previous snapshot, you s

 2. Enter the following command. Replace `<SNAPSHOT.db>` with any name that you want to use for the snapshot (e.g. `upgrade.db`).

-	```
-	rke etcd snapshot-save \
+    ```
+    rke etcd snapshot-save \
    --name <SNAPSHOT.db> \
    --config rancher-cluster.yml
-	```
+    ```

 **Result:** RKE takes a snapshot of `etcd` running on each `etcd` node. The file is saved to `/opt/rke/etcd-snapshots`.

@@ -45,7 +45,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`).

@@ -53,7 +53,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:

@@ -24,7 +24,7 @@ This section covers the following topics:
  - [Launching Kubernetes on Existing Custom Nodes](#launching-kubernetes-on-existing-custom-nodes)
 - [Importing Existing Clusters](#importing-existing-clusters)

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

 The following table summarizes the options and settings available for each cluster type:

@@ -27,7 +27,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 -->

 # Requirements for Windows Clusters

@@ -118,7 +118,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

@@ -19,7 +19,7 @@ When the Rancher server is installed on a Kubernetes cluster, it should not be r

 It is strongly recommended to use hosted infrastructure such as Amazon's EC2 or Google's GCE instead. When you create a cluster using RKE on an infrastructure provider, you can configure the cluster to create etcd snapshots as a backup. You can then [use RKE](https://rancher.com/docs/rke/latest/en/etcd-snapshots/) or [Rancher](../../pages-for-subheaders/backup-restore-and-disaster-recovery.md) to restore your cluster from one of these snapshots. In a hosted Kubernetes environment, this backup and restore functionality is not supported.

-### 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://github.com/etcd-io/etcd/blob/master/Documentation/op-guide/performance.md)

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

 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
@@ -88,9 +88,9 @@ Verify that the CNI is working by deploying a [sample application](https://istio
 1. Select the **Project: System** project.
 1. Choose **Tools > Catalogs** in the navigation bar.
 1. Add a catalog with the following:
-	1. Name: istio-cni
-	1. Catalog URL: https://github.com/istio/cni
-	1. Branch: The branch that matches your current release, for example: `release-1.4`.
+    1. Name: istio-cni
+    1. Catalog URL: https://github.com/istio/cni
+    1. Branch: The branch that matches your current release, for example: `release-1.4`.
 1. From the main menu select **Apps**
 1. Click Launch and select istio-cni
 1. Update the namespace to be "kube-system"
@@ -40,29 +40,29 @@ A restore is performed by creating a Restore custom resource.
 ### Create the Restore Custom Resource

 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.**
-	* **Note:** If the Rancher Backups app is not visible in the dropdown, 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.
+    * **Note:** If the Rancher Backups app is not visible in the dropdown, 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 **Restore.**
 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)
 1. To use the YAML editor, you can click **Create > Create from YAML.** Enter the Restore YAML. The following is an example 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.**

@@ -52,9 +52,9 @@ To install Rancher on your host, connect to it and then use a shell to install.

 1.  From your shell, enter the following command:

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

 **Result:** Rancher is installed.

@@ -85,9 +85,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1. Go to the [**Manage OAuth Client Access** page.](https://admin.google.com/AdminHome?chromeless=1#OGX:ManageOauthClients)
 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.
@@ -96,9 +96,9 @@ Using the Unique ID of the service account key, register it as an Oauth Client u
 1. Sign into Rancher using a local user assigned the [administrator](../../manage-role-based-access-control-rbac/global-permissions.md) role. This user is also called the local principal.
 1.	From the **Global** view, click **Security > Authentication** from the main menu.
 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,7 +24,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`).

@@ -34,7 +34,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:

@@ -115,7 +115,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. 

@@ -38,9 +38,9 @@ The Cloud Provider Interface (CPI) should be installed first before installing t
 1. Select the **vSphere CPI** chart. 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

@@ -86,10 +86,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

@@ -45,7 +45,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`).

@@ -53,7 +53,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:

@@ -26,7 +26,7 @@ This section covers the following topics:
  - [Launching Kubernetes on Existing Custom Nodes](#launching-kubernetes-on-existing-custom-nodes)
 - [Registering Existing Clusters](#registering-existing-clusters)

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

 ### Cluster Management Capabilities by Cluster Type

@@ -30,7 +30,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 -->

 # Requirements for Windows Clusters

@@ -162,7 +162,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

@@ -18,7 +18,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
@@ -3,7 +3,7 @@ title: DigitalOcean Node Template Configuration
 weight: 1
 aliases:
  - /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/do-node-template-config/
----
+---

 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.