Replace Hugo shortcodes

2026-09-25 20:48:11 +00:00 · 2022-09-09 19:43:45 -07:00
parent 878aa86c1a
commit 82667d93f9
50 changed files with 1139 additions and 128 deletions
@@ -91,7 +91,19 @@ You'll use the backup as a restoration point if something goes wrong during upgr

    For information about the repos and their differences, see [Helm Chart Repositories](../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories).

-    {{< release-channel >}}
+    - Latest: Recommended for trying out the newest features
+        ```
+        helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
+        ```
+    - Stable: Recommended for production environments
+        ```
+        helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+        ```
+    - Alpha: Experimental preview of upcoming releases.
+        ```
+        helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+        ```
+        Note: Upgrades are not supported to, from, or between Alphas.

    ```
    helm repo list
@@ -8,25 +8,12 @@ aliases:

 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import PortsIaasNodes from '@site/src/components/PortsIaasNodes'
+import PortsCustomNodes from '@site/src/components/PortsCustomNodes'
+import PortsImportedHosted from '@site/src/components/PortsImportedHosted'

 To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes.

- [Rancher Nodes](#rancher-nodes)
-  - [Ports for Rancher Server Nodes on K3s](#ports-for-rancher-server-nodes-on-k3s)
-  - [Ports for Rancher Server Nodes on RKE](#ports-for-rancher-server-nodes-on-rke)
-  - [Ports for Rancher Server Nodes on RancherD or RKE2](#ports-for-rancher-server-nodes-on-rancherd-or-rke2)
-  - [Ports for Rancher Server in Docker](#ports-for-rancher-server-in-docker)
- [Downstream Kubernetes Cluster Nodes](#downstream-kubernetes-cluster-nodes)
-  - [Ports for Rancher Launched Kubernetes Clusters using Node Pools](#ports-for-rancher-launched-kubernetes-clusters-using-node-pools)
-  - [Ports for Rancher Launched Kubernetes Clusters using Custom Nodes](#ports-for-rancher-launched-kubernetes-clusters-using-custom-nodes)
-  - [Ports for Hosted Kubernetes Clusters](#ports-for-hosted-kubernetes-clusters)
-  - [Ports for Registered Clusters](#ports-for-registered-clusters)
- [Other Port Considerations](#other-port-considerations)
-  - [Commonly Used Ports](#commonly-used-ports)
-  - [Local Node Traffic](#local-node-traffic)
-  - [Rancher AWS EC2 Security Group](#rancher-aws-ec2-security-group)
-  - [Opening SUSE Linux Ports](#opening-suse-linux-ports)
-
 # Rancher Nodes

 The following table lists the ports that need to be open to and from nodes that are running the Rancher server.
@@ -205,7 +192,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet
 >**Note:**
 >The required ports are automatically opened by Rancher during creation of clusters in cloud providers like Amazon EC2 or DigitalOcean.

-{{< ports-iaas-nodes >}}
+<PortsIaasNodes/>

 </details>

@@ -216,7 +203,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet

 The following table depicts the port requirements for [Rancher Launched Kubernetes](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) with [Custom Nodes](../../../pages-for-subheaders/use-existing-nodes.md).

-{{< ports-custom-nodes >}}
+<PortsCustomNodes/>

 </details>

@@ -227,7 +214,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet

 The following table depicts the port requirements for [hosted clusters](../../../pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers.md).

-{{< ports-imported-hosted >}}
+<PortsImportedHosted/>

 </details>

@@ -240,7 +227,7 @@ Note: Registered clusters were called imported clusters before Rancher v2.5.

 The following table depicts the port requirements for [registered clusters](../../../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/register-existing-clusters.md).

-{{< ports-imported-hosted >}}
+<PortsImportedHosted/>

 </details>

@@ -42,10 +42,19 @@ From a system that has access to the internet, fetch the latest Helm chart and c
 1. If you haven't already, install `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements](../../resources/helm-version-requirements.md) to choose a version of Helm to install Rancher.

 2. Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher](../../../../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories).
