Merge pull request #225 from btat/clean-frontmatter

Remove unsupported front matter fields
2026-09-25 20:48:11 +00:00 · 2022-09-27 13:41:59 -07:00
parent 408c4c3998 c390289797
commit 1c0d662469
1553 changed files with 871 additions and 4500 deletions
@@ -1,6 +1,5 @@
 ---
 title: Docker Install with TLS Termination at Layer-7 NGINX Load Balancer
-weight: 252
 ---

 For development and testing environments that have a special requirement to terminate TLS/SSL at a load balancer instead of your Rancher Server container, deploy Rancher and configure a load balancer to work with it conjunction.
@@ -1,6 +1,5 @@
 ---
 title: Enabling the API Audit Log to Record System Events
-weight: 4
 ---

 You can enable the API audit log to record the sequence of system events initiated by individual users. You can know what happened, when it happened, who initiated it, and what cluster it affected. When you enable this feature, all requests to the Rancher API and all responses from it are written to a log.
@@ -1,6 +1,5 @@
 ---
 title: Opening Ports with firewalld
-weight: 1
 ---

 > We recommend disabling firewalld. For Kubernetes 1.19.x and higher, firewalld must be turned off.
@@ -1,6 +1,5 @@
 ---
 title: Tuning etcd for Large Installations
-weight: 2
 ---

 When running larger Rancher installations with 15 or more clusters it is recommended to increase the default keyspace for etcd from the default 2GB. The maximum setting is 8GB and the host should have enough RAM to keep the entire dataset in memory. When increasing this value you should also increase the size of the host. The keyspace size can also be adjusted in smaller installations if you anticipate a high rate of change of pods during the garbage collection interval.
@@ -1,6 +1,5 @@
 ---
 title: Continuous Delivery
-weight: 3
 ---

 As of Rancher v2.5, [Fleet](../../../../how-to-guides/new-user-guides/deploy-apps-across-clusters/fleet.md) comes preinstalled in Rancher, and as of Rancher v2.6, Fleet can no longer be fully disabled. However, the Fleet feature for GitOps continuous delivery may be disabled using the `continuous-delivery` feature flag.
@@ -1,6 +1,5 @@
 ---
 title: UI for Istio Virtual Services and Destination Rules
-weight: 2
 ---

 This feature enables a UI that lets you create, read, update and delete virtual services and destination rules, which are traffic management features of Istio.
@@ -20,7 +19,7 @@ A central advantage of Istio's traffic management features is that they allow dy

 When enabled, this feature turns on a page that lets you configure some traffic management features of Istio using the Rancher UI. Without this feature, you need to use `kubectl` to manage traffic with Istio.

