diff --git a/docs/en/cluster-provisioning/node-requirements/node-requirements.md b/docs/en/cluster-provisioning/node-requirements/node-requirements.md index 519e8c31077..a6d2924de98 100644 --- a/docs/en/cluster-provisioning/node-requirements/node-requirements.md +++ b/docs/en/cluster-provisioning/node-requirements/node-requirements.md @@ -5,7 +5,11 @@ weight: 1 This page describes the requirements for the Rancher managed Kubernetes clusters where your apps and services will be installed. These downstream clusters should be separate from the three-node cluster running Rancher. -> If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server three-node cluster and downstream clusters have different requirements. For Rancher installation requirements, refer to the node requirements in the [installation section.]({{}}/rancher/v2.6/en/installation/requirements/) +:::note + +If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server three-node cluster and downstream clusters have different requirements. For Rancher installation requirements, refer to the node requirements in the [installation section.]({{}}/rancher/v2.6/en/installation/requirements/) + +::: Make sure the nodes for the Rancher server fulfill the following requirements: @@ -30,13 +34,17 @@ For information on how to install Docker, refer to the official [Docker document Some distributions of Linux derived from RHEL, including Oracle Linux, may have default firewall rules that block communication with Helm. We recommend disabling firewalld. For Kubernetes 1.19, firewalld must be turned off. ->**Note:** In RHEL 8.4, two extra services are included on the NetworkManager: `nm-cloud-setup.service` and `nm-cloud-setup.timer`. These services add a routing table that interferes with the CNI plugin's configuration. If these services are enabled, you must disable them using the command below, and then reboot the node to restore connectivity: -> -> ``` +:::note + +In RHEL 8.4, two extra services are included on the NetworkManager: `nm-cloud-setup.service` and `nm-cloud-setup.timer`. These services add a routing table that interferes with the CNI plugin's configuration. If these services are enabled, you must disable them using the command below, and then reboot the node to restore connectivity: + + ``` systemctl disable nm-cloud-setup.service nm-cloud-setup.timer reboot ``` +::: + ### SUSE Linux Nodes SUSE Linux may have a firewall that blocks all ports by default. In that situation, follow [these steps]({{}}/rancher/v2.6/en/installation/requirements/ports/#opening-suse-linux-ports) to open the ports needed for adding a host to a custom cluster. diff --git a/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md b/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md index c073cdb4388..ec7d5bd67d2 100644 --- a/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md +++ b/docs/en/cluster-provisioning/production/nodes-and-roles/nodes-and-roles.md @@ -14,13 +14,21 @@ This diagram is applicable to Kubernetes clusters [launched with Rancher using R Nodes with the `etcd` role run etcd, which is a consistent and highly available key value store used as Kubernetes’ backing store for all cluster data. etcd replicates the data to each node. ->**Note:** Nodes with the `etcd` role are shown as `Unschedulable` in the UI, meaning no pods will be scheduled to these nodes by default. +:::note + +Nodes with the `etcd` role are shown as `Unschedulable` in the UI, meaning no pods will be scheduled to these nodes by default. + +::: # controlplane Nodes with the `controlplane` role run the Kubernetes master components (excluding `etcd`, as it's a separate role). See [Kubernetes: Master Components](https://kubernetes.io/docs/concepts/overview/components/#master-components) for a detailed list of components. ->**Note:** Nodes with the `controlplane` role are shown as `Unschedulable` in the UI, meaning no pods will be scheduled to these nodes by default. +:::note + +Nodes with the `controlplane` role are shown as `Unschedulable` in the UI, meaning no pods will be scheduled to these nodes by default. + +::: ### kube-apiserver diff --git a/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md b/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md index 5bcc0cc73f0..69233513ad0 100644 --- a/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md +++ b/docs/en/cluster-provisioning/registered-clusters/registered-clusters.md @@ -67,8 +67,11 @@ EKS clusters must have at least one managed node group to be imported into Ranch - **Active** clusters are assigned two Projects: `Default` (containing the namespace `default`) and `System` (containing the namespaces `cattle-system`, `ingress-nginx`, `kube-public` and `kube-system`, if present). -> **Note:** -> You can not re-register a cluster that is currently active in a Rancher setup. +:::note + +You can not re-register a cluster that is currently active in a Rancher setup. + +::: ### Configuring a K3s Cluster to Enable Registration in Rancher @@ -90,7 +93,11 @@ $ 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. ->**Warning:** Even a small difference between the current EKS cluster and a user-provided config could have unexpected results. +::caution + +Even a small difference between the current EKS cluster and a user-provided config could have unexpected results. + +::: The minimum config fields required by Rancher to import EKS clusters with Terraform using `eks_config_v2` are as follows: @@ -155,7 +162,11 @@ The capabilities for registered clusters are listed in the table on [this page.] # Configuring K3s Cluster Upgrades -> It is a Kubernetes best practice to back up the cluster before upgrading. When upgrading a high-availability K3s cluster with an external database, back up the database in whichever way is recommended by the relational database provider. +:::tip + +It is a Kubernetes best practice to back up the cluster before upgrading. When upgrading a high-availability K3s cluster with an external database, back up the database in whichever way is recommended by the relational database provider. + +::: The **concurrency** is the maximum number of nodes that are permitted to be unavailable during an upgrade. If number of unavailable nodes is larger than the **concurrency,** the upgrade will fail. If an upgrade fails, you may need to repair or remove failed nodes before the upgrade can succeed. @@ -194,13 +205,15 @@ _Available as of v2.6.3_ Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and K3s clusters. This support includes manual steps you will perform on the downstream cluster to enable the ACE. For additional information on the authorized cluster endpoint, click [here]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace/). -> **Note:** -> -> - These steps only need to be performed on the control plane nodes of the downstream cluster. You must configure each control plane node individually. -> -> - The following steps will work on both RKE2 and K3s clusters registered in v2.6.x as well as those registered (or imported) from a previous version of Rancher with an upgrade to v2.6.x. -> -> - These steps will alter the configuration of the downstream RKE2 and K3s clusters and deploy the `kube-api-authn-webhook`. If a future implementation of the ACE requires an update to the `kube-api-authn-webhook`, then this would also have to be done manually. For more information on this webhook, click [here]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace/#about-the-kube-api-auth-authentication-webhook). +:::note Notes: + +- These steps only need to be performed on the control plane nodes of the downstream cluster. You must configure each control plane node individually. + +- The following steps will work on both RKE2 and K3s clusters registered in v2.6.x as well as those registered (or imported) from a previous version of Rancher with an upgrade to v2.6.x. + +- These steps will alter the configuration of the downstream RKE2 and K3s clusters and deploy the `kube-api-authn-webhook`. If a future implementation of the ACE requires an update to the `kube-api-authn-webhook`, then this would also have to be done manually. For more information on this webhook, click [here]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/ace/#about-the-kube-api-auth-authentication-webhook). + +::: ###### **Manual steps to be taken on the control plane of each downstream cluster to enable ACE:** @@ -236,7 +249,11 @@ Authorized Cluster Endpoint (ACE) support has been added for registered RKE2 and 1. Finally, you **must** go back to the Rancher UI and edit the imported cluster there to complete the ACE enablement. Click on **⋮ > Edit Config**, then click the **Networking** tab under Cluster Configuration. Finally, click the **Enabled** button for **Authorized Endpoint**. Once the ACE is enabled, you then have the option of entering a fully qualified domain name (FQDN) and certificate information. - >**Note:** The FQDN field is optional, and if one is entered, it should point to the downstream cluster. Certificate information is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field. + :::note + + The FQDN field is optional, and if one is entered, it should point to the downstream cluster. Certificate information is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field. + + ::: # Annotating Registered Clusters diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md b/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md index b8582ef3535..cbbb614615f 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md +++ b/docs/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/amazon.md @@ -131,7 +131,11 @@ The following resources need to tagged with a `ClusterID`: - **Subnet**: The subnet used for your cluster. - **Security Group**: The security group used for your cluster. ->**Note:** Do not tag multiple security groups. Tagging multiple groups generates an error when creating an Elastic Load Balancer (ELB). +::note + +Do not tag multiple security groups. Tagging multiple groups generates an error when creating an Elastic Load Balancer (ELB). + +::: When you create an [Amazon EC2 Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/), the `ClusterID` is automatically configured for the created nodes. Other resources still need to be tagged manually. diff --git a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md b/docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md index e1b7c2c3024..e6492ecb295 100644 --- a/docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md +++ b/docs/en/cluster-provisioning/rke-clusters/cloud-providers/gce/gce.md @@ -7,7 +7,11 @@ In this section, you'll learn how to enable the Google Compute Engine (GCE) clou The official Kubernetes documentation for the GCE cloud provider is [here.](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#gce) -> **Prerequisites:** The service account of `Identity and API` access on GCE needs the `Computer Admin` permission. +:::note Prerequisites: + +The service account of `Identity and API` access on GCE needs the `Computer Admin` permission. + +::: If you are using Calico, diff --git a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md b/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md index fcf49838d16..82e3cef778c 100644 --- a/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md +++ b/docs/en/cluster-provisioning/rke-clusters/custom-nodes/custom-nodes.md @@ -13,9 +13,11 @@ This section describes how to set up a custom cluster. # Creating a Cluster with Custom Nodes ->**Want to use Windows hosts as Kubernetes workers?** -> ->See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) before you start. +:::note Want to use Windows hosts as Kubernetes workers? + +See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) before you start. + +::: @@ -47,12 +49,18 @@ If you're using Amazon EC2 as your host and want to use the [dual-stack](https:/ 1. Enter a **Cluster Name**. 1. Use **Cluster Configuration** section to choose the version of Kubernetes, what network provider will be used and if you want to enable project network isolation. To see more cluster options, click on **Show advanced options**. - >**Using Windows nodes as Kubernetes workers?** - > - >- See [Enable the Windows Support Option]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). - >- The only Network Provider available for clusters with Windows support is Flannel. - > - >**Dual-stack on Amazon EC2:** If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) when configuring RKE. + :::note Using Windows nodes as Kubernetes workers? + + - See [Enable the Windows Support Option]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). + - The only Network Provider available for clusters with Windows support is Flannel. + + ::: + + :::note Dual-stack on Amazon EC2: + + If you're using Amazon EC2 as your host and want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) when configuring RKE. + + ::: 6. Click **Next**. @@ -60,10 +68,12 @@ If you're using Amazon EC2 as your host and want to use the [dual-stack](https:/ 7. From **Node Role**, choose the roles that you want filled by a cluster node. You must provision at least one node for each role: `etcd`, `worker`, and `control plane`. All three roles are required for a custom cluster to finish provisioning. For more information on roles, see [this section.]({{}}/rancher/v2.6/en/overview/concepts/#roles-for-nodes-in-kubernetes-clusters) - >**Notes:** - > - >- Using Windows nodes as Kubernetes workers? See [this section]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). - >- Bare-Metal Server Reminder: If you plan on dedicating bare-metal servers to each role, you must provision a bare-metal server for each role (i.e. provision multiple bare-metal servers). + :::note Notes: + + - Using Windows nodes as Kubernetes workers? See [this section]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/). + - Bare-Metal Server Reminder: If you plan on dedicating bare-metal servers to each role, you must provision a bare-metal server for each role (i.e. provision multiple bare-metal servers). + + ::: 8. **Optional**: Click **[Show advanced options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/)** to specify IP address(es) to use when registering the node, override the hostname of the node, or to add [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) or [taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) to the node. @@ -71,7 +81,11 @@ If you're using Amazon EC2 as your host and want to use the [dual-stack](https:/ 10. Log in to your Linux host using your preferred shell, such as PuTTy or a remote Terminal connection. Run the command copied to your clipboard. - >**Note:** Repeat steps 7-10 if you want to dedicate specific hosts to specific node roles. Repeat the steps as many times as needed. + :::note + + Repeat steps 7-10 if you want to dedicate specific hosts to specific node roles. Repeat the steps as many times as needed. + + ::: 11. When you finish running the command(s) on your Linux host(s), click **Done**. @@ -93,8 +107,11 @@ If you have configured your cluster to use Amazon as **Cloud Provider**, tag you [Amazon Documentation: Tagging Your Amazon EC2 Resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) ->**Note:** You can use Amazon EC2 instances without configuring a cloud provider in Kubernetes. You only have to configure the cloud provider if you want to use specific Kubernetes cloud provider functionality. For more information, see [Kubernetes Cloud Providers](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/) +:::note +You can use Amazon EC2 instances without configuring a cloud provider in Kubernetes. You only have to configure the cloud provider if you want to use specific Kubernetes cloud provider functionality. For more information, see [Kubernetes Cloud Providers](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/) + +::: The following resources need to be tagged with a `ClusterID`: @@ -102,7 +119,11 @@ The following resources need to be tagged with a `ClusterID`: - **Subnet**: The subnet used for your cluster - **Security Group**: The security group used for your cluster. - >**Note:** Do not tag multiple security groups. Tagging multiple groups generates an error when creating Elastic Load Balancer. + :::note + + Do not tag multiple security groups. Tagging multiple groups generates an error when creating Elastic Load Balancer. + + ::: The tag that should be used is: diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md b/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md index 8e7deb9bf62..731dd8c755d 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md +++ b/docs/en/cluster-provisioning/rke-clusters/node-pools/azure/azure.md @@ -10,12 +10,16 @@ First, you will set up your Azure cloud credentials in Rancher. Then you will us Then you will create an Azure cluster in Rancher, and when configuring the new cluster, you will define node pools for it. Each node pool will have a Kubernetes role of etcd, controlplane, or worker. Rancher will install Kubernetes on the new nodes, and it will set up each node with the Kubernetes role defined by the node pool. ->**Warning:** When the Rancher RKE cluster is running in Azure and has an Azure load balancer in front, the outbound flow will fail. The workaround for this problem is as follows: +:::caution -> - Terminate the SSL/TLS on the internal load balancer -> - Use the L7 load balancer +When the Rancher RKE cluster is running in Azure and has an Azure load balancer in front, the outbound flow will fail. The workaround for this problem is as follows: -> For more information, refer to the documentation on [Azure load balancer limitations](https://docs.microsoft.com/en-us/azure/load-balancer/components#limitations). +- Terminate the SSL/TLS on the internal load balancer +- Use the L7 load balancer + +For more information, refer to the documentation on [Azure load balancer limitations](https://docs.microsoft.com/en-us/azure/load-balancer/components#limitations). + +::: For more information on configuring the Kubernetes cluster that Rancher will install on the Azure nodes, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md b/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md index 26d8d3c4576..5cafd243f31 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md +++ b/docs/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2.md @@ -53,7 +53,11 @@ Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rk 1. Fill out a node template for EC2. For help filling out the form, refer to [EC2 Node Template Configuration.](./ec2-node-template-config) 1. Click **Create**. - >**Note:** If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + :::note + + If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + + ::: ### 3. Create a cluster with node pools using the node template @@ -66,7 +70,12 @@ Add one or more node pools to your cluster. For more information about node pool 1. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. 1. Use **Cluster Options** to choose the version of Kubernetes that will be installed, what network provider will be used and if you want to enable project network isolation. Refer to [Selecting Cloud Providers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/) to configure the Kubernetes Cloud Provider. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) - >**Note:** If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + :::note + + If you want to use the [dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/) feature, there are additional [requirements]({{}}/rke//latest/en/config-options/dual-stack#requirements) that must be taken into consideration. + + ::: + 1. Click **Create**. {{% /tab %}} diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md b/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md index 4f5700144d8..a840dec637c 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md +++ b/docs/en/cluster-provisioning/rke-clusters/node-pools/node-pools.md @@ -99,7 +99,11 @@ When there are taints on the node pool and node template, if there is no conflic If a node is in a node pool, Rancher can automatically replace unreachable nodes. Rancher will use the existing node template for the given node pool to recreate the node if it becomes inactive for a specified number of minutes. -> **Important:** Self-healing node pools are designed to help you replace worker nodes for stateless applications. It is not recommended to enable node auto-replace on a node pool of master nodes or nodes with persistent volumes attached, because VMs are treated ephemerally. When a node in a node pool loses connectivity with the cluster, its persistent volumes are destroyed, resulting in data loss for stateful applications. +:::caution + +Self-healing node pools are designed to help you replace worker nodes for stateless applications. It is not recommended to enable node auto-replace on a node pool of master nodes or nodes with persistent volumes attached, because VMs are treated ephemerally. When a node in a node pool loses connectivity with the cluster, its persistent volumes are destroyed, resulting in data loss for stateful applications. + +::: Node auto-replace works on top of the Kubernetes node controller. The node controller periodically checks the status of all the nodes (configurable via the `--node-monitor-period` flag of the `kube-controller`). When a node is unreachable, the node controller will taint that node. When this occurs, Rancher will begin its deletion countdown. You can configure the amount of time Rancher waits to delete the node. If the taint is not removed before the deletion countdown ends, Rancher will proceed to delete the node object. Rancher will then provision a node in accordance with the set quantity of the node pool. @@ -144,7 +148,11 @@ If you don't find the node driver that you want to use, you can see if it is ava Rancher v2.6 introduces provisioning for [RKE2](https://docs.rke2.io/) clusters directly from the Rancher UI. RKE2, also known as RKE Government, is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. -> **Note:** For RKE2 cluster templates, please refer to [this page]({{}}/rancher/v2.6/en/admin-settings/cluster-templates/#rke2-cluster-template) for additional information. +:::note + +For RKE2 cluster templates, please refer to [this page]({{}}/rancher/v2.6/en/admin-settings/cluster-templates/#rke2-cluster-template) for additional information. + +::: ### Node Roles diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md b/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md index 3cc65593540..bd446a50462 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md +++ b/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/vsphere-node-template-config.md @@ -78,7 +78,11 @@ For tags, all your vSphere tags will show up as options to select from in your n In the custom attributes, Rancher will let you select all the custom attributes you have already set up in vSphere. The custom attributes are keys and you can enter values for each one. -> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere. +:::note + +Custom attributes are a legacy feature that will eventually be removed from vSphere. + +::: # cloud-init diff --git a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md b/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md index e11d83949fb..85d83075cb5 100644 --- a/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md +++ b/docs/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere.md @@ -25,7 +25,11 @@ The vSphere node templates have been updated, allowing you to bring cloud operat One of the biggest advantages of provisioning vSphere nodes with Rancher is that it allows you to take advantage of Rancher's self-healing node pools, also called the [node auto-replace feature,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) in your on-premises clusters. Self-healing node pools are designed to help you replace worker nodes for stateless applications. When Rancher provisions nodes from a node template, Rancher can automatically replace unreachable nodes. -> **Important:** It is not recommended to enable node auto-replace on a node pool of master nodes or nodes with persistent volumes attached, because VMs are treated ephemerally. When a node in a node pool loses connectivity with the cluster, its persistent volumes are destroyed, resulting in data loss for stateful applications. +:::caution + +It is not recommended to enable node auto-replace on a node pool of master nodes or nodes with persistent volumes attached, because VMs are treated ephemerally. When a node in a node pool loses connectivity with the cluster, its persistent volumes are destroyed, resulting in data loss for stateful applications. + +::: ### Dynamically Populated Options for Instances and Scheduling diff --git a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md b/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md index 5db4add3d41..d79d4d76adc 100644 --- a/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md +++ b/docs/en/cluster-provisioning/rke-clusters/windows-clusters/windows-clusters.md @@ -43,7 +43,11 @@ The RKE2 provisioning feature also includes installing RKE2 on Windows clusters. Windows Support for RKE2 Custom Clusters requires choosing Calico as the CNI. ->**Important:** Rancher will allow Windows workload pods to deploy on both Windows and Linux worker nodes by default. When creating mixed clusters in RKE2, you must edit the `nodeSelector` in the chart to direct the pods to be placed onto a compatible Windows node. Refer to the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) for more information on how to use `nodeSelector` to assign pods to nodes. +:::note + +Rancher will allow Windows workload pods to deploy on both Windows and Linux worker nodes by default. When creating mixed clusters in RKE2, you must edit the `nodeSelector` in the chart to direct the pods to be placed onto a compatible Windows node. Refer to the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) for more information on how to use `nodeSelector` to assign pods to nodes. + +::: # Requirements for Windows Clusters @@ -85,7 +89,11 @@ For **VXLAN (Overlay)** networking, the [KB4489899](https://support.microsoft.co If you are configuring DHCP options sets for an AWS virtual private cloud, note that in the `domain-name` option field, only one domain name can be specified. According to the DHCP options [documentation:](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) -> Some Linux operating systems accept multiple domain names separated by spaces. However, other Linux operating systems and Windows treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. +:::note + +Some Linux operating systems accept multiple domain names separated by spaces. However, other Linux operating systems and Windows treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. + +::: ### Rancher on vSphere with ESXi 6.7u2 and above @@ -196,7 +204,11 @@ The instructions for creating a Windows cluster on existing nodes are very simil 1. Optional: After you enable Windows support, you will be able to choose the Flannel backend. There are two network options: [**Host Gateway (L2bridge)**](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#host-gw) and [**VXLAN (Overlay)**](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#vxlan). The default option is **VXLAN (Overlay)** mode. 1. Click **Next**. -> **Important:** For Host Gateway (L2bridge) networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. +:::note Important: + +For Host Gateway (L2bridge) networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/host-gateway-requirements/#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM. + +::: # 3. Add Nodes to the Cluster @@ -245,13 +257,17 @@ After the initial provisioning of your cluster, your cluster only has a single L **Result:** The **Worker** role is installed on your Linux host, and the node registers with Rancher. It may take a few minutes for the node to be registered in your cluster. -> **Note:** Taints on Linux Worker Nodes -> -> For each Linux worker node added into the cluster, the following taints will be added to Linux worker node. By adding this taint to the Linux worker node, any workloads added to the Windows cluster will be automatically scheduled to the Windows worker node. If you want to schedule workloads specifically onto the Linux worker node, you will need to add tolerations to those workloads. +:::note -> | Taint Key | Taint Value | Taint Effect | -> | -------------- | ----------- | ------------ | -> | `cattle.io/os` | `linux` | `NoSchedule` | +Taints on Linux Worker Nodes + +For each Linux worker node added into the cluster, the following taints will be added to Linux worker node. By adding this taint to the Linux worker node, any workloads added to the Windows cluster will be automatically scheduled to the Windows worker node. If you want to schedule workloads specifically onto the Linux worker node, you will need to add tolerations to those workloads. + +| Taint Key | Taint Value | Taint Effect | +| -------------- | ----------- | ------------ | +| `cattle.io/os` | `linux` | `NoSchedule` | + +::: ### Add a Windows Worker Node diff --git a/docs/en/contributing/contributing.md b/docs/en/contributing/contributing.md index cb8d8332c8e..781c277bb30 100644 --- a/docs/en/contributing/contributing.md +++ b/docs/en/contributing/contributing.md @@ -55,8 +55,17 @@ If you can't find anything related to your issue, contact us by [filing an issue Please follow this checklist when filing an issue which will helps us investigate and fix the issue. More info means more data we can use to determine what is causing the issue or what might be related to the issue. ->**Note:** For large amounts of data, please use [GitHub Gist](https://gist.github.com/) or similar and link the created resource in the issue. ->**Important:** Please remove any sensitive data as it will be publicly viewable. +:::note + +For large amounts of data, please use [GitHub Gist](https://gist.github.com/) or similar and link the created resource in the issue. + +::: + +:::note Important: + +Please remove any sensitive data as it will be publicly viewable. + +::: - **Resources:** Provide as much as detail as possible on the used resources. As the source of the issue can be many things, including as much of detail as possible helps to determine the root cause. See some examples below: - **Hosts:** What specifications does the host have, like CPU/memory/disk, what cloud does it happen on, what Amazon Machine Image are you using, what DigitalOcean droplet are you using, what image are you provisioning that we can rebuild or use when we try to reproduce @@ -78,7 +87,11 @@ Please follow this checklist when filing an issue which will helps us investigat ``` - Kubernetes install using `kubectl` - > **Note:** Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` if Rancher is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI. + :::note + + Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` if Rancher is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI. + + ::: ``` kubectl -n cattle-system \ @@ -95,7 +108,11 @@ Please follow this checklist when filing an issue which will helps us investigat ``` - Kubernetes Install with RKE Add-On - > **Note:** Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` if the Rancher server is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI. + :::note + + Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_cluster.yml` if the Rancher server is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI. + + ::: ``` kubectl -n cattle-system \ diff --git a/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md b/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md index 65e1978953d..b6a446453c3 100644 --- a/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md +++ b/docs/en/deploy-across-clusters/multi-cluster-apps/multi-cluster-apps.md @@ -88,13 +88,21 @@ Rancher will let you select from two options for Roles, **Project** and **Cluste When launching the application, Rancher will confirm if you have these permissions in the target projects before launching the application. -> **Note:** There are some applications like _Grafana_ or _Datadog_ that require access to specific cluster-scoped resources. These applications will require the _Cluster_ role. If you find out later that the application requires cluster roles, the multi-cluster application can be upgraded to update the roles. +:::note + +There are some applications like _Grafana_ or _Datadog_ that require access to specific cluster-scoped resources. These applications will require the _Cluster_ role. If you find out later that the application requires cluster roles, the multi-cluster application can be upgraded to update the roles. + +::: # Application Configuration Options For each Helm chart, there are a list of desired answers that must be entered in order to successfully deploy the chart. When entering answers, you must format them using the syntax rules found in [Using Helm: The format and limitations of –set](https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of---set), as Rancher passes them as `--set` flags to Helm. -> For example, when entering an answer that includes two values separated by a comma (i.e. `abc, bcd`), it is required to wrap the values with double quotes (i.e., ``"abc, bcd"``). +:::note Example + +When entering an answer that includes two values separated by a comma (i.e. `abc, bcd`), it is required to wrap the values with double quotes (i.e., ``"abc, bcd"``). + +::: ### Using a questions.yml file @@ -118,7 +126,11 @@ By default, multi-cluster applications can only be managed by the user who creat - **Read-only**: This access type cannot modify any configuration option for the multi-cluster application. Users can only view these applications. - > **Note:** Please ensure only trusted users are given _Owner_ or _Member_ access as they will automatically be able to manage applications created for this multi-cluster application in target projects they might not have direct access to. + :::caution + + Please ensure only trusted users are given _Owner_ or _Member_ access as they will automatically be able to manage applications created for this multi-cluster application in target projects they might not have direct access to. + + ::: ### Overriding Application Configuration Options for Specific Projects @@ -148,7 +160,11 @@ The creator and any users added with the access-type "owner" to a multi-cluster One of the benefits of using a multi-cluster application as opposed to multiple individual applications of the same type, is the ease of management. Multi-cluster applications can be cloned, upgraded or rolled back. -> **Prerequisite:** The `legacy` feature flag needs to be enabled. +:::note Prerequisite: + +The `legacy` feature flag needs to be enabled. + +::: 1. In the upper left corner, click **☰ > Multi-cluster Apps**. @@ -160,10 +176,18 @@ One of the benefits of using a multi-cluster application as opposed to multiple # Deleting a Multi-Cluster Application -> **Prerequisite:** The `legacy` feature flag needs to be enabled. +:::note Prerequisite: + +The `legacy` feature flag needs to be enabled. + +::: 1. In the upper left corner, click **☰ > Multi-cluster Apps**. 2. Choose the multi-cluster application you want to delete and click the **⋮ > Delete**. When deleting the multi-cluster application, all applications and namespaces are deleted in all of the target projects. - > **Note:** The applications in the target projects, that are created for a multi-cluster application, cannot be deleted individually. The applications can only be deleted when the multi-cluster application is deleted. + :::note + + The applications in the target projects, that are created for a multi-cluster application, cannot be deleted individually. The applications can only be deleted when the multi-cluster application is deleted. + + ::: \ No newline at end of file diff --git a/docs/en/faq/deprecated-features/deprecated-features.md b/docs/en/faq/deprecated-features/deprecated-features.md index b0eb76250a4..0815fd29044 100644 --- a/docs/en/faq/deprecated-features/deprecated-features.md +++ b/docs/en/faq/deprecated-features/deprecated-features.md @@ -19,6 +19,7 @@ Rancher will publish deprecated features as part of the [release notes](https:// | [2.6.3](https://github.com/rancher/rancher/releases/tag/v2.6.3) | Dec 21, 2021 | | [2.6.4](https://github.com/rancher/rancher/releases/tag/v2.6.4) | Mar 31, 2022 | | [2.6.5](https://github.com/rancher/rancher/releases/tag/v2.6.5) | May 12, 2022 | +| [2.6.6](https://github.com/rancher/rancher/releases/tag/v2.6.6) | Jun 30, 2022 | ### What can I expect when a feature is marked for deprecation? diff --git a/docs/en/faq/networking/cni-providers/cni-providers.md b/docs/en/faq/networking/cni-providers/cni-providers.md index ea4bbde4872..2aba76d51d0 100644 --- a/docs/en/faq/networking/cni-providers/cni-providers.md +++ b/docs/en/faq/networking/cni-providers/cni-providers.md @@ -109,11 +109,15 @@ Calico also provides a stateless IP-in-IP or VXLAN encapsulation mode that can b Kubernetes workers should open TCP port `179` if using BGP or UDP port `4789` if using VXLAN encapsulation. In addition, TCP port `5473` is needed when using Typha. See [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. ->**Important:** In Rancher v2.6.3, Calico probes fail on Windows nodes upon RKE2 installation. Note that this issue is resolved in v2.6.4. -> ->- To work around this issue, first navigate to `https:///v3/settings/windows-rke2-install-script`. -> ->- There, change the current setting: `https://raw.githubusercontent.com/rancher/wins/v0.1.3/install.ps1` to this new setting: `https://raw.githubusercontent.com/rancher/rke2/master/windows/rke2-install.ps1`. +:::note Important: + +In Rancher v2.6.3, Calico probes fail on Windows nodes upon RKE2 installation. Note that this issue is resolved in v2.6.4. + +- To work around this issue, first navigate to `https:///v3/settings/windows-rke2-install-script`. + +- There, change the current setting: `https://raw.githubusercontent.com/rancher/wins/v0.1.3/install.ps1` to this new setting: `https://raw.githubusercontent.com/rancher/rke2/master/windows/rke2-install.ps1`. + +::: ![Calico Diagram]({{}}/img/rancher/calico-diagram.svg)