-  {{< release-channel >}}
-    ```
-    helm repo add rancher-<CHART_REPO> https://releases.rancher.com/server-charts/<CHART_REPO>
-    ```
+    - Latest: Recommended for trying out the newest features
+        ```
+        helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
+        ```
+    - Stable: Recommended for production environments
+        ```
+        helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+        ```
+    - Alpha: Experimental preview of upcoming releases.
+        ```
+        helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+        ```
+    Note: Upgrades are not supported to, from, or between Alphas.

 3. Fetch the latest Rancher chart. This will pull down the chart and save it in the current directory as a `.tgz` file.
    ```plain
@@ -58,7 +58,19 @@ After installing Rancher, if you want to change which Helm chart repository to i

 > **Note:** Because the rancher-alpha repository contains only alpha charts, switching between the rancher-alpha repository and the rancher-stable or rancher-latest repository for upgrades is not supported.

-{{< release-channel >}}
+- Latest: Recommended for trying out the newest features
+    ```
+    helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
+    ```
+- Stable: Recommended for production environments
+    ```
+    helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+    ```
+- Alpha: Experimental preview of upcoming releases.
+    ```
+    helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+    ```
+    Note: Upgrades are not supported to, from, or between Alphas.

 1. List the current Helm chart repositories.

@@ -129,7 +129,14 @@ The following is an example process for Firefox, but will vary slightly for othe

 **Result:** Rancher is configured to work with Keycloak. Your users can now sign into Rancher using their Keycloak logins.

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::

 ## Configuration Reference

@@ -50,4 +50,11 @@ Setting | Value

 **Result:** Rancher is configured to work with Okta. Your users can now sign into Rancher using their Okta logins.

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::
@@ -52,4 +52,11 @@ Note that these URLs will not return valid data until the authentication configu

 **Result:** Rancher is configured to work with PingIdentity. Your users can now sign into Rancher using their PingIdentity logins.

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::
@@ -15,7 +15,14 @@ When adding a user or group to a resource, you can search for users or groups by

 All users, whether they are local users or from an authentication provider, can be viewed and managed. From the **Global** view, click on **Users**.

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::

 ## User Information

@@ -64,7 +64,14 @@ To set the Rancher access level for users in the authorization service, follow t

 **Result:** The Rancher access configuration settings are applied.

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::

 ## External Authentication Configuration and Principal Users

@@ -26,7 +26,14 @@ Setting up Microsoft AD FS with Rancher Server requires configuring AD FS on you
 - [1. Configuring Microsoft AD FS for Rancher](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md)
 - [2. Configuring Rancher for Microsoft AD FS](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-rancher-for-ms-adfs.md)

-{{< saml_caveats >}}
+:::note SAML Provider Caveats:
+
+- SAML Protocol does not support search or lookup for users or groups. Therefore, there is no validation on users or groups when adding them to Rancher.
+- When adding users, the exact user IDs (i.e. `UID Field`) must be entered correctly. As you type the user ID, there will be no search for other  user IDs that may match.
+- When adding groups, you must select the group from the drop-down that is next to the text box. Rancher assumes that any input from the text box is a user.
+- The group drop-down shows only the groups that you are a member of. You will not be able to add groups that you are not a member of.
+
+:::


 ### [Next: Configuring Microsoft AD FS for Rancher](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-microsoft-ad-federation-service-saml/configure-ms-adfs-for-rancher.md)
@@ -81,11 +81,19 @@ To set up Rancher,

 Use `helm repo add` command to add the Helm chart repository that contains charts to install Rancher. For more information about the repository choices and which is best for your use case, see [Choosing a Version of Rancher](../reference-guides/installation-references/helm-chart-options.md#helm-chart-repositories).

-{{< release-channel >}}
-
-```
-helm repo add rancher-<CHART_REPO> https://releases.rancher.com/server-charts/<CHART_REPO>
-```
+- Latest: Recommended for trying out the newest features
+    ```
+    helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
+    ```
+- Stable: Recommended for production environments
+    ```
+    helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+    ```
+- Alpha: Experimental preview of upcoming releases.
+    ```
+    helm repo add rancher-stable https://releases.rancher.com/server-charts/stable
+    ```
+    Note: Upgrades are not supported to, from, or between Alphas.

 ### 2. Create a Namespace for Rancher

@@ -8,6 +8,7 @@ aliases:
  - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-vsphere/
  - /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/
 ---
+import YouTube from '@site/src/components/YouTube'

 By using Rancher with vSphere, you can bring cloud operations on-premises.

@@ -44,7 +45,7 @@ You can provision VMs with any operating system that supports `cloud-init`. Only

 In this YouTube video, we demonstrate how to set up a node template with the new features designed to help you bring cloud operations to on-premises clusters.

-{{< youtube id="dPIwg6x1AlU">}}
+<YouTube id="dPIwg6x1AlU"/>

 # Creating a vSphere Cluster