-The feature enables two UI tabs: one tab for **Virtual Services** and another for **Destination Rules**. 
+The feature enables two UI tabs: one tab for **Virtual Services** and another for **Destination Rules**.

 - **Virtual services** intercept and direct traffic to your Kubernetes services, allowing you to direct percentages of traffic from a request to different services. You can use them to define a set of routing rules to apply when a host is addressed. For details, refer to the [Istio documentation.](https://istio.io/docs/reference/config/networking/v1alpha3/virtual-service/)
 - **Destination rules** serve as the single source of truth about which service versions are available to receive traffic from virtual services. You can use these resources to define policies that apply to traffic that is intended for a service after routing has occurred. For details, refer to the [Istio documentation.](https://istio.io/docs/reference/config/networking/v1alpha3/destination-rule)
@@ -1,6 +1,5 @@
 ---
 title: "Running on ARM64 (Experimental)"
-weight: 3
 ---

 :::caution
@@ -1,6 +1,5 @@
 ---
 title: Allow Unsupported Storage Drivers
-weight: 1
 ---

 This feature allows you to use types for storage providers and provisioners that are not enabled by default.
@@ -1,7 +1,5 @@
 ---
 title: Rendering the Helm Template in an Air-Gapped Environment
-shortTitle: Air Gap Upgrade
-weight: 1
 ---

 :::note
@@ -1,7 +1,5 @@
 ---
 title: Installing Rancher on Azure Kubernetes Service
-shortTitle: AKS
-weight: 3
 ---

 This page covers how to install Rancher on Microsoft's Azure Kubernetes Service (AKS).
@@ -1,7 +1,5 @@
 ---
 title: Installing Rancher on Amazon EKS
-shortTitle: Amazon EKS
-weight: 3
 ---

 This page covers two ways to install Rancher on EKS.
@@ -1,7 +1,5 @@
 ---
 title: Installing Rancher on a Google Kubernetes Engine Cluster
-shortTitle: GKE
-weight: 3
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: Rollbacks
-weight: 3
 ---


@@ -1,6 +1,5 @@
 ---
 title: Troubleshooting the Rancher Server Kubernetes Cluster
-weight: 276
 ---

 This section describes how to troubleshoot an installation of Rancher on a Kubernetes cluster.
@@ -1,6 +1,5 @@
 ---
 title: Upgrades
-weight: 2
 ---
 The following instructions will guide you through upgrading a Rancher server that was installed on a Kubernetes cluster with Helm. These steps also apply to air-gapped installs with Helm.

@@ -1,6 +1,5 @@
 ---
 title: Dockershim
-weight: 300
 ---

 The Dockershim is the CRI compliant layer between the Kubelet and the Docker daemon. As part of the Kubernetes 1.20 release, the [deprecation of the in-tree Dockershim was announced](https://kubernetes.io/blog/2020/12/02/dont-panic-kubernetes-and-docker/). For more information on the deprecation and its timelines, see the [Kubernetes Dockershim Deprecation FAQ](https://kubernetes.io/blog/2020/12/02/dockershim-faq/#when-will-dockershim-be-removed).
@@ -1,6 +1,5 @@
 ---
 title: Installing Docker
-weight: 1
 ---

 Docker is required to be installed on nodes where the Rancher server will be installed with Helm or Docker.
@@ -1,7 +1,6 @@
 ---
 title: Port Requirements
 description: Read about port requirements needed in order for Rancher to operate properly, both for Rancher nodes and downstream Kubernetes cluster nodes
-weight: 300
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: Docker Install Commands
-weight: 1
 ---

 The Docker installation is for Rancher users who want to test out Rancher.
@@ -1,6 +1,5 @@
 ---
 title: '1. Set up Infrastructure and Private Registry'
-weight: 100
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: '3. Install Kubernetes (Skip for Docker Installs)'
-weight: 300
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: 4. Install Rancher
-weight: 400
 ---

 This section is about how to deploy Rancher for your air gapped environment in a high-availability Kubernetes installation. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy.
@@ -1,6 +1,5 @@
 ---
 title: '2. Collect and Publish Images to your Private Registry'
-weight: 200
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: '2. Install Kubernetes'
-weight: 200
 ---

 Once the infrastructure is ready, you can continue with setting up an RKE cluster to install Rancher in.
@@ -1,6 +1,5 @@
 ---
 title: 3. Install Rancher
-weight: 300
 ---

 Now that you have a running RKE cluster, you can install Rancher in it. For security reasons all traffic to Rancher must be encrypted with TLS. For this tutorial you are going to automatically issue a self-signed certificate through [cert-manager](https://cert-manager.io/). In a real-world use-case you will likely use Let's Encrypt or provide your own certificate.
@@ -1,6 +1,5 @@
 ---
 title: '1. Set up Infrastructure'
-weight: 100
 ---

 In this section, you will provision the underlying infrastructure for your Rancher management server with internete access through a HTTP proxy.
@@ -1,6 +1,5 @@
 ---
 title: Certificate Troubleshooting
-weight: 4
 ---
 ### How Do I Know if My Certificates are in PEM Format?

@@ -1,6 +1,5 @@
 ---
 title: Rolling Back Rancher Installed with Docker
-weight: 1015
 ---

 If a Rancher upgrade does not complete successfully, you'll have to roll back to your Rancher setup that you were using before [Docker Upgrade](upgrade-docker-installed-rancher.md). Rolling back restores:
@@ -1,6 +1,5 @@
 ---
 title: Upgrading Rancher Installed with Docker
-weight: 1010
 ---

 import Tabs from '@theme/Tabs';
@@ -55,7 +54,7 @@ Write down or copy this information before starting the upgrade.

 You can obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` by logging into your Rancher server by remote connection and entering the command to view the containers that are running: `docker ps`. You can also view containers that are stopped using a different command: `docker ps -a`. Use these commands for help anytime during while creating backups.

-## Upgrade 
+## Upgrade

 During upgrade, you create a copy of the data from your current Rancher container and a backup in case something goes wrong. Then you deploy the new version of Rancher in a new container using your existing data.
 ### 1. Create a copy of the data from your Rancher server container
@@ -1,13 +1,12 @@
 ---
 title: Adding TLS Secrets
-weight: 2
 ---

 Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the `tls-rancher-ingress` secret in the `cattle-system` namespace with the certificate and key.

 Combine the server certificate followed by any intermediate certificate(s) needed into a file named `tls.crt`. Copy your certificate key into a file named `tls.key`.

-For example, [acme.sh](https://acme.sh) provides server certificate and CA chains in `fullchain.cer` file. 
+For example, [acme.sh](https://acme.sh) provides server certificate and CA chains in `fullchain.cer` file.
 This `fullchain.cer` should be renamed to `tls.crt` & certificate key file as `tls.key`.

 Use `kubectl` with the `tls` secret type to create the secrets.
@@ -1,6 +1,5 @@
 ---
 title: Bootstrap Password
-weight: 800
 ---

 When Rancher starts for the first time, a password is randomly generated for the first admin user. When the admin first logs in to Rancher, the UI shows commands that can be used to retrieve the bootstrap password. The admin needs to run those commands and log in with the bootstrap password. Then Rancher gives the admin an opportunity to reset the password.
@@ -1,6 +1,5 @@
 ---
 title: Choosing a Rancher Version
-weight: 1
 ---

 import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
 ---
 title: About Custom CA Root Certificates
-weight: 1
 ---

 If you're using Rancher in an internal production environment where you aren't exposing apps publicly, use a certificate from a private certificate authority (CA).
@@ -1,6 +1,5 @@
 ---
 title: Helm Version Requirements
-weight: 3
 ---

 This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster.
@@ -1,6 +1,5 @@
 ---
 title: Setting up Local System Charts for Air Gapped Installations
-weight: 120
 ---

 The [System Charts](https://github.com/rancher/system-charts) repository contains all the catalog items required for features such as monitoring, logging, alerting and global DNS.
@@ -1,6 +1,5 @@
 ---
 title: Updating the Rancher Certificate
-weight: 10
 ---

 # Updating a Private CA Certificate
@@ -81,7 +80,7 @@ Also get the version string of the currently deployed Rancher chart:
 $ helm ls -A
 ```

-Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade.    
+Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade.

 If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using custom certificates.

@@ -228,7 +227,7 @@ Also get the version string of the currently deployed Rancher chart:
 $ helm ls -A
 ```

-Upgrade the Helm application instance using the original configuration values and making sure to specify the current chart version to prevent an application upgrade.    
+Upgrade the Helm application instance using the original configuration values and making sure to specify the current chart version to prevent an application upgrade.

 Also make sure to read the documentation describing the initial installation using custom certificates.

@@ -240,9 +239,9 @@ helm upgrade rancher rancher-stable/rancher \
  --set ...
 ```

-On upgrade, you can either 
+On upgrade, you can either

- remove `--set ingress.tls.source=secret \` from the Helm upgrade command, as shown above, or 
+- remove `--set ingress.tls.source=secret \` from the Helm upgrade command, as shown above, or

 - remove the `privateCA` parameter or set it to `false` because the CA is valid:

@@ -1,6 +1,5 @@
 ---
 title: Upgrading Cert-Manager
-weight: 4
 ---

 Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:
@@ -1,6 +1,5 @@
 ---
 title: Upgrading and Rolling Back Kubernetes
-weight: 70
 ---

 Following an upgrade to the latest version of Rancher, downstream Kubernetes clusters can be upgraded to use the latest supported version of Kubernetes.
@@ -1,6 +1,5 @@
 ---
 title: Upgrading Kubernetes without Upgrading Rancher
-weight: 30
 ---

 The RKE metadata feature allows you to provision clusters with new versions of Kubernetes as soon as they are released, without upgrading Rancher. This feature is useful for taking advantage of patch versions of Kubernetes, for example, if you want to upgrade to Kubernetes v1.14.7 when your Rancher server originally supported v1.14.6.
@@ -13,9 +12,9 @@ The Kubernetes API can change between minor versions. Therefore, we don't suppor

 Rancher's Kubernetes metadata contains information specific to the Kubernetes version that Rancher uses to provision [RKE clusters](../../pages-for-subheaders/launch-kubernetes-with-rancher.md). Rancher syncs the data periodically and creates custom resource definitions (CRDs) for **system images,** **service options** and **addon templates**. Consequently, when a new Kubernetes version is compatible with the Rancher server version, the Kubernetes metadata makes the new version available to Rancher for provisioning clusters. The metadata gives you an overview of the information that the [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) uses for deploying various Kubernetes versions.

-This table below describes the CRDs that are affected by the periodic data sync. 
+This table below describes the CRDs that are affected by the periodic data sync.

-:::note 
+:::note

 Only administrators can edit metadata CRDs. It is recommended not to update existing objects unless explicitly advised.

@@ -1,6 +1,5 @@
 ---
 title: Overview
-weight: 1
 ---

 Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.
@@ -1,7 +1,6 @@
 ---
 title: Rancher AWS Marketplace Quick Start
 description: Use Amazon EKS to deploy Rancher server.
-weight: 110
 ---

 There is now an additional way for you to deploy the Rancher server in AWS by using Amazon EKS. To learn more, see our [Amazon Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-2yzbnvagmi4as).
@@ -1,7 +1,6 @@
 ---
 title: Rancher AWS Quick Start Guide
 description: Read this step by step Rancher AWS guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 100
 ---
 The following steps will quickly deploy a Rancher server on AWS in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.

@@ -1,7 +1,6 @@
 ---
 title: Rancher Azure Quick Start Guide
 description: Read this step by step Rancher Azure guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 115
 ---

 The following steps will quickly deploy a Rancher server on Azure in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.
@@ -1,7 +1,6 @@
 ---
 title: Rancher DigitalOcean Quick Start Guide
 description: Read this step by step Rancher DigitalOcean guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 120
 ---
 The following steps will quickly deploy a Rancher server on DigitalOcean in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.

@@ -1,6 +1,5 @@
 ---
 title: Rancher Equinix Metal Quick Start
-weight: 250
 ---

 ## This tutorial walks you through the following:
@@ -1,7 +1,6 @@
 ---
 title: Rancher GCP Quick Start Guide
 description: Read this step by step Rancher GCP guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 130
 ---
 The following steps will quickly deploy a Rancher server on GCP in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.

@@ -1,6 +1,5 @@
 ---
 title: Helm CLI Quick Start
-weight: 300
 ---

 import Tabs from '@theme/Tabs';
@@ -1,7 +1,6 @@
 ---
 title: Rancher Hetzner Cloud Quick Start Guide
 description: Read this step by step Rancher Hetzner Cloud guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 140
 ---
 The following steps will quickly deploy a Rancher server on Hetzner Cloud in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.

@@ -1,7 +1,6 @@
 ---
 title: Rancher Outscale Quick Start Guide
 description: Read this step by step Rancher Outscale guide to quickly deploy a Rancher server with a single-node downstream Kubernetes cluster attached.
-weight: 140
 ---
 The following steps will quickly deploy a Rancher server on Outscale in a single-node K3s Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.

@@ -1,6 +1,5 @@
 ---
 title: Vagrant Quick Start
-weight: 200
 ---
 The following steps quickly deploy a Rancher Server with a single node cluster attached.

@@ -1,6 +1,5 @@
 ---
 title: Workload with NodePort Quick Start
-weight: 200
 ---

 ### Prerequisite
@@ -1,6 +1,5 @@
 ---
 title: Workload with Ingress Quick Start
-weight: 100
 ---

 ### Prerequisite