diff --git a/content/rancher/v2.6/en/admin-settings/_index.md b/content/rancher/v2.6/en/admin-settings/_index.md index be8eec446e3..4983f894960 100644 --- a/content/rancher/v2.6/en/admin-settings/_index.md +++ b/content/rancher/v2.6/en/admin-settings/_index.md @@ -2,14 +2,14 @@ title: Authentication, Permissions and Global Configuration weight: 6 aliases: - - /rancher/v2.5/en/concepts/global-configuration/ - - /rancher/v2.5/en/tasks/global-configuration/ - - /rancher/v2.5/en/concepts/global-configuration/server-url/ - - /rancher/v2.5/en/tasks/global-configuration/server-url/ - - /rancher/v2.5/en/admin-settings/log-in/ + - /rancher/v2.6/en/concepts/global-configuration/ + - /rancher/v2.6/en/tasks/global-configuration/ + - /rancher/v2.6/en/concepts/global-configuration/server-url/ + - /rancher/v2.6/en/tasks/global-configuration/server-url/ + - /rancher/v2.6/en/admin-settings/log-in/ --- -After installation, the [system administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. +After installation, the [system administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries. ## First Log In @@ -21,36 +21,36 @@ After you log into Rancher for the first time, Rancher will prompt you for a **R One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows to set up local users and/or connect to an external authentication provider. By connecting to an external authentication provider, you can leverage that provider's user and groups. -For more information how authentication works and how to configure each provider, see [Authentication]({{}}/rancher/v2.5/en/admin-settings/authentication/). +For more information how authentication works and how to configure each provider, see [Authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/). ## Authorization Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. Once the user logs in to Rancher, their _authorization_, or their access rights within the system, is determined by the user's role. Rancher provides built-in roles to allow you to easily configure a user's permissions to resources, but Rancher also provides the ability to customize the roles for each Kubernetes resource. -For more information how authorization works and how to customize roles, see [Roles Based Access Control (RBAC)]({{}}/rancher/v2.5/en/admin-settings/rbac/). +For more information how authorization works and how to customize roles, see [Roles Based Access Control (RBAC)]({{}}/rancher/v2.6/en/admin-settings/rbac/). ## Pod Security Policies _Pod Security Policies_ (or PSPs) are objects that control security-sensitive aspects of pod specification, e.g. root privileges. If a pod does not meet the conditions specified in the PSP, Kubernetes will not allow it to start, and Rancher will display an error message. -For more information how to create and use PSPs, see [Pod Security Policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/). +For more information how to create and use PSPs, see [Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). ## Provisioning Drivers -Drivers in Rancher allow you to manage which providers can be used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. +Drivers in Rancher allow you to manage which providers can be used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. -For more information, see [Provisioning Drivers]({{}}/rancher/v2.5/en/admin-settings/drivers/). +For more information, see [Provisioning Drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/). ## Adding Kubernetes Versions into Rancher With this feature, you can upgrade to the latest version of Kubernetes as soon as it is released, without upgrading Rancher. This feature allows you to easily upgrade Kubernetes patch versions (i.e. `v1.15.X`), but not intended to upgrade Kubernetes minor versions (i.e. `v1.X.0`) as Kubernetes tends to deprecate or add APIs between minor versions. -The information that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) is now located in the Rancher Kubernetes Metadata. For details on metadata configuration and how to change the Kubernetes version used for provisioning RKE clusters, see [Rancher Kubernetes Metadata.]({{}}/rancher/v2.5/en/admin-settings/k8s-metadata/) +The information that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) is now located in the Rancher Kubernetes Metadata. For details on metadata configuration and how to change the Kubernetes version used for provisioning RKE clusters, see [Rancher Kubernetes Metadata.]({{}}/rancher/v2.6/en/admin-settings/k8s-metadata/) -Rancher Kubernetes Metadata contains Kubernetes version information which Rancher uses to provision [RKE clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/). +Rancher Kubernetes Metadata contains Kubernetes version information which Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). -For more information on how metadata works and how to configure metadata config, see [Rancher Kubernetes Metadata]({{}}/rancher/v2.5/en/admin-settings/k8s-metadata/). +For more information on how metadata works and how to configure metadata config, see [Rancher Kubernetes Metadata]({{}}/rancher/v2.6/en/admin-settings/k8s-metadata/). ## Enabling Experimental Features -Rancher includes some features that are experimental and disabled by default. Feature flags were introduced to allow you to try these features. For more information, refer to the section about [feature flags.]({{}}/rancher/v2.5/en/installation/options/feature-flags/) +Rancher includes some features that are experimental and disabled by default. Feature flags were introduced to allow you to try these features. For more information, refer to the section about [feature flags.]({{}}/rancher/v2.6/en/installation/options/feature-flags/) diff --git a/content/rancher/v2.6/en/admin-settings/authentication/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/_index.md index 53c03cedcf7..aec1aeb047f 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/_index.md @@ -2,8 +2,8 @@ title: Authentication weight: 1115 aliases: - - /rancher/v2.5/en/concepts/global-configuration/authentication/ - - /rancher/v2.5/en/tasks/global-configuration/authentication/ + - /rancher/v2.6/en/concepts/global-configuration/authentication/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/ --- One of the key features that Rancher adds to Kubernetes is centralized user authentication. This feature allows your users to use one set of credentials to authenticate with any of your Kubernetes clusters. @@ -16,30 +16,30 @@ The Rancher authentication proxy integrates with the following external authenti | Auth Service | | ------------------------------------------------------------------------------------------------ | -| [Microsoft Active Directory]({{}}/rancher/v2.5/en/admin-settings/authentication/ad/) | -| [GitHub]({{}}/rancher/v2.5/en/admin-settings/authentication/github/) | -| [Microsoft Azure AD]({{}}/rancher/v2.5/en/admin-settings/authentication/azure-ad/) | -| [FreeIPA]({{}}/rancher/v2.5/en/admin-settings/authentication/freeipa/) | -| [OpenLDAP]({{}}/rancher/v2.5/en/admin-settings/authentication/openldap/) | -| [Microsoft AD FS]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/) | -| [PingIdentity]({{}}/rancher/v2.5/en/admin-settings/authentication/ping-federate/) | -| [Keycloak]({{}}/rancher/v2.5/en/admin-settings/authentication/keycloak/) | -| [Okta]({{}}/rancher/v2.5/en/admin-settings/authentication/okta/) | -| [Google OAuth]({{}}/rancher/v2.5/en/admin-settings/authentication/google/) | -| [Shibboleth]({{}}/rancher/v2.5/en/admin-settings/authentication/shibboleth) | +| [Microsoft Active Directory]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/) | +| [GitHub]({{}}/rancher/v2.6/en/admin-settings/authentication/github/) | +| [Microsoft Azure AD]({{}}/rancher/v2.6/en/admin-settings/authentication/azure-ad/) | +| [FreeIPA]({{}}/rancher/v2.6/en/admin-settings/authentication/freeipa/) | +| [OpenLDAP]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap/) | +| [Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/) | +| [PingIdentity]({{}}/rancher/v2.6/en/admin-settings/authentication/ping-federate/) | +| [Keycloak]({{}}/rancher/v2.6/en/admin-settings/authentication/keycloak/) | +| [Okta]({{}}/rancher/v2.6/en/admin-settings/authentication/okta/) | +| [Google OAuth]({{}}/rancher/v2.6/en/admin-settings/authentication/google/) | +| [Shibboleth]({{}}/rancher/v2.6/en/admin-settings/authentication/shibboleth) |
-However, Rancher also provides [local authentication]({{}}/rancher/v2.5/en/admin-settings/authentication/local/). +However, Rancher also provides [local authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/local/). In most cases, you should use an external authentication service over local authentication, as external authentication allows user management from a central location. However, you may want a few local authentication users for managing Rancher under rare circumstances, such as if your external authentication provider is unavailable or undergoing maintenance. ## Users and Groups -Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, multi-cluster apps, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.5/en/admin-settings/rbac/). +Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When authenticating with an external provider, groups are provided from the external provider based on the user. These users and groups are given specific roles to resources like clusters, projects, multi-cluster apps, and global DNS providers and entries. When you give access to a group, all users who are a member of that group in the authentication provider will be able to access the resource with the permissions that you've specified. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.6/en/admin-settings/rbac/). > **Note:** Local authentication does not support creating or managing groups. -For more information, see [Users and Groups]({{}}/rancher/v2.5/en/admin-settings/authentication/user-groups/) +For more information, see [Users and Groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) ## Scope of Rancher Authorization diff --git a/content/rancher/v2.6/en/admin-settings/authentication/ad/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/ad/_index.md index bffe3d786e4..56682701858 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/ad/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/ad/_index.md @@ -2,16 +2,16 @@ title: Configuring Active Directory (AD) weight: 1112 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/active-directory/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/active-directory/ --- If your organization uses Microsoft Active Directory as central user repository, you can configure Rancher to communicate with an Active Directory server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the Active Directory, while allowing end-users to authenticate with their AD credentials when logging in to the Rancher UI. -Rancher uses LDAP to communicate with the Active Directory server. The authentication flow for Active Directory is therefore the same as for the [OpenLDAP authentication]({{}}/rancher/v2.5/en/admin-settings/authentication/openldap) integration. +Rancher uses LDAP to communicate with the Active Directory server. The authentication flow for Active Directory is therefore the same as for the [OpenLDAP authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap) integration. > **Note:** > -> Before you start, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you start, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). ## Prerequisites @@ -196,4 +196,4 @@ In the same way, we can observe that the value in the **memberOf** attribute in ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the Active Directory server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.5/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the Active Directory server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/azure-ad/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/azure-ad/_index.md index 6330a68f992..3af6c610800 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/azure-ad/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/azure-ad/_index.md @@ -2,7 +2,7 @@ title: Configuring Azure AD weight: 1115 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/azure-ad/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/azure-ad/ --- If you have an instance of Active Directory (AD) hosted in Azure, you can configure Rancher to allow your users to log in using their AD accounts. Configuration of Azure AD external authentication requires you to make configurations in both Azure and Rancher. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/freeipa/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/freeipa/_index.md index 12c5404d535..72ec7d508c6 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/freeipa/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/freeipa/_index.md @@ -2,7 +2,7 @@ title: Configuring FreeIPA weight: 1114 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/freeipa/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/freeipa/ --- If your organization uses FreeIPA for user authentication, you can configure Rancher to allow your users to login using their FreeIPA credentials. @@ -11,7 +11,7 @@ If your organization uses FreeIPA for user authentication, you can configure Ran > >- You must have a [FreeIPA Server](https://www.freeipa.org/) configured. >- Create a service account in FreeIPA with `read-only` access. Rancher uses this account to verify group membership when a user makes a request using an API key. ->- Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +>- Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). 1. Sign into Rancher using a local user assigned the `administrator` role (i.e., the _local principal_). diff --git a/content/rancher/v2.6/en/admin-settings/authentication/github/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/github/_index.md index 5344cfa977e..30b171ba9cd 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/github/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/github/_index.md @@ -2,12 +2,12 @@ title: Configuring GitHub weight: 1116 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/github/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/github/ --- In environments using GitHub, you can configure Rancher to allow sign on using GitHub credentials. ->**Prerequisites:** Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +>**Prerequisites:** Read [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). 1. Sign into Rancher using a local user assigned the `administrator` role (i.e., the _local principal_). diff --git a/content/rancher/v2.6/en/admin-settings/authentication/google/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/google/_index.md index 32c0324399d..c1e299f6d3a 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/google/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/google/_index.md @@ -6,7 +6,7 @@ If your organization uses G Suite for user authentication, you can configure Ran Only admins of the G Suite domain have access to the Admin SDK. Therefore, only G Suite admins can configure Google OAuth for Rancher. -Within Rancher, only administrators or users with the **Manage Authentication** [global role]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) can configure authentication. +Within Rancher, only administrators or users with the **Manage Authentication** [global role]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) can configure authentication. # Prerequisites - You must have a [G Suite admin account](https://admin.google.com) configured. @@ -90,7 +90,7 @@ Using the Unique ID of the service account key, register it as an Oauth Client u **Result:** The service account is registered as an OAuth client in your G Suite account. # Configuring Google OAuth in Rancher -1. Sign into Rancher using a local user assigned the [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions) role. This user is also called the local principal. +1. Sign into Rancher using a local user assigned the [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions) 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. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/keycloak/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/keycloak/_index.md index 2498376139a..dbe665b1605 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/keycloak/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/keycloak/_index.md @@ -92,7 +92,7 @@ If your organization uses Keycloak Identity Provider (IdP) for user authenticati ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration option of your SAML client. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.5/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the Keycloak server, first double-check the configuration option of your SAML client. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. ### You are not redirected to Keycloak diff --git a/content/rancher/v2.6/en/admin-settings/authentication/local/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/local/_index.md index 56142b1435f..db41033e4a5 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/local/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/local/_index.md @@ -2,7 +2,7 @@ title: Local Authentication weight: 1111 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/local-authentication/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/local-authentication/ --- Local authentication is the default until you configure an external authentication provider. Local authentication is where Rancher stores the user information, i.e. names and passwords, of who can log in to Rancher. By default, the `admin` user that logs in to Rancher for the first time is a local user. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/_index.md index 7ed0a373845..32a60c9fec0 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/_index.md @@ -21,10 +21,10 @@ You must have a [Microsoft AD FS Server](https://docs.microsoft.com/en-us/window Setting up Microsoft AD FS with Rancher Server requires configuring AD FS on your Active Directory server, and configuring Rancher to utilize your AD FS server. The following pages serve as guides for setting up Microsoft AD FS authentication on your Rancher installation. -- [1. Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) -- [2. Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup) +- [1. Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) +- [2. Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup) {{< saml_caveats >}} -### [Next: Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) +### [Next: Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup) diff --git a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/_index.md index d442e6476e6..1744b496fde 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/_index.md @@ -79,4 +79,4 @@ https:///federationmetadata/2007-06/federationmetadata.xml **Result:** You've added Rancher as a relying trust party. Now you can configure Rancher to leverage AD. -### [Next: Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/) +### [Next: Configuring Rancher for Microsoft AD FS]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/) diff --git a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/_index.md index 0f36d2631dd..43842cb5426 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/_index.md @@ -3,7 +3,7 @@ title: 2. Configuring Rancher for Microsoft AD FS weight: 1205 --- -After you complete [Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.5/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/), enter your AD FS information into Rancher to allow AD FS users to authenticate with Rancher. +After you complete [Configuring Microsoft AD FS for Rancher]({{}}/rancher/v2.6/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup/), enter your AD FS information into Rancher to allow AD FS users to authenticate with Rancher. >**Important Notes For Configuring Your AD FS Server:** > diff --git a/content/rancher/v2.6/en/admin-settings/authentication/openldap/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/openldap/_index.md index 91894d204fb..38a75b58b80 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/openldap/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/openldap/_index.md @@ -2,7 +2,7 @@ title: Configuring OpenLDAP weight: 1113 aliases: - - /rancher/v2.5/en/tasks/global-configuration/authentication/openldap/ + - /rancher/v2.6/en/tasks/global-configuration/authentication/openldap/ --- If your organization uses LDAP for user authentication, you can configure Rancher to communicate with an OpenLDAP server to authenticate users. This allows Rancher admins to control access to clusters and projects based on users and groups managed externally in the organisation's central user repository, while allowing end-users to authenticate with their LDAP credentials when logging in to the Rancher UI. @@ -19,7 +19,7 @@ Rancher must be configured with a LDAP bind account (aka service account) to sea Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.](./openldap-config) -> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). 1. Log into the Rancher UI using the initial local `admin` account. 2. From the **Global** view, navigate to **Security** > **Authentication** @@ -47,4 +47,4 @@ Once you have completed the configuration, proceed by testing the connection to ## Annex: Troubleshooting -If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.5/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config/_index.md index 0162a9fe585..895d4ac0450 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config/_index.md @@ -7,7 +7,7 @@ This section is intended to be used as a reference when setting up an OpenLDAP a For further details on configuring OpenLDAP, refer to the [official documentation.](https://www.openldap.org/doc/) -> Before you proceed with the configuration, please familiarize yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarize yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). - [Background: OpenLDAP Authentication Flow](#background-openldap-authentication-flow) - [OpenLDAP server configuration](#openldap-server-configuration) @@ -30,7 +30,7 @@ You will need to enter the address, port, and protocol to connect to your OpenLD > > If the certificate used by the OpenLDAP server is self-signed or not from a recognized certificate authority, make sure have at hand the CA certificate (concatenated with any intermediate certificates) in PEM format. You will have to paste in this certificate during the configuration so that Rancher is able to validate the certificate chain. -If you are in doubt about the correct values to enter in the user/group Search Base configuration fields, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.5/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. +If you are in doubt about the correct values to enter in the user/group Search Base configuration fields, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation.
OpenLDAP Server Parameters
@@ -51,7 +51,7 @@ If your OpenLDAP directory deviates from the standard OpenLDAP schema, you must Note that the attribute mappings configured in this section are used by Rancher to construct search filters and resolve group membership. It is therefore always recommended to verify that the configuration here matches the schema used in your OpenLDAP. -If you are unfamiliar with the user/group schema used in the OpenLDAP server, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.5/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. +If you are unfamiliar with the user/group schema used in the OpenLDAP server, consult your LDAP administrator or refer to the section [Identify Search Base and Schema using ldapsearch]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/#annex-identify-search-base-and-schema-using-ldapsearch) in the Active Directory authentication documentation. ### User Schema Configuration diff --git a/content/rancher/v2.6/en/admin-settings/authentication/shibboleth/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/shibboleth/_index.md index fe00899aaf1..ef252e74227 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/shibboleth/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/shibboleth/_index.md @@ -94,9 +94,9 @@ Rancher must be configured with a LDAP bind account (aka service account) to sea ### Configure OpenLDAP in Rancher -Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.]({{}}/rancher/v2.5/en/admin-settings/authentication/openldap/openldap-config) Note that nested group membership is not available for Shibboleth. +Configure the settings for the OpenLDAP server, groups and users. For help filling out each field, refer to the [configuration reference.]({{}}/rancher/v2.6/en/admin-settings/authentication/openldap/openldap-config) Note that nested group membership is not available for Shibboleth. -> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). +> Before you proceed with the configuration, please familiarise yourself with the concepts of [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). 1. Log into the Rancher UI using the initial local `admin` account. 2. From the **Global** view, navigate to **Security** > **Authentication** @@ -104,4 +104,4 @@ Configure the settings for the OpenLDAP server, groups and users. For help filli # Troubleshooting -If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.5/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. +If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging]({{}}/rancher/v2.6/en/faq/technical/#how-can-i-enable-debug-logging) in this documentation. diff --git a/content/rancher/v2.6/en/admin-settings/authentication/user-groups/_index.md b/content/rancher/v2.6/en/admin-settings/authentication/user-groups/_index.md index 148047cc740..11a2f4ebbdd 100644 --- a/content/rancher/v2.6/en/admin-settings/authentication/user-groups/_index.md +++ b/content/rancher/v2.6/en/admin-settings/authentication/user-groups/_index.md @@ -5,11 +5,11 @@ weight: 1 Rancher relies on users and groups to determine who is allowed to log in to Rancher and which resources they can access. When you configure an external authentication provider, users from that provider will be able to log in to your Rancher server. When a user logs in, the authentication provider will supply your Rancher server with a list of groups to which the user belongs. -Access to clusters, projects, multi-cluster apps, and global DNS providers and entries can be controlled by adding either individual users or groups to these resources. When you add a group to a resource, all users who are members of that group in the authentication provider, will be able to access the resource with the permissions that you've specified for the group. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.5/en/admin-settings/rbac/). +Access to clusters, projects, multi-cluster apps, and global DNS providers and entries can be controlled by adding either individual users or groups to these resources. When you add a group to a resource, all users who are members of that group in the authentication provider, will be able to access the resource with the permissions that you've specified for the group. For more information on roles and permissions, see [Role Based Access Control]({{}}/rancher/v2.6/en/admin-settings/rbac/). ## Managing Members -When adding a user or group to a resource, you can search for users or groups by beginning to type their name. The Rancher server will query the authentication provider to find users and groups that match what you've entered. Searching is limited to the authentication provider that you are currently logged in with. For example, if you've enabled GitHub authentication but are logged in using a [local]({{}}/rancher/v2.5/en/admin-settings/authentication/local/) user account, you will not be able to search for GitHub users or groups. +When adding a user or group to a resource, you can search for users or groups by beginning to type their name. The Rancher server will query the authentication provider to find users and groups that match what you've entered. Searching is limited to the authentication provider that you are currently logged in with. For example, if you've enabled GitHub authentication but are logged in using a [local]({{}}/rancher/v2.6/en/admin-settings/authentication/local/) user account, you will not be able to search for GitHub users or groups. All users, whether they are local users or from an authentication provider, can be viewed and managed. From the **Global** view, click on **Users**. diff --git a/content/rancher/v2.6/en/admin-settings/config-private-registry/_index.md b/content/rancher/v2.6/en/admin-settings/config-private-registry/_index.md index f7871051246..dd2da3cfa33 100644 --- a/content/rancher/v2.6/en/admin-settings/config-private-registry/_index.md +++ b/content/rancher/v2.6/en/admin-settings/config-private-registry/_index.md @@ -10,7 +10,7 @@ There are two main ways to set up private registries in Rancher: by setting up t This section is about configuring the global default private registry, and focuses on how to configure the registry from the Rancher UI after Rancher is installed. -For instructions on setting up a private registry with command line options during the installation of Rancher, refer to the [air gapped Docker installation]({{}}/rancher/v2.5/en/installation/air-gap-single-node) or [air gapped Kubernetes installation]({{}}/rancher/v2.5/en/installation/air-gap-high-availability) instructions. +For instructions on setting up a private registry with command line options during the installation of Rancher, refer to the [air gapped Docker installation]({{}}/rancher/v2.6/en/installation/air-gap-single-node) or [air gapped Kubernetes installation]({{}}/rancher/v2.6/en/installation/air-gap-high-availability) instructions. If your private registry requires credentials, it cannot be used as the default registry. There is no global way to set up a private registry with authorization for every Rancher-provisioned cluster. Therefore, if you want a Rancher-provisioned cluster to pull images from a private registry with credentials, you will have to [pass in the registry credentials through the advanced cluster options](#setting-a-private-registry-with-credentials-when-deploying-a-cluster) every time you create a new cluster. diff --git a/content/rancher/v2.6/en/admin-settings/drivers/_index.md b/content/rancher/v2.6/en/admin-settings/drivers/_index.md index e86b4545322..af6f9626d95 100644 --- a/content/rancher/v2.6/en/admin-settings/drivers/_index.md +++ b/content/rancher/v2.6/en/admin-settings/drivers/_index.md @@ -3,7 +3,7 @@ title: Provisioning Drivers weight: 1140 --- -Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. +Drivers in Rancher allow you to manage which providers can be used to deploy [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) or [nodes in an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) to allow Rancher to deploy and manage Kubernetes. ### Rancher Drivers @@ -16,19 +16,19 @@ There are two types of drivers within Rancher: ### Cluster Drivers -Cluster drivers are used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/), such as GKE, EKS, AKS, etc.. The availability of which cluster driver to display when creating a cluster is defined based on the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters for hosted Kubernetes clusters. By default, Rancher is packaged with several existing cluster drivers, but you can also create custom cluster drivers to add to Rancher. +Cluster drivers are used to provision [hosted Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/), such as GKE, EKS, AKS, etc.. The availability of which cluster driver to display when creating a cluster is defined based on the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters for hosted Kubernetes clusters. By default, Rancher is packaged with several existing cluster drivers, but you can also create custom cluster drivers to add to Rancher. By default, Rancher has activated several hosted Kubernetes cloud providers including: -* [Amazon EKS]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/eks/) -* [Google GKE]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke/) -* [Azure AKS]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/aks/) +* [Amazon EKS]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/) +* [Google GKE]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/) +* [Azure AKS]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/) There are several other hosted Kubernetes cloud providers that are disabled by default, but are packaged in Rancher: -* [Alibaba ACK]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/ack/) -* [Huawei CCE]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/cce/) -* [Tencent]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/tke/) +* [Alibaba ACK]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/) +* [Huawei CCE]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/) +* [Tencent]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/) ### Node Drivers @@ -38,7 +38,7 @@ If there are specific node drivers that you don't want to show to your users, yo Rancher supports several major cloud providers, but by default, these node drivers are active and available for deployment: -* [Amazon EC2]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/) -* [Azure]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/azure/) -* [Digital Ocean]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/) -* [vSphere]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/) +* [Amazon EC2]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) +* [Azure]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/) +* [Digital Ocean]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/) +* [vSphere]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/) diff --git a/content/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/_index.md b/content/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/_index.md index 3cfba1c2784..a2756f8e674 100644 --- a/content/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/_index.md +++ b/content/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/_index.md @@ -3,7 +3,7 @@ title: Cluster Drivers weight: 1 --- -Cluster drivers are used to create clusters in a [hosted Kubernetes provider]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/), such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher. +Cluster drivers are used to create clusters in a [hosted Kubernetes provider]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/), such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers, but you can also add custom cluster drivers to Rancher. If there are specific cluster drivers that you do not want to show your users, you may deactivate those cluster drivers within Rancher and they will not appear as an option for cluster creation. @@ -11,8 +11,8 @@ If there are specific cluster drivers that you do not want to show your users, y >**Prerequisites:** To create, edit, or delete cluster drivers, you need _one_ of the following permissions: > ->- [Administrator Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) ->- [Custom Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Cluster Drivers]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) role assigned. +>- [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) +>- [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Cluster Drivers]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. ## Activating/Deactivating Cluster Drivers diff --git a/content/rancher/v2.6/en/admin-settings/drivers/node-drivers/_index.md b/content/rancher/v2.6/en/admin-settings/drivers/node-drivers/_index.md index 7161b4e14d1..fd0dcfff3c1 100644 --- a/content/rancher/v2.6/en/admin-settings/drivers/node-drivers/_index.md +++ b/content/rancher/v2.6/en/admin-settings/drivers/node-drivers/_index.md @@ -2,8 +2,8 @@ title: Node Drivers weight: 2 aliases: - - /rancher/v2.5/en/concepts/global-configuration/node-drivers/ - - /rancher/v2.5/en/tasks/global-configuration/node-drivers/ + - /rancher/v2.6/en/concepts/global-configuration/node-drivers/ + - /rancher/v2.6/en/tasks/global-configuration/node-drivers/ --- Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a [Docker Machine driver](https://docs.docker.com/machine/drivers/). The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only `active` node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher. @@ -14,8 +14,8 @@ If there are specific node drivers that you don't want to show to your users, yo >**Prerequisites:** To create, edit, or delete drivers, you need _one_ of the following permissions: > ->- [Administrator Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) ->- [Custom Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Node Drivers]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) role assigned. +>- [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) +>- [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Node Drivers]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. ## Activating/Deactivating Node Drivers diff --git a/content/rancher/v2.6/en/admin-settings/k8s-metadata/_index.md b/content/rancher/v2.6/en/admin-settings/k8s-metadata/_index.md index c6c5737eadd..2f4669759b6 100644 --- a/content/rancher/v2.6/en/admin-settings/k8s-metadata/_index.md +++ b/content/rancher/v2.6/en/admin-settings/k8s-metadata/_index.md @@ -7,7 +7,7 @@ The RKE metadata feature allows you to provision clusters with new versions of K > **Note:** The Kubernetes API can change between minor versions. Therefore, we don't support introducing minor Kubernetes versions, such as introducing v1.15 when Rancher currently supports v1.14. You would need to upgrade Rancher to add support for minor Kubernetes versions. -Rancher's Kubernetes metadata contains information specific to the Kubernetes version that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/). 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]({{}}/rke/latest/en/) (RKE) uses for deploying various Kubernetes versions. +Rancher's Kubernetes metadata contains information specific to the Kubernetes version that Rancher uses to provision [RKE clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). 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]({{}}/rke/latest/en/) (RKE) uses for deploying various Kubernetes versions. This table below describes the CRDs that are affected by the periodic data sync. @@ -27,7 +27,7 @@ Administrators might configure the RKE metadata settings to do the following: ### Refresh Kubernetes Metadata -The option to refresh the Kubernetes metadata is available for administrators by default, or for any user who has the **Manage Cluster Drivers** [global role.]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) +The option to refresh the Kubernetes metadata is available for administrators by default, or for any user who has the **Manage Cluster Drivers** [global role.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) To force Rancher to refresh the Kubernetes metadata, a manual refresh action is available under **Tools > Drivers > Refresh Kubernetes Metadata** on the right side corner. @@ -66,6 +66,6 @@ After new Kubernetes versions are loaded into the Rancher setup, additional step 1. To download the system images for the private registry, click the Rancher server version at the bottom left corner of the Rancher UI. 1. Download the OS specific image lists for Linux or Windows. 1. Download `rancher-images.txt`. -1. Prepare the private registry using the same steps during the [air gap install]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry), but instead of using the `rancher-images.txt` from the releases page, use the one obtained from the previous steps. +1. Prepare the private registry using the same steps during the [air gap install]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry), but instead of using the `rancher-images.txt` from the releases page, use the one obtained from the previous steps. **Result:** The air gap installation of Rancher can now sync the Kubernetes metadata. If you update your private registry when new versions of Kubernetes are released, you can provision clusters with the new version without having to upgrade Rancher. diff --git a/content/rancher/v2.6/en/admin-settings/pod-security-policies/_index.md b/content/rancher/v2.6/en/admin-settings/pod-security-policies/_index.md index 2c31ddb8cb3..5dc7c5f644e 100644 --- a/content/rancher/v2.6/en/admin-settings/pod-security-policies/_index.md +++ b/content/rancher/v2.6/en/admin-settings/pod-security-policies/_index.md @@ -2,9 +2,9 @@ title: Pod Security Policies weight: 1135 aliases: - - /rancher/v2.5/en/concepts/global-configuration/pod-security-policies/ - - /rancher/v2.5/en/tasks/global-configuration/pod-security-policies/ - - /rancher/v2.5/en/tasks/clusters/adding-a-pod-security-policy/ + - /rancher/v2.6/en/concepts/global-configuration/pod-security-policies/ + - /rancher/v2.6/en/tasks/global-configuration/pod-security-policies/ + - /rancher/v2.6/en/tasks/clusters/adding-a-pod-security-policy/ --- _Pod Security Policies_ (or PSPs) are objects that control security-sensitive aspects of pod specification (like root privileges). @@ -55,9 +55,9 @@ Using Rancher, you can create a Pod Security Policy using our GUI rather than cr ### Requirements -Rancher can only assign PSPs for clusters that are [launched using RKE.]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) +Rancher can only assign PSPs for clusters that are [launched using RKE.]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) -You must enable PSPs at the cluster level before you can assign them to a project. This can be configured by [editing the cluster.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) +You must enable PSPs at the cluster level before you can assign them to a project. This can be configured by [editing the cluster.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) It is a best practice to set PSP at the cluster level. diff --git a/content/rancher/v2.6/en/admin-settings/rbac/_index.md b/content/rancher/v2.6/en/admin-settings/rbac/_index.md index 31b40d250ac..5db734ee9e0 100644 --- a/content/rancher/v2.6/en/admin-settings/rbac/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rbac/_index.md @@ -2,10 +2,10 @@ title: Role-Based Access Control (RBAC) weight: 1120 aliases: - - /rancher/v2.5/en/concepts/global-configuration/users-permissions-roles/ + - /rancher/v2.6/en/concepts/global-configuration/users-permissions-roles/ --- -Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication]({{}}/rancher/v2.5/en/admin-settings/authentication/), users can either be local or external. +Within Rancher, each person authenticates as a _user_, which is a login that grants you access to Rancher. As mentioned in [Authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/), users can either be local or external. After you configure external authentication, the users that display on the **Users** page changes. @@ -17,11 +17,11 @@ After you configure external authentication, the users that display on the **Use Once the user logs in to Rancher, their _authorization_, or their access rights within the system, is determined by _global permissions_, and _cluster and project roles_. -- [Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/): +- [Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/): Define user authorization outside the scope of any particular cluster. -- [Cluster and Project Roles]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/): +- [Cluster and Project Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/): Define user authorization inside the specific cluster or project where they are assigned the role. diff --git a/content/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/_index.md b/content/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/_index.md index 10e2d21fcc8..2d61e06d057 100644 --- a/content/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/_index.md @@ -53,7 +53,7 @@ For details on how each cluster role can access Kubernetes resources, you can go ### Giving a Custom Cluster Role to a Cluster Member -After an administrator [sets up a custom cluster role,]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles/) cluster owners and admins can then assign those roles to cluster members. +After an administrator [sets up a custom cluster role,]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/) cluster owners and admins can then assign those roles to cluster members. To assign a custom role to a new cluster member, you can use the Rancher UI. To modify the permissions of an existing member, you will need to use the Rancher API view. @@ -140,7 +140,7 @@ By default, when a standard user creates a new cluster or project, they are auto There are two methods for changing default cluster/project roles: -- **Assign Custom Roles**: Create a [custom role]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles) for either your [cluster](#custom-cluster-roles) or [project](#custom-project-roles), and then set the custom role as default. +- **Assign Custom Roles**: Create a [custom role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles) for either your [cluster](#custom-cluster-roles) or [project](#custom-project-roles), and then set the custom role as default. - **Assign Individual Roles**: Configure multiple [cluster](#cluster-role-reference)/[project](#project-role-reference) roles as default for assignment to the creating user. @@ -148,7 +148,7 @@ There are two methods for changing default cluster/project roles: >**Note:** > ->- Although you can [lock]({{}}/rancher/v2.5/en/admin-settings/rbac/locked-roles/) a default role, the system still assigns the role to users who create a cluster/project. +>- Although you can [lock]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles/) a default role, the system still assigns the role to users who create a cluster/project. >- Only users that create clusters/projects inherit their roles. Users added to the cluster/project membership afterward must be explicitly assigned their roles. ### Configuring Default Roles for Cluster and Project Creators diff --git a/content/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/_index.md b/content/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/_index.md index 01764ad0ace..2836a39da80 100644 --- a/content/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/_index.md @@ -2,7 +2,7 @@ title: Custom Roles weight: 1128 aliases: - - /rancher/v2.5/en/tasks/global-configuration/roles/ + - /rancher/v2.6/en/tasks/global-configuration/roles/ --- Within Rancher, _roles_ determine what actions a user can make within a cluster or project. @@ -21,8 +21,8 @@ This section covers the following topics: To complete the tasks on this page, one of the following permissions are required: - - [Administrator Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/). - - [Custom Global Permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Roles]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) role assigned. + - [Administrator Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/). + - [Custom Global Permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) role assigned. ## Creating A Custom Role for a Cluster or Project @@ -115,8 +115,8 @@ If a user is removed from the external authentication provider group, they would > **Prerequisites:** You can only assign a global role to a group if: > -> * You have set up an [external authentication provider]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-vs-local-authentication) -> * The external authentication provider supports [user groups]({{}}/rancher/v2.5/en/admin-settings/authentication/user-groups/) +> * You have set up an [external authentication provider]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-vs-local-authentication) +> * The external authentication provider supports [user groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) > * You have already set up at least one user group with the authentication provider To assign a custom global role to a group, follow these steps: diff --git a/content/rancher/v2.6/en/admin-settings/rbac/global-permissions/_index.md b/content/rancher/v2.6/en/admin-settings/rbac/global-permissions/_index.md index 7ebbefbbe5e..24c0adf98a8 100644 --- a/content/rancher/v2.6/en/admin-settings/rbac/global-permissions/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rbac/global-permissions/_index.md @@ -81,7 +81,7 @@ You can [assign a role to everyone in the group at the same time](#configuring-g Using custom permissions is convenient for providing users with narrow or specialized access to Rancher. -When a user from an [external authentication source]({{}}/rancher/v2.5/en/admin-settings/authentication/) signs into Rancher for the first time, they're automatically assigned a set of global permissions (hereafter, permissions). By default, after a user logs in for the first time, they are created as a user and assigned the default `user` permission. The standard `user` permission allows users to login and create clusters. +When a user from an [external authentication source]({{}}/rancher/v2.6/en/admin-settings/authentication/) signs into Rancher for the first time, they're automatically assigned a set of global permissions (hereafter, permissions). By default, after a user logs in for the first time, they are created as a user and assigned the default `user` permission. The standard `user` permission allows users to login and create clusters. However, in some organizations, these permissions may extend too much access. Rather than assigning users the default global permissions of `Administrator` or `Standard User`, you can assign them a more restrictive set of custom global permissions. @@ -172,8 +172,8 @@ If a user is removed from the external authentication provider group, they would > **Prerequisites:** You can only assign a global role to a group if: > -> * You have set up an [external authentication provider]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-vs-local-authentication) -> * The external authentication provider supports [user groups]({{}}/rancher/v2.5/en/admin-settings/authentication/user-groups/) +> * You have set up an [external authentication provider]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-vs-local-authentication) +> * The external authentication provider supports [user groups]({{}}/rancher/v2.6/en/admin-settings/authentication/user-groups/) > * You have already set up at least one user group with the authentication provider To assign a custom global role to a group, follow these steps: diff --git a/content/rancher/v2.6/en/admin-settings/rbac/locked-roles/_index.md b/content/rancher/v2.6/en/admin-settings/rbac/locked-roles/_index.md index 8dead228672..422e14c2b52 100644 --- a/content/rancher/v2.6/en/admin-settings/rbac/locked-roles/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rbac/locked-roles/_index.md @@ -27,7 +27,7 @@ If you want to prevent a role from being assigned to users, you can set it to a You can lock roles in two contexts: -- When you're [adding a custom role]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles/). +- When you're [adding a custom role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). - When you editing an existing role (see below). 1. From the **Global** view, select **Security** > **Roles**. diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/_index.md index db5cd9e8c10..964b4e90f96 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/_index.md @@ -15,7 +15,7 @@ Admins control which cluster options can be changed by end users. RKE templates If a cluster was created with an RKE template, you can't change it to a different RKE template. You can only update the cluster to a new revision of the same template. -You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. The new template can also be used to launch new clusters. +You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. The new template can also be used to launch new clusters. The core features of RKE templates allow DevOps and security teams to: @@ -46,24 +46,24 @@ The [add-on section](#add-ons) of an RKE template is especially powerful because RKE templates are supported for Rancher-provisioned clusters. The templates can be used to provision custom clusters or clusters that are launched by an infrastructure provider. -RKE templates are for defining Kubernetes and Rancher settings. Node templates are responsible for configuring nodes. For tips on how to use RKE templates in conjunction with hardware, refer to [RKE Templates and Hardware]({{}}/rancher/v2.5/en/admin-settings/rke-templates/rke-templates-and-hardware). +RKE templates are for defining Kubernetes and Rancher settings. Node templates are responsible for configuring nodes. For tips on how to use RKE templates in conjunction with hardware, refer to [RKE Templates and Hardware]({{}}/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware). RKE templates can be created from scratch to pre-define cluster configuration. They can be applied to launch new clusters, or templates can also be exported from existing running clusters. -The settings of an existing cluster can be [saved as an RKE template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) This creates a new template and binds the cluster settings to the template, so that the cluster can only be upgraded if the [template is updated]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template), and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) The new template can also be used to create new clusters. +The settings of an existing cluster can be [saved as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) This creates a new template and binds the cluster settings to the template, so that the cluster can only be upgraded if the [template is updated]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template), and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) The new template can also be used to create new clusters. # Example Scenarios When an organization has both basic and advanced Rancher users, administrators might want to give the advanced users more options for cluster creation, while restricting the options for basic users. -These [example scenarios]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-scenarios) describe how an organization could use templates to standardize cluster creation. +These [example scenarios]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios) describe how an organization could use templates to standardize cluster creation. Some of the example scenarios include the following: -- **Enforcing templates:** Administrators might want to [enforce one or more template settings for everyone]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-scenarios/#enforcing-a-template-setting-for-everyone) if they want all new Rancher-provisioned clusters to have those settings. -- **Sharing different templates with different users:** Administrators might give [different templates to basic and advanced users,]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-scenarios/#templates-for-basic-and-advanced-users) so that basic users can have more restricted options and advanced users can use more discretion when creating clusters. -- **Updating template settings:** If an organization's security and DevOps teams decide to embed best practices into the required settings for new clusters, those best practices could change over time. If the best practices change, [a template can be updated to a new revision]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-scenarios/#updating-templates-and-clusters-created-with-them) and clusters created from the template can [upgrade to the new version]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) of the template. -- **Sharing ownership of a template:** When a template owner no longer wants to maintain a template, or wants to share ownership of the template, this scenario describes how [template ownership can be shared.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-scenarios/#allowing-other-users-to-control-and-share-a-template) +- **Enforcing templates:** Administrators might want to [enforce one or more template settings for everyone]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#enforcing-a-template-setting-for-everyone) if they want all new Rancher-provisioned clusters to have those settings. +- **Sharing different templates with different users:** Administrators might give [different templates to basic and advanced users,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#templates-for-basic-and-advanced-users) so that basic users can have more restricted options and advanced users can use more discretion when creating clusters. +- **Updating template settings:** If an organization's security and DevOps teams decide to embed best practices into the required settings for new clusters, those best practices could change over time. If the best practices change, [a template can be updated to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#updating-templates-and-clusters-created-with-them) and clusters created from the template can [upgrade to the new version]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) of the template. +- **Sharing ownership of a template:** When a template owner no longer wants to maintain a template, or wants to share ownership of the template, this scenario describes how [template ownership can be shared.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/#allowing-other-users-to-control-and-share-a-template) # Template Management @@ -79,32 +79,32 @@ For the settings that cannot be overridden, the end user will not be able to dir The documents in this section explain the details of RKE template management: -- [Getting permission to create templates]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creator-permissions/) -- [Creating and revising templates]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/) +- [Getting permission to create templates]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/) +- [Creating and revising templates]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/) - [Enforcing template settings](./enforcement/#requiring-new-clusters-to-use-an-rke-template) -- [Overriding template settings]({{}}/rancher/v2.5/en/admin-settings/rke-templates/overrides/) -- [Sharing templates with cluster creators]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) -- [Sharing ownership of a template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +- [Overriding template settings]({{}}/rancher/v2.6/en/admin-settings/rke-templates/overrides/) +- [Sharing templates with cluster creators]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) +- [Sharing ownership of a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) -An [example YAML configuration file for a template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-yaml) is provided for reference. +An [example YAML configuration file for a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-yaml) is provided for reference. # Applying Templates -You can [create a cluster from a template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing) +You can [create a cluster from a template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) -If the RKE template owner creates a new revision of the template, you can [upgrade your cluster to that revision.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) +If the RKE template owner creates a new revision of the template, you can [upgrade your cluster to that revision.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) RKE templates can be created from scratch to pre-define cluster configuration. They can be applied to launch new clusters, or templates can also be exported from existing running clusters. -You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. +You can [save the configuration of an existing cluster as an RKE template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#converting-an-existing-cluster-to-use-an-rke-template) Then the cluster's settings can only be changed if the template is updated. # Standardizing Hardware -RKE templates are designed to standardize Kubernetes and Rancher settings. If you want to standardize your infrastructure as well, you use RKE templates [in conjunction with other tools]({{}}/rancher/v2.5/en/admin-settings/rke-templates/rke-templates-and-hardware). +RKE templates are designed to standardize Kubernetes and Rancher settings. If you want to standardize your infrastructure as well, you use RKE templates [in conjunction with other tools]({{}}/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware). # YAML Customization -If you define an RKE template as a YAML file, you can modify this [example RKE template YAML]({{}}/rancher/v2.5/en/admin-settings/rke-templates/example-yaml). The YAML in the RKE template uses the same customization that Rancher uses when creating an RKE cluster, but since the YAML is located within the context of a Rancher provisioned cluster, you will need to nest the RKE template customization under the `rancher_kubernetes_engine_config` directive in the YAML. +If you define an RKE template as a YAML file, you can modify this [example RKE template YAML]({{}}/rancher/v2.6/en/admin-settings/rke-templates/example-yaml). The YAML in the RKE template uses the same customization that Rancher uses when creating an RKE cluster, but since the YAML is located within the context of a Rancher provisioned cluster, you will need to nest the RKE template customization under the `rancher_kubernetes_engine_config` directive in the YAML. The RKE documentation also has [annotated]({{}}/rke/latest/en/example-yamls/) `cluster.yml` files that you can use for reference. diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/_index.md index d51a8238a85..d281f12ac91 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/_index.md @@ -3,7 +3,7 @@ title: Applying Templates weight: 50 --- -You can create a cluster from an RKE template that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing) +You can create a cluster from an RKE template that you created, or from a template that has been [shared with you.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) RKE templates can be applied to new clusters. @@ -19,7 +19,7 @@ This section covers the following topics: ### Creating a Cluster from an RKE Template -To add a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters) using an RKE template, use these steps: +To add a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) using an RKE template, use these steps: 1. From the **Global** view, go to the **Clusters** tab. 1. Click **Add Cluster** and choose the infrastructure provider. @@ -33,7 +33,7 @@ To add a cluster [hosted by an infrastructure provider]({{}}/rancher/v2 When the template owner creates a template, each setting has a switch in the Rancher UI that indicates if users can override the setting. -- If the setting allows a user override, you can update these settings in the cluster by [editing the cluster.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) +- If the setting allows a user override, you can update these settings in the cluster by [editing the cluster.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) - If the switch is turned off, you cannot change these settings unless the cluster owner creates a template revision that lets you override them. If there are settings that you want to change, but don't have the option to, you will need to contact the template owner to get a new revision of the template. If a cluster was created from an RKE template, you can edit the cluster to update the cluster to a new revision of the template. @@ -46,7 +46,7 @@ An existing cluster's settings can be [saved as an RKE template.](#converting-an This section describes how to create an RKE template from an existing cluster. -RKE templates cannot be applied to existing clusters, except if you save an existing cluster's settings as an RKE template. This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) +RKE templates cannot be applied to existing clusters, except if you save an existing cluster's settings as an RKE template. This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#upgrading-a-cluster-to-use-a-new-template-revision) To convert an existing cluster to use an RKE template, @@ -58,4 +58,4 @@ To convert an existing cluster to use an RKE template, - A new RKE template is created. - The cluster is converted to use the new template. -- New clusters can be [created from the new template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file +- New clusters can be [created from the new template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/_index.md index 533b4e1fdb8..82e91bc2fc1 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/_index.md @@ -28,19 +28,19 @@ This section covers the following topics: ### Prerequisites -You can create RKE templates if you have the **Create RKE Templates** permission, which can be [given by an administrator.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creator-permissions) +You can create RKE templates if you have the **Create RKE Templates** permission, which can be [given by an administrator.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions) -You can revise, share, and delete a template if you are an owner of the template. For details on how to become an owner of a template, refer to [the documentation on sharing template ownership.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +You can revise, share, and delete a template if you are an owner of the template. For details on how to become an owner of a template, refer to [the documentation on sharing template ownership.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) ### Creating a Template 1. From the **Global** view, click **Tools > RKE Templates.** 1. Click **Add Template.** 1. Provide a name for the template. An auto-generated name is already provided for the template' first version, which is created along with this template. -1. Optional: Share the template with other users or groups by [adding them as members.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) You can also make the template public to share with everyone in the Rancher setup. +1. Optional: Share the template with other users or groups by [adding them as members.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-templates-with-specific-users-or-groups) You can also make the template public to share with everyone in the Rancher setup. 1. Then follow the form on screen to save the cluster configuration parameters as part of the template's revision. The revision can be marked as default for this template. -**Result:** An RKE template with one revision is configured. You can use this RKE template revision later when you [provision a Rancher-launched cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters). After a cluster is managed by an RKE template, it cannot be disconnected and the option to uncheck **Use an existing RKE Template and Revision** will be unavailable. +**Result:** An RKE template with one revision is configured. You can use this RKE template revision later when you [provision a Rancher-launched cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). After a cluster is managed by an RKE template, it cannot be disconnected and the option to uncheck **Use an existing RKE Template and Revision** will be unavailable. ### Updating a Template @@ -131,7 +131,7 @@ To permanently delete a revision, ### Upgrading a Cluster to Use a New Template Revision -> This section assumes that you already have a cluster that [has an RKE template applied.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates) +> This section assumes that you already have a cluster that [has an RKE template applied.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates) > This section also assumes that you have [updated the template that the cluster is using](#updating-a-template) so that a new template revision is available. To upgrade a cluster to use a new template revision, @@ -147,7 +147,7 @@ To upgrade a cluster to use a new template revision, You can save an existing cluster's settings as an RKE template. -This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.] +This exports the cluster's settings as a new RKE template, and also binds the cluster to that template. The result is that the cluster can only be changed if the [template is updated,]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) and the cluster is upgraded to [use a newer version of the template.] To convert an existing cluster to use an RKE template, @@ -159,4 +159,4 @@ To convert an existing cluster to use an RKE template, - A new RKE template is created. - The cluster is converted to use the new template. -- New clusters can be [created from the new template and revision.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file +- New clusters can be [created from the new template and revision.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#creating-a-cluster-from-an-rke-template) \ No newline at end of file diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/_index.md index 3c5104a09f3..7464d43e23e 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/_index.md @@ -5,7 +5,7 @@ weight: 10 Administrators have the permission to create RKE templates, and only administrators can give that permission to other users. -For more information on administrator permissions, refer to the [documentation on global permissions]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/). +For more information on administrator permissions, refer to the [documentation on global permissions]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/). # Giving Users Permission to Create Templates @@ -13,7 +13,7 @@ Templates can only be created by users who have the global permission **Create R Administrators have the global permission to create templates, and only administrators can give that permission to other users. -For information on allowing users to modify existing templates, refer to [Sharing Templates.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing) +For information on allowing users to modify existing templates, refer to [Sharing Templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) Administrators can give users permission to create RKE templates in two ways: diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/enforcement/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/enforcement/_index.md index 4e632411060..21f61479dba 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/enforcement/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/enforcement/_index.md @@ -11,13 +11,13 @@ By default, any standard user in Rancher can create clusters. But when RKE templ - All standard users must use an RKE template to create a new cluster. - Standard users cannot create a cluster without using a template. -Users can only create new templates if the administrator [gives them permission.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creator-permissions/#allowing-a-user-to-create-templates) +Users can only create new templates if the administrator [gives them permission.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creator-permissions/#allowing-a-user-to-create-templates) -After a cluster is created with an RKE template, the cluster creator cannot edit settings that are defined in the template. The only way to change those settings after the cluster is created is to [upgrade the cluster to a new revision]({{}}/rancher/v2.5/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) of the same template. If cluster creators want to change template-defined settings, they would need to contact the template owner to get a new revision of the template. For details on how template revisions work, refer to the [documentation on revising templates.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) +After a cluster is created with an RKE template, the cluster creator cannot edit settings that are defined in the template. The only way to change those settings after the cluster is created is to [upgrade the cluster to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/applying-templates/#updating-a-cluster-created-with-an-rke-template) of the same template. If cluster creators want to change template-defined settings, they would need to contact the template owner to get a new revision of the template. For details on how template revisions work, refer to the [documentation on revising templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) # Requiring New Clusters to Use an RKE Template -You might want to require new clusters to use a template to ensure that any cluster launched by a [standard user]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) will use the Kubernetes and/or Rancher settings that are vetted by administrators. +You might want to require new clusters to use a template to ensure that any cluster launched by a [standard user]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) will use the Kubernetes and/or Rancher settings that are vetted by administrators. To require new clusters to use an RKE template, administrators can turn on RKE template enforcement with the following steps: diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/_index.md index 50a2ea8bdad..f8ccd249f2d 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/example-scenarios/_index.md @@ -22,7 +22,7 @@ Let's say there is an organization in which the administrators decide that all n **Results:** - All Rancher users in the organization have access to the template. -- All new clusters created by [standard users]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) with this template will use Kubernetes 1.14 and they are unable to use a different Kubernetes version. By default, standard users don't have permission to create templates, so this template will be the only template they can use unless more templates are shared with them. +- All new clusters created by [standard users]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) with this template will use Kubernetes 1.14 and they are unable to use a different Kubernetes version. By default, standard users don't have permission to create templates, so this template will be the only template they can use unless more templates are shared with them. - All standard users must use a cluster template to create a new cluster. They cannot create a cluster without using a template. In this way, the administrators enforce the Kubernetes version across the organization, while still allowing end users to configure everything else. @@ -31,7 +31,7 @@ In this way, the administrators enforce the Kubernetes version across the organi Let's say an organization has both basic and advanced users. Administrators want the basic users to be required to use a template, while the advanced users and administrators create their clusters however they want. -1. First, an administrator turns on [RKE template enforcement.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/enforcement/#requiring-new-clusters-to-use-an-rke-template) This means that every [standard user]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) in Rancher will need to use an RKE template when they create a cluster. +1. First, an administrator turns on [RKE template enforcement.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/enforcement/#requiring-new-clusters-to-use-an-rke-template) This means that every [standard user]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) in Rancher will need to use an RKE template when they create a cluster. 1. The administrator then creates two templates: - One template for basic users, with almost every option specified except for access keys @@ -60,12 +60,12 @@ Let's say Alice is a Rancher administrator. She owns an RKE template that reflec Bob is an advanced user who can make informed decisions about cluster configuration. Alice trusts Bob to create new revisions of her template as the best practices get updated over time. Therefore, she decides to make Bob an owner of the template. -To share ownership of the template with Bob, Alice [adds Bob as an owner of her template.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) +To share ownership of the template with Bob, Alice [adds Bob as an owner of her template.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/#sharing-ownership-of-templates) The result is that as a template owner, Bob is in charge of version control for that template. Bob can now do all of the following: -- [Revise the template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) when the best practices change -- [Disable outdated revisions]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#disabling-a-template-revision) of the template so that no new clusters can be created with it -- [Delete the whole template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#deleting-a-template) if the organization wants to go in a different direction -- [Set a certain revision as default]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising/#setting-a-template-revision-as-default) when users create a cluster with it. End users of the template will still be able to choose which revision they want to create the cluster with. -- [Share the template]({{}}/rancher/v2.5/en/admin-settings/rke-templates/template-access-and-sharing) with specific users, make the template available to all Rancher users, or share ownership of the template with another user. \ No newline at end of file +- [Revise the template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#updating-a-template) when the best practices change +- [Disable outdated revisions]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#disabling-a-template-revision) of the template so that no new clusters can be created with it +- [Delete the whole template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#deleting-a-template) if the organization wants to go in a different direction +- [Set a certain revision as default]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising/#setting-a-template-revision-as-default) when users create a cluster with it. End users of the template will still be able to choose which revision they want to create the cluster with. +- [Share the template]({{}}/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing) with specific users, make the template available to all Rancher users, or share ownership of the template with another user. \ No newline at end of file diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/overrides/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/overrides/_index.md index 76cf9ce04ae..4f61fb990e6 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/overrides/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/overrides/_index.md @@ -5,7 +5,7 @@ weight: 33 When a user creates an RKE template, each setting in the template has a switch in the Rancher UI that indicates if users can override the setting. This switch marks those settings as **Allow User Override.** -After a cluster is created with a template, end users can't update any of the settings defined in the template unless the template owner marked them as **Allow User Override.** However, if the template is [updated to a new revision]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising) that changes the settings or allows end users to change them, the cluster can be upgraded to a new revision of the template and the changes in the new revision will be applied to the cluster. +After a cluster is created with a template, end users can't update any of the settings defined in the template unless the template owner marked them as **Allow User Override.** However, if the template is [updated to a new revision]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising) that changes the settings or allows end users to change them, the cluster can be upgraded to a new revision of the template and the changes in the new revision will be applied to the cluster. When any parameter is set as **Allow User Override** on the RKE template, it means that end users have to fill out those fields during cluster creation and they can edit those settings afterward at any time. diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware/_index.md index edc049ab6bd..8e10bf7ea38 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/rke-templates-and-hardware/_index.md @@ -11,7 +11,7 @@ If you want to standardize the hardware in your clusters, use RKE templates conj ### Node Templates -[Node templates]({{}}/rancher/v2.5/en/user-settings/node-templates) are responsible for node configuration and node provisioning in Rancher. From your user profile, you can set up node templates to define which templates are used in each of your node pools. With node pools enabled, you can make sure you have the required number of nodes in each node pool, and ensure that all nodes in the pool are the same. +[Node templates]({{}}/rancher/v2.6/en/user-settings/node-templates) are responsible for node configuration and node provisioning in Rancher. From your user profile, you can set up node templates to define which templates are used in each of your node pools. With node pools enabled, you can make sure you have the required number of nodes in each node pool, and ensure that all nodes in the pool are the same. ### Terraform @@ -55,7 +55,7 @@ When you need to make changes to your infrastructure, instead of manually updati This section describes one way that you can make security and compliance-related config files standard in your clusters. -When you create a [CIS benchmark compliant cluster,]({{}}/rancher/v2.5/en/security/) you have an encryption config file and an audit log config file. +When you create a [CIS benchmark compliant cluster,]({{}}/rancher/v2.6/en/security/) you have an encryption config file and an audit log config file. Your infrastructure provisioning system can write those files to disk. Then in your RKE template, you would specify where those files will be, then add your encryption config file and audit log config file as extra mounts to the `kube-api-server`. diff --git a/content/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/_index.md b/content/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/_index.md index 8a552a35ae5..192a215c476 100644 --- a/content/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/_index.md +++ b/content/rancher/v2.6/en/admin-settings/rke-templates/template-access-and-sharing/_index.md @@ -14,7 +14,7 @@ When you share a template, each user can have one of two access levels: If you create a template, you automatically become an owner of that template. -If you want to delegate responsibility for updating the template, you can share ownership of the template. For details on how owners can modify templates, refer to the [documentation about revising templates.]({{}}/rancher/v2.5/en/admin-settings/rke-templates/creating-and-revising) +If you want to delegate responsibility for updating the template, you can share ownership of the template. For details on how owners can modify templates, refer to the [documentation about revising templates.]({{}}/rancher/v2.6/en/admin-settings/rke-templates/creating-and-revising) There are several ways to share templates: diff --git a/content/rancher/v2.6/en/api/_index.md b/content/rancher/v2.6/en/api/_index.md index 75b7acf2bfe..60cf9320914 100644 --- a/content/rancher/v2.6/en/api/_index.md +++ b/content/rancher/v2.6/en/api/_index.md @@ -5,13 +5,13 @@ weight: 24 ## How to use the API -The API has its own user interface accessible from a web browser. This is an easy way to see resources, perform actions, and see the equivalent cURL or HTTP request & response. To access it, click on your user avatar in the upper right corner. Under **API & Keys**, you can find the URL endpoint as well as create [API keys]({{}}/rancher/v2.5/en/user-settings/api-keys/). +The API has its own user interface accessible from a web browser. This is an easy way to see resources, perform actions, and see the equivalent cURL or HTTP request & response. To access it, click on your user avatar in the upper right corner. Under **API & Keys**, you can find the URL endpoint as well as create [API keys]({{}}/rancher/v2.6/en/user-settings/api-keys/). ## Authentication -API requests must include authentication information. Authentication is done with HTTP basic authentication using [API Keys]({{}}/rancher/v2.5/en/user-settings/api-keys/). API keys can create new clusters and have access to multiple clusters via `/v3/clusters/`. [Cluster and project roles]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/) apply to these keys and restrict what clusters and projects the account can see and what actions they can take. +API requests must include authentication information. Authentication is done with HTTP basic authentication using [API Keys]({{}}/rancher/v2.6/en/user-settings/api-keys/). API keys can create new clusters and have access to multiple clusters via `/v3/clusters/`. [Cluster and project roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) apply to these keys and restrict what clusters and projects the account can see and what actions they can take. -By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. For details on how to invalidate them, refer to the [API tokens page]({{}}/rancher/v2.5/en/api/api-tokens). +By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. For details on how to invalidate them, refer to the [API tokens page]({{}}/rancher/v2.6/en/api/api-tokens). ## Making requests diff --git a/content/rancher/v2.6/en/api/api-tokens/_index.md b/content/rancher/v2.6/en/api/api-tokens/_index.md index a0f19b8cd78..a411b0bf8c6 100644 --- a/content/rancher/v2.6/en/api/api-tokens/_index.md +++ b/content/rancher/v2.6/en/api/api-tokens/_index.md @@ -2,7 +2,7 @@ title: API Tokens weight: 1 aliases: - - /rancher/v2.5/en/cluster-admin/api/api-tokens/ + - /rancher/v2.6/en/cluster-admin/api/api-tokens/ --- By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. Tokens are not invalidated by changing a password. diff --git a/content/rancher/v2.6/en/backups/_index.md b/content/rancher/v2.6/en/backups/_index.md index 4b64fec0272..ee1dae56ae2 100644 --- a/content/rancher/v2.6/en/backups/_index.md +++ b/content/rancher/v2.6/en/backups/_index.md @@ -2,7 +2,7 @@ title: Backups and Disaster Recovery weight: 5 aliases: - - /rancher/v2.5/en/backups/v2.5 + - /rancher/v2.6/en/backups/v2.5 --- In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. @@ -104,7 +104,7 @@ A restore is performed by creating a Restore custom resource. For a tutorial, re # Migrating Rancher to a New Cluster -A migration is performed by following [these steps.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +A migration is performed by following [these steps.]({{}}/rancher/v2.6/en/backups/migrating-rancher) # Default Storage Location Configuration diff --git a/content/rancher/v2.6/en/backups/back-up-rancher/_index.md b/content/rancher/v2.6/en/backups/back-up-rancher/_index.md index dee7c261fd1..7657fc4d9bf 100644 --- a/content/rancher/v2.6/en/backups/back-up-rancher/_index.md +++ b/content/rancher/v2.6/en/backups/back-up-rancher/_index.md @@ -2,10 +2,10 @@ title: Backing up Rancher weight: 1 aliases: - - /rancher/v2.5/en/backups/v2.5/back-up-rancher + - /rancher/v2.6/en/backups/v2.5/back-up-rancher --- -In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups]({{}}/rancher/v2.5/en/backups/v2.5/docker-installs/docker-backups) +In this section, you'll learn how to back up Rancher running on any Kubernetes cluster. To backup Rancher installed with Docker, refer the instructions for [single node backups]({{}}/rancher/v2.6/en/backups/v2.5/docker-installs/docker-backups) The backup-restore operator needs to be installed in the local cluster, and only backs up the Rancher app. The backup and restore operations are performed only in the local Kubernetes cluster. diff --git a/content/rancher/v2.6/en/backups/configuration/_index.md b/content/rancher/v2.6/en/backups/configuration/_index.md index 52236ff1d7c..1ccff9b9706 100644 --- a/content/rancher/v2.6/en/backups/configuration/_index.md +++ b/content/rancher/v2.6/en/backups/configuration/_index.md @@ -3,7 +3,7 @@ title: Rancher Backup Configuration Reference shortTitle: Configuration weight: 4 aliases: - - /rancher/v2.5/en/backups/v2.5/configuration + - /rancher/v2.6/en/backups/v2.5/configuration --- - [Backup configuration](./backup-config) diff --git a/content/rancher/v2.6/en/backups/configuration/backup-config/_index.md b/content/rancher/v2.6/en/backups/configuration/backup-config/_index.md index 5ad25999879..e223ce1813e 100644 --- a/content/rancher/v2.6/en/backups/configuration/backup-config/_index.md +++ b/content/rancher/v2.6/en/backups/configuration/backup-config/_index.md @@ -3,7 +3,7 @@ title: Backup Configuration shortTitle: Backup weight: 1 aliases: - - /rancher/v2.5/en/backups/v2.5/configuration/backup-config + - /rancher/v2.6/en/backups/v2.5/configuration/backup-config --- The Backup Create page lets you configure a schedule, enable encryption and specify the storage location for your backups. diff --git a/content/rancher/v2.6/en/backups/configuration/restore-config/_index.md b/content/rancher/v2.6/en/backups/configuration/restore-config/_index.md index b6b62f90166..a71c53df722 100644 --- a/content/rancher/v2.6/en/backups/configuration/restore-config/_index.md +++ b/content/rancher/v2.6/en/backups/configuration/restore-config/_index.md @@ -3,7 +3,7 @@ title: Restore Configuration shortTitle: Restore weight: 2 aliases: - - /rancher/v2.5/en/backups/v2.5/configuration/restore-config + - /rancher/v2.6/en/backups/v2.5/configuration/restore-config --- The Restore Create page lets you provide details of the backup to restore from diff --git a/content/rancher/v2.6/en/backups/configuration/storage-config/_index.md b/content/rancher/v2.6/en/backups/configuration/storage-config/_index.md index 8acb97c56cf..d9f841edf85 100644 --- a/content/rancher/v2.6/en/backups/configuration/storage-config/_index.md +++ b/content/rancher/v2.6/en/backups/configuration/storage-config/_index.md @@ -3,7 +3,7 @@ title: Backup Storage Location Configuration shortTitle: Storage weight: 3 aliases: - - /rancher/v2.5/en/backups/v2.5/configuration/storage-config + - /rancher/v2.6/en/backups/v2.5/configuration/storage-config --- Configure a storage location where all backups are saved by default. You will have the option to override this with each backup, but will be limited to using an S3-compatible object store. @@ -28,7 +28,7 @@ You can choose to not have any operator-level storage location configured. If yo | Parameter | Description | | -------------- | -------------- | -| Credential Secret | Choose the credentials for S3 from your secrets in Rancher. [Example]({{}}/rancher/v2.5/en/backups/v2.5/examples/#example-credential-secret-for-storing-backups-in-s3). | +| Credential Secret | Choose the credentials for S3 from your secrets in Rancher. [Example]({{}}/rancher/v2.6/en/backups/v2.5/examples/#example-credential-secret-for-storing-backups-in-s3). | | Bucket Name | Enter the name of the [S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) where the backups will be stored. Default: `rancherbackups`. | | Region | The [AWS region](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) where the S3 bucket is located. | | Folder | The [folder in the S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) where the backups will be stored. | @@ -40,7 +40,7 @@ You can choose to not have any operator-level storage location configured. If yo Installing the `rancher-backup` chart by selecting the StorageClass option will create a Persistent Volume Claim (PVC), and Kubernetes will in turn dynamically provision a Persistent Volume (PV) where all the backups will be saved by default. -For information about creating storage classes refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/provisioning-new-storage/) +For information about creating storage classes refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/) > **Important** It is highly recommended to use a StorageClass with a reclaim policy of "Retain". Otherwise if the PVC created by the `rancher-backup` chart gets deleted (either during app upgrade, or accidentally), the PV will get deleted too, which means all backups saved in it will get deleted. @@ -48,7 +48,7 @@ If no such StorageClass is available, after the PV is provisioned, make sure to ### Existing Persistent Volume -Select an existing Persistent Volume (PV) that will be used to store your backups. For information about creating PersistentVolumes in Rancher, refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/#2-add-a-persistent-volume-that-refers-to-the-persistent-storage) +Select an existing Persistent Volume (PV) that will be used to store your backups. For information about creating PersistentVolumes in Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/#2-add-a-persistent-volume-that-refers-to-the-persistent-storage) > **Important** It is highly recommended to use a Persistent Volume with a reclaim policy of "Retain". Otherwise if the PVC created by the `rancher-backup` chart gets deleted (either during app upgrade, or accidentally), the PV will get deleted too, which means all backups saved in it will get deleted. diff --git a/content/rancher/v2.6/en/backups/docker-installs/_index.md b/content/rancher/v2.6/en/backups/docker-installs/_index.md index b6e88a8f855..26281ee956f 100644 --- a/content/rancher/v2.6/en/backups/docker-installs/_index.md +++ b/content/rancher/v2.6/en/backups/docker-installs/_index.md @@ -3,8 +3,8 @@ title: Backup and Restore for Rancher Installed with Docker shortTitle: Docker Installs weight: 10 aliases: - - /rancher/v2.5/en/installation/backups-and-restoration/single-node-backup-and-restoration/ - - /rancher/v2.5/en/backups/v2.5/docker-installs + - /rancher/v2.6/en/installation/backups-and-restoration/single-node-backup-and-restoration/ + - /rancher/v2.6/en/backups/v2.5/docker-installs --- - [Backups](./docker-backups) diff --git a/content/rancher/v2.6/en/backups/docker-installs/docker-backups/_index.md b/content/rancher/v2.6/en/backups/docker-installs/docker-backups/_index.md index 507b7168b2c..1eefcabd805 100644 --- a/content/rancher/v2.6/en/backups/docker-installs/docker-backups/_index.md +++ b/content/rancher/v2.6/en/backups/docker-installs/docker-backups/_index.md @@ -3,11 +3,11 @@ title: Backing up Rancher Installed with Docker shortTitle: Backups weight: 3 aliases: - - /rancher/v2.5/en/installation/after-installation/single-node-backup-and-restoration/ - - /rancher/v2.5/en/installation/after-installation/single-node-backup-and-restoration/ - - /rancher/v2.5/en/backups/backups/single-node-backups/ - - /rancher/v2.5/en/backups/legacy/backup/single-node-backups/ - - /rancher/v2.5/en/backups/v2.5/docker-installs/docker-backups/ + - /rancher/v2.6/en/installation/after-installation/single-node-backup-and-restoration/ + - /rancher/v2.6/en/installation/after-installation/single-node-backup-and-restoration/ + - /rancher/v2.6/en/backups/backups/single-node-backups/ + - /rancher/v2.6/en/backups/legacy/backup/single-node-backups/ + - /rancher/v2.6/en/backups/v2.5/docker-installs/docker-backups/ --- @@ -74,4 +74,4 @@ This procedure creates a backup that you can restore if Rancher encounters a dis docker start ``` -**Result:** A backup tarball of your Rancher Server data is created. See [Restoring Backups: Docker Installs]({{}}/rancher/v2.5/en/backups/restorations/single-node-restoration) if you need to restore backup data. +**Result:** A backup tarball of your Rancher Server data is created. See [Restoring Backups: Docker Installs]({{}}/rancher/v2.6/en/backups/restorations/single-node-restoration) if you need to restore backup data. diff --git a/content/rancher/v2.6/en/backups/docker-installs/docker-restores/_index.md b/content/rancher/v2.6/en/backups/docker-installs/docker-restores/_index.md index cca3af9c994..89d7557c3bb 100644 --- a/content/rancher/v2.6/en/backups/docker-installs/docker-restores/_index.md +++ b/content/rancher/v2.6/en/backups/docker-installs/docker-restores/_index.md @@ -3,9 +3,9 @@ title: Restoring Backups—Docker Installs shortTitle: Restores weight: 3 aliases: - - /rancher/v2.5/en/installation/after-installation/single-node-backup-and-restoration/ - - /rancher/v2.5/en/backups/restorations/single-node-restoration - - /rancher/v2.5/en/backups/v2.5/docker-installs/docker-restores + - /rancher/v2.6/en/installation/after-installation/single-node-backup-and-restoration/ + - /rancher/v2.6/en/backups/restorations/single-node-restoration + - /rancher/v2.6/en/backups/v2.5/docker-installs/docker-restores --- If you encounter a disaster scenario, you can restore your Rancher Server to your most recent backup. @@ -39,7 +39,7 @@ You can obtain `` and `` by loggi ## Restoring Backups -Using a [backup]({{}}/rancher/v2.5/en/backups/backups/single-node-backups/) that you created earlier, restore Rancher to its last known healthy state. +Using a [backup]({{}}/rancher/v2.6/en/backups/backups/single-node-backups/) that you created earlier, restore Rancher to its last known healthy state. 1. Using a remote Terminal connection, log into the node running your Rancher Server. @@ -48,9 +48,9 @@ Using a [backup]({{}}/rancher/v2.5/en/backups/backups/single-node-backu ``` docker stop ``` -1. Move the backup tarball that you created during completion of [Creating Backups—Docker Installs]({{}}/rancher/v2.5/en/backups/backups/single-node-backups/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. +1. Move the backup tarball that you created during completion of [Creating Backups—Docker Installs]({{}}/rancher/v2.6/en/backups/backups/single-node-backups/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Creating Backups—Docker Installs]({{}}/rancher/v2.5/en/backups/backups/single-node-backups/), it will have a name similar to `rancher-data-backup--.tar.gz`. + If you followed the naming convention we suggested in [Creating Backups—Docker Installs]({{}}/rancher/v2.6/en/backups/backups/single-node-backups/), it will have a name similar to `rancher-data-backup--.tar.gz`. 1. Enter the following command to delete your current state data and replace it with your backup data, replacing the placeholders. Don't forget to close the quotes. diff --git a/content/rancher/v2.6/en/backups/examples/_index.md b/content/rancher/v2.6/en/backups/examples/_index.md index 95a6a99002e..7c7fe29824e 100644 --- a/content/rancher/v2.6/en/backups/examples/_index.md +++ b/content/rancher/v2.6/en/backups/examples/_index.md @@ -2,7 +2,7 @@ title: Examples weight: 5 aliases: - - /rancher/v2.5/en/backups/v2.5/examples + - /rancher/v2.6/en/backups/v2.5/examples --- This section contains examples of Backup and Restore custom resources. diff --git a/content/rancher/v2.6/en/backups/migrating-rancher/_index.md b/content/rancher/v2.6/en/backups/migrating-rancher/_index.md index 49e3e58d52a..191eea93428 100644 --- a/content/rancher/v2.6/en/backups/migrating-rancher/_index.md +++ b/content/rancher/v2.6/en/backups/migrating-rancher/_index.md @@ -84,7 +84,7 @@ kubectl apply -f migrationResource.yaml ### 3. Install cert-manager -Follow the steps to [install cert-manager]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#5-install-cert-manager) in the documentation about installing cert-manager on Kubernetes. +Follow the steps to [install cert-manager]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#5-install-cert-manager) in the documentation about installing cert-manager on Kubernetes. ### 4. Bring up Rancher with Helm diff --git a/content/rancher/v2.6/en/backups/restoring-rancher/_index.md b/content/rancher/v2.6/en/backups/restoring-rancher/_index.md index 64830e652aa..4a9952d63c5 100644 --- a/content/rancher/v2.6/en/backups/restoring-rancher/_index.md +++ b/content/rancher/v2.6/en/backups/restoring-rancher/_index.md @@ -10,14 +10,14 @@ A restore is performed by creating a Restore custom resource. > **Important** > -> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.6/en/backups/migrating-rancher) > * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. ### Create the Restore Custom Resource 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml @@ -38,7 +38,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) 1. Click **Create.** diff --git a/content/rancher/v2.6/en/best-practices/_index.md b/content/rancher/v2.6/en/best-practices/_index.md index 7be71efebed..2c377c90c84 100644 --- a/content/rancher/v2.6/en/best-practices/_index.md +++ b/content/rancher/v2.6/en/best-practices/_index.md @@ -2,7 +2,7 @@ title: Best Practices Guide weight: 4 aliases: - - /rancher/v2.5/en/best-practices/v2.5 + - /rancher/v2.6/en/best-practices/v2.5 --- The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers. @@ -13,7 +13,7 @@ Use the navigation bar on the left to find the current best practices for managi For more guidance on best practices, you can consult these resources: -- [Security]({{}}/rancher/v2.5/en/security/) +- [Security]({{}}/rancher/v2.6/en/security/) - [Rancher Blog](https://rancher.com/blog/) - [Articles about best practices on the Rancher blog](https://rancher.com/tags/best-practices/) - [101 More Security Best Practices for Kubernetes](https://rancher.com/blog/2019/2019-01-17-101-more-kubernetes-security-best-practices/) diff --git a/content/rancher/v2.6/en/best-practices/rancher-managed/_index.md b/content/rancher/v2.6/en/best-practices/rancher-managed/_index.md index 7bcc920d4fc..30c972ce084 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-managed/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-managed/_index.md @@ -3,7 +3,7 @@ title: Best Practices for Rancher Managed Clusters shortTitle: Rancher Managed Clusters weight: 2 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-managed + - /rancher/v2.6/en/best-practices/v2.5/rancher-managed --- ### Logging diff --git a/content/rancher/v2.6/en/best-practices/rancher-managed/containers/_index.md b/content/rancher/v2.6/en/best-practices/rancher-managed/containers/_index.md index 3763c0b2576..8e7763848db 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-managed/containers/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-managed/containers/_index.md @@ -2,8 +2,8 @@ title: Tips for Setting Up Containers weight: 100 aliases: - - /rancher/v2.5/en/best-practices/containers - - /rancher/v2.5/en/best-practices/v2.5/rancher-managed/containers + - /rancher/v2.6/en/best-practices/containers + - /rancher/v2.6/en/best-practices/v2.5/rancher-managed/containers --- Running well-built containers can greatly impact the overall performance and security of your environment. diff --git a/content/rancher/v2.6/en/best-practices/rancher-managed/logging/_index.md b/content/rancher/v2.6/en/best-practices/rancher-managed/logging/_index.md index 30a9a2a8f5a..5888c68364e 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-managed/logging/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-managed/logging/_index.md @@ -2,7 +2,7 @@ title: Logging Best Practices weight: 1 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-managed/logging + - /rancher/v2.6/en/best-practices/v2.5/rancher-managed/logging --- In this guide, we recommend best practices for cluster-level logging and application logging. diff --git a/content/rancher/v2.6/en/best-practices/rancher-managed/managed-vsphere/_index.md b/content/rancher/v2.6/en/best-practices/rancher-managed/managed-vsphere/_index.md index 12b794bacf7..c3f147c010c 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-managed/managed-vsphere/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-managed/managed-vsphere/_index.md @@ -2,7 +2,7 @@ title: Best Practices for Rancher Managed vSphere Clusters shortTitle: Rancher Managed Clusters in vSphere aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-managed/managed-vsphere + - /rancher/v2.6/en/best-practices/v2.5/rancher-managed/managed-vsphere --- This guide outlines a reference architecture for provisioning downstream Rancher clusters in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. diff --git a/content/rancher/v2.6/en/best-practices/rancher-managed/monitoring/_index.md b/content/rancher/v2.6/en/best-practices/rancher-managed/monitoring/_index.md index 24faff8755c..f290d415341 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-managed/monitoring/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-managed/monitoring/_index.md @@ -2,12 +2,12 @@ title: Monitoring Best Practices weight: 2 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-managed/monitoring + - /rancher/v2.6/en/best-practices/v2.5/rancher-managed/monitoring --- Configuring sensible monitoring and alerting rules is vital for running any production workloads securely and reliably. This is not different when using Kubernetes and Rancher. Fortunately the integrated monitoring and alerting functionality makes this whole process a lot easier. -The [Rancher monitoring documentation]({{}}/rancher/v2.5/en/monitoring-alerting/) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. +The [Rancher monitoring documentation]({{}}/rancher/v2.6/en/monitoring-alerting/) describes how you can set up a complete Prometheus and Grafana stack. Out of the box this will scrape monitoring data from all system and Kubernetes components in your cluster and provide sensible dashboards and alerts for them to get started. But for a reliable setup, you also need to monitor your own workloads and adapt Prometheus and Grafana to your own specific use cases and cluster sizes. This document aims to give you best practices for this. - [What to Monitor](#what-to-monitor) - [Configuring Prometheus Resource Usage](#configuring-prometheus-resource-usage) @@ -97,7 +97,7 @@ Sometimes it is useful to monitor workloads from the outside. For this, you can If you have a (micro)service architecture where multiple individual workloads within your cluster are communicating with each other, it is really important to have detailed metrics and traces about this traffic to understand how all these workloads are communicating with each other and where a problem or bottleneck may be. -Of course you can monitor all this internal traffic in all your workloads and expose these metrics to Prometheus. But this can quickly become quite work intensive. Service Meshes like Istio, which can be installed with [a click](https://rancher.com/docs/rancher/v2.5/en/cluster-admin/tools/istio/) in Rancher, can do this automatically and provide rich telemetry about the traffic between all services. +Of course you can monitor all this internal traffic in all your workloads and expose these metrics to Prometheus. But this can quickly become quite work intensive. Service Meshes like Istio, which can be installed with [a click](https://rancher.com/docs/rancher/v2.6/en/cluster-admin/tools/istio/) in Rancher, can do this automatically and provide rich telemetry about the traffic between all services. # Real User Monitoring @@ -105,7 +105,7 @@ Monitoring the availability and performance of all your internal workloads is vi # Security Monitoring -In addition to monitoring workloads to detect performance, availability or scalability problems, the cluster and the workloads running into it should also be monitored for potential security problems. A good starting point is to frequently run and alert on [CIS Scans]({{}}/rancher/v2.5/en/cis-scans/v2.5/) which check if the cluster is configured according to security best practices. +In addition to monitoring workloads to detect performance, availability or scalability problems, the cluster and the workloads running into it should also be monitored for potential security problems. A good starting point is to frequently run and alert on [CIS Scans]({{}}/rancher/v2.6/en/cis-scans/v2.5/) which check if the cluster is configured according to security best practices. For the workloads, you can have a look at Kubernetes and Container security solutions like [Falko](https://falco.org/), [Aqua Kubernetes Security](https://www.aquasec.com/solutions/kubernetes-container-security/), [SysDig](https://sysdig.com/). @@ -119,4 +119,4 @@ When setting up alerts, configure them for all the workloads that are critical t If an alert starts firing, but there is nothing you can do about it at the moment, it's also fine to silence the alert for a certain amount of time, so that you can look at it later. -You can find more information on how to set up alerts and notification channels in the [Rancher Documentation]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5). \ No newline at end of file +You can find more information on how to set up alerts and notification channels in the [Rancher Documentation]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5). \ No newline at end of file diff --git a/content/rancher/v2.6/en/best-practices/rancher-server/_index.md b/content/rancher/v2.6/en/best-practices/rancher-server/_index.md index 2967207d26c..016328bc5f4 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-server/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-server/_index.md @@ -3,7 +3,7 @@ title: Best Practices for the Rancher Server shortTitle: Rancher Server weight: 1 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-server + - /rancher/v2.6/en/best-practices/v2.5/rancher-server --- This guide contains our recommendations for running the Rancher server, and is intended to be used in situations in which Rancher manages downstream Kubernetes clusters. diff --git a/content/rancher/v2.6/en/best-practices/rancher-server/deployment-strategies/_index.md b/content/rancher/v2.6/en/best-practices/rancher-server/deployment-strategies/_index.md index 15b895e94ea..bad95c692d4 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-server/deployment-strategies/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-server/deployment-strategies/_index.md @@ -2,7 +2,7 @@ title: Rancher Deployment Strategy weight: 100 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-server/deployment-strategies + - /rancher/v2.6/en/best-practices/v2.5/rancher-server/deployment-strategies --- There are two recommended deployment strategies for a Rancher server that manages downstream Kubernetes clusters. Each one has its own pros and cons. Read more about which one would fit best for your use case: diff --git a/content/rancher/v2.6/en/best-practices/rancher-server/deployment-types/_index.md b/content/rancher/v2.6/en/best-practices/rancher-server/deployment-types/_index.md index 7dc67404bdf..6e515fd3a3b 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-server/deployment-types/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-server/deployment-types/_index.md @@ -2,8 +2,8 @@ title: Tips for Running Rancher weight: 100 aliases: - - /rancher/v2.5/en/best-practices/deployment-types - - /rancher/v2.5/en/best-practices/v2.5/rancher-server/deployment-types + - /rancher/v2.6/en/best-practices/deployment-types + - /rancher/v2.6/en/best-practices/v2.5/rancher-server/deployment-types --- This guide is geared toward use cases where Rancher is used to manage downstream Kubernetes clusters. The high-availability setup is intended to prevent losing access to downstream clusters if the Rancher server is not available. @@ -30,11 +30,11 @@ For best performance, run all three of your nodes in the same geographic datacen It's strongly recommended to have a "staging" or "pre-production" environment of the Kubernetes cluster that Rancher runs on. This environment should mirror your production environment as closely as possible in terms of software and hardware configuration. ### Monitor Your Clusters to Plan Capacity -The Rancher server's Kubernetes cluster should run within the [system and hardware requirements]({{}}/rancher/v2.5/en/installation/requirements/) as closely as possible. The more you deviate from the system and hardware requirements, the more risk you take. +The Rancher server's Kubernetes cluster should run within the [system and hardware requirements]({{}}/rancher/v2.6/en/installation/requirements/) as closely as possible. The more you deviate from the system and hardware requirements, the more risk you take. However, metrics-driven capacity planning analysis should be the ultimate guidance for scaling Rancher, because the published requirements take into account a variety of workload types. Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with Prometheus, a leading open-source monitoring solution, and Grafana, which lets you visualize the metrics from Prometheus. -After you [enable monitoring]({{}}/rancher/v2.5/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/) in the cluster, you can set up [a notification channel]({{}}/rancher/v2.5/en/cluster-admin/tools/notifiers/) and [cluster alerts]({{}}/rancher/v2.5/en/cluster-admin/tools/alerts/) to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. +After you [enable monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/) in the cluster, you can set up [a notification channel]({{}}/rancher/v2.6/en/cluster-admin/tools/notifiers/) and [cluster alerts]({{}}/rancher/v2.6/en/cluster-admin/tools/alerts/) to let you know if your cluster is approaching its capacity. You can also use the Prometheus and Grafana monitoring framework to establish a baseline for key metrics as you scale. diff --git a/content/rancher/v2.6/en/best-practices/rancher-server/rancher-in-vsphere/_index.md b/content/rancher/v2.6/en/best-practices/rancher-server/rancher-in-vsphere/_index.md index d4f9f64449f..b633d867db1 100644 --- a/content/rancher/v2.6/en/best-practices/rancher-server/rancher-in-vsphere/_index.md +++ b/content/rancher/v2.6/en/best-practices/rancher-server/rancher-in-vsphere/_index.md @@ -3,7 +3,7 @@ title: Installing Rancher in a vSphere Environment shortTitle: On-Premises Rancher in vSphere weight: 3 aliases: - - /rancher/v2.5/en/best-practices/v2.5/rancher-server/rancher-in-vsphere + - /rancher/v2.6/en/best-practices/v2.5/rancher-server/rancher-in-vsphere --- This guide outlines a reference architecture for installing Rancher on an RKE Kubernetes cluster in a vSphere environment, in addition to standard vSphere best practices as documented by VMware. @@ -48,7 +48,7 @@ Configure appropriate Firewall / ACL rules to only expose access to Rancher ### Size the VM's According to Rancher Documentation -https://rancher.com/docs/rancher/v2.5/en/installation/requirements/ +https://rancher.com/docs/rancher/v2.6/en/installation/requirements/ ### Leverage VM Templates to Construct the Environment diff --git a/content/rancher/v2.6/en/cis-scans/_index.md b/content/rancher/v2.6/en/cis-scans/_index.md index 98a8b6a9a8e..05797269b72 100644 --- a/content/rancher/v2.6/en/cis-scans/_index.md +++ b/content/rancher/v2.6/en/cis-scans/_index.md @@ -82,7 +82,7 @@ The Benchmark version is included in the generated report. The Benchmark provides recommendations of two types: Scored and Not Scored. Recommendations marked as Not Scored in the Benchmark are not included in the generated report. -Some tests are designated as "Not Applicable." These tests will not be run on any CIS scan because of the way that Rancher provisions RKE clusters. For information on how test results can be audited, and why some tests are designated to be not applicable, refer to Rancher's self-assessment guide for the corresponding Kubernetes version. +Some tests are designated as "Not Applicable." These tests will not be run on any CIS scan because of the way that Rancher provisions RKE clusters. For information on how test results can be audited, and why some tests are designated to be not applicable, refer to Rancher's self-assessment guide for the corresponding Kubernetes version. The report contains the following information: @@ -101,7 +101,7 @@ The report contains the following information: | `actual_value` | The test's actual value, present if reported by `kube-bench`. | | `expected_result` | The test's expected result, present if reported by `kube-bench`. | -Refer to the table in the cluster hardening guide for information on which versions of Kubernetes, the Benchmark, Rancher, and our cluster hardening guide correspond to each other. Also refer to the hardening guide for configuration files of CIS-compliant clusters and information on remediating failed tests. +Refer to the table in the cluster hardening guide for information on which versions of Kubernetes, the Benchmark, Rancher, and our cluster hardening guide correspond to each other. Also refer to the hardening guide for configuration files of CIS-compliant clusters and information on remediating failed tests. # Test Profiles @@ -129,11 +129,11 @@ There are two types of RKE cluster scan profiles: The EKS and GKE cluster scan profiles are based on CIS Benchmark versions that are specific to those types of clusters. -In order to pass the "Hardened" profile, you will need to follow the steps on the hardening guide and use the `cluster.yml` defined in the hardening guide to provision a hardened cluster. +In order to pass the "Hardened" profile, you will need to follow the steps on the hardening guide and use the `cluster.yml` defined in the hardening guide to provision a hardened cluster. # About Skipped and Not Applicable Tests -For a list of skipped and not applicable tests, refer to this page. +For a list of skipped and not applicable tests, refer to this page. For now, only user-defined skipped tests are marked as skipped in the generated report. @@ -141,11 +141,11 @@ Any skipped tests that are defined as being skipped by one of the default profil # Roles-based Access Control -For information about permissions, refer to this page. +For information about permissions, refer to this page. # Configuration -For more information about configuring the custom resources for the scans, profiles, and benchmark versions, refer to this page. +For more information about configuring the custom resources for the scans, profiles, and benchmark versions, refer to this page. # How-to Guides @@ -257,9 +257,9 @@ Alerts can be configured to be sent out for a scan that runs on a schedule. > **Prerequisite:** > -> Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager/) +> Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration/alertmanager/) > -> While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager/#example-route-config-for-cis-scan-alerts) +> While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration/alertmanager/#example-route-config-for-cis-scan-alerts) While installing or upgrading the `rancher-cis-benchmark` application, set the following flag to `true` in the `values.yaml`: @@ -284,9 +284,9 @@ The `rancher-cis-benchmark` application supports two types of alerts: > **Prerequisite:** > -> Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager/) +> Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see [this section.]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration/alertmanager/) > -> While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager/#example-route-config-for-cis-scan-alerts) +> While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here.]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration/alertmanager/#example-route-config-for-cis-scan-alerts) To configure alerts for a scan that runs on a schedule, diff --git a/content/rancher/v2.6/en/cis-scans/configuration/_index.md b/content/rancher/v2.6/en/cis-scans/configuration/_index.md index 38e4eaed6ef..890a84fb8aa 100644 --- a/content/rancher/v2.6/en/cis-scans/configuration/_index.md +++ b/content/rancher/v2.6/en/cis-scans/configuration/_index.md @@ -2,7 +2,7 @@ title: Configuration weight: 3 aliases: - - /rancher/v2.5/en/cis-scans/v2.5/configuration + - /rancher/v2.6/en/cis-scans/v2.5/configuration --- This configuration reference is intended to help you manage the custom resources created by the `rancher-cis-benchmark` application. These resources are used for performing CIS scans on a cluster, skipping tests, setting the test profile that will be used during a scan, and other customization. diff --git a/content/rancher/v2.6/en/cis-scans/custom-benchmark/_index.md b/content/rancher/v2.6/en/cis-scans/custom-benchmark/_index.md index 5b4627ea42a..05ff6e87feb 100644 --- a/content/rancher/v2.6/en/cis-scans/custom-benchmark/_index.md +++ b/content/rancher/v2.6/en/cis-scans/custom-benchmark/_index.md @@ -2,7 +2,7 @@ title: Creating a Custom Benchmark Version for Running a Cluster Scan weight: 4 aliases: - - /rancher/v2.5/en/cis-scans/v2.5/custom-benchmark + - /rancher/v2.6/en/cis-scans/v2.5/custom-benchmark --- _Available as of v2.5.4_ diff --git a/content/rancher/v2.6/en/cis-scans/rbac/_index.md b/content/rancher/v2.6/en/cis-scans/rbac/_index.md index 66cff4f39cc..16e205fd722 100644 --- a/content/rancher/v2.6/en/cis-scans/rbac/_index.md +++ b/content/rancher/v2.6/en/cis-scans/rbac/_index.md @@ -3,8 +3,8 @@ title: Roles-based Access Control shortTitle: RBAC weight: 3 aliases: - - /rancher/v2.5/en/cis-scans/rbac - - /rancher/v2.5/en/cis-scans/v2.5/rbac + - /rancher/v2.6/en/cis-scans/rbac + - /rancher/v2.6/en/cis-scans/v2.5/rbac --- This section describes the permissions required to use the rancher-cis-benchmark App. diff --git a/content/rancher/v2.6/en/cis-scans/skipped-tests/_index.md b/content/rancher/v2.6/en/cis-scans/skipped-tests/_index.md index f997b814e9d..13c9ec34f7f 100644 --- a/content/rancher/v2.6/en/cis-scans/skipped-tests/_index.md +++ b/content/rancher/v2.6/en/cis-scans/skipped-tests/_index.md @@ -2,8 +2,8 @@ title: Skipped and Not Applicable Tests weight: 3 aliases: - - /rancher/v2.5/en/cis-scans/skipped-tests - - /rancher/v2.5/en/cis-scans/v2.5/skipped-tests + - /rancher/v2.6/en/cis-scans/skipped-tests + - /rancher/v2.6/en/cis-scans/v2.5/skipped-tests --- This section lists the tests that are skipped in the permissive test profile for RKE. diff --git a/content/rancher/v2.6/en/cli/_index.md b/content/rancher/v2.6/en/cli/_index.md index 7c1f5b96006..6ac3f1e75d7 100644 --- a/content/rancher/v2.6/en/cli/_index.md +++ b/content/rancher/v2.6/en/cli/_index.md @@ -5,7 +5,7 @@ metaTitle: "Using the Rancher Command Line Interface " metaDescription: "The Rancher CLI is a unified tool that you can use to interact with Rancher. With it, you can operate Rancher using a command line interface rather than the GUI" weight: 21 aliases: - - /rancher/v2.5/en/cluster-admin/cluster-access/cli + - /rancher/v2.6/en/cluster-admin/cluster-access/cli --- The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI. @@ -19,7 +19,7 @@ The binary can be downloaded directly from the UI. The link can be found in the After you download the Rancher CLI, you need to make a few configurations. Rancher CLI requires: - Your Rancher Server URL, which is used to connect to Rancher Server. -- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.5/en/user-settings/api-keys/). +- An API Bearer Token, which is used to authenticate with Rancher. For more information about obtaining a Bearer Token, see [Creating an API Key]({{}}/rancher/v2.6/en/user-settings/api-keys/). ### CLI Authentication @@ -33,7 +33,7 @@ If Rancher Server uses a self-signed certificate, Rancher CLI prompts you to con ### Project Selection -Before you can perform any commands, you must select a Rancher project to perform those commands against. To select a [project]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/) to work on, use the command `./rancher context switch`. When you enter this command, a list of available projects displays. Enter a number to choose your project. +Before you can perform any commands, you must select a Rancher project to perform those commands against. To select a [project]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/) to work on, use the command `./rancher context switch`. When you enter this command, a list of available projects displays. Enter a number to choose your project. **Example: `./rancher context switch` Output** ``` @@ -60,16 +60,16 @@ The following commands are available for use in Rancher CLI. | Command | Result | |---|---| | `apps, [app]` | Performs operations on catalog applications (i.e. individual [Helm charts](https://docs.helm.sh/developing_charts/) or Rancher charts. | -| `catalog` | Performs operations on [catalogs]({{}}/rancher/v2.5/en/catalog/). | -| `clusters, [cluster]` | Performs operations on your [clusters]({{}}/rancher/v2.5/en/cluster-provisioning/). | -| `context` | Switches between Rancher [projects]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/). For an example, see [Project Selection](#project-selection). | -| `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/) and [workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/)). Specify resources by name or ID. | +| `catalog` | Performs operations on [catalogs]({{}}/rancher/v2.6/en/catalog/). | +| `clusters, [cluster]` | Performs operations on your [clusters]({{}}/rancher/v2.6/en/cluster-provisioning/). | +| `context` | Switches between Rancher [projects]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/). For an example, see [Project Selection](#project-selection). | +| `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/) and [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/)). Specify resources by name or ID. | | `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | | `namespaces, [namespace]` |Performs operations on namespaces. | | `nodes, [node]` |Performs operations on nodes. | -| `projects, [project]` | Performs operations on [projects]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/). | -| `ps` | Displays [workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads) in a project. | +| `projects, [project]` | Performs operations on [projects]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/). | +| `ps` | Displays [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads) in a project. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/content/rancher/v2.6/en/cluster-admin/_index.md b/content/rancher/v2.6/en/cluster-admin/_index.md index 9b2c0d73d25..ec3d1b87895 100644 --- a/content/rancher/v2.6/en/cluster-admin/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/_index.md @@ -11,7 +11,7 @@ This page covers the following topics: - [Managing clusters in Rancher](#managing-clusters-in-rancher) - [Configuring tools](#configuring-tools) -> This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.5/en/overview/concepts) page. +> This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. ## Switching between Clusters @@ -21,9 +21,9 @@ Alternatively, you can switch between projects and clusters directly in the navi ## Managing Clusters in Rancher -After clusters have been [provisioned into Rancher]({{}}/rancher/v2.5/en/cluster-provisioning/), [cluster owners]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) will need to manage these clusters. There are many different options of how to manage your cluster. +After clusters have been [provisioned into Rancher]({{}}/rancher/v2.6/en/cluster-provisioning/), [cluster owners]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) will need to manage these clusters. There are many different options of how to manage your cluster. -{{% include file="/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table" %}} +{{% include file="/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table" %}} ## Configuring Tools @@ -36,4 +36,4 @@ Rancher contains a variety of tools that aren't included in Kubernetes to assist - Istio Service Mesh - OPA Gatekeeper -For more information, see [Tools]({{}}/rancher/v2.5/en/cluster-admin/tools/) +For more information, see [Tools]({{}}/rancher/v2.6/en/cluster-admin/tools/) diff --git a/content/rancher/v2.6/en/cluster-admin/backing-up-etcd/_index.md b/content/rancher/v2.6/en/cluster-admin/backing-up-etcd/_index.md index 6494178871f..92222fd4988 100644 --- a/content/rancher/v2.6/en/cluster-admin/backing-up-etcd/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/backing-up-etcd/_index.md @@ -3,7 +3,7 @@ title: Backing up a Cluster weight: 2045 --- -In the Rancher UI, etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) can be easily performed. +In the Rancher UI, etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) can be easily performed. Rancher recommends configuring recurrent `etcd` snapshots for all production clusters. Additionally, one-time snapshots can easily be taken as well. @@ -83,7 +83,7 @@ On restore, the following process is used: Select how often you want recurring snapshots to be taken as well as how many snapshots to keep. The amount of time is measured in hours. With timestamped snapshots, the user has the ability to do a point-in-time recovery. -By default, [Rancher launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) are configured to take recurring snapshots (saved to local disk). To protect against local disk failure, using the [S3 Target](#s3-backup-target) or replicating the path on disk is advised. +By default, [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) are configured to take recurring snapshots (saved to local disk). To protect against local disk failure, using the [S3 Target](#s3-backup-target) or replicating the path on disk is advised. During cluster provisioning or editing the cluster, the configuration for snapshots can be found in the advanced section for **Cluster Options**. Click on **Show advanced options**. @@ -115,7 +115,7 @@ Rancher supports two different backup targets: ### Local Backup Target -By default, the `local` backup target is selected. The benefits of this option is that there is no external configuration. Snapshots are automatically saved locally to the etcd nodes in the [Rancher launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) in `/opt/rke/etcd-snapshots`. All recurring snapshots are taken at configured intervals. The downside of using the `local` backup target is that if there is a total disaster and _all_ etcd nodes are lost, there is no ability to restore the cluster. +By default, the `local` backup target is selected. The benefits of this option is that there is no external configuration. Snapshots are automatically saved locally to the etcd nodes in the [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) in `/opt/rke/etcd-snapshots`. All recurring snapshots are taken at configured intervals. The downside of using the `local` backup target is that if there is a total disaster and _all_ etcd nodes are lost, there is no ability to restore the cluster. ### S3 Backup Target @@ -163,4 +163,4 @@ This option is not available directly in the UI, and is only available through t # Enabling Snapshot Features for Clusters Created Before Rancher v2.2.0 -If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.5/en/cluster-admin/restoring-etcd/). +If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/). diff --git a/content/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/_index.md b/content/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/_index.md index 59f8087da31..f54c9086cbb 100644 --- a/content/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/_index.md @@ -3,7 +3,7 @@ title: Removing Kubernetes Components from Nodes description: Learn about cluster cleanup when removing nodes from your Rancher-launched Kubernetes cluster. What is removed, how to do it manually weight: 2055 aliases: - - /rancher/v2.5/en/faq/cleaning-cluster-nodes/ + - /rancher/v2.6/en/faq/cleaning-cluster-nodes/ --- This section describes how to disconnect a node from a Rancher-launched Kubernetes cluster and remove all of the Kubernetes components from the node. This process allows you to use the node for other purposes. @@ -26,10 +26,10 @@ When cleaning nodes provisioned using Rancher, the following components are dele | All resources create under the `management.cattle.io` API Group | ✓ | ✓ | ✓ | | | All CRDs created by Rancher v2.x | ✓ | ✓ | ✓ | | -[1]: {{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ -[2]: {{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/ -[3]: {{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/ -[4]: {{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/ +[1]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ +[2]: {{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/ +[3]: {{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ +[4]: {{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/ ## Removing a Node from a Cluster by Rancher UI diff --git a/content/rancher/v2.6/en/cluster-admin/cloning-clusters/_index.md b/content/rancher/v2.6/en/cluster-admin/cloning-clusters/_index.md index ea1257aa10a..da9fbf471f6 100644 --- a/content/rancher/v2.6/en/cluster-admin/cloning-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cloning-clusters/_index.md @@ -2,7 +2,7 @@ title: Cloning Clusters weight: 2035 aliases: - - /rancher/v2.5/en/cluster-provisioning/cloning-clusters/ + - /rancher/v2.6/en/cluster-provisioning/cloning-clusters/ --- If you have a cluster in Rancher that you want to use as a template for creating similar clusters, you can use Rancher CLI to clone the cluster's configuration, edit it, and then use it to quickly launch the cloned cluster. @@ -11,16 +11,16 @@ Duplication of registered clusters is not supported. | Cluster Type | Cloneable? | |----------------------------------|---------------| -| [Nodes Hosted by Infrastructure Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) | ✓ | -| [Hosted Kubernetes Providers]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) | ✓ | -| [Custom Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes) | ✓ | -| [Registered Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/) | | +| [Nodes Hosted by Infrastructure Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) | ✓ | +| [Hosted Kubernetes Providers]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) | ✓ | +| [Custom Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) | ✓ | +| [Registered Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/) | | > **Warning:** During the process of duplicating a cluster, you will edit a config file full of cluster settings. However, we recommend editing only values explicitly listed in this document, as cluster duplication is designed for simple cluster copying, _not_ wide scale configuration changes. Editing other values may invalidate the config file, which will lead to cluster deployment failure. ## Prerequisites -Download and install [Rancher CLI]({{}}/rancher/v2.5/en/cli). Remember to [create an API bearer token]({{}}/rancher/v2.5/en/user-settings/api-keys) if necessary. +Download and install [Rancher CLI]({{}}/rancher/v2.6/en/cli). Remember to [create an API bearer token]({{}}/rancher/v2.6/en/user-settings/api-keys) if necessary. ## 1. Export Cluster Config @@ -51,7 +51,7 @@ Begin by using Rancher CLI to export the configuration for the cluster that you Use your favorite text editor to modify the cluster configuration in `cluster-template.yml` for your cloned cluster. -> **Note:** Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) +> **Note:** Cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) 1. Open `cluster-template.yml` (or whatever you named your config) in your favorite text editor. diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-access/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-access/_index.md index 8d882c39148..d6f576b0443 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-access/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-access/_index.md @@ -5,11 +5,11 @@ weight: 1 This section is about what tools can be used to access clusters managed by Rancher. -For information on how to give users permission to access a cluster, see the section on [adding users to clusters.]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/) +For information on how to give users permission to access a cluster, see the section on [adding users to clusters.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/) -For more information on roles-based access control, see [this section.]({{}}/rancher/v2.5/en/admin-settings/rbac/) +For more information on roles-based access control, see [this section.]({{}}/rancher/v2.6/en/admin-settings/rbac/) -For information on how to set up an authentication system, see [this section.]({{}}/rancher/v2.5/en/admin-settings/authentication/) +For information on how to set up an authentication system, see [this section.]({{}}/rancher/v2.6/en/admin-settings/authentication/) ### Rancher UI @@ -20,13 +20,13 @@ Rancher provides an intuitive user interface for interacting with your clusters. You can use the Kubernetes command-line tool, [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/), to manage your clusters. You have two options for using kubectl: -- **Rancher kubectl shell:** Interact with your clusters by launching a kubectl shell available in the Rancher UI. This option requires no configuration actions on your part. For more information, see [Accessing Clusters with kubectl Shell]({{}}/rancher/v2.5/en/k8s-in-rancher/kubectl/). +- **Rancher kubectl shell:** Interact with your clusters by launching a kubectl shell available in the Rancher UI. This option requires no configuration actions on your part. For more information, see [Accessing Clusters with kubectl Shell]({{}}/rancher/v2.6/en/k8s-in-rancher/kubectl/). - **Terminal remote connection:** You can also interact with your clusters by installing [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your local desktop and then copying the cluster's kubeconfig file to your local `~/.kube/config` directory. For more information, see [Accessing Clusters with kubectl and a kubeconfig File](./kubectl/). ### Rancher CLI -You can control your clusters by downloading Rancher's own command-line interface, [Rancher CLI]({{}}/rancher/v2.5/en/cli/). This CLI tool can interact directly with different clusters and projects or pass them `kubectl` commands. +You can control your clusters by downloading Rancher's own command-line interface, [Rancher CLI]({{}}/rancher/v2.6/en/cli/). This CLI tool can interact directly with different clusters and projects or pass them `kubectl` commands. ### Rancher API -Finally, you can interact with your clusters over the Rancher API. Before you use the API, you must obtain an [API key]({{}}/rancher/v2.5/en/user-settings/api-keys/). To view the different resource fields and actions for an API object, open the API UI, which can be accessed by clicking on **View in API** for any Rancher UI object. \ No newline at end of file +Finally, you can interact with your clusters over the Rancher API. Before you use the API, you must obtain an [API key]({{}}/rancher/v2.6/en/user-settings/api-keys/). To view the different resource fields and actions for an API object, open the API UI, which can be accessed by clicking on **View in API** for any Rancher UI object. \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-access/ace/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-access/ace/_index.md index 784b69c574e..a3aeb428feb 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-access/ace/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-access/ace/_index.md @@ -13,12 +13,12 @@ This kubeconfig file and its contents are specific to the cluster you are viewin After you download the kubeconfig file, you will be able to use the kubeconfig file and its Kubernetes [contexts](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-context-and-configuration) to access your downstream cluster. -If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.5/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires [rancher cli](../cli) to be present in your PATH. +If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.6/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires [rancher cli](../cli) to be present in your PATH. ### Two Authentication Methods for RKE Clusters -If the cluster is not an [RKE cluster,]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) the kubeconfig file allows you to access the cluster in only one way: it lets you be authenticated with the Rancher server, then Rancher allows you to run kubectl commands on the cluster. +If the cluster is not an [RKE cluster,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) the kubeconfig file allows you to access the cluster in only one way: it lets you be authenticated with the Rancher server, then Rancher allows you to run kubectl commands on the cluster. For RKE clusters, the kubeconfig file allows you to be authenticated in two ways: @@ -29,11 +29,11 @@ This second method, the capability to connect directly to the cluster's Kubernet To use the authorized cluster endpoint, you will need to configure kubectl to use the extra kubectl context in the kubeconfig file that Rancher generates for you when the RKE cluster is created. This file can be downloaded from the cluster view in the Rancher UI, and the instructions for configuring kubectl are on [this page.](../kubectl/#authenticating-directly-with-a-downstream-cluster) -These methods of communicating with downstream Kubernetes clusters are also explained in the [architecture page]({{}}/rancher/v2.5/en/overview/architecture/#communicating-with-downstream-user-clusters) in the larger context of explaining how Rancher works and how Rancher communicates with downstream clusters. +These methods of communicating with downstream Kubernetes clusters are also explained in the [architecture page]({{}}/rancher/v2.6/en/overview/architecture/#communicating-with-downstream-user-clusters) in the larger context of explaining how Rancher works and how Rancher communicates with downstream clusters. ### About the kube-api-auth Authentication Webhook -The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) which is only available for [RKE clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook. +The `kube-api-auth` microservice is deployed to provide the user authentication functionality for the [authorized cluster endpoint,]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) which is only available for [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) When you access the user cluster using `kubectl`, the cluster's Kubernetes API server authenticates you by using the `kube-api-auth` service as a webhook. During cluster provisioning, the file `/etc/kubernetes/kube-api-authn-webhook.yaml` is deployed and `kube-apiserver` is configured with `--authentication-token-webhook-config-file=/etc/kubernetes/kube-api-authn-webhook.yaml`. This configures the `kube-apiserver` to query `http://127.0.0.1:6440/v1/authenticate` to determine authentication for bearer tokens. diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/_index.md index 9c4bf05aea6..2cca9e9afaf 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/_index.md @@ -2,15 +2,15 @@ title: Adding Users to Clusters weight: 2020 aliases: - - /rancher/v2.5/en/tasks/clusters/adding-managing-cluster-members/ - - /rancher/v2.5/en/k8s-in-rancher/cluster-members/ - - /rancher/v2.5/en/cluster-admin/cluster-members - - /rancher/v2.5/en/cluster-provisioning/cluster-members/ + - /rancher/v2.6/en/tasks/clusters/adding-managing-cluster-members/ + - /rancher/v2.6/en/k8s-in-rancher/cluster-members/ + - /rancher/v2.6/en/cluster-admin/cluster-members + - /rancher/v2.6/en/cluster-provisioning/cluster-members/ --- If you want to provide a user with access and permissions to _all_ projects, nodes, and resources within a cluster, assign the user a cluster membership. ->**Tip:** Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/project-members/) instead. +>**Tip:** Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/project-members/) instead. There are two contexts where you can add cluster members: @@ -34,23 +34,23 @@ Cluster administrators can edit the membership for a cluster, controlling which If external authentication is configured: - - Rancher returns users from your [external authentication]({{}}/rancher/v2.5/en/admin-settings/authentication/) source as you type. + - Rancher returns users from your [external authentication]({{}}/rancher/v2.6/en/admin-settings/authentication/) source as you type. >**Using AD but can't find your users?** - >There may be an issue with your search attribute configuration. See [Configuring Active Directory Authentication: Step 5]({{}}/rancher/v2.5/en/admin-settings/authentication/ad/). + >There may be an issue with your search attribute configuration. See [Configuring Active Directory Authentication: Step 5]({{}}/rancher/v2.6/en/admin-settings/authentication/ad/). - A drop-down allows you to add groups instead of individual users. The drop-down only lists groups that you, the logged in user, are part of. - >**Note:** If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users]({{}}/rancher/v2.5/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). + >**Note:** If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users]({{}}/rancher/v2.6/en/admin-settings/authentication/#external-authentication-configuration-and-principal-users). 4. Assign the user or group **Cluster** roles. - [What are Cluster Roles?]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/) + [What are Cluster Roles?]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) >**Tip:** For Custom Roles, you can modify the list of individual roles available for assignment. > - > - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles/). - > - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.5/en/admin-settings/rbac/locked-roles). + > - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). + > - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles). **Result:** The chosen users are added to the cluster. diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/_index.md index d4a2e08f1ec..c184103187a 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/_index.md @@ -3,10 +3,10 @@ title: "Access a Cluster with Kubectl and kubeconfig" description: "Learn how you can access and manage your Kubernetes clusters using kubectl with kubectl Shell or with kubectl CLI and kubeconfig file. A kubeconfig file is used to configure access to Kubernetes. When you create a cluster with Rancher, it automatically creates a kubeconfig for your cluster." weight: 2010 aliases: - - /rancher/v2.5/en/k8s-in-rancher/kubectl/ - - /rancher/v2.5/en/cluster-admin/kubectl - - /rancher/v2.5/en/concepts/clusters/kubeconfig-files/ - - /rancher/v2.5/en/k8s-in-rancher/kubeconfig/ + - /rancher/v2.6/en/k8s-in-rancher/kubectl/ + - /rancher/v2.6/en/cluster-admin/kubectl + - /rancher/v2.6/en/concepts/clusters/kubeconfig-files/ + - /rancher/v2.6/en/k8s-in-rancher/kubeconfig/ - /rancher/2.x/en/cluster-admin/kubeconfig --- @@ -54,9 +54,9 @@ Rancher will discover and show resources created by `kubectl`. However, these re # Authenticating Directly with a Downstream Cluster -This section intended to help you set up an alternative method to access an [RKE cluster.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters) +This section intended to help you set up an alternative method to access an [RKE cluster.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) -This method is only available for RKE clusters that have the [authorized cluster endpoint]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) enabled. When Rancher creates this RKE cluster, it generates a kubeconfig file that includes additional kubectl context(s) for accessing your cluster. This additional context allows you to use kubectl to authenticate with the downstream cluster without authenticating through Rancher. For a longer explanation of how the authorized cluster endpoint works, refer to [this page.](../ace) +This method is only available for RKE clusters that have the [authorized cluster endpoint]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) enabled. When Rancher creates this RKE cluster, it generates a kubeconfig file that includes additional kubectl context(s) for accessing your cluster. This additional context allows you to use kubectl to authenticate with the downstream cluster without authenticating through Rancher. For a longer explanation of how the authorized cluster endpoint works, refer to [this page.](../ace) We recommend that as a best practice, you should set up this method to access your RKE cluster, so that just in case you can’t connect to Rancher, you can still access the cluster. @@ -75,7 +75,7 @@ In this example, when you use `kubectl` with the first context, `my-cluster`, yo With the second context, `my-cluster-controlplane-1`, you would authenticate with the authorized cluster endpoint, communicating with an downstream RKE cluster directly. -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.5/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) Now that you have the name of the context needed to authenticate directly with the cluster, you can pass the name of the context in as an option when running kubectl commands. The commands will differ depending on whether your cluster has an FQDN defined. Examples are provided in the sections below. diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/_index.md index 4c5cc1dc623..093de0f447d 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/_index.md @@ -22,4 +22,4 @@ Cluster Autoscaler provides support to distinct cloud providers. For more inform ### Setting up Cluster Autoscaler on Amazon Cloud Provider -For details on running the cluster autoscaler on Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.5/en/cluster-admin/cluster-autoscaler/amazon) +For details on running the cluster autoscaler on Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon) diff --git a/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon/_index.md b/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon/_index.md index 86eb6e4e3e4..ffa5b83b76b 100644 --- a/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/cluster-autoscaler/amazon/_index.md @@ -149,7 +149,7 @@ On AWS EC2, we should create a few objects to configure our system. We've define ``` * IAM role: `K8sMasterRole: [K8sMasterProfile,K8sAutoscalerProfile]` - * Security group: `K8sMasterSg` More info at[RKE ports (custom nodes tab)]({{}}/rancher/v2.5/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) + * Security group: `K8sMasterSg` More info at[RKE ports (custom nodes tab)]({{}}/rancher/v2.6/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) * Tags: `kubernetes.io/cluster/: owned` * User data: `K8sMasterUserData` Ubuntu 18.04(ami-0e11cbb34015ff725), installs docker and add etcd+controlplane node to the k8s cluster @@ -206,7 +206,7 @@ On AWS EC2, we should create a few objects to configure our system. We've define ``` * IAM role: `K8sWorkerRole: [K8sWorkerProfile]` - * Security group: `K8sWorkerSg` More info at [RKE ports (custom nodes tab)]({{}}/rancher/v2.5/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) + * Security group: `K8sWorkerSg` More info at [RKE ports (custom nodes tab)]({{}}/rancher/v2.6/en/installation/requirements/ports/#downstream-kubernetes-cluster-nodes) * Tags: * `kubernetes.io/cluster/: owned` * `k8s.io/cluster-autoscaler/: true` @@ -237,13 +237,13 @@ On AWS EC2, we should create a few objects to configure our system. We've define sudo docker run -d --privileged --restart=unless-stopped --net=host -v /etc/kubernetes:/etc/kubernetes -v /var/run:/var/run rancher/rancher-agent: --server https:// --token --ca-checksum --address ${PUBLIC_IP} --internal-address ${PRIVATE_IP} ${K8S_ROLES} ``` -More info is at [RKE clusters on AWS]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/) and [Cluster Autoscaler on AWS.](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md) +More info is at [RKE clusters on AWS]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/) and [Cluster Autoscaler on AWS.](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md) ### 3. Deploy Nodes Once we've configured AWS, let's create VMs to bootstrap our cluster: -* master (etcd+controlplane): Depending your needs, deploy three master instances with proper size. More info is at [the recommendations for production-ready clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/production/) +* master (etcd+controlplane): Depending your needs, deploy three master instances with proper size. More info is at [the recommendations for production-ready clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/production/) * IAM role: `K8sMasterRole` * Security group: `K8sMasterSg` * Tags: diff --git a/content/rancher/v2.6/en/cluster-admin/editing-clusters/_index.md b/content/rancher/v2.6/en/cluster-admin/editing-clusters/_index.md index 68996a69b8c..bb18700c326 100644 --- a/content/rancher/v2.6/en/cluster-admin/editing-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/editing-clusters/_index.md @@ -2,12 +2,12 @@ title: Cluster Configuration weight: 2025 aliases: - - /rancher/v2.5/en/k8s-in-rancher/editing-clusters + - /rancher/v2.6/en/k8s-in-rancher/editing-clusters --- After you provision a Kubernetes cluster using Rancher, you can still edit options and settings for the cluster. -For information on editing cluster membership, go to [this page.]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members) +For information on editing cluster membership, go to [this page.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members) ### Cluster Configuration References @@ -23,5 +23,5 @@ The options and settings available for an existing cluster change based on the m The following table summarizes the options and settings available for each cluster type: -{{% include file="/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table" %}} +{{% include file="/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table" %}} diff --git a/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/_index.md b/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/_index.md index 6b452ead8d8..2db5a497b00 100644 --- a/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/_index.md @@ -91,13 +91,13 @@ The address range assigned to the services in the cluster. Must be a valid CIDR _Mutable: no_ -> Warning: private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke/private-clusters/). +> Warning: private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/private-clusters/). Assign nodes only internal IP addresses. Private cluster nodes cannot access the public internet unless additional networking steps are taken in GCP. ### Enable Private Endpoint -> Warning: private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke/#private-clusters). +> Warning: private clusters require additional planning and configuration outside of Rancher. Refer to the [private cluster guide]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/#private-clusters). _Mutable: no_ @@ -180,7 +180,7 @@ _Mutable: yes_ The node operating system image. For more information for the node image options that GKE offers for each OS, refer to [this page.](https://cloud.google.com/kubernetes-engine/docs/concepts/node-images#available_node_images) -> Note: the default option is "Container-Optimized OS with Docker". The read-only filesystem on GCP's Container-Optimized OS is not compatible with the [legacy logging]({{}}/rancher/v2.0-v2.4/en/cluster-admin/tools/logging) implementation in Rancher. If you need to use the legacy logging feature, select "Ubuntu with Docker" or "Ubuntu with Containerd". The [logging feature as of v2.5]({{}}/rancher/v2.5/en/logging) is compatible with the Container-Optimized OS image. +> Note: the default option is "Container-Optimized OS with Docker". The read-only filesystem on GCP's Container-Optimized OS is not compatible with the [legacy logging]({{}}/rancher/v2.0-v2.4/en/cluster-admin/tools/logging) implementation in Rancher. If you need to use the legacy logging feature, select "Ubuntu with Docker" or "Ubuntu with Containerd". The [logging feature as of v2.5]({{}}/rancher/v2.6/en/logging) is compatible with the Container-Optimized OS image. > Note: if selecting "Windows Long Term Service Channel" or "Windows Semi-Annual Channel" for the node pool image type, you must also add at least one Container-Optimized OS or Ubuntu node pool. diff --git a/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/_index.md b/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/_index.md index d66fdb087bd..75994c9b8a4 100644 --- a/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/_index.md @@ -2,7 +2,7 @@ title: Private Clusters weight: 2 aliases: - - /rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke/private-clusters + - /rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/private-clusters --- _Available as of v2.5.8_ diff --git a/content/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/_index.md b/content/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/_index.md index 6d89a799f1e..024e3c648d4 100644 --- a/content/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/editing-clusters/rke-config-reference/_index.md @@ -3,7 +3,7 @@ title: RKE Cluster Configuration weight: 1 --- -In [clusters launched by RKE]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/), you can edit any of the remaining options that follow. +In [clusters launched by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/), you can edit any of the remaining options that follow. - [Configuration Options in the Rancher UI](#configuration-options-in-the-rancher-ui) - [Editing Clusters with YAML](#editing-clusters-with-yaml) @@ -17,7 +17,7 @@ Some advanced configuration options are not exposed in the Rancher UI forms, but ### Kubernetes Version -The version of Kubernetes installed on each cluster node. For more detail, see [Upgrading Kubernetes]({{}}/rancher/v2.5/en/cluster-admin/upgrading-kubernetes). +The version of Kubernetes installed on each cluster node. For more detail, see [Upgrading Kubernetes]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes). ### Network Provider @@ -41,7 +41,7 @@ Each cloud provider capable of launching a cluster using RKE can collect metrics ### Pod Security Policy Support -Enables [pod security policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. +Enables [pod security policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) for the cluster. After enabling this option, choose a policy using the **Default Pod Security Policy** drop-down. ### Docker version on nodes @@ -57,7 +57,7 @@ If you enable **Pod Security Policy Support**, use this drop-down to choose the ### Cloud Provider -If you're using a cloud provider to host cluster nodes launched by RKE, enable [this option]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) so that you can use the cloud provider's native features. If you want to store persistent data for your cloud-hosted cluster, this option is required. +If you're using a cloud provider to host cluster nodes launched by RKE, enable [this option]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) so that you can use the cloud provider's native features. If you want to store persistent data for your cloud-hosted cluster, this option is required. # Editing Clusters with YAML diff --git a/content/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/_index.md b/content/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/_index.md index 13a6b1e7f98..f485e9b58b3 100644 --- a/content/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/_index.md @@ -2,7 +2,7 @@ title: Syncing weight: 10 aliases: - - /rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/syncing + - /rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/syncing --- Syncing is the feature for EKS and GKE clusters that causes Rancher to update the clusters' values so they are up to date with their corresponding cluster object in the hosted Kubernetes provider. This enables Rancher to not be the sole owner of a hosted cluster’s state. Its largest limitation is that processing an update from Rancher and another source at the same time or within 5 minutes of one finishing may cause the state from one source to completely overwrite the other. diff --git a/content/rancher/v2.6/en/cluster-admin/nodes/_index.md b/content/rancher/v2.6/en/cluster-admin/nodes/_index.md index ca88ce4ab49..15cc58f62eb 100644 --- a/content/rancher/v2.6/en/cluster-admin/nodes/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/nodes/_index.md @@ -3,9 +3,9 @@ title: Nodes and Node Pools weight: 2030 --- -After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's **Node** tab. Depending on the [option used]({{}}/rancher/v2.5/en/cluster-provisioning/) to provision the cluster, there are different node options available. +After you launch a Kubernetes cluster in Rancher, you can manage individual nodes from the cluster's **Node** tab. Depending on the [option used]({{}}/rancher/v2.6/en/cluster-provisioning/) to provision the cluster, there are different node options available. -> If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters]({{< baseurl >}}/rancher/v2.5/en/k8s-in-rancher/editing-clusters). +> If you want to manage the _cluster_ and not individual nodes, see [Editing Clusters]({{< baseurl >}}/rancher/v2.6/en/k8s-in-rancher/editing-clusters). This section covers the following topics: @@ -51,21 +51,21 @@ The following table lists which node options are available for each type of clus ### Nodes Hosted by an Infrastructure Provider -Node pools are available when you provision Rancher-launched Kubernetes clusters on nodes that are [hosted in an infrastructure provider.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) +Node pools are available when you provision Rancher-launched Kubernetes clusters on nodes that are [hosted in an infrastructure provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) -Clusters provisioned using [one of the node pool options]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) can be scaled up or down if the node pool is edited. +Clusters provisioned using [one of the node pool options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) can be scaled up or down if the node pool is edited. -A node pool can also automatically maintain the node scale that's set during the initial cluster provisioning if [node auto-replace is enabled.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) This scale determines the number of active nodes that Rancher maintains for the cluster. +A node pool can also automatically maintain the node scale that's set during the initial cluster provisioning if [node auto-replace is enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) This scale determines the number of active nodes that Rancher maintains for the cluster. -Rancher uses [node templates]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to replace nodes in the node pool. Each node template uses cloud provider credentials to allow Rancher to set up the node in the infrastructure provider. +Rancher uses [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to replace nodes in the node pool. Each node template uses cloud provider credentials to allow Rancher to set up the node in the infrastructure provider. ### Nodes Provisioned by Hosted Kubernetes Providers -Options for managing nodes [hosted by a Kubernetes provider]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. +Options for managing nodes [hosted by a Kubernetes provider]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) are somewhat limited in Rancher. Rather than using the Rancher UI to make edits such as scaling the number of nodes up or down, edit the cluster directly. ### Registered Nodes -Although you can deploy workloads to a [registered cluster]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. +Although you can deploy workloads to a [registered cluster]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/) using Rancher, you cannot manage individual cluster nodes. All management of imported cluster nodes must take place outside of Rancher. # Managing and Editing Individual Nodes @@ -80,23 +80,23 @@ To manage individual nodes, browse to the cluster that you want to manage and th # Viewing a Node in the Rancher API -Select this option to view the node's [API endpoints]({{< baseurl >}}/rancher/v2.5/en/api/). +Select this option to view the node's [API endpoints]({{< baseurl >}}/rancher/v2.6/en/api/). # Deleting a Node Use **Delete** to remove defective nodes from the cloud provider. -When you the delete a defective node, Rancher can automatically replace it with an identically provisioned node if the node is in a node pool and [node auto-replace is enabled.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) +When you the delete a defective node, Rancher can automatically replace it with an identically provisioned node if the node is in a node pool and [node auto-replace is enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#about-node-auto-replace) >**Tip:** If your cluster is hosted by an infrastructure provider, and you want to scale your cluster down instead of deleting a defective node, [scale down](#scaling-nodes) rather than delete. # Scaling Nodes -For nodes hosted by an infrastructure provider, you can scale the number of nodes in each [node pool]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) by using the scale controls. This option isn't available for other cluster types. +For nodes hosted by an infrastructure provider, you can scale the number of nodes in each [node pool]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) by using the scale controls. This option isn't available for other cluster types. # SSH into a Node Hosted by an Infrastructure Provider -For [nodes hosted by an infrastructure provider]({{< baseurl >}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/), you have the option of downloading its SSH key so that you can connect to it remotely from your desktop. +For [nodes hosted by an infrastructure provider]({{< baseurl >}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/), you have the option of downloading its SSH key so that you can connect to it remotely from your desktop. 1. From the cluster hosted by an infrastructure provider, select **Nodes** from the main menu. diff --git a/content/rancher/v2.6/en/cluster-admin/pod-security-policy/_index.md b/content/rancher/v2.6/en/cluster-admin/pod-security-policy/_index.md index d902a84955c..8407c2f7b16 100644 --- a/content/rancher/v2.6/en/cluster-admin/pod-security-policy/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/pod-security-policy/_index.md @@ -3,9 +3,9 @@ title: Adding a Pod Security Policy weight: 80 --- -> **Prerequisite:** The options below are available only for clusters that are [launched using RKE.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) +> **Prerequisite:** The options below are available only for clusters that are [launched using RKE.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) -When your cluster is running pods with security-sensitive configurations, assign it a [pod security policy]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/), which is a set of rules that monitors the conditions and settings in your pods. If a pod doesn't meet the rules specified in your policy, the policy stops it from running. +When your cluster is running pods with security-sensitive configurations, assign it a [pod security policy]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/), which is a set of rules that monitors the conditions and settings in your pods. If a pod doesn't meet the rules specified in your policy, the policy stops it from running. You can assign a pod security policy when you provision a cluster. However, if you need to relax or restrict security for your pods later, you can update the policy while editing your cluster. @@ -15,11 +15,11 @@ You can assign a pod security policy when you provision a cluster. However, if y 3. From **Pod Security Policy Support**, select **Enabled**. - >**Note:** This option is only available for clusters [provisioned by RKE]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/). + >**Note:** This option is only available for clusters [provisioned by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). 4. From the **Default Pod Security Policy** drop-down, select the policy you want to apply to the cluster. - Rancher ships with [policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/#default-pod-security-policies) of `restricted` and `unrestricted`, although you can [create custom policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/#default-pod-security-policies) as well. + Rancher ships with [policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/#default-pod-security-policies) of `restricted` and `unrestricted`, although you can [create custom policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/#default-pod-security-policies) as well. 5. Click **Save**. diff --git a/content/rancher/v2.6/en/cluster-admin/projects-and-namespaces/_index.md b/content/rancher/v2.6/en/cluster-admin/projects-and-namespaces/_index.md index b495d62f208..4f46735f890 100644 --- a/content/rancher/v2.6/en/cluster-admin/projects-and-namespaces/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/projects-and-namespaces/_index.md @@ -3,10 +3,10 @@ title: Projects and Kubernetes Namespaces with Rancher description: Rancher Projects ease the administrative burden of your cluster and support multi-tenancy. Learn to create projects and divide projects into Kubernetes namespaces weight: 2032 aliases: - - /rancher/v2.5/en/concepts/projects/ - - /rancher/v2.5/en/tasks/projects/ - - /rancher/v2.5/en/tasks/projects/create-project/ - - /rancher/v2.5/en/tasks/projects/create-project/ + - /rancher/v2.6/en/concepts/projects/ + - /rancher/v2.6/en/tasks/projects/ + - /rancher/v2.6/en/tasks/projects/create-project/ + - /rancher/v2.6/en/tasks/projects/create-project/ --- A namespace is a Kubernetes concept that allows a virtual cluster within a cluster, which is useful for dividing the cluster into separate "virtual clusters" that each have their own access control and resource quotas. @@ -39,18 +39,18 @@ You can assign resources at the project level so that each namespace in the proj You can assign the following resources directly to namespaces: -- [Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/) -- [Load Balancers/Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/) -- [Service Discovery Records]({{}}/rancher/v2.5/en/k8s-in-rancher/service-discovery/) -- [Persistent Volume Claims]({{}}/rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/) -- [Certificates]({{}}/rancher/v2.5/en/k8s-in-rancher/certificates/) -- [ConfigMaps]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps/) -- [Registries]({{}}/rancher/v2.5/en/k8s-in-rancher/registries/) -- [Secrets]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/) +- [Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/) +- [Load Balancers/Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/) +- [Service Discovery Records]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery/) +- [Persistent Volume Claims]({{}}/rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/) +- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/) +- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/) +- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/) +- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) To manage permissions in a vanilla Kubernetes cluster, cluster admins configure role-based access policies for each namespace. With Rancher, user permissions are assigned on the project level instead, and permissions are automatically inherited by any namespace owned by the particular project. -For more information on creating and moving namespaces, see [Namespaces]({{}}/rancher/v2.5/en/project-admin/namespaces/). +For more information on creating and moving namespaces, see [Namespaces]({{}}/rancher/v2.6/en/project-admin/namespaces/). ### Role-based access control issues with namespaces and kubectl @@ -58,7 +58,7 @@ Because projects are a concept introduced by Rancher, kubectl does not have the This means that when standard users with project-scoped permissions create a namespaces with `kubectl`, it may be unusable because `kubectl` doesn't require the new namespace to be scoped within a certain project. -If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.5/en/project-admin/namespaces/) to ensure that you will have permission to access the namespace. +If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.6/en/project-admin/namespaces/) to ensure that you will have permission to access the namespace. If a standard user is a project owner, the user will be able to create namespaces within that project. The Rancher UI will prevent that user from creating namespaces outside the scope of the projects they have access to. @@ -75,8 +75,8 @@ In the base version of Kubernetes, features like role-based access rights or clu You can use projects to perform actions such as: -- Assign users to a group of namespaces (i.e., [project membership]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/project-members)). -- Assign users specific roles in a project. A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles/). +- Assign users to a group of namespaces (i.e., [project membership]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/project-members)). +- Assign users specific roles in a project. A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/). - Assign resources to the project. - Assign Pod Security Policies. @@ -117,7 +117,7 @@ Standard users are only authorized for project access in two situations: # Pod Security Policies -Rancher extends Kubernetes to allow the application of [Pod Security Policies](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) at the [project level]({{}}/rancher/v2.5/en/project-admin/pod-security-policies) in addition to the [cluster level.](../pod-security-policy) However, as a best practice, we recommend applying Pod Security Policies at the cluster level. +Rancher extends Kubernetes to allow the application of [Pod Security Policies](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) at the [project level]({{}}/rancher/v2.6/en/project-admin/pod-security-policies) in addition to the [cluster level.](../pod-security-policy) However, as a best practice, we recommend applying Pod Security Policies at the cluster level. # Creating Projects @@ -138,7 +138,7 @@ This section describes how to create a new project with a name and with optional ### 2. Optional: Select a Pod Security Policy -This option is only available if you've already created a Pod Security Policy. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/). +This option is only available if you've already created a Pod Security Policy. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). Assigning a PSP to a project will: @@ -155,24 +155,24 @@ By default, your user is added as the project `Owner`. >**Notes on Permissions:** > >- Users assigned the `Owner` or `Member` role for a project automatically inherit the `namespace creation` role. However, this role is a [Kubernetes ClusterRole](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole), meaning its scope extends to all projects in the cluster. Therefore, users explicitly assigned the `Owner` or `Member` role for a project can create namespaces in other projects they're assigned to, even with only the `Read Only` role assigned. ->- Choose `Custom` to create a custom role on the fly: [Custom Project Roles]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#custom-project-roles). +>- Choose `Custom` to create a custom role on the fly: [Custom Project Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#custom-project-roles). To add members: 1. Click **Add Member**. 1. From the **Name** combo box, search for a user or group that you want to assign project access. Note: You can only search for groups if external authentication is enabled. -1. From the **Role** drop-down, choose a role. For more information, refer to the [documentation on project roles.]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/) +1. From the **Role** drop-down, choose a role. For more information, refer to the [documentation on project roles.]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) ### 4. Optional: Add Resource Quotas -Resource quotas limit the resources that a project (and its namespaces) can consume. For more information, see [Resource Quotas]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas). +Resource quotas limit the resources that a project (and its namespaces) can consume. For more information, see [Resource Quotas]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas). To add a resource quota, 1. Click **Add Quota**. -1. Select a Resource Type. For more information, see [Resource Quotas.]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/). +1. Select a Resource Type. For more information, see [Resource Quotas.]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/). 1. Enter values for the **Project Limit** and the **Namespace Default Limit**. -1. **Optional:** Specify **Container Default Resource Limit**, which will be applied to every container started in the project. The parameter is recommended if you have CPU or Memory limits set by the Resource Quota. It can be overridden on per an individual namespace or a container level. For more information, see [Container Default Resource Limit]({{}}/rancher/v2.5/en/project-admin/resource-quotas/) +1. **Optional:** Specify **Container Default Resource Limit**, which will be applied to every container started in the project. The parameter is recommended if you have CPU or Memory limits set by the Resource Quota. It can be overridden on per an individual namespace or a container level. For more information, see [Container Default Resource Limit]({{}}/rancher/v2.6/en/project-admin/resource-quotas/) 1. Click **Create**. **Result:** Your project is created. You can view it from the cluster's **Projects/Namespaces** view. diff --git a/content/rancher/v2.6/en/cluster-admin/restoring-etcd/_index.md b/content/rancher/v2.6/en/cluster-admin/restoring-etcd/_index.md index 03560c17b5f..ff7035f1cee 100644 --- a/content/rancher/v2.6/en/cluster-admin/restoring-etcd/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/restoring-etcd/_index.md @@ -3,9 +3,9 @@ title: Restoring a Cluster from Backup weight: 2050 --- -etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster. +etcd backup and recovery for [Rancher launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) can be easily performed. Snapshots of the etcd database are taken and saved either locally onto the etcd nodes or to a S3 compatible target. The advantages of configuring S3 is that if all etcd nodes are lost, your snapshot is saved remotely and can be used to restore the cluster. -Rancher recommends enabling the [ability to set up recurring snapshots of etcd]({{}}/rancher/v2.5/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots), but [one-time snapshots]({{}}/rancher/v2.5/en/cluster-admin/backing-up-etcd/#one-time-snapshots) can easily be taken as well. Rancher allows restore from [saved snapshots](#restoring-a-cluster-from-a-snapshot) or if you don't have any snapshots, you can still [restore etcd](#recovering-etcd-without-a-snapshot). +Rancher recommends enabling the [ability to set up recurring snapshots of etcd]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots), but [one-time snapshots]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#one-time-snapshots) can easily be taken as well. Rancher allows restore from [saved snapshots](#restoring-a-cluster-from-a-snapshot) or if you don't have any snapshots, you can still [restore etcd](#recovering-etcd-without-a-snapshot). Clusters can also be restored to a prior Kubernetes version and cluster configuration. @@ -34,9 +34,9 @@ Snapshots are composed of the cluster data in etcd, the Kubernetes version, and - **Restore etcd and Kubernetes version:** This option should be used if a Kubernetes upgrade is the reason that your cluster is failing, and you haven't made any cluster configuration changes. - **Restore etcd, Kubernetes versions and cluster configuration:** This option should be used if you changed both the Kubernetes version and cluster configuration when upgrading. -When rolling back to a prior Kubernetes version, the [upgrade strategy options]({{}}/rancher/v2.5/en/cluster-admin/upgrading-kubernetes/#configuring-the-upgrade-strategy) are ignored. Worker nodes are not cordoned or drained before being reverted to the older Kubernetes version, so that an unhealthy cluster can be more quickly restored to a healthy state. +When rolling back to a prior Kubernetes version, the [upgrade strategy options]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/#configuring-the-upgrade-strategy) are ignored. Worker nodes are not cordoned or drained before being reverted to the older Kubernetes version, so that an unhealthy cluster can be more quickly restored to a healthy state. -> **Prerequisite:** To restore snapshots from S3, the cluster needs to be configured to [take recurring snapshots on S3.]({{}}/rancher/v2.5/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots) +> **Prerequisite:** To restore snapshots from S3, the cluster needs to be configured to [take recurring snapshots on S3.]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#configuring-recurring-snapshots) 1. In the **Global** view, navigate to the cluster that you want to restore from a snapshots. @@ -78,8 +78,8 @@ If the group of etcd nodes loses quorum, the Kubernetes cluster will report a fa 5. Run the revised command. -6. After the single nodes is up and running, Rancher recommends adding additional etcd nodes to your cluster. If you have a [custom cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes) and you want to reuse an old node, you are required to [clean up the nodes]({{}}/rancher/v2.5/en/faq/cleaning-cluster-nodes/) before attempting to add them back into a cluster. +6. After the single nodes is up and running, Rancher recommends adding additional etcd nodes to your cluster. If you have a [custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) and you want to reuse an old node, you are required to [clean up the nodes]({{}}/rancher/v2.6/en/faq/cleaning-cluster-nodes/) before attempting to add them back into a cluster. # Enabling Snapshot Features for Clusters Created Before Rancher v2.2.0 -If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.5/en/cluster-admin/restoring-etcd/). +If you have any Rancher launched Kubernetes clusters that were created before v2.2.0, after upgrading Rancher, you must [edit the cluster]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) and _save_ it, in order to enable the updated snapshot features. Even if you were already creating snapshots before v2.2.0, you must do this step as the older snapshots will not be available to use to [back up and restore etcd through the UI]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/). diff --git a/content/rancher/v2.6/en/cluster-admin/tools/_index.md b/content/rancher/v2.6/en/cluster-admin/tools/_index.md index 7438d3b9439..8d0db8ce35f 100644 --- a/content/rancher/v2.6/en/cluster-admin/tools/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/tools/_index.md @@ -2,7 +2,7 @@ title: Tools for Logging, Monitoring, and Visibility weight: 2033 aliases: - - /rancher/v2.5/en/tools/notifiers-and-alerts/ + - /rancher/v2.6/en/tools/notifiers-and-alerts/ --- Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently. Tools are divided into following categories: @@ -30,7 +30,7 @@ Logging is helpful because it allows you to: Rancher can integrate with Elasticsearch, splunk, kafka, syslog, and fluentd. -For more information, refer to the logging documentation [here.]({{}}/rancher/v2.5/en/logging/) +For more information, refer to the logging documentation [here.]({{}}/rancher/v2.6/en/logging/) # Monitoring and Alerts Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. @@ -41,7 +41,7 @@ Notifiers are services that inform you of alert events. You can configure notifi Alerts are rules that trigger those notifications. Before you can receive alerts, you must configure one or more notifier in Rancher. The scope for alerts can be set at either the cluster or project level. -For more information, refer to the monitoring documentation [here.]({{}}/rancher/v2.5/en/monitoring-alerting/) +For more information, refer to the monitoring documentation [here.]({{}}/rancher/v2.6/en/monitoring-alerting/) # Istio @@ -49,13 +49,13 @@ For more information, refer to the monitoring documentation [here.]({{} Rancher's integration with Istio was improved in Rancher v2.5. -For more information, refer to the Istio documentation [here.]({{}}/rancher/v2.5/en/istio) +For more information, refer to the Istio documentation [here.]({{}}/rancher/v2.6/en/istio) # OPA Gatekeeper -[OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.]({{}}/rancher/v2.5/en/opa-gatekeper) +[OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.]({{}}/rancher/v2.6/en/opa-gatekeper) # CIS Scans Rancher can run a security scan to check whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark. -For more information, refer to the CIS scan documentation [here.]({{}}/rancher/v2.5/en/cis-scans) \ No newline at end of file +For more information, refer to the CIS scan documentation [here.]({{}}/rancher/v2.6/en/cis-scans) \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/_index.md b/content/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/_index.md index 3c89e2a612d..4598263f927 100644 --- a/content/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/_index.md @@ -47,8 +47,8 @@ The restore operation will work on a cluster that is not in a healthy or active > **Prerequisites:** > -> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) and [Registered K3s Kubernetes clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/#additional-features-for-registered-k3s-clusters) -> - Before upgrading Kubernetes, [back up your cluster.]({{}}/rancher/v2.5/en/backups) +> - The options below are available only for [Rancher-launched RKE Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) and [Registered K3s Kubernetes clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/#additional-features-for-registered-k3s-clusters) +> - Before upgrading Kubernetes, [back up your cluster.]({{}}/rancher/v2.6/en/backups) 1. From the **Global** view, find the cluster for which you want to upgrade Kubernetes. Select **⋮ > Edit**. @@ -64,8 +64,8 @@ The restore operation will work on a cluster that is not in a healthy or active A cluster can be restored to a backup in which the previous Kubernetes version was used. For more information, refer to the following sections: -- [Backing up a cluster]({{}}/rancher/v2.5/en/cluster-admin/backing-up-etcd/#how-snapshots-work) -- [Restoring a cluster from backup]({{}}/rancher/v2.5/en/cluster-admin/restoring-etcd/#restoring-a-cluster-from-a-snapshot) +- [Backing up a cluster]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/#how-snapshots-work) +- [Restoring a cluster from backup]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/#restoring-a-cluster-from-a-snapshot) # Configuring the Upgrade Strategy @@ -97,7 +97,7 @@ To enable draining each node during a cluster upgrade, 1. Go to the cluster view in the Rancher UI. 1. Click **⋮ > Edit.** 1. In the **Advanced Options** section, go to the **Drain nodes** field and click **Yes.** -1. Choose a safe or aggressive drain option. For more information about each option, refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/nodes/#aggressive-and-safe-draining-options) +1. Choose a safe or aggressive drain option. For more information about each option, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/nodes/#aggressive-and-safe-draining-options) 1. Optionally, configure a grace period. The grace period is the timeout given to each pod for cleaning things up, so they will have chance to exit gracefully. Pods might need to finish any outstanding requests, roll back transactions or save state to some external storage. If this value is negative, the default value specified in the pod will be used. 1. Optionally, configure a timeout, which is the amount of time the drain should continue to wait before giving up. 1. Click **Save.** diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/_index.md index ad6328fbaac..c0eb2db49eb 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/_index.md @@ -3,8 +3,8 @@ title: "Kubernetes Persistent Storage: Volumes and Storage Classes" description: "Learn about the two ways with which you can create persistent storage in Kubernetes: persistent volumes and storage classes" weight: 2031 aliases: - - /rancher/v2.5/en/tasks/clusters/adding-storage/ - - /rancher/v2.5/en/cluster-admin/volumes-and-storage/persistent-volume-claims/ + - /rancher/v2.6/en/tasks/clusters/adding-storage/ + - /rancher/v2.6/en/cluster-admin/volumes-and-storage/persistent-volume-claims/ --- When deploying an application that needs to retain data, you'll need to create persistent storage. Persistent storage allows you to store application data external from the pod running your application. This storage practice allows you to maintain application data, even if the application's pod fails. @@ -12,11 +12,11 @@ The documents in this section assume that you understand the Kubernetes concepts ### Prerequisites -To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. +To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. -For provisioning new storage with Rancher, the cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) +For provisioning new storage with Rancher, the cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) For attaching existing persistent storage to a cluster, the cloud provider does not need to be enabled. @@ -49,7 +49,7 @@ Longhorn is free, open source software. Originally developed by Rancher Labs, it If you have a pool of block storage, Longhorn can help you provide persistent storage to your Kubernetes cluster without relying on cloud providers. For more information about Longhorn features, refer to the [documentation.](https://longhorn.io/docs/1.0.2/what-is-longhorn/) -Rancher v2.5 simplified the process of installing Longhorn on a Rancher-managed cluster. For more information, see [this page.]({{}}/rancher/v2.5/en/longhorn) +Rancher v2.5 simplified the process of installing Longhorn on a Rancher-managed cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) ### Provisioning Storage Examples @@ -61,7 +61,7 @@ In clusters that store data on GlusterFS volumes, you may experience an issue wh ### iSCSI Volumes -In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. For details on resolving this issue, refer to [this page.](./iscsi-volumes) +In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. For details on resolving this issue, refer to [this page.](./iscsi-volumes) ### hostPath Volumes Before you create a hostPath volume, you need to set up an [extra_bind]({{}}/rke/latest/en/config-options/services/services-extras/#extra-binds/) in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads. @@ -70,7 +70,7 @@ Before you create a hostPath volume, you need to set up an [extra_bind]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree) +For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree) ### Related Links diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md index 4d1ebf61624..9064c6a69c4 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/_index.md @@ -2,7 +2,7 @@ title: Setting up Existing Storage weight: 1 aliases: - - /rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/ + - /rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/ --- This section describes how to set up existing persistent storage for workloads in Rancher. @@ -18,7 +18,7 @@ To set up storage, follow these steps: ### Prerequisites -- To create a persistent volume as a Kubernetes resource, you must have the `Manage Volumes` [role.]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) +- To create a persistent volume as a Kubernetes resource, you must have the `Manage Volumes` [role.]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) - If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. ### 1. Set up persistent storage @@ -27,7 +27,7 @@ Creating a persistent volume in Rancher will not create a storage volume. It onl The steps to set up a persistent storage device will differ based on your infrastructure. We provide examples of how to set up storage using [vSphere,](../examples/vsphere) [NFS,](../examples/nfs) or Amazon's [EBS.](../examples/ebs) -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.5/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) ### 2. Add a persistent volume that refers to the persistent storage diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/_index.md index 339efbf1244..d31092a4881 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/_index.md @@ -2,8 +2,8 @@ title: Provisioning Storage Examples weight: 3053 aliases: - - /rancher/v2.5/en/tasks/clusters/adding-storage/provisioning-storage/ - - /rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/examples/ + - /rancher/v2.6/en/tasks/clusters/adding-storage/provisioning-storage/ + - /rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/examples/ --- Rancher supports persistent storage with a variety of volume plugins. However, before you use any of these plugins to bind persistent storage to your workloads, you have to configure the storage itself, whether its a cloud-based solution from a service-provider or an on-prem solution that you manage yourself. diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/ebs/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/ebs/_index.md index 22ecb6d7258..8a25fb77c00 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/ebs/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/ebs/_index.md @@ -13,4 +13,4 @@ This section describes how to set up Amazon's Elastic Block Store in EC2. **Result:** Persistent storage has been created. -For details on how to set up the newly created storage in Rancher, refer to the section on [setting up existing storage.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/attaching-existing-storage/) \ No newline at end of file +For details on how to set up the newly created storage in Rancher, refer to the section on [setting up existing storage.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/attaching-existing-storage/) \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/nfs/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/nfs/_index.md index 608b5f56979..b64012d1b31 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/nfs/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/nfs/_index.md @@ -2,14 +2,14 @@ title: NFS Storage weight: 3054 aliases: - - /rancher/v2.5/en/tasks/clusters/adding-storage/provisioning-storage/nfs/ + - /rancher/v2.6/en/tasks/clusters/adding-storage/provisioning-storage/nfs/ --- Before you can use the NFS storage volume plug-in with Rancher deployments, you need to provision an NFS server. >**Note:** > ->- If you already have an NFS share, you don't need to provision a new NFS server to use the NFS volume plugin within Rancher. Instead, skip the rest of this procedure and complete [adding storage]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/). +>- If you already have an NFS share, you don't need to provision a new NFS server to use the NFS volume plugin within Rancher. Instead, skip the rest of this procedure and complete [adding storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/). > >- This procedure demonstrates how to set up an NFS server using Ubuntu, although you should be able to use these instructions for other Linux distros (e.g. Debian, RHEL, Arch Linux, etc.). For official instruction on how to create an NFS server using another Linux distro, consult the distro's documentation. diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere/_index.md index cf7375dc2ad..81a4d0689b0 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere/_index.md @@ -2,12 +2,12 @@ title: vSphere Storage weight: 3055 aliases: - - /rancher/v2.5/en/tasks/clusters/adding-storage/provisioning-storage/vsphere/ + - /rancher/v2.6/en/tasks/clusters/adding-storage/provisioning-storage/vsphere/ --- -To provide stateful workloads with vSphere storage, we recommend creating a vSphereVolume StorageClass. This practice dynamically provisions vSphere storage when workloads request volumes through a [persistent volume claim]({{}}/rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/). +To provide stateful workloads with vSphere storage, we recommend creating a vSphereVolume StorageClass. This practice dynamically provisions vSphere storage when workloads request volumes through a [persistent volume claim]({{}}/rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/). -In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) - [Prerequisites](#prerequisites) - [Creating a StorageClass](#creating-a-storageclass) @@ -17,7 +17,7 @@ In order to dynamically provision storage in vSphere, the vSphere provider must ### Prerequisites -In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)]({{< baseurl>}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/), the [vSphere cloud provider]({{}}/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/). +In order to provision vSphere volumes in a cluster created with the [Rancher Kubernetes Engine (RKE)]({{< baseurl>}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/), the [vSphere cloud provider]({{}}/rke/latest/en/config-options/cloud-providers/vsphere) must be explicitly enabled in the [cluster options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/). ### Creating a StorageClass @@ -37,7 +37,7 @@ In order to provision vSphere volumes in a cluster created with the [Rancher Kub ### Creating a Workload with a vSphere Volume -1. From the cluster where you configured vSphere storage, begin creating a workload as you would in [Deploying Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/). +1. From the cluster where you configured vSphere storage, begin creating a workload as you would in [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). 2. For **Workload Type**, select **Stateful set of 1 pod**. 3. Expand the **Volumes** section and click **Add Volume**. 4. Choose **Add a new persistent volume (claim)**. This option will implicitly create the claim once you deploy the workload. diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/glusterfs-volumes/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/glusterfs-volumes/_index.md index da7b3889dcc..eaf2386d9fa 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/glusterfs-volumes/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/glusterfs-volumes/_index.md @@ -3,7 +3,7 @@ title: GlusterFS Volumes weight: 5000 --- -> This section only applies to [RKE clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) +> This section only applies to [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) In clusters that store data on GlusterFS volumes, you may experience an issue where pods fail to mount volumes after restarting the `kubelet`. The logging of the `kubelet` will show: `transport endpoint is not connected`. To prevent this from happening, you can configure your cluster to mount the `systemd-run` binary in the `kubelet` container. There are two requirements before you can change the cluster configuration: diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/_index.md index 64b19969863..634d5509d5f 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/_index.md @@ -2,7 +2,7 @@ title: How Persistent Storage Works weight: 1 aliases: - - /rancher/v2.5/en/tasks/workloads/add-persistent-volume-claim + - /rancher/v2.6/en/tasks/workloads/add-persistent-volume-claim --- A persistent volume (PV) is a piece of storage in the Kubernetes cluster, while a persistent volume claim (PVC) is a request for storage. diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/iscsi-volumes/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/iscsi-volumes/_index.md index 154ac03dd04..01d87aabd59 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/iscsi-volumes/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/iscsi-volumes/_index.md @@ -3,7 +3,7 @@ title: iSCSI Volumes weight: 6000 --- -In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes. +In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) that store data on iSCSI volumes, you may experience an issue where kubelets fail to automatically connect with iSCSI volumes. This failure is likely due to an incompatibility issue involving the iSCSI initiator tool. You can resolve this issue by installing the iSCSI initiator tool on each of your cluster nodes. Rancher Launched Kubernetes clusters storing data on iSCSI volumes leverage the [iSCSI initiator tool](http://www.open-iscsi.com/), which is embedded in the kubelet's `rancher/hyperkube` Docker image. From each kubelet (i.e., the _initiator_), the tool discovers and launches sessions with an iSCSI volume (i.e., the _target_). However, in some instances, the versions of the iSCSI initiator tool installed on the initiator and the target may not match, resulting in a connection failure. diff --git a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md index 54370f020b2..de6b5d0711c 100644 --- a/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md +++ b/content/rancher/v2.6/en/cluster-admin/volumes-and-storage/provisioning-new-storage/_index.md @@ -9,7 +9,7 @@ This section assumes that you understand the Kubernetes concepts of storage clas New storage is often provisioned by a cloud provider such as Amazon EBS. However, new storage doesn't have to be in the cloud. -If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.5/en/longhorn) +If you have a pool of block storage, and you don't want to use a cloud provider, Longhorn could help you provide persistent storage to your Kubernetes cluster. For more information, see [this page.]({{}}/rancher/v2.6/en/longhorn) To provision new storage for your workloads, follow these steps: @@ -19,9 +19,9 @@ To provision new storage for your workloads, follow these steps: ### Prerequisites -- To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. +- To set up persistent storage, the `Manage Volumes` [role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-role-reference) is required. - If you are provisioning storage for a cluster hosted in the cloud, the storage and cluster hosts must have the same cloud provider. -- The cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) +- The cloud provider must be enabled. For details on enabling cloud providers, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) - Make sure your storage provisioner is available to be enabled. The following storage provisioners are enabled by default: @@ -38,7 +38,7 @@ Local | `local` Network File System | `nfs` hostPath | `host-path` -To use a storage provisioner that is not on the above list, you will need to use a [feature flag to enable unsupported storage drivers.]({{}}/rancher/v2.5/en/installation/options/feature-flags/enable-not-default-storage-drivers/) +To use a storage provisioner that is not on the above list, you will need to use a [feature flag to enable unsupported storage drivers.]({{}}/rancher/v2.6/en/installation/options/feature-flags/enable-not-default-storage-drivers/) ### 1. Add a storage class and configure it to use your storage @@ -92,7 +92,7 @@ You can mount PVCs during the deployment of a workload, or following workload cr To attach the PVC to a new workload, -1. Create a workload as you would in [Deploying Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/). +1. Create a workload as you would in [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). 1. For **Workload Type**, select **Stateful set of 1 pod**. 1. Expand the **Volumes** section and click **Add Volume > Add a New Persistent Volume (Claim).** 1. In the **Persistent Volume Claim** section, select the newly created persistent volume claim that is attached to the storage class. diff --git a/content/rancher/v2.6/en/cluster-provisioning/_index.md b/content/rancher/v2.6/en/cluster-provisioning/_index.md index 3be9c2d0505..40e504a7ac8 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/_index.md @@ -3,16 +3,16 @@ title: Setting up Kubernetes Clusters in Rancher description: Provisioning Kubernetes Clusters weight: 7 aliases: - - /rancher/v2.5/en/concepts/clusters/ - - /rancher/v2.5/en/concepts/clusters/cluster-providers/ - - /rancher/v2.5/en/tasks/clusters/ + - /rancher/v2.6/en/concepts/clusters/ + - /rancher/v2.6/en/concepts/clusters/cluster-providers/ + - /rancher/v2.6/en/tasks/clusters/ --- Rancher simplifies the creation of clusters by allowing you to create them through the Rancher UI rather than more complex alternatives. Rancher provides multiple options for launching a cluster. Use the option that best fits your use case. -This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.5/en/overview/concepts) page. +This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. -For a conceptual overview of how the Rancher server provisions clusters and what tools it uses to provision them, refer to the [architecture]({{}}/rancher/v2.5/en/overview/architecture/) page. +For a conceptual overview of how the Rancher server provisions clusters and what tools it uses to provision them, refer to the [architecture]({{}}/rancher/v2.6/en/overview/architecture/) page. This section covers the following topics: @@ -32,7 +32,7 @@ This section covers the following topics: The following table summarizes the options and settings available for each cluster type: -{{% include file="/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table" %}} +{{% include file="/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table" %}} # Setting up Clusters in a Hosted Kubernetes Provider @@ -40,7 +40,7 @@ In this scenario, Rancher does not provision Kubernetes because it is installed If you use a Kubernetes provider such as Google GKE, Rancher integrates with its cloud APIs, allowing you to create and manage role-based access control for the hosted cluster from the Rancher UI. -For more information, refer to the section on [hosted Kubernetes clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters) +For more information, refer to the section on [hosted Kubernetes clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters) # Launching Kubernetes with Rancher @@ -52,23 +52,23 @@ These nodes can be dynamically provisioned through Rancher's UI, which calls [Do If you already have a node that you want to add to an RKE cluster, you can add it to the cluster by running a Rancher agent container on it. -For more information, refer to the section on [RKE clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) +For more information, refer to the section on [RKE clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) ### Launching Kubernetes and Provisioning Nodes in an Infrastructure Provider Rancher can dynamically provision nodes in infrastructure providers such as Amazon EC2, DigitalOcean, Azure, or vSphere, then install Kubernetes on them. -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This template defines the parameters used to launch nodes in your cloud providers. +Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This template defines the parameters used to launch nodes in your cloud providers. One benefit of using nodes hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically replace it, thus maintaining the expected cluster configuration. -The cloud providers available for creating a node template are decided based on the [node drivers]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers) active in the Rancher UI. +The cloud providers available for creating a node template are decided based on the [node drivers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers) active in the Rancher UI. -For more information, refer to the section on [nodes hosted by an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) +For more information, refer to the section on [nodes hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) ### Launching Kubernetes on Existing Custom Nodes -When setting up this type of cluster, Rancher installs Kubernetes on existing [custom nodes,]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/) which creates a custom cluster. +When setting up this type of cluster, Rancher installs Kubernetes on existing [custom nodes,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) which creates a custom cluster. You can bring any nodes you want to Rancher and use them to create a cluster. diff --git a/content/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table/index.md b/content/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table/index.md index 469dd74318a..c123229be0c 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table/index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table/index.md @@ -4,25 +4,25 @@ headless: true | Action | Rancher Launched Kubernetes Clusters | EKS and GKE Clusters* | Other Hosted Kubernetes Clusters | Non-EKS or GKE Registered Clusters | | --- | --- | ---| ---|----| -| [Using kubectl and a kubeconfig file to Access a Cluster]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/) | ✓ | ✓ | ✓ | ✓ | -| [Managing Cluster Members]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/cluster-members/) | ✓ | ✓ | ✓ | ✓ | -| [Editing and Upgrading Clusters]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) | ✓ | ✓ | ✓ | ** | -| [Managing Nodes]({{}}/rancher/v2.5/en/cluster-admin/nodes) | ✓ | ✓ | ✓ | ✓ *** | -| [Managing Persistent Volumes and Storage Classes]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/) | ✓ | ✓ | ✓ | ✓ | -| [Managing Projects, Namespaces and Workloads]({{}}/rancher/v2.5/en/cluster-admin/projects-and-namespaces/) | ✓ | ✓ | ✓ | ✓ | -| [Using App Catalogs]({{}}/rancher/v2.5/en/catalog/) | ✓ | ✓ | ✓ | ✓ | -| [Configuring Tools (Alerts, Notifiers, Logging, Monitoring, Istio)]({{}}/rancher/v2.5/en/cluster-admin/tools/) | ✓ | ✓ | ✓ | ✓ | -| [Running Security Scans]({{}}/rancher/v2.5/en/security/security-scan/) | ✓ | ✓ | ✓ | ✓ | -| [Cloning Clusters]({{}}/rancher/v2.5/en/cluster-admin/cloning-clusters/)| ✓ | ✓ |✓ | | -| [Ability to rotate certificates]({{}}/rancher/v2.5/en/cluster-admin/certificate-rotation/) | ✓ | ✓ | | | -| [Ability to back up your Kubernetes Clusters]({{}}/rancher/v2.5/en/cluster-admin/backing-up-etcd/) | ✓ | ✓ | | | -| [Ability to recover and restore etcd]({{}}/rancher/v2.5/en/cluster-admin/restoring-etcd/) | ✓ | ✓ | | | -| [Cleaning Kubernetes components when clusters are no longer reachable from Rancher]({{}}/rancher/v2.5/en/cluster-admin/cleaning-cluster-nodes/) | ✓ | | | | -| [Configuring Pod Security Policies]({{}}/rancher/v2.5/en/cluster-admin/pod-security-policy/) | ✓ | ✓ | || +| [Using kubectl and a kubeconfig file to Access a Cluster]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) | ✓ | ✓ | ✓ | ✓ | +| [Managing Cluster Members]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/cluster-members/) | ✓ | ✓ | ✓ | ✓ | +| [Editing and Upgrading Clusters]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) | ✓ | ✓ | ✓ | ** | +| [Managing Nodes]({{}}/rancher/v2.6/en/cluster-admin/nodes) | ✓ | ✓ | ✓ | ✓ *** | +| [Managing Persistent Volumes and Storage Classes]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) | ✓ | ✓ | ✓ | ✓ | +| [Managing Projects, Namespaces and Workloads]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/) | ✓ | ✓ | ✓ | ✓ | +| [Using App Catalogs]({{}}/rancher/v2.6/en/catalog/) | ✓ | ✓ | ✓ | ✓ | +| [Configuring Tools (Alerts, Notifiers, Logging, Monitoring, Istio)]({{}}/rancher/v2.6/en/cluster-admin/tools/) | ✓ | ✓ | ✓ | ✓ | +| [Running Security Scans]({{}}/rancher/v2.6/en/security/security-scan/) | ✓ | ✓ | ✓ | ✓ | +| [Cloning Clusters]({{}}/rancher/v2.6/en/cluster-admin/cloning-clusters/)| ✓ | ✓ |✓ | | +| [Ability to rotate certificates]({{}}/rancher/v2.6/en/cluster-admin/certificate-rotation/) | ✓ | ✓ | | | +| [Ability to back up your Kubernetes Clusters]({{}}/rancher/v2.6/en/cluster-admin/backing-up-etcd/) | ✓ | ✓ | | | +| [Ability to recover and restore etcd]({{}}/rancher/v2.6/en/cluster-admin/restoring-etcd/) | ✓ | ✓ | | | +| [Cleaning Kubernetes components when clusters are no longer reachable from Rancher]({{}}/rancher/v2.6/en/cluster-admin/cleaning-cluster-nodes/) | ✓ | | | | +| [Configuring Pod Security Policies]({{}}/rancher/v2.6/en/cluster-admin/pod-security-policy/) | ✓ | ✓ | || -\* Registered GKE and EKS clusters have the same options available as GKE and EKS clusters created from the Rancher UI. The difference is that when a registered cluster is deleted from the Rancher UI, [it is not destroyed.]({{}}/rancher/v2.5/en/cluster-provisioning/registered-clusters/#additional-features-for-registered-eks-and-gke-clusters) +\* Registered GKE and EKS clusters have the same options available as GKE and EKS clusters created from the Rancher UI. The difference is that when a registered cluster is deleted from the Rancher UI, [it is not destroyed.]({{}}/rancher/v2.6/en/cluster-provisioning/registered-clusters/#additional-features-for-registered-eks-and-gke-clusters) -\* \* Cluster configuration options can't be edited for imported clusters, except for [K3s and RKE2 clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/imported-clusters/) +\* \* Cluster configuration options can't be edited for imported clusters, except for [K3s and RKE2 clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/imported-clusters/) \* \* \* For registered cluster nodes, the Rancher UI exposes the ability to cordon drain, and edit the node. diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/_index.md index 2b196bcea8f..32bb6ee82cd 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/_index.md @@ -22,9 +22,9 @@ Rancher supports the following Kubernetes providers: When using Rancher to create a cluster hosted by a provider, you are prompted for authentication information. This information is required to access the provider's API. For more information on how to obtain this information, see the following procedures: -- [Creating a GKE Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke) -- [Creating an EKS Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/eks) -- [Creating an AKS Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/aks) -- [Creating an ACK Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/ack) -- [Creating a TKE Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/tke) -- [Creating a CCE Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/cce) +- [Creating a GKE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke) +- [Creating an EKS Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks) +- [Creating an AKS Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks) +- [Creating an ACK Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack) +- [Creating a TKE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke) +- [Creating a CCE Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce) diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/_index.md index fd4051e7506..5f576700929 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/ack/_index.md @@ -4,7 +4,7 @@ shortTitle: Alibaba Cloud Container Service for Kubernetes weight: 2120 --- -You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/) for ACK, but by default, this cluster driver is `inactive`. In order to launch ACK clusters, you will need to [enable the ACK cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning ACK clusters. +You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for ACK, but by default, this cluster driver is `inactive`. In order to launch ACK clusters, you will need to [enable the ACK cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning ACK clusters. ## Prerequisites diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/_index.md index 1ea81aa7971..0d20d5f62b3 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/aks/_index.md @@ -3,7 +3,7 @@ title: Creating an AKS Cluster shortTitle: Azure Kubernetes Service weight: 2115 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-azure-container-service/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-azure-container-service/ --- You can use Rancher to create a cluster hosted in Microsoft Azure Kubernetes Service (AKS). diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/_index.md index 1ef8a38397a..fa51c2a2624 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/cce/_index.md @@ -4,7 +4,7 @@ shortTitle: Huawei Cloud Kubernetes Service weight: 2130 --- -You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/) for CCE, but by default, this cluster driver is `inactive`. In order to launch CCE clusters, you will need to [enable the CCE cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning CCE clusters. +You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for CCE, but by default, this cluster driver is `inactive`. In order to launch CCE clusters, you will need to [enable the CCE cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning CCE clusters. ## Prerequisites in Huawei @@ -57,7 +57,7 @@ You can access your cluster after its state is updated to **Active.** | Cluster Label | The labels for the cluster. | | Highway Subnet | This option is only supported in `BareMetal` type. It requires you to select a VPC with high network speed for the bare metal machines. | -**Note:** If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) +**Note:** If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) # Node Configuration diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/_index.md index f47bb016f57..6846ea0f7ac 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/_index.md @@ -3,7 +3,7 @@ title: Creating an EKS Cluster shortTitle: Amazon EKS weight: 2110 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-eks/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-eks/ --- Amazon EKS provides a managed control plane for your Kubernetes cluster. Amazon EKS runs the Kubernetes control plane instances across multiple Availability Zones to ensure high availability. Rancher provides an intuitive user interface for managing and deploying the Kubernetes clusters you run in Amazon EKS. With this guide, you will use Rancher to quickly and easily launch an Amazon EKS Kubernetes cluster in your AWS account. For more information on Amazon EKS, see this [documentation](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html). @@ -74,7 +74,7 @@ You can access your cluster after its state is updated to **Active.** # EKS Cluster Configuration Reference -For the full list of EKS cluster configuration options, see [this page.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/eks-config-reference) +For the full list of EKS cluster configuration options, see [this page.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/eks-config-reference) # Architecture @@ -104,9 +104,9 @@ See [this page](./permissions) for the minimum set of permissions necessary to u # Syncing -The EKS provisioner can synchronize the state of an EKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/syncing/) +The EKS provisioner can synchronize the state of an EKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/syncing/) -For information on configuring the refresh interval, refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/eks-config-reference/#configuring-the-refresh-interval) +For information on configuring the refresh interval, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/eks-config-reference/#configuring-the-refresh-interval) # Troubleshooting diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/_index.md index 6e3d2d0bfc3..e7b25e9dc24 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke/_index.md @@ -3,8 +3,8 @@ title: Managing GKE Clusters shortTitle: Google Kubernetes Engine weight: 2105 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-gke/ - - /rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/gke + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-gke/ + - /rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/gke --- - [Prerequisites](#prerequisites) @@ -82,11 +82,11 @@ You can access your cluster after its state is updated to **Active.** # Private Clusters -Private GKE clusters are supported. Note: This advanced setup can require more steps during the cluster provisioning process. For details, see [this section.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/) +Private GKE clusters are supported. Note: This advanced setup can require more steps during the cluster provisioning process. For details, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/private-clusters/) # Configuration Reference -For details on configuring GKE clusters in Rancher, see [this page.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/gke-config-reference) +For details on configuring GKE clusters in Rancher, see [this page.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference) # Updating Kubernetes Version The Kubernetes version of a cluster can be upgraded to any version available in the region or zone fo the GKE cluster. Upgrading the master Kubernetes version does not automatically upgrade worker nodes. Nodes can be upgraded independently. @@ -96,7 +96,7 @@ The Kubernetes version of a cluster can be upgraded to any version available in # Syncing -The GKE provisioner can synchronize the state of a GKE cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/syncing) +The GKE provisioner can synchronize the state of a GKE cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see [Syncing.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/syncing) -For information on configuring the refresh interval, see [this section.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/gke-config-reference/#configuring-the-refresh-interval) +For information on configuring the refresh interval, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/gke-config-reference/#configuring-the-refresh-interval) diff --git a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/_index.md b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/_index.md index 2420cb57d85..43c5ec61633 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/tke/_index.md @@ -4,7 +4,7 @@ shortTitle: Tencent Kubernetes Engine weight: 2125 --- -You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/) for TKE, but by default, this cluster driver is `inactive`. In order to launch TKE clusters, you will need to [enable the TKE cluster driver]({{}}/rancher/v2.5/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning TKE clusters. +You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the [cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/) for TKE, but by default, this cluster driver is `inactive`. In order to launch TKE clusters, you will need to [enable the TKE cluster driver]({{}}/rancher/v2.6/en/admin-settings/drivers/cluster-drivers/#activating-deactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning TKE clusters. ## Prerequisites in Tencent @@ -46,7 +46,7 @@ You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE | VPC | Select the VPC name that you have created in the Tencent Cloud Console. | | Container Network CIDR | Enter the CIDR range of your Kubernetes cluster, you may check the available range of the CIDR in the VPC service of the Tencent Cloud Console. Default to 172.16.0.0/16. | - **Note:** If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that, cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) + **Note:** If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that, cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#config-file-structure-in-rancher-v2-3-0) 7. Click `Next: Select Instance Type` to choose the instance type that will use for your TKE cluster. diff --git a/content/rancher/v2.6/en/cluster-provisioning/node-requirements/_index.md b/content/rancher/v2.6/en/cluster-provisioning/node-requirements/_index.md index 1ab8a565fcf..f8d03ebc979 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/node-requirements/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/node-requirements/_index.md @@ -5,7 +5,7 @@ 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 cluster (or single node) running Rancher. -> If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server cluster and downstream clusters have different requirements. For Rancher installation requirements, refer to the node requirements in the [installation section.]({{}}/rancher/v2.5/en/installation/requirements/) +> If Rancher is installed on a high-availability Kubernetes cluster, the Rancher server 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: @@ -22,7 +22,7 @@ For details on which OS and Docker versions were tested with each Rancher versio All supported operating systems are 64-bit x86. -If you plan to use ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.5/en/installation/options/arm64-platform/) +If you plan to use ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.6/en/installation/options/arm64-platform/) For information on how to install Docker, refer to the official [Docker documentation.](https://docs.docker.com/) @@ -32,11 +32,11 @@ Some distributions of Linux derived from RHEL, including Oracle Linux, may have ### SUSE Linux Nodes -SUSE Linux may have a firewall that blocks all ports by default. In that situation, follow [these steps]({{}}/rancher/v2.5/en/installation/requirements/ports/#opening-suse-linux-ports) to open the ports needed for adding a host to a custom cluster. +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. ### Flatcar Container Linux Nodes -When [Launching Kubernetes with Rancher]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) using Flatcar Container Linux nodes, it is required to use the following configuration in the [Cluster Config File]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) +When [Launching Kubernetes with Rancher]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) using Flatcar Container Linux nodes, it is required to use the following configuration in the [Cluster Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) {{% tabs %}} {{% tab "Canal"%}} @@ -80,13 +80,13 @@ It is also required to enable the Docker service, you can enable the Docker serv systemctl enable docker.service ``` -The Docker service is enabled automatically when using [Node Drivers]({{}}/rancher/v2.5/en/admin-settings/drivers/#node-drivers). +The Docker service is enabled automatically when using [Node Drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/#node-drivers). ### Windows Nodes Nodes with Windows Server must run Docker Enterprise Edition. -Windows nodes can be used for worker nodes only. See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/) +Windows nodes can be used for worker nodes only. See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) # Hardware Requirements @@ -102,14 +102,14 @@ For hardware recommendations for etcd clusters in production, refer to the offic For a production cluster, we recommend that you restrict traffic by opening only the ports defined in the port requirements below. -The ports required to be open are different depending on how the user cluster is launched. Each of the sections below list the ports that need to be opened for different [cluster creation options]({{}}/rancher/v2.5/en/cluster-provisioning/). +The ports required to be open are different depending on how the user cluster is launched. Each of the sections below list the ports that need to be opened for different [cluster creation options]({{}}/rancher/v2.6/en/cluster-provisioning/). For a breakdown of the port requirements for etcd nodes, controlplane nodes, and worker nodes in a Kubernetes cluster, refer to the [port requirements for the Rancher Kubernetes Engine.]({{}}/rke/latest/en/os/#ports) -Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.5/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). +Details on which ports are used in each situation are found under [Downstream Cluster Port Requirements]({{}}/rancher/v2.6/en/installation/requirements/ports#downstream-kubernetes-cluster-nodes). # Optional: Security Considerations If you want to provision a Kubernetes cluster that is compliant with the CIS (Center for Internet Security) Kubernetes Benchmark, we recommend to following our hardening guide to configure your nodes before installing Kubernetes. -For more information on the hardening guide and details on which version of the guide corresponds to your Rancher and Kubernetes versions, refer to the [security section.]({{}}/rancher/v2.5/en/security/#rancher-hardening-guide) +For more information on the hardening guide and details on which version of the guide corresponds to your Rancher and Kubernetes versions, refer to the [security section.]({{}}/rancher/v2.6/en/security/#rancher-hardening-guide) diff --git a/content/rancher/v2.6/en/cluster-provisioning/production/_index.md b/content/rancher/v2.6/en/cluster-provisioning/production/_index.md index 040e59b5563..53a6f83f09d 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/production/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/production/_index.md @@ -5,15 +5,15 @@ weight: 2 In this section, we recommend best practices for creating the production-ready Kubernetes clusters that will run your apps and services. -For a list of requirements for your cluster, including the requirements for OS/Docker, hardware, and networking, refer to the section on [node requirements.]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements) +For a list of requirements for your cluster, including the requirements for OS/Docker, hardware, and networking, refer to the section on [node requirements.]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) This is a shortlist of best practices that we strongly recommend for all production clusters. -For a full list of all the best practices that we recommend, refer to the [best practices section.]({{}}/rancher/v2.5/en/best-practices) +For a full list of all the best practices that we recommend, refer to the [best practices section.]({{}}/rancher/v2.6/en/best-practices) ### Node Requirements -* Make sure your nodes fulfill all of the [node requirements,]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/) including the port requirements. +* Make sure your nodes fulfill all of the [node requirements,]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/) including the port requirements. ### Back up etcd @@ -30,10 +30,10 @@ For a full list of all the best practices that we recommend, refer to the [best * Assign two or more nodes the `controlplane` role for master component high availability. * Assign two or more nodes the `worker` role for workload rescheduling upon node failure. -For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.5/en/cluster-provisioning/production/nodes-and-roles) +For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles) For more information about the -number of nodes for each Kubernetes role, refer to the section on [recommended architecture.]({{}}/rancher/v2.5/en/overview/architecture-recommendations/) +number of nodes for each Kubernetes role, refer to the section on [recommended architecture.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/) ### Logging and Monitoring @@ -47,4 +47,4 @@ number of nodes for each Kubernetes role, refer to the section on [recommended a ### Networking * Minimize network latency. Rancher recommends minimizing latency between the etcd nodes. The default setting for `heartbeat-interval` is `500`, and the default setting for `election-timeout` is `5000`. These [settings for etcd tuning](https://coreos.com/etcd/docs/latest/tuning.html) allow etcd to run in most networks (except really high latency networks). -* Cluster nodes should be located within a single region. Most cloud providers provide multiple availability zones within a region, which can be used to create higher availability for your cluster. Using multiple availability zones is fine for nodes with any role. If you are using [Kubernetes Cloud Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) resources, consult the documentation for any restrictions (i.e. zone storage restrictions). +* Cluster nodes should be located within a single region. Most cloud providers provide multiple availability zones within a region, which can be used to create higher availability for your cluster. Using multiple availability zones is fine for nodes with any role. If you are using [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) resources, consult the documentation for any restrictions (i.e. zone storage restrictions). diff --git a/content/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles/_index.md b/content/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles/_index.md index e4d6979ded6..c073cdb4388 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles/_index.md @@ -5,7 +5,7 @@ weight: 1 This section describes the roles for etcd nodes, controlplane nodes, and worker nodes in Kubernetes, and how the roles work together in a cluster. -This diagram is applicable to Kubernetes clusters [launched with Rancher using RKE.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/). +This diagram is applicable to Kubernetes clusters [launched with Rancher using RKE.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). ![Cluster diagram]({{}}/img/rancher/clusterdiagram.svg)
Lines show the traffic flow between components. Colors are used purely for visual aid diff --git a/content/rancher/v2.6/en/cluster-provisioning/production/recommended-architecture/_index.md b/content/rancher/v2.6/en/cluster-provisioning/production/recommended-architecture/_index.md index 6824da88b5f..f9d4eb5e427 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/production/recommended-architecture/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/production/recommended-architecture/_index.md @@ -9,7 +9,7 @@ There are three roles that can be assigned to nodes: `etcd`, `controlplane` and When designing your cluster(s), you have two options: -* Use dedicated nodes for each role. This ensures resource availability for the components needed for the specified role. It also strictly isolates network traffic between each of the roles according to the [port requirements]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements). +* Use dedicated nodes for each role. This ensures resource availability for the components needed for the specified role. It also strictly isolates network traffic between each of the roles according to the [port requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements). * Assign the `etcd` and `controlplane` roles to the same nodes. These nodes must meet the hardware requirements for both roles. In either case, the `worker` role should not be used or added to nodes with the `etcd` or `controlplane` role. @@ -29,7 +29,7 @@ The cluster should have: - At least two nodes with the role `controlplane` for master component high availability. - At least two nodes with the role `worker` for workload rescheduling upon node failure. -For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.5/en/cluster-provisioning/production/nodes-and-roles) +For more information on what each role is used for, refer to the [section on roles for nodes in Kubernetes.]({{}}/rancher/v2.6/en/cluster-provisioning/production/nodes-and-roles) ### Number of Controlplane Nodes @@ -63,7 +63,7 @@ Adding more than one node with the `worker` role will make sure your workloads c ### Why Production Requirements are Different for the Rancher Cluster and the Clusters Running Your Applications -You may have noticed that our [Kubernetes Install]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) instructions do not meet our definition of a production-ready cluster, as there are no dedicated nodes for the `worker` role. However, for your Rancher installation, this three node cluster is valid, because: +You may have noticed that our [Kubernetes Install]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) instructions do not meet our definition of a production-ready cluster, as there are no dedicated nodes for the `worker` role. However, for your Rancher installation, this three node cluster is valid, because: * It allows one `etcd` node failure. * It maintains multiple instances of the master components by having multiple `controlplane` nodes. diff --git a/content/rancher/v2.6/en/cluster-provisioning/registered-clusters/_index.md b/content/rancher/v2.6/en/cluster-provisioning/registered-clusters/_index.md index 9eb8edcf1ff..576bd2ac818 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/registered-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/registered-clusters/_index.md @@ -2,7 +2,7 @@ title: Registering Existing Clusters weight: 6 aliases: - - /rancher/v2.5/en/cluster-provisioning/imported-clusters + - /rancher/v2.6/en/cluster-provisioning/imported-clusters --- The cluster registration feature replaced the feature to import clusters. @@ -40,7 +40,7 @@ If you are registering a K3s cluster, make sure the `cluster.yml` is readable. I 2. Choose **Register**. 3. Enter a **Cluster Name**. 4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user. -5. For Rancher v2.5.6+, use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. +5. For Rancher v2.5.6+, use **Agent Environment Variables** under **Cluster Options** to set environment variables for [rancher cluster agent]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/). The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables can be set using agent environment variables. 6. Click **Create**. 7. The prerequisite for `cluster-admin` privileges is shown (see **Prerequisites** above), including an example command to fulfil the prerequisite. 8. Copy the `kubectl` command to your clipboard and run it on a node where kubeconfig is configured to point to the cluster you want to import. If you are unsure it is configured correctly, run `kubectl get nodes` to verify before running the command shown in Rancher. @@ -86,11 +86,11 @@ The control that Rancher has to manage a registered cluster depends on the type After registering a cluster, the cluster owner can: -- [Manage cluster access]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/) through role-based access control -- Enable [monitoring, alerts and notifiers]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/) -- Enable [logging]({{}}/rancher/v2.5/en/logging/v2.5/) -- Enable [Istio]({{}}/rancher/v2.5/en/istio/v2.5/) -- Use [pipelines]({{}}/rancher/v2.5/en/project-admin/pipelines/) +- [Manage cluster access]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) through role-based access control +- Enable [monitoring, alerts and notifiers]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/) +- Enable [logging]({{}}/rancher/v2.6/en/logging/v2.5/) +- Enable [Istio]({{}}/rancher/v2.6/en/istio/v2.5/) +- Use [pipelines]({{}}/rancher/v2.6/en/project-admin/pipelines/) - Manage projects and workloads ### Additional Features for Registered K3s Clusters @@ -99,7 +99,7 @@ After registering a cluster, the cluster owner can: When a K3s cluster is registered in Rancher, Rancher will recognize it as K3s. The Rancher UI will expose the features for [all registered clusters,](#features-for-all-registered-clusters) in addition to the following features for editing and upgrading the cluster: -- The ability to [upgrade the K3s version]({{}}/rancher/v2.5/en/cluster-admin/upgrading-kubernetes/) +- The ability to [upgrade the K3s version]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes/) - The ability to configure the maximum number of nodes that will be upgraded concurrently - The ability to see a read-only version of the K3s cluster's configuration arguments and environment variables used to launch each node in the cluster @@ -111,7 +111,7 @@ Amazon EKS clusters and GKE clusters can now be registered in Rancher. For the m When you delete an EKS cluster or GKE cluster that was created in Rancher, the cluster is destroyed. When you delete a cluster that was registered in Rancher, it is disconnected from the Rancher server, but it still exists and you can still access it in the same way you did before it was registered in Rancher. -The capabilities for registered clusters are listed in the table on [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/) +The capabilities for registered clusters are listed in the table on [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/) # Configuring K3s Cluster Upgrades diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/_index.md index 672e8cd9e5b..2b338b88a9f 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/_index.md @@ -15,20 +15,20 @@ RKE clusters include clusters that Rancher launched on Windows nodes or other ex ### Requirements -If you use RKE to set up a cluster, your nodes must meet the [requirements]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements) for nodes in downstream user clusters. +If you use RKE to set up a cluster, your nodes must meet the [requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) for nodes in downstream user clusters. ### Launching Kubernetes on New Nodes in an Infrastructure Provider -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers. +Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers. One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected. -For more information, refer to the section on [launching Kubernetes on new nodes.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) +For more information, refer to the section on [launching Kubernetes on new nodes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) ### Launching Kubernetes on Existing Custom Nodes In this scenario, you want to install Kubernetes on bare-metal servers, on-prem virtual machines, or virtual machines that already exist in a cloud provider. With this option, you will run a Rancher agent Docker container on the machine. -If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.5/en/admin-settings/removing-rancher/rancher-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. +If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.6/en/admin-settings/removing-rancher/rancher-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. -For more information, refer to the section on [custom nodes.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/) +For more information, refer to the section on [custom nodes.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/_index.md index 79e705f929c..51e67db8a88 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/_index.md @@ -2,8 +2,8 @@ title: Setting up Cloud Providers weight: 2300 aliases: - - /rancher/v2.5/en/concepts/clusters/cloud-providers/ - - /rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers + - /rancher/v2.6/en/concepts/clusters/cloud-providers/ + - /rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers --- A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. For more information, refer to the [official Kubernetes documentation on cloud providers.](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/) @@ -22,15 +22,15 @@ The following cloud providers can be enabled: ### Setting up the Amazon Cloud Provider -For details on enabling the Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/amazon) +For details on enabling the Amazon cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon) ### Setting up the Azure Cloud Provider -For details on enabling the Azure cloud provider, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/azure) +For details on enabling the Azure cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/azure) ### Setting up the GCE Cloud Provider -For details on enabling the Google Compute Engine cloud provider, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/gce) +For details on enabling the Google Compute Engine cloud provider, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/gce) ### Setting up the vSphere Cloud Provider diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md index 3549afe1d1b..b8582ef3535 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/amazon/_index.md @@ -22,9 +22,9 @@ All nodes added to the cluster must be able to interact with EC2 so that they ca * The first policy is for the nodes with the `controlplane` role. These nodes have to be able to create/remove EC2 resources. The following IAM policy is an example, please remove any unneeded permissions for your use case. * The second policy is for the nodes with the `etcd` or `worker` role. These nodes only have to be able to retrieve information from EC2. -While creating an [Amazon EC2 cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/), you must fill in the **IAM Instance Profile Name** (not ARN) of the created IAM role when creating the **Node Template**. +While creating an [Amazon EC2 cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/), you must fill in the **IAM Instance Profile Name** (not ARN) of the created IAM role when creating the **Node Template**. -While creating a [Custom cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes), you must manually attach the IAM role to the instance(s). +While creating a [Custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes), you must manually attach the IAM role to the instance(s). IAM Policy for nodes with the `controlplane` role: @@ -133,7 +133,7 @@ The following resources need to tagged with a `ClusterID`: >**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.5/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. +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. Use the following tag: diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md index 419860882dd..f4c812b26fa 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/_index.md @@ -4,13 +4,13 @@ description: To create a cluster with custom nodes, you’ll need to access serv metaDescription: "To create a cluster with custom nodes, you’ll need to access servers in your cluster and provision them according to Rancher requirements" weight: 2225 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-custom/ - - /rancher/v2.5/en/cluster-provisioning/custom-clusters/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-custom/ + - /rancher/v2.6/en/cluster-provisioning/custom-clusters/ --- When you create a custom cluster, Rancher uses RKE (the Rancher Kubernetes Engine) to create a Kubernetes cluster in on-prem bare-metal servers, on-prem virtual machines, or in any node hosted by an infrastructure provider. -To use this option you'll need access to servers you intend to use in your Kubernetes cluster. Provision each server according to the [requirements]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements), which includes some hardware specifications and Docker. After you install Docker on each server, you willl also run the command provided in the Rancher UI on each server to turn each one into a Kubernetes node. +To use this option you'll need access to servers you intend to use in your Kubernetes cluster. Provision each server according to the [requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements), which includes some hardware specifications and Docker. After you install Docker on each server, you willl also run the command provided in the Rancher UI on each server to turn each one into a Kubernetes node. This section describes how to set up a custom cluster. @@ -18,7 +18,7 @@ This section describes how to set up a custom cluster. >**Want to use Windows hosts as Kubernetes workers?** > ->See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/) before you start. +>See [Configuring Custom Clusters for Windows]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/) before you start. @@ -36,9 +36,9 @@ Begin creation of a custom cluster by provisioning a Linux host. Your host can b - An on-prem VM - A bare-metal server -If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.5/en/admin-settings/removing-rancher/rancher-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. +If you want to reuse a node from a previous custom cluster, [clean the node]({{}}/rancher/v2.6/en/admin-settings/removing-rancher/rancher-cluster-nodes/) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail. -Provision the host according to the [installation requirements]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements) and the [checklist for production-ready clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/production) +Provision the host according to the [installation requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements) and the [checklist for production-ready clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/production) ### 2. Create the Custom Cluster @@ -54,18 +54,18 @@ Provision the host according to the [installation requirements]({{}}/ra >**Using Windows nodes as Kubernetes workers?** > - >- See [Enable the Windows Support Option]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/). + >- 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. 6. Click **Next**. -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.5/en/overview/concepts/#roles-for-nodes-in-kubernetes-clusters) +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.5/en/cluster-provisioning/rke-clusters/windows-clusters/). + >- 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.5/en/admin-settings/agent-options/)** 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. +8. **Optional**: Click **[Show advanced options]({{}}/rancher/v2.6/en/admin-settings/agent-options/)** 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. 9. Copy the command displayed on screen to your clipboard. @@ -122,5 +122,5 @@ Key=kubernetes.io/cluster/CLUSTERID, Value=shared After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/_index.md index 2a100a7f684..1792438d7b3 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/_index.md @@ -2,13 +2,13 @@ title: Rancher Agent Options weight: 2500 aliases: - - /rancher/v2.5/en/admin-settings/agent-options/ - - /rancher/v2.5/en/cluster-provisioning/custom-clusters/agent-options + - /rancher/v2.6/en/admin-settings/agent-options/ + - /rancher/v2.6/en/cluster-provisioning/custom-clusters/agent-options --- -Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes) and add the options to the generated `docker run` command when adding a node. +Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) and add the options to the generated `docker run` command when adding a node. -For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.]({{}}/rancher/v2.5/en/overview/architecture/#3-node-agents) +For an overview of how Rancher communicates with downstream clusters using node agents, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#3-node-agents) ## General options diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/_index.md index 52744238b12..6a64b9c0cf0 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/_index.md @@ -2,14 +2,14 @@ title: Launching Kubernetes on New Nodes in an Infrastructure Provider weight: 2205 aliases: - - /rancher/v2.5/en/concepts/global-configuration/node-templates/ + - /rancher/v2.6/en/concepts/global-configuration/node-templates/ --- -Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers. +Using Rancher, you can create pools of nodes based on a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). This node template defines the parameters you want to use to launch nodes in your infrastructure providers or cloud providers. One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected. -The available cloud providers to create a node template are decided based on active [node drivers]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers). +The available cloud providers to create a node template are decided based on active [node drivers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-drivers). This section covers the following topics: @@ -126,8 +126,8 @@ Node templates can use cloud credentials to store credentials for launching node - Multiple node templates can share the same cloud credential to create node pools. If your key is compromised or expired, the cloud credential can be updated in a single place, which allows all node templates that are using it to be updated at once. -After cloud credentials are created, the user can start [managing the cloud credentials that they created]({{}}/rancher/v2.5/en/user-settings/cloud-credentials/). +After cloud credentials are created, the user can start [managing the cloud credentials that they created]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/). # Node Drivers -If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it]({{}}/rancher/v2.5/en/admin-settings/drivers/node-drivers/#activating-deactivating-node-drivers), or you can [add your own custom node driver]({{}}/rancher/v2.5/en/admin-settings/drivers/node-drivers/#adding-custom-node-drivers). +If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/#activating-deactivating-node-drivers), or you can [add your own custom node driver]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/#adding-custom-node-drivers). diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md index 99a61942c22..290120d6742 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/azure/_index.md @@ -3,7 +3,7 @@ title: Creating an Azure Cluster shortTitle: Azure weight: 2220 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-azure/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-azure/ --- In this section, you'll learn how to install an [RKE]({{}}/rke/latest/en/) Kubernetes cluster in Azure through Rancher. @@ -12,7 +12,7 @@ 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. -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.5/en/cluster-provisioning/rke-clusters/options) +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) For more information on configuring Azure node templates, refer to the [Azure node template configuration reference.](./azure-node-template-config) @@ -56,7 +56,7 @@ The creation of this service principal returns three pieces of identification in ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for Azure will allow Rancher to provision new nodes in Azure. Node templates can be reused for other clusters. +Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for Azure will allow Rancher to provision new nodes in Azure. Node templates can be reused for other clusters. 1. In the Rancher UI, click the user profile button in the upper right corner, and click **Node Templates.** 1. Click **Add Template.** @@ -70,8 +70,8 @@ Use Rancher to create a Kubernetes cluster in Azure. 1. Choose **Azure**. 1. Enter a **Cluster Name**. 1. Use **Member Roles** to configure user authorization for the cluster. 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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options) -1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices, see [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools) +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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) 1. Review your options to confirm they're correct. Then click **Create**. **Result:** @@ -89,5 +89,5 @@ You can access your cluster after its state is updated to **Active.** After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md index 61b810178d5..f0773df18cd 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/digital-ocean/_index.md @@ -3,7 +3,7 @@ title: Creating a DigitalOcean Cluster shortTitle: DigitalOcean weight: 2215 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-digital-ocean/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-digital-ocean/ --- In this section, you'll learn how to use Rancher to install an [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes cluster in DigitalOcean. @@ -29,7 +29,7 @@ Then you will create a DigitalOcean cluster in Rancher, and when configuring the ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for DigitalOcean will allow Rancher to provision new nodes in DigitalOcean. Node templates can be reused for other clusters. +Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for DigitalOcean will allow Rancher to provision new nodes in DigitalOcean. Node templates can be reused for other clusters. 1. In the Rancher UI, click the user profile button in the upper right corner, and click **Node Templates.** 1. Click **Add Template.** @@ -41,8 +41,8 @@ Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rk 1. Choose **DigitalOcean**. 1. Enter a **Cluster Name**. 1. Use **Member Roles** to configure user authorization for the cluster. 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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options) -1. Add one or more node pools to your cluster. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools) +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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. Add one or more node pools to your cluster. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) 1. Review your options to confirm they're correct. Then click **Create**. **Result:** @@ -59,5 +59,5 @@ You can access your cluster after its state is updated to **Active.** After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md index 8515bcf6a05..f7b484425c8 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/_index.md @@ -15,7 +15,7 @@ Then you will create an EC2 cluster in Rancher, and when configuring the new clu - **AWS EC2 Access Key and Secret Key** that will be used to create the instances. See [Amazon Documentation: Creating Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) how to create an Access Key and Secret Key. - **IAM Policy created** to add to the user of the Access Key And Secret Key. See [Amazon Documentation: Creating IAM Policies (Console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-start) how to create an IAM policy. See our three example JSON policies below: - [Example IAM Policy](#example-iam-policy) - - [Example IAM Policy with PassRole](#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers) or want to pass an IAM Profile to an instance) + - [Example IAM Policy with PassRole](#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers) or want to pass an IAM Profile to an instance) - [Example IAM Policy to allow encrypted EBS volumes](#example-iam-policy-to-allow-encrypted-ebs-volumes) - **IAM Policy added as Permission** to the user. See [Amazon Documentation: Adding Permissions to a User (Console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) how to attach it to an user. @@ -41,7 +41,7 @@ The steps to create a cluster differ based on your Rancher version. ### 2. Create a node template with your cloud credentials and information from EC2 -Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for EC2 will allow Rancher to provision new nodes in EC2. Node templates can be reused for other clusters. +Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for EC2 will allow Rancher to provision new nodes in EC2. Node templates can be reused for other clusters. 1. In the Rancher UI, click the user profile button in the upper right corner, and click **Node Templates.** 1. Click **Add Template.** @@ -49,14 +49,14 @@ Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rk ### 3. Create a cluster with node pools using the node template -Add one or more node pools to your cluster. For more information about node pools, see [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools) +Add one or more node pools to your cluster. For more information about node pools, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) 1. From the **Clusters** page, click **Add Cluster**. 1. Choose **Amazon EC2**. 1. Enter a **Cluster Name**. -1. Create a node pool for each Kubernetes role. For each node pool, choose a node template that you created. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools) +1. Create a node pool for each Kubernetes role. For each node pool, choose a node template that you created. For more information about node pools, including best practices for assigning Kubernetes roles to them, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) 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.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) to configure the Kubernetes Cloud Provider. For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options) +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/options/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) 1. Click **Create**. **Result:** @@ -73,8 +73,8 @@ You can access your cluster after its state is updated to **Active.** After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. # IAM Policies diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/_index.md index ca30c9abf85..7d52f4f8c07 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/ec2-node-template-config/_index.md @@ -10,7 +10,7 @@ In the **Region** field, select the same region that you used when creating your ### Cloud Credentials -Your AWS account access information, stored in a [cloud credential.]({{}}/rancher/v2.5/en/user-settings/cloud-credentials/) +Your AWS account access information, stored in a [cloud credential.]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/) See [Amazon Documentation: Creating Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) how to create an Access Key and Secret Key. @@ -20,9 +20,9 @@ See [Amazon Documentation: Adding Permissions to a User (Console)](https://docs. See our three example JSON policies: -- [Example IAM Policy]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy) -- [Example IAM Policy with PassRole]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers) or want to pass an IAM Profile to an instance) -- [Example IAM Policy to allow encrypted EBS volumes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-to-allow-encrypted-ebs-volumes) policy to an user. +- [Example IAM Policy]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy) +- [Example IAM Policy with PassRole]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-with-passrole) (needed if you want to use [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers) or want to pass an IAM Profile to an instance) +- [Example IAM Policy to allow encrypted EBS volumes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/#example-iam-policy-to-allow-encrypted-ebs-volumes) policy to an user. ### Authenticate & Configure Nodes @@ -32,13 +32,13 @@ Choose an availability zone and network settings for your cluster. Choose the default security group or configure a security group. -Please refer to [Amazon EC2 security group when using Node Driver]({{}}/rancher/v2.5/en/installation/requirements/ports/#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. +Please refer to [Amazon EC2 security group when using Node Driver]({{}}/rancher/v2.6/en/installation/requirements/ports/#rancher-aws-ec2-security-group) to see what rules are created in the `rancher-nodes` Security Group. ### Instance Options Configure the instances that will be created. Make sure you configure the correct **SSH User** for the configured AMI. It is possible that a selected region does not support the default instance type. In this scenario you must select an instance type that does exist, otherwise an error will occur stating the requested configuration is not supported. -If you need to pass an **IAM Instance Profile Name** (not ARN), for example, when you want to use a [Kubernetes Cloud Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers), you will need an additional permission in your policy. See [Example IAM policy with PassRole](#example-iam-policy-with-passrole) for an example policy. +If you need to pass an **IAM Instance Profile Name** (not ARN), for example, when you want to use a [Kubernetes Cloud Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers), you will need an additional permission in your policy. See [Example IAM policy with PassRole](#example-iam-policy-with-passrole) for an example policy. ### Engine Options diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md index 695503f45af..1ab8011584c 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/_index.md @@ -5,7 +5,7 @@ description: Use Rancher to create a vSphere cluster. It may consist of groups o metaDescription: Use Rancher to create a vSphere cluster. It may consist of groups of VMs with distinct properties which allow for fine-grained control over the sizing of nodes. weight: 2225 aliases: - - /rancher/v2.5/en/tasks/clusters/creating-a-cluster/create-cluster-vsphere/ + - /rancher/v2.6/en/tasks/clusters/creating-a-cluster/create-cluster-vsphere/ --- By using Rancher with vSphere, you can bring cloud operations on-premises. @@ -25,7 +25,7 @@ The vSphere node templates have been updated, allowing you to bring cloud operat ### Self-healing Node Pools -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.5/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. +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. @@ -33,7 +33,7 @@ One of the biggest advantages of provisioning vSphere nodes with Rancher is that Node templates for vSphere have been updated so that when you create a node template with your vSphere credentials, the template is automatically populated with the same options for provisioning VMs that you have access to in the vSphere console. -For the fields to be populated, your setup needs to fulfill the [prerequisites.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/#prerequisites) +For the fields to be populated, your setup needs to fulfill the [prerequisites.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/#prerequisites) ### More Supported Operating Systems @@ -50,10 +50,10 @@ In [this section,](./provisioning-vsphere-clusters) you'll learn how to use Ranc # Provisioning Storage -For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) # Enabling the vSphere Cloud Provider When a cloud provider is set up in Rancher, the Rancher server can automatically provision new infrastructure for the cluster, including new nodes or persistent storage devices. -For details, refer to the section on [enabling the vSphere cloud provider.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) \ No newline at end of file +For details, refer to the section on [enabling the vSphere cloud provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/_index.md index ca459868331..2f7b96e0cfd 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/creating-credentials/_index.md @@ -2,7 +2,7 @@ title: Creating Credentials in the vSphere Console weight: 3 aliases: - - /rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/creating-credentials + - /rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/creating-credentials --- This section describes how to create a vSphere username and password. You will need to provide these vSphere credentials to Rancher, which allows Rancher to provision resources in vSphere. diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/_index.md index 03a33fbc749..df1bb91cc3a 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/_index.md @@ -9,9 +9,9 @@ First, you will set up your vSphere cloud credentials in Rancher. Then you will Then you will create a vSphere 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 RKE Kubernetes on the new nodes, and it will set up each node with the Kubernetes role defined by the node pool. -For details on configuring the vSphere node template, refer to the [vSphere node template configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/node-template-reference/) +For details on configuring the vSphere node template, refer to the [vSphere node template configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/node-template-reference/) -For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options) +For details on configuring RKE Kubernetes clusters in Rancher, refer to the [cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) - [Preparation in vSphere](#preparation-in-vsphere) - [Creating a vSphere Cluster](#creating-a-vsphere-cluster) @@ -26,7 +26,7 @@ The node templates are documented and tested with the vSphere Web Services API v Before proceeding to create a cluster, you must ensure that you have a vSphere user with sufficient permissions. When you set up a node template, the template will need to use these vSphere credentials. -Refer to this [how-to guide]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/creating-credentials) for instructions on how to create a user in vSphere with the required permissions. These steps result in a username and password that you will need to provide to Rancher, which allows Rancher to provision resources in vSphere. +Refer to this [how-to guide]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/creating-credentials) for instructions on how to create a user in vSphere with the required permissions. These steps result in a username and password that you will need to provide to Rancher, which allows Rancher to provision resources in vSphere. ### Network Permissions @@ -36,7 +36,7 @@ It must be ensured that the hosts running the Rancher server are able to establi - To the Host API (port 443/TCP) on all ESXi hosts used to instantiate virtual machines for the clusters (*only required when using the ISO creation method*). - To port 22/TCP and 2376/TCP on the created VMs -See [Node Networking Requirements]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. +See [Node Networking Requirements]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for a detailed list of port requirements applicable for creating nodes on an infrastructure provider. ### Valid ESXi License for vSphere API Access @@ -60,18 +60,18 @@ The a vSphere cluster is created in Rancher depends on the Rancher version. 1. Click **Add Cloud Credential.** 1. Enter a name for the cloud credential. 1. In the **Cloud Credential Type** field, select **vSphere**. -1. Enter your vSphere credentials. For help, refer to **Account Access** in the [node template configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/) +1. Enter your vSphere credentials. For help, refer to **Account Access** in the [node template configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/) 1. Click **Create.** **Result:** You have created the cloud credentials that will be used to provision nodes in your cluster. You can reuse these credentials for other node templates, or in other clusters. ### 2. Create a node template with your cloud credentials -Creating a [node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for vSphere will allow Rancher to provision new nodes in vSphere. Node templates can be reused for other clusters. +Creating a [node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for vSphere will allow Rancher to provision new nodes in vSphere. Node templates can be reused for other clusters. 1. In the Rancher UI, click the user profile button in the upper right corner, and click **Node Templates.** 1. Click **Add Template.** -1. Fill out a node template for vSphere. For help filling out the form, refer to the vSphere node template [configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/). +1. Fill out a node template for vSphere. For help filling out the form, refer to the vSphere node template [configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/). ### 3. Create a cluster with node pools using the node template @@ -81,9 +81,9 @@ Use Rancher to create a Kubernetes cluster in vSphere. 1. Click **Add Cluster** and select the **vSphere** infrastructure provider. 1. Enter a **Cluster Name.** 1. Use **Member Roles** to configure user authorization for the cluster. 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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options) -1. If you want to dynamically provision persistent storage or other infrastructure later, you will need to enable the vSphere cloud provider by modifying the cluster YAML file. For details, refer to [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) -1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) +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. To see more cluster options, click on **Show advanced options.** For help configuring the cluster, refer to the [RKE cluster configuration reference.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options) +1. If you want to dynamically provision persistent storage or other infrastructure later, you will need to enable the vSphere cloud provider by modifying the cluster YAML file. For details, refer to [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) +1. Add one or more node pools to your cluster. Each node pool uses a node template to provision new nodes. For more information about node pools, including best practices for assigning Kubernetes roles to the nodes, see [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-pools) 1. Review your options to confirm they're correct. Then click **Create**. **Result:** @@ -102,6 +102,6 @@ You can access your cluster after its state is updated to **Active.** After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. -- **Provision Storage:** For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) \ No newline at end of file +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through Rancher. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Provision Storage:** For an example of how to provision storage in vSphere using Rancher, refer to [this section.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/examples/vsphere) In order to dynamically provision storage in vSphere, the vSphere provider must be [enabled.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere) \ No newline at end of file diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/_index.md index 5676424c53c..343040c3436 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/_index.md @@ -2,8 +2,8 @@ title: VSphere Node Template Configuration weight: 2 aliases: - - /rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/node-template-reference - - /rancher/v2.5/en/cluster-provisionin/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/enabling-uuids + - /rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/node-template-reference + - /rancher/v2.6/en/cluster-provisionin/rke-clusters/node-pools/vsphere/provisioning-vsphere-clusters/enabling-uuids --- The following node template configuration reference applies to Rancher v2.3.3+. @@ -19,7 +19,7 @@ The following node template configuration reference applies to Rancher v2.3.3+. | Parameter | Required | Description | |:----------------------|:--------:|:-----| -| Cloud Credentials | * | Your vSphere account access information, stored in a [cloud credential.]({{}}/rancher/v2.5/en/user-settings/cloud-credentials/) | +| Cloud Credentials | * | Your vSphere account access information, stored in a [cloud credential.]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/) | Your cloud credential has these fields: diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/_index.md index 48cc8dd929b..d5807a3634b 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/_index.md @@ -3,7 +3,7 @@ title: RKE Cluster Configuration Reference weight: 2250 --- -When Rancher installs Kubernetes, it uses [RKE]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) as the Kubernetes distribution. +When Rancher installs Kubernetes, it uses [RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. @@ -40,7 +40,7 @@ This section is a cluster configuration reference, covering the following topics # Rancher UI Options -When creating a cluster using one of the options described in [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters), you can configure basic Kubernetes options using the **Cluster Options** section. +When creating a cluster using one of the options described in [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters), you can configure basic Kubernetes options using the **Cluster Options** section. ### Kubernetes Version @@ -48,7 +48,7 @@ The version of Kubernetes installed on your cluster nodes. Rancher packages its ### Network Provider -The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. For more details on the different networking providers, please view our [Networking FAQ]({{}}/rancher/v2.5/en/faq/networking/cni-providers/). +The [Network Provider](https://kubernetes.io/docs/concepts/cluster-administration/networking/) that the cluster uses. For more details on the different networking providers, please view our [Networking FAQ]({{}}/rancher/v2.6/en/faq/networking/cni-providers/). >**Note:** After you launch the cluster, you cannot change your network provider. Therefore, choose which network provider you want to use carefully, as Kubernetes doesn't allow switching between network providers. Once a cluster is created with a network provider, changing network providers would require you tear down the entire cluster and all its applications. @@ -62,7 +62,7 @@ Out of the box, Rancher is compatible with the following network providers: **Notes on Weave:** -When Weave is selected as network provider, Rancher will automatically enable encryption by generating a random password. If you want to specify the password manually, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the [Weave Network Plug-in Options]({{}}/rke/latest/en/config-options/add-ons/network-plugins/#weave-network-plug-in-options). +When Weave is selected as network provider, Rancher will automatically enable encryption by generating a random password. If you want to specify the password manually, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the [Weave Network Plug-in Options]({{}}/rke/latest/en/config-options/add-ons/network-plugins/#weave-network-plug-in-options). ### Project Network Isolation @@ -72,7 +72,7 @@ To enable project network isolation as a cluster option, you will need to use an ### Kubernetes Cloud Providers -You can configure a [Kubernetes cloud provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers). If you want to use [volumes and storage]({{}}/rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. +You can configure a [Kubernetes cloud provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers). If you want to use [volumes and storage]({{}}/rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/) in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the `aws` cloud provider. >**Note:** If the cloud provider you want to use is not listed as an option, you will need to use the [config file option](#cluster-config-file) to configure the cloud provider. Please reference the [RKE cloud provider documentation]({{}}/rke/latest/en/config-options/cloud-providers/) on how to configure the cloud provider. @@ -82,7 +82,7 @@ If you want to see all the configuration options for a cluster, please click **S The cluster-level private registry configuration is only used for provisioning clusters. -There are two main ways to set up private registries in Rancher: by setting up the [global default registry]({{}}/rancher/v2.5/en/admin-settings/config-private-registry) through the **Settings** tab in the global view, and by setting up a private registry in the advanced options in the cluster-level settings. The global default registry is intended to be used for air-gapped setups, for registries that do not require credentials. The cluster-level private registry is intended to be used in all setups in which the private registry requires credentials. +There are two main ways to set up private registries in Rancher: by setting up the [global default registry]({{}}/rancher/v2.6/en/admin-settings/config-private-registry) through the **Settings** tab in the global view, and by setting up a private registry in the advanced options in the cluster-level settings. The global default registry is intended to be used for air-gapped setups, for registries that do not require credentials. The cluster-level private registry is intended to be used in all setups in which the private registry requires credentials. If your private registry requires credentials, you need to pass the credentials to Rancher by editing the cluster options for each cluster that needs to pull images from the registry. @@ -97,17 +97,17 @@ See the [RKE documentation on private registries]({{}}/rke/latest/en/co Authorized Cluster Endpoint can be used to directly access the Kubernetes API server, without requiring communication through Rancher. -> The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.5/en/overview/architecture/#tools-for-provisioning-kubernetes-clusters) to provision the cluster. It is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. +> The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.6/en/overview/architecture/#tools-for-provisioning-kubernetes-clusters) to provision the cluster. It is not available for clusters in a hosted Kubernetes provider, such as Amazon's EKS. This is enabled by default in Rancher-launched Kubernetes clusters, using the IP of the node with the `controlplane` role and the default Kubernetes self signed certificates. -For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) +For more detail on how an authorized cluster endpoint works and why it is used, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) -We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.5/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) +We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#architecture-for-an-authorized-cluster-endpoint) ### Node Pools -For information on using the Rancher UI to set up node pools in an RKE cluster, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools) +For information on using the Rancher UI to set up node pools in an RKE cluster, refer to [this page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools) # Advanced Options @@ -127,11 +127,11 @@ Option to enable or disable [Metrics Server]({{}}/rke/latest/en/config- ### Pod Security Policy Support -Option to enable and select a default [Pod Security Policy]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies). You must have an existing Pod Security Policy configured before you can use this option. +Option to enable and select a default [Pod Security Policy]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies). You must have an existing Pod Security Policy configured before you can use this option. ### Docker Version on Nodes -Option to require [a supported Docker version]({{}}/rancher/v2.5/en/installation/requirements/) installed on the cluster nodes that are added to the cluster, or to allow unsupported Docker versions installed on the cluster nodes. +Option to require [a supported Docker version]({{}}/rancher/v2.6/en/installation/requirements/) installed on the cluster nodes that are added to the cluster, or to allow unsupported Docker versions installed on the cluster nodes. ### Docker Root Directory @@ -275,7 +275,7 @@ See [Docker Root Directory](#docker-root-directory). ### enable_cluster_monitoring -Option to enable or disable [Cluster Monitoring]({{}}/rancher/v2.5/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/). +Option to enable or disable [Cluster Monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/). ### enable_network_policy diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/pod-security-policies/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/pod-security-policies/_index.md index 98a232126b4..4d1b3ca719f 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/pod-security-policies/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/pod-security-policies/_index.md @@ -10,7 +10,7 @@ _Pod Security Policies_ are objects that control security-sensitive aspects of p When you create a new cluster with RKE, you can configure it to apply a PSP immediately. As you create the cluster, use the **Cluster Options** to enable a PSP. The PSP assigned to the cluster will be the default PSP for projects within the cluster. >**Prerequisite:** ->Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/). +>Create a Pod Security Policy within Rancher. Before you can assign a default PSP to a new cluster, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). >**Note:** >For security purposes, we recommend assigning a PSP as you create your clusters. diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/_index.md index 60e609230e2..a998a4c9e04 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/rancher-agents/_index.md @@ -8,15 +8,15 @@ There are two different agent resources deployed on Rancher managed clusters: - [cattle-cluster-agent](#cattle-cluster-agent) - [cattle-node-agent](#cattle-node-agent) -For a conceptual overview of how the Rancher server provisions clusters and communicates with them, refer to the [architecture]({{}}/rancher/v2.5/en/overview/architecture/) +For a conceptual overview of how the Rancher server provisions clusters and communicates with them, refer to the [architecture]({{}}/rancher/v2.6/en/overview/architecture/) ### cattle-cluster-agent -The `cattle-cluster-agent` is used to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters. The `cattle-cluster-agent` is deployed using a Deployment resource. +The `cattle-cluster-agent` is used to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. The `cattle-cluster-agent` is deployed using a Deployment resource. ### cattle-node-agent -The `cattle-node-agent` is used to interact with nodes in a [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) cluster when performing cluster operations. Examples of cluster operations are upgrading Kubernetes version and creating/restoring etcd snapshots. The `cattle-node-agent` is deployed using a DaemonSet resource to make sure it runs on every node. The `cattle-node-agent` is used as fallback option to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters when `cattle-cluster-agent` is unavailable. +The `cattle-node-agent` is used to interact with nodes in a [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) cluster when performing cluster operations. Examples of cluster operations are upgrading Kubernetes version and creating/restoring etcd snapshots. The `cattle-node-agent` is deployed using a DaemonSet resource to make sure it runs on every node. The `cattle-node-agent` is used as fallback option to connect to the Kubernetes API of [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters when `cattle-cluster-agent` is unavailable. ### Scheduling rules @@ -29,7 +29,7 @@ Starting with Rancher v2.5.4, the tolerations for the `cattle-cluster-agent` cha | `cattle-cluster-agent` | `beta.kubernetes.io/os:NotIn:windows` | none | **Note:** These are the default tolerations, and will be replaced by tolerations matching taints applied to controlplane nodes.

`effect:NoSchedule`
`key:node-role.kubernetes.io/controlplane`
`value:true`

`effect:NoSchedule`
`key:node-role.kubernetes.io/control-plane`
`operator:Exists`

`effect:NoSchedule`
`key:node-role.kubernetes.io/master`
`operator:Exists` | | `cattle-node-agent` | `beta.kubernetes.io/os:NotIn:windows` | none | `operator:Exists` | -The `cattle-cluster-agent` Deployment has preferred scheduling rules using `preferredDuringSchedulingIgnoredDuringExecution`, favoring to be scheduled on nodes with the `controlplane` node. When there are no controlplane nodes visible in the cluster (this is usually the case when using [Clusters from Hosted Kubernetes Providers]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/)), you can add the label `cattle.io/cluster-agent=true` on a node to prefer scheduling the `cattle-cluster-agent` pod to that node. +The `cattle-cluster-agent` Deployment has preferred scheduling rules using `preferredDuringSchedulingIgnoredDuringExecution`, favoring to be scheduled on nodes with the `controlplane` node. When there are no controlplane nodes visible in the cluster (this is usually the case when using [Clusters from Hosted Kubernetes Providers]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/)), you can add the label `cattle.io/cluster-agent=true` on a node to prefer scheduling the `cattle-cluster-agent` pod to that node. See [Kubernetes: Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) to find more information about scheduling rules. diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/_index.md index 06419998b31..adc25aa5a6e 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/_index.md @@ -3,7 +3,7 @@ title: Launching Kubernetes on Windows Clusters weight: 2240 --- -When provisioning a [custom cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. +When provisioning a [custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes) using Rancher, Rancher uses RKE (the Rancher Kubernetes Engine) to install Kubernetes on your existing nodes. In a Windows cluster provisioned with Rancher, the cluster must contain both Linux and Windows nodes. The Kubernetes controlplane can only run on Linux nodes, and the Windows nodes can only have the worker role. Windows nodes can only be used for deploying workloads. @@ -29,7 +29,7 @@ This guide covers the following topics: # Requirements for Windows Clusters -The general node requirements for networking, operating systems, and Docker are the same as the node requirements for a [Rancher installation]({{}}/rancher/v2.5/en/installation/requirements/). +The general node requirements for networking, operating systems, and Docker are the same as the node requirements for a [Rancher installation]({{}}/rancher/v2.6/en/installation/requirements/). ### OS and Docker Requirements @@ -53,13 +53,13 @@ Rancher will not provision the node if the node does not meet these requirements ### Networking Requirements -Before provisioning a new cluster, be sure that you have already installed Rancher on a device that accepts inbound network traffic. This is required in order for the cluster nodes to communicate with Rancher. If you have not already installed Rancher, please refer to the [installation documentation]({{}}/rancher/v2.5/en/installation/) before proceeding with this guide. +Before provisioning a new cluster, be sure that you have already installed Rancher on a device that accepts inbound network traffic. This is required in order for the cluster nodes to communicate with Rancher. If you have not already installed Rancher, please refer to the [installation documentation]({{}}/rancher/v2.6/en/installation/) before proceeding with this guide. Rancher only supports Windows using Flannel as the network provider. 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. -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.5/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.5/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. +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. For **VXLAN (Overlay)** networking, the [KB4489899](https://support.microsoft.com/en-us/help/4489899) hotfix must be installed. Most cloud-hosted VMs already have this hotfix. @@ -89,18 +89,18 @@ Windows requires that containers must be built on the same Windows Server versio ### Cloud Provider Specific Requirements -If you set a Kubernetes cloud provider in your cluster, some additional steps are required. You might want to set a cloud provider if you want to want to leverage a cloud provider's capabilities, for example, to automatically provision storage, load balancers, or other infrastructure for your cluster. Refer to [this page]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) for details on how to configure a cloud provider cluster of nodes that meet the prerequisites. +If you set a Kubernetes cloud provider in your cluster, some additional steps are required. You might want to set a cloud provider if you want to want to leverage a cloud provider's capabilities, for example, to automatically provision storage, load balancers, or other infrastructure for your cluster. Refer to [this page]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) for details on how to configure a cloud provider cluster of nodes that meet the prerequisites. If you are using the GCE (Google Compute Engine) cloud provider, you must do the following: -- Enable the GCE cloud provider in the `cluster.yml` by following [these steps.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/gce) +- Enable the GCE cloud provider in the `cluster.yml` by following [these steps.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/gce) - When provisioning the cluster in Rancher, choose **Custom cloud provider** as the cloud provider in the Rancher UI. # Tutorial: How to Create a Cluster with Windows Support This tutorial describes how to create a Rancher-provisioned cluster with the three nodes in the [recommended architecture.](#guide-architecture) -When you provision a cluster with Rancher on existing nodes, you will add nodes to the cluster by installing the [Rancher agent]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/) on each one. When you create or edit your cluster from the Rancher UI, you will see a **Customize Node Run Command** that you can run on each server to add it to your cluster. +When you provision a cluster with Rancher on existing nodes, you will add nodes to the cluster by installing the [Rancher agent]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/agent-options/) on each one. When you create or edit your cluster from the Rancher UI, you will see a **Customize Node Run Command** that you can run on each server to add it to your cluster. To set up a cluster with support for Windows nodes and containers, you will need to complete the tasks below. @@ -134,11 +134,11 @@ You will provision three nodes: | Node 2 | Linux (Ubuntu Server 18.04 recommended) | | Node 3 | Windows (Windows Server core version 1809 or above required) | -If your nodes are hosted by a **Cloud Provider** and you want automation support such as loadbalancers or persistent storage devices, your nodes have additional configuration requirements. For details, see [Selecting Cloud Providers.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers) +If your nodes are hosted by a **Cloud Provider** and you want automation support such as loadbalancers or persistent storage devices, your nodes have additional configuration requirements. For details, see [Selecting Cloud Providers.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers) # 2. Create the Cluster on Existing Nodes -The instructions for creating a Windows cluster on existing nodes are very similar to the general [instructions for creating a custom cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/) with some Windows-specific requirements. +The instructions for creating a Windows cluster on existing nodes are very similar to the general [instructions for creating a custom cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/) with some Windows-specific requirements. 1. From the **Global** view, click on the **Clusters** tab and click **Add Cluster**. 1. Click **From existing nodes (Custom)**. @@ -149,7 +149,7 @@ 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.5/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.5/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. +> **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 @@ -163,7 +163,7 @@ The first node in your cluster should be a Linux host has both the **Control Pla 1. In the **Node Operating System** section, click **Linux**. 1. In the **Node Role** section, choose at least **etcd** and **Control Plane**. We recommend selecting all three. -1. Optional: If you click **Show advanced options,** you can customize the settings for the [Rancher agent]({{}}/rancher/v2.5/en/admin-settings/agent-options/) and [node labels.](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) +1. Optional: If you click **Show advanced options,** you can customize the settings for the [Rancher agent]({{}}/rancher/v2.6/en/admin-settings/agent-options/) and [node labels.](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) 1. Copy the command displayed on the screen to your clipboard. 1. SSH into your Linux host and run the command that you copied to your clipboard. 1. When you are finished provisioning your Linux node(s), select **Done**. @@ -226,9 +226,9 @@ You can add Windows hosts to the cluster by editing the cluster and choosing the After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster: -- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. -- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through the Rancher server. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. +- **Access your cluster with the kubectl CLI:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI. +- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through the Rancher server. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster. # Configuration for Storage Classes in Azure -If you are using Azure VMs for your nodes, you can use [Azure files](https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv) as a StorageClass for the cluster. For details, refer to [this section.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass) +If you are using Azure VMs for your nodes, you can use [Azure files](https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv) as a StorageClass for the cluster. For details, refer to [this section.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass) diff --git a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/_index.md b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/_index.md index 10f8743b89e..23e41953557 100644 --- a/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/_index.md +++ b/content/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/azure-storageclass/_index.md @@ -7,7 +7,7 @@ If you are using Azure VMs for your nodes, you can use [Azure files](https://doc In order to have the Azure platform create the required storage resources, follow these steps: -1. [Configure the Azure cloud provider.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/azure) +1. [Configure the Azure cloud provider.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/cloud-providers/azure) 1. Configure `kubectl` to connect to your cluster. 1. Copy the `ClusterRole` and `ClusterRoleBinding` manifest for the service account: diff --git a/content/rancher/v2.6/en/contributing/_index.md b/content/rancher/v2.6/en/contributing/_index.md index 4d81c27ac63..1ba1c513212 100644 --- a/content/rancher/v2.6/en/contributing/_index.md +++ b/content/rancher/v2.6/en/contributing/_index.md @@ -2,7 +2,7 @@ title: Contributing to Rancher weight: 27 aliases: - - /rancher/v2.5/en/faq/contributing/ + - /rancher/v2.6/en/faq/contributing/ --- This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue. diff --git a/content/rancher/v2.6/en/deploy-across-clusters/multi-cluster-apps/_index.md b/content/rancher/v2.6/en/deploy-across-clusters/multi-cluster-apps/_index.md index d1acf032400..f9e9314b675 100644 --- a/content/rancher/v2.6/en/deploy-across-clusters/multi-cluster-apps/_index.md +++ b/content/rancher/v2.6/en/deploy-across-clusters/multi-cluster-apps/_index.md @@ -3,7 +3,7 @@ title: Multi-cluster Apps weight: 2 --- -> As of Rancher v2.5, we now recommend using [Fleet]({{}}/rancher/v2.5/en/deploy-across-clusters/fleet) for deploying apps across clusters. +> As of Rancher v2.5, we now recommend using [Fleet]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) for deploying apps across clusters. Typically, most applications are deployed on a single Kubernetes cluster, but there will be times you might want to deploy multiple copies of the same application across different clusters and/or projects. In Rancher, a _multi-cluster application_, is an application deployed using a Helm chart across multiple clusters. With the ability to deploy the same application across multiple clusters, it avoids the repetition of the same action on each cluster, which could introduce user error during application configuration. With multi-cluster applications, you can customize to have the same configuration across all projects/clusters as well as have the ability to change the configuration based on your target project. Since multi-cluster application is considered a single application, it's easy to manage and maintain this application. @@ -30,8 +30,8 @@ After creating a multi-cluster application, you can program a global DNS entry t To create a multi-cluster app in Rancher, you must have at least one of the following permissions: -- A [project-member role]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles) in the target cluster(s), which gives you the ability to create, read, update, and delete the workloads -- A [cluster owner role]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) for the clusters(s) that include the target project(s) +- A [project-member role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) in the target cluster(s), which gives you the ability to create, read, update, and delete the workloads +- A [cluster owner role]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles) for the clusters(s) that include the target project(s) # Launching a Multi-Cluster App @@ -73,15 +73,15 @@ In the **Upgrades** section, select the upgrade strategy to use, when you decide ### Roles -In the **Roles** section, you define the role of the multi-cluster application. Typically, when a user [launches catalog applications]({{}}/rancher/v2.5/en/catalog/launching-apps), that specific user's permissions are used for creation of all workloads/resources that is required by the app. +In the **Roles** section, you define the role of the multi-cluster application. Typically, when a user [launches catalog applications]({{}}/rancher/v2.6/en/catalog/launching-apps), that specific user's permissions are used for creation of all workloads/resources that is required by the app. For multi-cluster applications, the application is deployed by a _system user_ and is assigned as the creator of all underlying resources. A _system user_ is used instead of the actual user due to the fact that the actual user could be removed from one of the target projects. If the actual user was removed from one of the projects, then that user would no longer be able to manage the application for the other projects. Rancher will let you select from two options for Roles, **Project** and **Cluster**. Rancher will allow creation using any of these roles based on the user's permissions. -- **Project** - This is the equivalent of a [project member]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [project member]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _project member_ role, if the user is an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/), a [cluster owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or a [project owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles), then the user is considered to have the appropriate level of permissions. +- **Project** - This is the equivalent of a [project member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [project member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _project member_ role, if the user is an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), a [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or a [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles), then the user is considered to have the appropriate level of permissions. -- **Cluster** - This is the equivalent of a [cluster owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [cluster owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _cluster owner_ role, if the user is an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/), then the user is considered to have the appropriate level of permissions. +- **Cluster** - This is the equivalent of a [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles). If you select this role, Rancher will check that in all the target projects, the user has minimally the [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) role. While the user might not be explicitly granted the _cluster owner_ role, if the user is an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), then the user is considered to have the appropriate level of permissions. When launching the application, Rancher will confirm if you have these permissions in the target projects before launching the application. diff --git a/content/rancher/v2.6/en/faq/_index.md b/content/rancher/v2.6/en/faq/_index.md index 0aab8d42359..08499b81aec 100644 --- a/content/rancher/v2.6/en/faq/_index.md +++ b/content/rancher/v2.6/en/faq/_index.md @@ -2,12 +2,12 @@ title: FAQ weight: 25 aliases: - - /rancher/v2.5/en/about/ + - /rancher/v2.6/en/about/ --- This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x. -See [Technical FAQ]({{}}/rancher/v2.5/en/faq/technical/), for frequently asked technical questions. +See [Technical FAQ]({{}}/rancher/v2.6/en/faq/technical/), for frequently asked technical questions.
@@ -25,13 +25,13 @@ Yes. **Does Rancher support Windows?** -As of Rancher 2.3.0, we support Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/) +As of Rancher 2.3.0, we support Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/)
**Does Rancher support Istio?** -As of Rancher 2.3.0, we support [Istio.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/) +As of Rancher 2.3.0, we support [Istio.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/) Furthermore, Istio is implemented in our micro-PaaS "Rio", which works on Rancher 2.x along with any CNCF compliant Kubernetes cluster. You can read more about it [here](https://rio.io/) diff --git a/content/rancher/v2.6/en/faq/networking/_index.md b/content/rancher/v2.6/en/faq/networking/_index.md index 1b3488e9fec..e9ebe37f4df 100644 --- a/content/rancher/v2.6/en/faq/networking/_index.md +++ b/content/rancher/v2.6/en/faq/networking/_index.md @@ -5,5 +5,5 @@ weight: 8005 Networking FAQ's -- [CNI Providers]({{}}/rancher/v2.5/en/faq/networking/cni-providers/) +- [CNI Providers]({{}}/rancher/v2.6/en/faq/networking/cni-providers/) diff --git a/content/rancher/v2.6/en/faq/networking/cni-providers/_index.md b/content/rancher/v2.6/en/faq/networking/cni-providers/_index.md index 6fc64f0e1c8..498e63ad5f1 100644 --- a/content/rancher/v2.6/en/faq/networking/cni-providers/_index.md +++ b/content/rancher/v2.6/en/faq/networking/cni-providers/_index.md @@ -54,7 +54,7 @@ Canal is a CNI network provider that gives you the best of Flannel and Calico. I In Rancher, Canal is the default CNI network provider combined with Flannel and VXLAN encapsulation. -Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (healthcheck). For details, refer to [the port requirements for user clusters.]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/) +Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (healthcheck). For details, refer to [the port requirements for user clusters.]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/) {{< img "/img/rancher/canal-diagram.png" "Canal Diagram">}} @@ -68,7 +68,7 @@ Flannel is a simple and easy way to configure L3 network fabric designed for Kub Encapsulated traffic is unencrypted by default. Therefore, flannel provides an experimental backend for encryption, [IPSec](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#ipsec), which makes use of [strongSwan](https://www.strongswan.org/) to establish encrypted IPSec tunnels between Kubernetes workers. -Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (healthcheck). See [the port requirements for user clusters]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open UDP port `8472` (VXLAN) and TCP port `9099` (healthcheck). See [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. ![Flannel Diagram]({{}}/img/rancher/flannel-diagram.png) @@ -82,7 +82,7 @@ Calico enables networking and network policy in Kubernetes clusters across the c Calico also provides a stateless IP-in-IP encapsulation mode that can be used, if necessary. Calico also offers policy isolation, allowing you to secure and govern your Kubernetes workloads using advanced ingress and egress policies. -Kubernetes workers should open TCP port `179` (BGP). See [the port requirements for user clusters]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open TCP port `179` (BGP). See [the port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. ![Calico Diagram]({{}}/img/rancher/calico-diagram.svg) @@ -98,7 +98,7 @@ For more information, see the following pages: Weave enables networking and network policy in Kubernetes clusters across the cloud. Additionally, it support encrypting traffic between the peers. -Kubernetes workers should open TCP port `6783` (control port), UDP port `6783` and UDP port `6784` (data ports). See the [port requirements for user clusters]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. +Kubernetes workers should open TCP port `6783` (control port), UDP port `6783` and UDP port `6784` (data ports). See the [port requirements for user clusters]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for more details. For more information, see the following pages: @@ -150,4 +150,4 @@ Canal is the default CNI network provider. We recommend it for most use cases. I ### How can I configure a CNI network provider? -Please see [Cluster Options]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/) on how to configure a network provider for your cluster. For more advanced configuration options, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the options for [Network Plug-ins]({{}}/rke/latest/en/config-options/add-ons/network-plugins/). +Please see [Cluster Options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/) on how to configure a network provider for your cluster. For more advanced configuration options, please see how to configure your cluster using a [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) and the options for [Network Plug-ins]({{}}/rke/latest/en/config-options/add-ons/network-plugins/). diff --git a/content/rancher/v2.6/en/faq/removing-rancher/_index.md b/content/rancher/v2.6/en/faq/removing-rancher/_index.md index be8e6175ddb..ea47bbf7da4 100644 --- a/content/rancher/v2.6/en/faq/removing-rancher/_index.md +++ b/content/rancher/v2.6/en/faq/removing-rancher/_index.md @@ -2,10 +2,10 @@ title: Rancher is No Longer Needed weight: 8010 aliases: - - /rancher/v2.5/en/installation/removing-rancher/cleaning-cluster-nodes/ - - /rancher/v2.5/en/installation/removing-rancher/ - - /rancher/v2.5/en/admin-settings/removing-rancher/ - - /rancher/v2.5/en/admin-settings/removing-rancher/rancher-cluster-nodes/ + - /rancher/v2.6/en/installation/removing-rancher/cleaning-cluster-nodes/ + - /rancher/v2.6/en/installation/removing-rancher/ + - /rancher/v2.6/en/admin-settings/removing-rancher/ + - /rancher/v2.6/en/admin-settings/removing-rancher/rancher-cluster-nodes/ --- This page is intended to answer questions about what happens if you don't want Rancher anymore, if you don't want a cluster to be managed by Rancher anymore, or if the Rancher server is deleted. @@ -26,11 +26,11 @@ The capability to access a downstream cluster without Rancher depends on the typ - **Registered clusters:** The cluster will be unaffected and you can access the cluster using the same methods that you did before the cluster was registered into Rancher. - **Hosted Kubernetes clusters:** If you created the cluster in a cloud-hosted Kubernetes provider such as EKS, GKE, or AKS, you can continue to manage the cluster using your provider's cloud credentials. -- **RKE clusters:** To access an [RKE cluster,]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) the cluster must have the [authorized cluster endpoint]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) enabled, and you must have already downloaded the cluster's kubeconfig file from the Rancher UI. (The authorized cluster endpoint is enabled by default for RKE clusters.) With this endpoint, you can access your cluster with kubectl directly instead of communicating through the Rancher server's [authentication proxy.]({{}}/rancher/v2.5/en/overview/architecture/#1-the-authentication-proxy) For instructions on how to configure kubectl to use the authorized cluster endpoint, refer to the section about directly accessing clusters with [kubectl and the kubeconfig file.]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) These clusters will use a snapshot of the authentication as it was configured when Rancher was removed. +- **RKE clusters:** To access an [RKE cluster,]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) the cluster must have the [authorized cluster endpoint]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) enabled, and you must have already downloaded the cluster's kubeconfig file from the Rancher UI. (The authorized cluster endpoint is enabled by default for RKE clusters.) With this endpoint, you can access your cluster with kubectl directly instead of communicating through the Rancher server's [authentication proxy.]({{}}/rancher/v2.6/en/overview/architecture/#1-the-authentication-proxy) For instructions on how to configure kubectl to use the authorized cluster endpoint, refer to the section about directly accessing clusters with [kubectl and the kubeconfig file.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/#authenticating-directly-with-a-downstream-cluster) These clusters will use a snapshot of the authentication as it was configured when Rancher was removed. ### What if I don't want Rancher anymore? -If you [installed Rancher on a Kubernetes cluster,]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) remove Rancher by using the [System Tools]({{}}/rancher/v2.5/en/system-tools/) with the `remove` subcommand. +If you [installed Rancher on a Kubernetes cluster,]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) remove Rancher by using the [System Tools]({{}}/rancher/v2.6/en/system-tools/) with the `remove` subcommand. As of Rancher v2.5.8, uninstalling Rancher in high-availability (HA) mode will also remove all `helm-operation-*` pods and the following apps: diff --git a/content/rancher/v2.6/en/faq/security/_index.md b/content/rancher/v2.6/en/faq/security/_index.md index 29e0cc3fb25..55eb76ee087 100644 --- a/content/rancher/v2.6/en/faq/security/_index.md +++ b/content/rancher/v2.6/en/faq/security/_index.md @@ -6,10 +6,10 @@ weight: 8007 **Is there a Hardening Guide?** -The Hardening Guide is now located in the main [Security]({{}}/rancher/v2.5/en/security/) section. +The Hardening Guide is now located in the main [Security]({{}}/rancher/v2.6/en/security/) section.
**What are the results of Rancher's Kubernetes cluster when it is CIS benchmarked?** -We have run the CIS Kubernetes benchmark against a hardened Rancher Kubernetes cluster. The results of that assessment can be found in the main [Security]({{}}/rancher/v2.5/en/security/) section. +We have run the CIS Kubernetes benchmark against a hardened Rancher Kubernetes cluster. The results of that assessment can be found in the main [Security]({{}}/rancher/v2.6/en/security/) section. diff --git a/content/rancher/v2.6/en/faq/technical/_index.md b/content/rancher/v2.6/en/faq/technical/_index.md index 6abef193325..290674f33d5 100644 --- a/content/rancher/v2.6/en/faq/technical/_index.md +++ b/content/rancher/v2.6/en/faq/technical/_index.md @@ -40,7 +40,7 @@ New password for default administrator (user-xxxxx): ``` ### How can I enable debug logging? -See [Troubleshooting: Logging]({{}}/rancher/v2.5/en/troubleshooting/logging/) +See [Troubleshooting: Logging]({{}}/rancher/v2.6/en/troubleshooting/logging/) ### My ClusterIP does not respond to ping @@ -52,7 +52,7 @@ Node Templates can be accessed by opening your account menu (top right) and sele ### Why is my Layer-4 Load Balancer in `Pending` state? -The Layer-4 Load Balancer is created as `type: LoadBalancer`. In Kubernetes, this needs a cloud provider or controller that can satisfy these requests, otherwise these will be in `Pending` state forever. More information can be found on [Cloud Providers]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) or [Create External Load Balancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/) +The Layer-4 Load Balancer is created as `type: LoadBalancer`. In Kubernetes, this needs a cloud provider or controller that can satisfy these requests, otherwise these will be in `Pending` state forever. More information can be found on [Cloud Providers]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) or [Create External Load Balancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/) ### Where is the state of Rancher stored? @@ -86,13 +86,13 @@ The UI consists of static files, and works based on responses of the API. That m A node is required to have a static IP configured (or a reserved IP via DHCP). If the IP of a node has changed, you will have to remove it from the cluster and readd it. After it is removed, Rancher will update the cluster to the correct state. If the cluster is no longer in `Provisioning` state, the node is removed from the cluster. -When the IP address of the node changed, Rancher lost connection to the node, so it will be unable to clean the node properly. See [Cleaning cluster nodes]({{}}/rancher/v2.5/en/faq/cleaning-cluster-nodes/) to clean the node. +When the IP address of the node changed, Rancher lost connection to the node, so it will be unable to clean the node properly. See [Cleaning cluster nodes]({{}}/rancher/v2.6/en/faq/cleaning-cluster-nodes/) to clean the node. When the node is removed from the cluster, and the node is cleaned, you can readd the node to the cluster. ### How can I add additional arguments/binds/environment variables to Kubernetes components in a Rancher Launched Kubernetes cluster? -You can add additional arguments/binds/environment variables via the [Config File]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) option in Cluster Options. For more information, see the [Extra Args, Extra Binds, and Extra Environment Variables]({{}}/rke/latest/en/config-options/services/services-extras/) in the RKE documentation or browse the [Example Cluster.ymls]({{}}/rke/latest/en/example-yamls/). +You can add additional arguments/binds/environment variables via the [Config File]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#cluster-config-file) option in Cluster Options. For more information, see the [Extra Args, Extra Binds, and Extra Environment Variables]({{}}/rke/latest/en/config-options/services/services-extras/) in the RKE documentation or browse the [Example Cluster.ymls]({{}}/rke/latest/en/example-yamls/). ### How do I check if my certificate chain is valid? diff --git a/content/rancher/v2.6/en/helm-charts/_index.md b/content/rancher/v2.6/en/helm-charts/_index.md index f310c46c58e..4f21ba27581 100644 --- a/content/rancher/v2.6/en/helm-charts/_index.md +++ b/content/rancher/v2.6/en/helm-charts/_index.md @@ -3,9 +3,9 @@ title: Helm Charts in Rancher weight: 11 aliases: - /rancher/v2.x/en/helm-charts/apps-marketplace - - /rancher/v2.5/en/catalog/ - - /rancher/v2.5/en/catalog/apps - - /rancher/v2.5/en/catalog/launching-apps + - /rancher/v2.6/en/catalog/ + - /rancher/v2.6/en/catalog/apps + - /rancher/v2.6/en/catalog/launching-apps --- In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. diff --git a/content/rancher/v2.6/en/installation/_index.md b/content/rancher/v2.6/en/installation/_index.md index c722beafad5..838853b2a42 100644 --- a/content/rancher/v2.6/en/installation/_index.md +++ b/content/rancher/v2.6/en/installation/_index.md @@ -3,7 +3,7 @@ title: Installing/Upgrading Rancher description: Learn how to install Rancher in development and production environments. Read about single node and high availability installation weight: 3 aliases: - - /rancher/v2.5/en/installation/how-ha-works/ + - /rancher/v2.6/en/installation/how-ha-works/ --- This section provides an overview of the architecture options of installing Rancher, describing advantages of each option. @@ -24,7 +24,7 @@ In Rancher v2.5, the Rancher management server can be installed on any Kubernete For Docker installations, a local Kubernetes cluster is installed in the single Docker container, and Rancher is installed on the local cluster. -The `restrictedAdmin` Helm chart option was added. When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#restricted-admin) +The `restrictedAdmin` Helm chart option was added. When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#restricted-admin) # Overview of Installation Options @@ -60,7 +60,7 @@ However, this option is useful if you want to save resources by using a single n For test and demonstration purposes, Rancher can be installed with Docker on a single node. -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) ### Other Options @@ -68,9 +68,9 @@ There are also separate instructions for installing Rancher in an air gap enviro | Level of Internet Access | Kubernetes Installation - Strongly Recommended | Docker Installation | | ---------------------------------- | ------------------------------ | ---------- | -| With direct access to the Internet | [Docs]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) | [Docs]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) | -| Behind an HTTP proxy | [Docs]({{}}/rancher/v2.5/en/installation/other-installation-methods/behind-proxy/) | These [docs,]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) plus this [configuration]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/proxy/) | -| In an air gap environment | [Docs]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) | [Docs]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) | +| With direct access to the Internet | [Docs]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) | +| Behind an HTTP proxy | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/) | These [docs,]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) plus this [configuration]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) | +| In an air gap environment | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) | [Docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) | We recommend installing Rancher on a Kubernetes cluster, because in a multi-node cluster, the Rancher management server becomes highly available. This high-availability configuration helps maintain consistent access to the downstream Kubernetes clusters that Rancher will manage. @@ -78,28 +78,28 @@ For that reason, we recommend that for a production-grade architecture, you shou For testing or demonstration purposes, you can install Rancher in single Docker container. In this Docker install, you can use Rancher to set up Kubernetes clusters out-of-the-box. The Docker install allows you to explore the Rancher server functionality, but it is intended to be used for development and testing purposes only. -Our [instructions for installing Rancher on Kubernetes]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s) describe how to first use K3s or RKE to create and manage a Kubernetes cluster, then install Rancher onto that cluster. +Our [instructions for installing Rancher on Kubernetes]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s) describe how to first use K3s or RKE to create and manage a Kubernetes cluster, then install Rancher onto that cluster. -When the nodes in your Kubernetes cluster are running and fulfill the [node requirements,]({{}}/rancher/v2.5/en/installation/requirements) you will use Helm to deploy Rancher onto Kubernetes. Helm uses Rancher's Helm chart to install a replica of Rancher on each node in the Kubernetes cluster. We recommend using a load balancer to direct traffic to each replica of Rancher in the cluster. +When the nodes in your Kubernetes cluster are running and fulfill the [node requirements,]({{}}/rancher/v2.6/en/installation/requirements) you will use Helm to deploy Rancher onto Kubernetes. Helm uses Rancher's Helm chart to install a replica of Rancher on each node in the Kubernetes cluster. We recommend using a load balancer to direct traffic to each replica of Rancher in the cluster. -For a longer discussion of Rancher architecture, refer to the [architecture overview,]({{}}/rancher/v2.5/en/overview/architecture) [recommendations for production-grade architecture,]({{}}/rancher/v2.5/en/overview/architecture-recommendations) or our [best practices guide.]({{}}/rancher/v2.5/en/best-practices/deployment-types) +For a longer discussion of Rancher architecture, refer to the [architecture overview,]({{}}/rancher/v2.6/en/overview/architecture) [recommendations for production-grade architecture,]({{}}/rancher/v2.6/en/overview/architecture-recommendations) or our [best practices guide.]({{}}/rancher/v2.6/en/best-practices/deployment-types) # Prerequisites -Before installing Rancher, make sure that your nodes fulfill all of the [installation requirements.]({{}}/rancher/v2.5/en/installation/requirements/) +Before installing Rancher, make sure that your nodes fulfill all of the [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) # Architecture Tip -For the best performance and greater security, we recommend a separate, dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.5/en/cluster-provisioning/) for running your workloads. +For the best performance and greater security, we recommend a separate, dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. -For more architecture recommendations, refer to [this page.]({{}}/rancher/v2.5/en/overview/architecture-recommendations) +For more architecture recommendations, refer to [this page.]({{}}/rancher/v2.6/en/overview/architecture-recommendations) ### More Options for Installations on a Kubernetes Cluster -Refer to the [Helm chart options]({{}}/rancher/v2.5/en/installation/resources/chart-options/) for details on installing Rancher on a Kubernetes cluster with other configurations, including: +Refer to the [Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) for details on installing Rancher on a Kubernetes cluster with other configurations, including: -- With [API auditing to record all transactions]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) -- With [TLS termination on a load balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -- With a [custom Ingress]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#customizing-your-ingress) +- With [API auditing to record all transactions]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) +- With [TLS termination on a load balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- With a [custom Ingress]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#customizing-your-ingress) In the Rancher installation instructions, we recommend using K3s or RKE to set up a Kubernetes cluster before installing Rancher on the cluster. Both K3s and RKE have many configuration options for customizing the Kubernetes cluster to suit your specific environment. For the full list of their capabilities, refer to their documentation: @@ -108,8 +108,8 @@ In the Rancher installation instructions, we recommend using K3s or RKE to set u ### More Options for Installations with Docker -Refer to the [docs about options for Docker installs]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) for details about other configurations including: +Refer to the [docs about options for Docker installs]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) for details about other configurations including: -- With [API auditing to record all transactions]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) -- With an [external load balancer]({{}}/rancher/v2.5/en/installation/options/single-node-install-external-lb/) -- With a [persistent data store]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#persistent-data) +- With [API auditing to record all transactions]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) +- With an [external load balancer]({{}}/rancher/v2.6/en/installation/options/single-node-install-external-lb/) +- With a [persistent data store]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#persistent-data) diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/_index.md index 7d4887312eb..3a6a7fd1767 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/_index.md @@ -3,11 +3,11 @@ title: Install/Upgrade Rancher on a Kubernetes Cluster description: Learn how to install Rancher in development and production environments. Read about single node and high availability installation weight: 2 aliases: - - /rancher/v2.5/en/installation/k8s-install/ - - /rancher/v2.5/en/installation/k8s-install/helm-rancher - - /rancher/v2.5/en/installation/k8s-install/kubernetes-rke - - /rancher/v2.5/en/installation/ha-server-install - - /rancher/v2.5/en/installation/install-rancher-on-k8s/install + - /rancher/v2.6/en/installation/k8s-install/ + - /rancher/v2.6/en/installation/k8s-install/helm-rancher + - /rancher/v2.6/en/installation/k8s-install/kubernetes-rke + - /rancher/v2.6/en/installation/ha-server-install + - /rancher/v2.6/en/installation/install-rancher-on-k8s/install --- In this section, you'll learn how to deploy Rancher on a Kubernetes cluster using the Helm CLI. @@ -29,24 +29,24 @@ Rancher can be installed on any Kubernetes cluster. This cluster can use upstrea For help setting up a Kubernetes cluster, we provide these tutorials: -- **RKE:** For the tutorial to install an RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke/) For help setting up the infrastructure for a high-availability RKE cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha) -- **K3s:** For the tutorial to install a K3s Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-with-external-db) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db) -- **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) -- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/amazon-eks) -- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/gke) +- **RKE:** For the tutorial to install an RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke/) For help setting up the infrastructure for a high-availability RKE cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha) +- **K3s:** For the tutorial to install a K3s Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db) +- **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks) +- **GKE:** For details on how to install Rancher with Google Kubernetes Engine, including how to install an ingress so that the Rancher server can be accessed, refer to [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/gke) ### CLI Tools The following CLI tools are required for setting up the Kubernetes cluster. Please make sure these tools are installed and available in your `$PATH`. - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes command-line tool. -- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. +- [helm](https://docs.helm.sh/using_helm/#installing-helm) - Package management for Kubernetes. Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/options/helm-version) to choose a version of Helm to install Rancher. Refer to the [instructions provided by the Helm project](https://helm.sh/docs/intro/install/) for your specific platform. ### Ingress Controller (For Hosted Kubernetes) To deploy Rancher v2.5 on a hosted Kubernetes cluster such as EKS, GKE, or AKS, you should deploy a compatible Ingress controller first to configure [SSL termination on Rancher.](#3-choose-your-ssl-configuration) -For an example of how to deploy an ingress on EKS, refer to [this section.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/amazon-eks/#5-install-an-ingress) +For an example of how to deploy an ingress on EKS, refer to [this section.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/#5-install-an-ingress) # Install the Rancher Helm Chart @@ -54,13 +54,13 @@ Rancher is installed using the Helm package manager for Kubernetes. Helm charts With Helm, we can create configurable deployments instead of just using static files. For more information about creating your own catalog of deployments, check out the docs at https://helm.sh/. -For systems without direct internet access, see [Air Gap: Kubernetes install]({{}}/rancher/v2.5/en/installation/air-gap-installation/install-rancher/). +For systems without direct internet access, see [Air Gap: Kubernetes install]({{}}/rancher/v2.6/en/installation/air-gap-installation/install-rancher/). -To choose a Rancher version to install, refer to [Choosing a Rancher Version.]({{}}/rancher/v2.5/en/installation/options/server-tags) +To choose a Rancher version to install, refer to [Choosing a Rancher Version.]({{}}/rancher/v2.6/en/installation/options/server-tags) -To choose a version of Helm to install Rancher with, refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) +To choose a version of Helm to install Rancher with, refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/options/helm-version) -> **Note:** The installation instructions assume you are using Helm 3. For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) This [section]({{}}/rancher/v2.5/en/installation/options/helm2) provides a copy of the older installation instructions for Rancher installed on an RKE Kubernetes cluster with Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. +> **Note:** The installation instructions assume you are using Helm 3. For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) This [section]({{}}/rancher/v2.6/en/installation/options/helm2) provides a copy of the older installation instructions for Rancher installed on an RKE Kubernetes cluster with Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. To set up Rancher, @@ -74,7 +74,7 @@ To set up Rancher, ### 1. Add the Helm Chart Repository -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]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). +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]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). {{< release-channel >}} @@ -94,7 +94,7 @@ kubectl create namespace cattle-system The Rancher management server is designed to be secure by default and requires SSL/TLS configuration. -> **Note:** If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +> **Note:** If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). There are three recommended options for the source of the certificate used for TLS termination at the Rancher server: @@ -111,13 +111,13 @@ There are three recommended options for the source of the certificate used for T ### 4. Install cert-manager -> You should skip this step if you are bringing your own certificate files (option `ingress.tls.source=secret`), or if you use [TLS termination on an external load balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +> You should skip this step if you are bringing your own certificate files (option `ingress.tls.source=secret`), or if you use [TLS termination on an external load balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). This step is only required to use certificates issued by Rancher's generated CA (`ingress.tls.source=rancher`) or to request Let's Encrypt issued certificates (`ingress.tls.source=letsEncrypt`). {{% accordion id="cert-manager" label="Click to Expand" %}} -> **Important:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager/). +> **Important:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager/). These instructions are adapted from the [official cert-manager documentation](https://cert-manager.io/docs/installation/kubernetes/#installing-with-helm). @@ -230,7 +230,7 @@ When you run this command, the `hostname` option must match the `Common Name` or Although an entry in the `Subject Alternative Names` is technically required, having a matching `Common Name` maximizes compatibility with older browsers and applications. -> If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?]({{}}/rancher/v2.5/en/faq/technical/#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) +> If you want to check if your certificates are correct, see [How do I check Common Name and Subject Alternative Names in my server certificate?]({{}}/rancher/v2.6/en/faq/technical/#how-do-i-check-common-name-and-subject-alternative-names-in-my-server-certificate) - Set the `hostname`. - Set `ingress.tls.source` to `secret`. @@ -253,17 +253,17 @@ helm install rancher rancher-latest/rancher \ --set privateCA=true ``` -Now that Rancher is deployed, see [Adding TLS Secrets]({{}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the Ingress controller can use them. +Now that Rancher is deployed, see [Adding TLS Secrets]({{}}/rancher/v2.6/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the Ingress controller can use them. {{% /tab %}} {{% /tabs %}} The Rancher chart configuration has many options for customizing the installation to suit your specific environment. Here are some common advanced scenarios. -- [HTTP Proxy]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#http-proxy) -- [Private Docker Image Registry]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#private-registry-and-air-gap-installs) -- [TLS Termination on an External Load Balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- [HTTP Proxy]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#http-proxy) +- [Private Docker Image Registry]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#private-registry-and-air-gap-installs) +- [TLS Termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -See the [Chart Options]({{}}/rancher/v2.5/en/installation/resources/chart-options/) for the full list of options. +See the [Chart Options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) for the full list of options. ### 6. Verify that the Rancher Server is Successfully Deployed @@ -296,7 +296,7 @@ That's it. You should have a functional Rancher server. In a web browser, go to the DNS name that forwards traffic to your load balancer. Then you should be greeted by the colorful login page. -Doesn't work? Take a look at the [Troubleshooting]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) Page +Doesn't work? Take a look at the [Troubleshooting]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) Page ### Optional Next Steps diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/aks/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/aks/_index.md index 08b873dd53b..97890c7c5de 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/aks/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/aks/_index.md @@ -8,7 +8,7 @@ This page covers how to install Rancher on Microsoft's Azure Kubernetes Servcice The guide uses command line tools to provision an AKS cluster with an ingress. If you prefer to provision your cluster using the Azure portal, refer to the [official documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal). -If you already have an AKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have an AKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) # Prerequisites @@ -18,7 +18,7 @@ If you already have an AKS Kubernetes cluster, skip to the step about [installin - [Microsoft Azure Account](https://azure.microsoft.com/en-us/free/): A Microsoft Azure Account is required to create resources for deploying Rancher and Kubernetes. - [Microsoft Azure Subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription#create-a-subscription-in-the-azure-portal): Use this link to follow a tutorial to create a Microsoft Azure subscription if you don't have one yet. - [Micsoroft Azure Tenant](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant): Use this link and follow instructions to create a Microsoft Azure tenant. -- Your subscription has sufficient quota for at least 2 vCPUs. For details on Rancher server resource requirements, refer to [this section]({{}}/rancher/v2.5/en/installation/requirements/#rke-and-hosted-kubernetes) +- Your subscription has sufficient quota for at least 2 vCPUs. For details on Rancher server resource requirements, refer to [this section]({{}}/rancher/v2.6/en/installation/requirements/#rke-and-hosted-kubernetes) # 1. Prepare your Workstation @@ -113,6 +113,6 @@ There are many valid ways to set up the DNS. For help, refer to the [Azure DNS d # 8. Install the Rancher Helm Chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use that DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/_index.md index 53bb9ecfce1..abc02be9455 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/_index.md @@ -10,7 +10,7 @@ The first is a guide for deploying the Rancher server on an EKS cluster using Cl The second is a guide for installing an EKS cluster with an ingress by using command line tools. This guide may be useful if you want to use fewer resources while trying out Rancher on EKS. -If you already have an EKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have an EKS Kubernetes cluster, skip to the step about [installing an ingress.](#5-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) - [Automated Quickstart using AWS Best Practices](#automated-quickstart-using-aws-best-practices) - [Creating an EKS Cluster for the Rancher Server](#creating-an-eks-cluster-for-the-rancher-server) @@ -159,6 +159,6 @@ There are many valid ways to set up the DNS. For help, refer to the AWS document ### 8. Install the Rancher Helm Chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use that DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. \ No newline at end of file diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/_index.md index 68bdf90f03e..e390e6bf5c7 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/_index.md @@ -2,17 +2,17 @@ title: Rancher Helm Chart Options weight: 1 aliases: - - /rancher/v2.5/en/installation/options/ - - /rancher/v2.5/en/installation/options/chart-options/ - - /rancher/v2.5/en/installation/options/helm2/helm-rancher/chart-options/ - - /rancher/v2.5/en/installation/resources/chart-options + - /rancher/v2.6/en/installation/options/ + - /rancher/v2.6/en/installation/options/chart-options/ + - /rancher/v2.6/en/installation/options/helm2/helm-rancher/chart-options/ + - /rancher/v2.6/en/installation/resources/chart-options --- This page is a configuration reference for the Rancher Helm chart. -For help choosing a Helm chart version, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/choosing-version/) +For help choosing a Helm chart version, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/choosing-version/) -For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/feature-flags/) +For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/feature-flags/) - [Common Options](#common-options) - [Advanced Options](#advanced-options) @@ -46,7 +46,7 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.5/en/installation/api-auditing) level. 0 is off. [0-3] | +| `auditLog.level` | 0 | `int` - set the [API Audit Log]({{}}/rancher/v2.6/en/installation/api-auditing) level. 0 is off. [0-3] | | `auditLog.maxAge` | 1 | `int` - maximum number of days to retain old audit log files (only applies when `auditLog.destination` is set to `hostPath`) | | `auditLog.maxBackup` | 1 | `int` - maximum number of audit log files to retain (only applies when `auditLog.destination` is set to `hostPath`) | | `auditLog.maxSize` | 100 | `int` - maximum size in megabytes of the audit log file before it gets rotated (only applies when `auditLog.destination` is set to `hostPath`) | @@ -66,7 +66,7 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#restricted-admin) | +| `restrictedAdmin` | `false` | _Available in Rancher v2.5_ `bool` - When this option is set to true, the initial Rancher user has restricted access to the local Kubernetes cluster to prevent privilege escalation. For more information, see the section about the [restricted-admin role.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#restricted-admin) | | `systemDefaultRegistry` | "" | `string` - private registry to be used for all system Docker images, e.g., http://registry.example.com/ | | `tls` | "ingress" | `string` - See [External TLS Termination](#external-tls-termination) for details. - "ingress, external" | | `useBundledSystemChart` | `false` | `bool` - select to use the system-charts packaged with Rancher server. This option is used for air gapped installations. | @@ -75,15 +75,15 @@ For information on enabling experimental features, refer to [this page.]({{}}/rancher/v2.5/en/installation/api-auditing/). +Enabling the [API Audit Log]({{}}/rancher/v2.6/en/installation/api-auditing/). -You can collect this log as you would any container log. Enable [logging]({{}}/rancher/v2.5/en/logging) for the `System` Project on the Rancher server cluster. +You can collect this log as you would any container log. Enable [logging]({{}}/rancher/v2.6/en/logging) for the `System` Project on the Rancher server cluster. ```plain --set auditLog.level=1 ``` -By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging]({{}}/rancher/v2.5/en/logging) for the Rancher server cluster or System Project. +By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging]({{}}/rancher/v2.6/en/logging) for the Rancher server cluster or System Project. Set the `auditLog.destination` to `hostPath` to forward logs to volume shared with the host system instead of streaming to a sidecar container. When setting the destination to `hostPath` you may want to adjust the other auditLog parameters for log rotation. @@ -105,7 +105,7 @@ To set a different TLS configuration, you can use the `CATTLE_TLS_MIN_VERSION` a --set 'extraEnv[0].value=1.0' ``` -See [TLS settings]({{}}/rancher/v2.5/en/admin-settings/tls-settings) for more information and options. +See [TLS settings]({{}}/rancher/v2.6/en/admin-settings/tls-settings) for more information and options. ### Import `local` Cluster @@ -166,8 +166,8 @@ kubectl -n cattle-system create secret generic tls-ca-additional --from-file=ca- For details on installing Rancher with a private registry, see: -- [Air Gap: Docker Install]({{}}/rancher/v2.5/en/installation/air-gap-single-node/) -- [Air Gap: Kubernetes Install]({{}}/rancher/v2.5/en/installation/air-gap-high-availability/) +- [Air Gap: Docker Install]({{}}/rancher/v2.6/en/installation/air-gap-single-node/) +- [Air Gap: Kubernetes Install]({{}}/rancher/v2.6/en/installation/air-gap-high-availability/) # External TLS Termination @@ -175,7 +175,7 @@ We recommend configuring your load balancer as a Layer 4 balancer, forwarding pl You may terminate the SSL/TLS on a L7 load balancer external to the Rancher cluster (ingress). Use the `--set tls=external` option and point your load balancer at port http 80 on all of the Rancher cluster nodes. This will expose the Rancher interface on http port 80. Be aware that clients that are allowed to connect directly to the Rancher cluster will not be encrypted. If you choose to do this we recommend that you restrict direct access at the network level to just your load balancer. -> **Note:** If you are using a Private CA signed certificate, add `--set privateCA=true` and see [Adding TLS Secrets - Using a Private CA Signed Certificate]({{}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to add the CA cert for Rancher. +> **Note:** If you are using a Private CA signed certificate, add `--set privateCA=true` and see [Adding TLS Secrets - Using a Private CA Signed Certificate]({{}}/rancher/v2.6/en/installation/resources/encryption/tls-secrets/) to add the CA cert for Rancher. Your load balancer must support long lived websocket connections and will need to insert proxy headers so Rancher can route links correctly. diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/gke/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/gke/_index.md index 492a2f60ccc..d2e3a525d08 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/gke/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/gke/_index.md @@ -6,13 +6,13 @@ weight: 5 In this section, you'll learn how to install Rancher using Google Kubernetes Engine. -If you already have a GKE Kubernetes cluster, skip to the step about [installing an ingress.](#7-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) +If you already have a GKE Kubernetes cluster, skip to the step about [installing an ingress.](#7-install-an-ingress) Then install the Rancher Helm chart following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) # Prerequisites - You will need a Google account. - You will need a Google Cloud billing account. You can manage your Cloud Billing accounts using the Google Cloud Console. For more information about the Cloud Console, visit [General guide to the console.](https://support.google.com/cloud/answer/3465889?hl=en&ref_topic=3340599) -- You will need a cloud quota for at least one in-use IP address and at least 2 CPUs. For more details about hardware requirements for the Rancher server, refer to [this section.]({{}}/rancher/v2.5/en/installation/requirements/#rke-and-hosted-kubernetes) +- You will need a cloud quota for at least one in-use IP address and at least 2 CPUs. For more details about hardware requirements for the Rancher server, refer to [this section.]({{}}/rancher/v2.6/en/installation/requirements/#rke-and-hosted-kubernetes) # 1. Enable the Kubernetes Engine API @@ -175,6 +175,6 @@ There are many valid ways to set up the DNS. For help, refer to the Google Cloud # 10. Install the Rancher Helm chart -Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. +Next, install the Rancher Helm chart by following the instructions on [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/#install-the-rancher-helm-chart) The Helm instructions are the same for installing Rancher on any Kubernetes distribution. Use the DNS name from the previous step as the Rancher server URL when you install Rancher. It can be passed in as a Helm option. For example, if the DNS name is `rancher.my.org`, you could run the Helm installation command with the option `--set hostname=rancher.my.org`. \ No newline at end of file diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks/_index.md index acf3b933318..312555f92ec 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/rollbacks/_index.md @@ -24,14 +24,14 @@ A restore is performed by creating a Restore custom resource. > **Important** > -> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +> * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.]({{}}/rancher/v2.6/en/backups/migrating-rancher) > * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. ### Create the Restore Custom Resource 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.** -1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.5/en/backups/examples) +1. Create the Restore with the form, or with YAML. For creating the Restore resource using form, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/configuration/restore-config) and to the [examples.]({{}}/rancher/v2.6/en/backups/examples) 1. For using the YAML editor, we can click **Create > Create from YAML.** Enter the Restore YAML. ```yaml @@ -52,7 +52,7 @@ A restore is performed by creating a Restore custom resource. endpoint: s3.us-west-2.amazonaws.com ``` - For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.5/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.5/en/backups/v2.5/examples/) + For help configuring the Restore, refer to the [configuration reference]({{}}/rancher/v2.6/en/backups/v2.5/configuration/restore-config/) and to the [examples.]({{}}/rancher/v2.6/en/backups/v2.5/examples/) 1. Click **Create.** @@ -82,7 +82,7 @@ Rancher can be rolled back using the Rancher UI. To roll back to Rancher before v2.5, follow the procedure detailed here: [Restoring Backups — Kubernetes installs]({{}}/rancher/v2.0-v2.4/en/backups/restore/rke-restore/) Restoring a snapshot of the Rancher server cluster will revert Rancher to the version and state at the time of the snapshot. -For information on how to roll back Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks) +For information on how to roll back Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks) > Managed clusters are authoritative for their state. This means restoring the rancher server will not revert workload deployments or changes made on managed clusters after the snapshot was taken. diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/_index.md index f3ac8f7e527..74071733b47 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/_index.md @@ -2,25 +2,25 @@ title: Upgrades weight: 2 aliases: - - /rancher/v2.5/en/upgrades/upgrades - - /rancher/v2.5/en/installation/upgrades-rollbacks/upgrades - - /rancher/v2.5/en/upgrades/upgrades/ha-server-upgrade-helm-airgap - - /rancher/v2.5/en/upgrades/air-gap-upgrade/ - - /rancher/v2.5/en/upgrades/upgrades/ha - - /rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/upgrades/ha - - /rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ - - /rancher/v2.5/en/upgrades/upgrades/ha-server-upgrade-helm/ - - /rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha - - /rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades - - /rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/ha - - /rancher/v2.5/en/installation/upgrades-rollbacks/ - - /rancher/v2.5/en/upgrades/ + - /rancher/v2.6/en/upgrades/upgrades + - /rancher/v2.6/en/installation/upgrades-rollbacks/upgrades + - /rancher/v2.6/en/upgrades/upgrades/ha-server-upgrade-helm-airgap + - /rancher/v2.6/en/upgrades/air-gap-upgrade/ + - /rancher/v2.6/en/upgrades/upgrades/ha + - /rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/upgrades/ha + - /rancher/v2.6/en/installation/upgrades-rollbacks/upgrades/ + - /rancher/v2.6/en/upgrades/upgrades/ha-server-upgrade-helm/ + - /rancher/v2.6/en/installation/upgrades-rollbacks/upgrades/ha + - /rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades + - /rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/ha + - /rancher/v2.6/en/installation/upgrades-rollbacks/ + - /rancher/v2.6/en/upgrades/ --- 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 gap installs with Helm. -For the instructions to upgrade Rancher installed on Kubernetes with RancherD, refer to [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-linux/upgrades) +For the instructions to upgrade Rancher installed on Kubernetes with RancherD, refer to [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-linux/upgrades) -For the instructions to upgrade Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-upgrades) +For the instructions to upgrade Rancher installed with Docker, refer to [this page.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades) To upgrade the components in your Kubernetes cluster, or the definition of the [Kubernetes services]({{}}/rke/latest/en/config-options/services/) or [add-ons]({{}}/rke/latest/en/config-options/add-ons/), refer to the [upgrade documentation for RKE]({{}}/rke/latest/en/upgrades/), the Rancher Kubernetes Engine. @@ -43,7 +43,7 @@ The kubeconfig can also be manually targeted for the intended cluster with the ` Review the list of known issues for each Rancher version, which can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) -Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren't supported. +Note that upgrades _to_ or _from_ any chart in the [rancher-alpha repository]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren't supported. ### Helm Version @@ -53,15 +53,15 @@ For migration of installs started with Helm 2, refer to the official [Helm 2 to ### For air gap installs: Populate private registry -For [air gap installs only,]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version. Follow the guide to [populate your private registry]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. +For [air gap installs only,]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version. Follow the guide to [populate your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. ### For upgrades from a Rancher server with a hidden local cluster -If you are upgrading to Rancher v2.5 from a Rancher server that was started with the Helm chart option `--add-local=false`, you will need to drop that flag when upgrading. Otherwise, the Rancher server will not start. The `restricted-admin` role can be used to continue restricting access to the local cluster. For more information, see [this section.]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/#upgrading-from-rancher-with-a-hidden-local-cluster) +If you are upgrading to Rancher v2.5 from a Rancher server that was started with the Helm chart option `--add-local=false`, you will need to drop that flag when upgrading. Otherwise, the Rancher server will not start. The `restricted-admin` role can be used to continue restricting access to the local cluster. For more information, see [this section.]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/#upgrading-from-rancher-with-a-hidden-local-cluster) ### For upgrades with cert-manager older than 0.8.0 -[Let's Encrypt will be blocking cert-manager instances older than 0.8.0 starting November 1st 2019.](https://community.letsencrypt.org/t/blocking-old-cert-manager-versions/98753) Upgrade cert-manager to the latest version by following [these instructions.]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager) +[Let's Encrypt will be blocking cert-manager instances older than 0.8.0 starting November 1st 2019.](https://community.letsencrypt.org/t/blocking-old-cert-manager-versions/98753) Upgrade cert-manager to the latest version by following [these instructions.]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager) # Upgrade Outline @@ -74,7 +74,7 @@ Follow the steps to upgrade Rancher server: # 1. Back up Your Kubernetes Cluster that is Running Rancher Server -Use the [backup application]({{}}/rancher/v2.5/en/backups/back-up-rancher) to back up Rancher. +Use the [backup application]({{}}/rancher/v2.6/en/backups/back-up-rancher) to back up Rancher. You'll use the backup as a restoration point if something goes wrong during upgrade. @@ -88,7 +88,7 @@ You'll use the backup as a restoration point if something goes wrong during upgr 1. Get the repository name that you used to install Rancher. - For information about the repos and their differences, see [Helm Chart Repositories]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). + For information about the repos and their differences, see [Helm Chart Repositories]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). {{< release-channel >}} @@ -100,7 +100,7 @@ You'll use the backup as a restoration point if something goes wrong during upgr rancher- https://releases.rancher.com/server-charts/ ``` - > **Note:** If you want to switch to a different Helm chart repository, please follow the [steps on how to switch repositories]({{}}/rancher/v2.5/en/installation/resources/choosing-version/#switching-to-a-different-helm-chart-repository). If you switch repositories, make sure to list the repositories again before continuing onto Step 3 to ensure you have the correct one added. + > **Note:** If you want to switch to a different Helm chart repository, please follow the [steps on how to switch repositories]({{}}/rancher/v2.6/en/installation/resources/choosing-version/#switching-to-a-different-helm-chart-repository). If you switch repositories, make sure to list the repositories again before continuing onto Step 3 to ensure you have the correct one added. 1. Fetch the latest chart to install Rancher from the Helm chart repository. @@ -172,7 +172,7 @@ If you are currently running the cert-manger whose version is older than v0.11, helm delete rancher -n cattle-system ``` -2. Uninstall and reinstall `cert-manager` according to the instructions on the [Upgrading Cert-Manager]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager) page. +2. Uninstall and reinstall `cert-manager` according to the instructions on the [Upgrading Cert-Manager]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager) page. 3. Reinstall Rancher to the latest version with all your settings. Take all the values from the step 1 and append them to the command using `--set key=value`. Note: There will be many more options from the step 1 that need to be appended. diff --git a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/_index.md b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/_index.md index 5e69f3ea54e..3b0ef16a876 100644 --- a/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/_index.md +++ b/content/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/air-gap-upgrade/_index.md @@ -4,7 +4,7 @@ shortTitle: Air Gap Upgrade weight: 1 --- -> These instructions assume you have already followed the instructions for a Kubernetes upgrade on [this page,]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/) including the prerequisites, up until step 3. Upgrade Rancher. +> These instructions assume you have already followed the instructions for a Kubernetes upgrade on [this page,]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/) including the prerequisites, up until step 3. Upgrade Rancher. ### Rancher Helm Template Options diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/_index.md index 20b34efef95..c6c34ac234b 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/_index.md @@ -5,16 +5,16 @@ weight: 3 ### Air Gapped Installations -Follow [these steps]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) to install the Rancher server in an air gapped environment. +Follow [these steps]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. ### Docker Installations -The [single-node Docker installation]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. +The [single-node Docker installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. The Docker installation is for development and testing environments only. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -For Rancher v2.5+, the Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.5/en/backups/migrating-rancher) \ No newline at end of file +For Rancher v2.5+, the Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) \ No newline at end of file diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/_index.md index 57d7dc158c4..0680f526e3e 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/_index.md @@ -2,16 +2,16 @@ title: Air Gapped Helm CLI Install weight: 1 aliases: - - /rancher/v2.5/en/installation/air-gap-installation/ - - /rancher/v2.5/en/installation/air-gap-high-availability/ - - /rancher/v2.5/en/installation/air-gap-single-node/ + - /rancher/v2.6/en/installation/air-gap-installation/ + - /rancher/v2.6/en/installation/air-gap-high-availability/ + - /rancher/v2.6/en/installation/air-gap-single-node/ --- This section is about using the Helm CLI to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. The installation steps differ depending on whether Rancher is installed on an RKE Kubernetes cluster, a K3s Kubernetes cluster, or a single Docker container. -For more information on each installation option, refer to [this page.]({{}}/rancher/v2.5/en/installation/) +For more information on each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation/) Throughout the installation instructions, there will be _tabs_ for each installation option. @@ -19,13 +19,13 @@ Throughout the installation instructions, there will be _tabs_ for each installa # Installation Outline -1. [Set up infrastructure and private registry]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/) -2. [Collect and publish images to your private registry]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/) -3. [Set up a Kubernetes cluster (Skip this step for Docker installations)]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/) -4. [Install Rancher]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/) +1. [Set up infrastructure and private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/) +2. [Collect and publish images to your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) +3. [Set up a Kubernetes cluster (Skip this step for Docker installations)]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/) +4. [Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/) # Upgrades -To upgrade Rancher with Helm CLI in an air gap environment, follow [this procedure.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/) +To upgrade Rancher with Helm CLI in an air gap environment, follow [this procedure.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/) -### [Next: Prepare your Node(s)]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/prepare-nodes/) +### [Next: Prepare your Node(s)]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/_index.md index f70e8ada91e..c4f6cba29f5 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/_index.md @@ -2,12 +2,12 @@ title: 4. Install Rancher weight: 400 aliases: - - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-system-charts/ - - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ - - /rancher/v2.5/en/installation/air-gap-single-node/install-rancher - - /rancher/v2.5/en/installation/air-gap/install-rancher - - /rancher/v2.5/en/installation/air-gap-installation/install-rancher/ - - /rancher/v2.5/en/installation/air-gap-high-availability/install-rancher/ + - /rancher/v2.6/en/installation/air-gap-high-availability/config-rancher-system-charts/ + - /rancher/v2.6/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ + - /rancher/v2.6/en/installation/air-gap-single-node/install-rancher + - /rancher/v2.6/en/installation/air-gap/install-rancher + - /rancher/v2.6/en/installation/air-gap-installation/install-rancher/ + - /rancher/v2.6/en/installation/air-gap-high-availability/install-rancher/ --- 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. @@ -35,9 +35,9 @@ This section describes installing Rancher: From a system that has access to the internet, fetch the latest Helm chart and copy the resulting manifests to a system that has access to the Rancher server cluster. -1. If you haven't already, install `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. +1. If you haven't already, install `helm` locally on a workstation that has internet access. Note: Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/options/helm-version) 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]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). +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]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories). {{< release-channel >}} ``` helm repo add rancher- https://releases.rancher.com/server-charts/ @@ -59,7 +59,7 @@ Rancher Server is designed to be secure by default and requires SSL/TLS configur When Rancher is installed on an air gapped Kubernetes cluster, there are two recommended options for the source of the certificate. -> **Note:** If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). +> **Note:** If you want terminate SSL/TLS externally, see [TLS termination on an External Load Balancer]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination). | Configuration | Chart option | Description | Requires cert-manager | | ------------------------------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | @@ -86,7 +86,7 @@ Based on the choice your made in [2. Choose your SSL Configuration](#2-choose-yo By default, Rancher generates a CA and uses cert-manager to issue the certificate for access to the Rancher server interface. > **Note:** -> Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade cert-manager documentation]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager/). +> Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.11.0, please see our [upgrade cert-manager documentation]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager/). ### 1. Add the cert-manager repo @@ -193,7 +193,7 @@ If you are using a Private CA signed cert, add `--set privateCA=true` following **Optional**: To install a specific Rancher version, set the `rancherImageTag` value, example: `--set rancherImageTag=v2.3.6` -Then refer to [Adding TLS Secrets]({{}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. +Then refer to [Adding TLS Secrets]({{}}/rancher/v2.6/en/installation/resources/encryption/tls-secrets/) to publish the certificate files so Rancher and the ingress controller can use them. # 4. Install Rancher @@ -237,12 +237,12 @@ kubectl -n cattle-system apply -R -f ./rancher ``` The installation is complete. -> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.5/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. +> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. # Additional Resources These resources could be helpful when installing Rancher: -- [Rancher Helm chart options]({{}}/rancher/v2.5/en/installation/resources/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) -- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) +- [Rancher Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) +- [Adding TLS secrets]({{}}/rancher/v2.6/en/installation/resources/encryption/tls-secrets/) +- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/_index.md index 81a30b69e84..cff561a6dd9 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/docker-install-commands/_index.md @@ -7,7 +7,7 @@ The Docker installation is for Rancher users who want to test out Rancher. Instead of running on a Kubernetes cluster, you install the Rancher server component on a single node using a `docker run` command. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. -For Rancher v2.5+, the backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +For Rancher v2.5+, the backup application can be used to migrate the Rancher server from a Docker install to a Kubernetes install using [these steps.]({{}}/rancher/v2.6/en/backups/migrating-rancher) For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster. @@ -18,8 +18,8 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher > **Do you want to...** > -> - Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.5/en/installation/options/custom-ca-root-certificate/). -> - Record all transactions with the Rancher API? See [API Auditing]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log). +> - Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.6/en/installation/options/custom-ca-root-certificate/). +> - Record all transactions with the Rancher API? See [API Auditing]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log). Choose from the following options: @@ -34,7 +34,7 @@ Log into your Linux host, and then run the installation command below. When ente | Placeholder | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | As of Rancher v2.5, privileged access is [required.](#privileged-access-for-rancher-v2-5) @@ -59,7 +59,7 @@ In development or testing environments where your team will access your Rancher > From a computer with an internet connection, create a self-signed certificate using [OpenSSL](https://www.openssl.org/) or another method of your choice. > > - The certificate files must be in PEM format. -> - In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +> - In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) After creating your certificate, log into your Linux host, and then run the installation command below. When entering the command, use the table below to replace each placeholder. Use the `-v` flag and provide the path to your certificates to mount them in your container. @@ -70,7 +70,7 @@ After creating your certificate, log into your Linux host, and then run the inst | `` | The path to the private key for your certificate. | | `` | The path to the certificate authority's certificate. | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | As of Rancher v2.5, privileged access is [required.](#privileged-access-for-rancher-v2-5) @@ -104,7 +104,7 @@ After obtaining your certificate, log into your Linux host, and then run the ins | `` | The path to your full certificate chain. | | `` | The path to the private key for your certificate. | | `` | Your private registry URL and port. | -| `` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to install. | +| `` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to install. | > **Note:** Use the `--no-cacerts` as argument to the container to disable the default CA certificate generated by Rancher. @@ -126,5 +126,5 @@ docker run -d --restart=unless-stopped \ -> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.5/en/faq/telemetry/) during the initial login. +> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md index d30cfd006ef..b063349521c 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/_index.md @@ -2,12 +2,12 @@ title: '3. Install Kubernetes (Skip for Docker Installs)' weight: 300 aliases: - - /rancher/v2.5/en/installation/air-gap-high-availability/install-kube + - /rancher/v2.6/en/installation/air-gap-high-availability/install-kube --- > Skip this section if you are installing Rancher on a single node with Docker. -This section describes how to install a Kubernetes cluster according to our [best practices for the Rancher server environment.]({{}}/rancher/v2.5/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) This cluster should be dedicated to run only the Rancher server. +This section describes how to install a Kubernetes cluster according to our [best practices for the Rancher server environment.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) This cluster should be dedicated to run only the Rancher server. As of Rancher v2.5, Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes providers. @@ -217,6 +217,6 @@ Save a copy of the following files in a secure location: ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) page. +See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) page. ### [Next: Install Rancher](../install-rancher) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md index 6a42b228665..881c9908c50 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/_index.md @@ -2,20 +2,20 @@ title: '2. Collect and Publish Images to your Private Registry' weight: 200 aliases: - - /rancher/v2.5/en/installation/air-gap-high-availability/prepare-private-registry/ - - /rancher/v2.5/en/installation/air-gap-single-node/prepare-private-registry/ - - /rancher/v2.5/en/installation/air-gap-single-node/config-rancher-for-private-reg/ - - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ - - /rancher/v2.5/en/installation/air-gap-installation/prepare-private-reg/ + - /rancher/v2.6/en/installation/air-gap-high-availability/prepare-private-registry/ + - /rancher/v2.6/en/installation/air-gap-single-node/prepare-private-registry/ + - /rancher/v2.6/en/installation/air-gap-single-node/config-rancher-for-private-reg/ + - /rancher/v2.6/en/installation/air-gap-high-availability/config-rancher-for-private-reg/ + - /rancher/v2.6/en/installation/air-gap-installation/prepare-private-reg/ --- This section describes how to set up your private registry so that when you install Rancher, Rancher will pull all the required images from this registry. -By default, all images used to [provision Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/) or launch any [tools]({{}}/rancher/v2.5/en/cluster-admin/tools/) in Rancher, e.g. monitoring, pipelines, alerts, are pulled from Docker Hub. In an air gapped installation of Rancher, you will need a private registry that is located somewhere accessible by your Rancher server. Then, you will load the registry with all the images. +By default, all images used to [provision Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) or launch any [tools]({{}}/rancher/v2.6/en/cluster-admin/tools/) in Rancher, e.g. monitoring, pipelines, alerts, are pulled from Docker Hub. In an air gapped installation of Rancher, you will need a private registry that is located somewhere accessible by your Rancher server. Then, you will load the registry with all the images. Populating the private registry with images is the same process for installing Rancher with Docker and for installing Rancher on a Kubernetes cluster. -The steps in this section differ depending on whether or not you are planning to use Rancher to provision a downstream cluster with Windows nodes or not. By default, we provide the steps of how to populate your private registry assuming that Rancher will provision downstream Kubernetes clusters with only Linux nodes. But if you plan on provisioning any [downstream Kubernetes clusters using Windows nodes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/windows-clusters/), there are separate instructions to support the images needed. +The steps in this section differ depending on whether or not you are planning to use Rancher to provision a downstream cluster with Windows nodes or not. By default, we provide the steps of how to populate your private registry assuming that Rancher will provision downstream Kubernetes clusters with only Linux nodes. But if you plan on provisioning any [downstream Kubernetes clusters using Windows nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/windows-clusters/), there are separate instructions to support the images needed. > **Prerequisites:** > @@ -59,7 +59,7 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS 1. Fetch the latest `cert-manager` Helm chart and parse the template for image details: - > **Note:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager/). + > **Note:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager/). ```plain helm repo add jetstack https://charts.jetstack.io @@ -231,7 +231,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are **For Kubernetes Installs using Rancher Generated Self-Signed Certificate:** In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS certificates, you must add the [`cert-manager`](https://hub.helm.sh/charts/jetstack/cert-manager) image to `rancher-images.txt` as well. You skip this step if you are using you using your own certificates. 1. Fetch the latest `cert-manager` Helm chart and parse the template for image details: - > **Note:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager/). + > **Note:** Recent changes to cert-manager require an upgrade. If you are upgrading Rancher and using a version of cert-manager older than v0.12.0, please see our [upgrade documentation]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager/). ```plain helm repo add jetstack https://charts.jetstack.io helm repo update @@ -290,6 +290,6 @@ The image list, `rancher-images.txt` or `rancher-windows-images.txt`, is expecte {{% /tab %}} {{% /tabs %}} -### [Next step for Kubernetes Installs - Launch a Kubernetes Cluster]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/launch-kubernetes/) +### [Next step for Kubernetes Installs - Launch a Kubernetes Cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/launch-kubernetes/) -### [Next step for Docker Installs - Install Rancher]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher/) +### [Next step for Docker Installs - Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md index 0d21d8ca329..f76772cccae 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/air-gap/prepare-nodes/_index.md @@ -2,14 +2,14 @@ title: '1. Set up Infrastructure and Private Registry' weight: 100 aliases: - - /rancher/v2.5/en/installation/air-gap-single-node/provision-host + - /rancher/v2.6/en/installation/air-gap-single-node/provision-host --- In this section, you will provision the underlying infrastructure for your Rancher management server in an air gapped environment. You will also set up the private Docker registry that must be available to your Rancher node(s). An air gapped environment is an environment where the Rancher server is installed offline or behind a firewall. -The infrastructure depends on whether you are installing Rancher on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. For more information on each installation option, refer to [this page.]({{}}/rancher/v2.5/en/installation/) +The infrastructure depends on whether you are installing Rancher on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. For more information on each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation/) As of Rancher v2.5, Rancher can be installed on any Kubernetes cluster. The RKE and K3s Kubernetes infrastructure tutorials below are still included for convenience. @@ -27,9 +27,9 @@ We recommend setting up the following infrastructure for a high-availability ins These hosts will be disconnected from the internet, but require being able to connect with your private registry. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. ### 2. Set up External Datastore @@ -43,7 +43,7 @@ For a high-availability K3s installation, you will need to set up one of the fol When you install Kubernetes, you will pass in details for K3s to connect to the database. -For an example of one way to set up the database, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/rds) for setting up a MySQL database on Amazon's RDS service. +For an example of one way to set up the database, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/rds) for setting up a MySQL database on Amazon's RDS service. For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/datastore/) @@ -58,11 +58,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nginx/) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nlb/) > **Important:** > Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications. @@ -106,9 +106,9 @@ The etcd database requires an odd number of nodes so that it can always elect a These hosts will be disconnected from the internet, but require being able to connect with your private registry. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -121,11 +121,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nginx/) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nlb/) > **Important:** > Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications. @@ -152,15 +152,15 @@ If you need help with creating a private registry, please refer to the [official {{% tab "Docker" %}} > The Docker installation is for Rancher users that are wanting to test out Rancher. Since there is only one node and a single Docker container, if the node goes down, you will lose all the data of your Rancher server. > -> As of Rancher v2.5, the Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +> As of Rancher v2.5, the Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) ### 1. Set up a Linux Node This host will be disconnected from the Internet, but needs to be able to connect to your private registry. -Make sure that your node fulfills the general installation requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your node fulfills the general installation requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. ### 2. Set up a Private Docker Registry @@ -173,4 +173,4 @@ If you need help with creating a private registry, please refer to the [official {{% /tab %}} {{% /tabs %}} -### [Next: Collect and Publish Images to your Private Registry]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/) +### [Next: Collect and Publish Images to your Private Registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/_index.md index 958d25fbba1..2214b1c3b25 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/_index.md @@ -5,10 +5,10 @@ weight: 4 In a lot of enterprise environments, servers or VMs running on premise do not have direct Internet access, but must connect to external services through a HTTP(S) proxy for security reasons. This tutorial shows step by step how to set up a highly available Rancher installation in such an environment. -Alternatively, it is also possible to set up Rancher completely air-gapped without any Internet access. This process is described in detail in the [Rancher docs]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/). +Alternatively, it is also possible to set up Rancher completely air-gapped without any Internet access. This process is described in detail in the [Rancher docs]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/). # Installation Outline -1. [Set up infrastructure]({{}}/rancher/v2.5/en/installation/other-installation-methods/behind-proxy/prepare-nodes/) -2. [Set up a Kubernetes cluster]({{}}/rancher/v2.5/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) -3. [Install Rancher]({{}}/rancher/v2.5/en/installation/other-installation-methods/behind-proxy/install-rancher/) +1. [Set up infrastructure]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/) +2. [Set up a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) +3. [Install Rancher]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/_index.md index 93d0a036753..bdfb4b94d26 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/install-rancher/_index.md @@ -76,12 +76,12 @@ kubectl rollout status deployment -n cattle-system rancher You can now navigate to `https://rancher.example.com` and start using Rancher. -> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.5/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. +> **Note:** If you don't intend to send telemetry data, opt out [telemetry]({{}}/rancher/v2.6/en/faq/telemetry/) during the initial login. Leaving this active in an air-gapped environment can cause issues if the sockets cannot be opened successfully. ### Additional Resources These resources could be helpful when installing Rancher: -- [Rancher Helm chart options]({{}}/rancher/v2.5/en/installation/resources/chart-options/) -- [Adding TLS secrets]({{}}/rancher/v2.5/en/installation/resources/encryption/tls-secrets/) -- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) +- [Rancher Helm chart options]({{}}/rancher/v2.6/en/installation/resources/chart-options/) +- [Adding TLS secrets]({{}}/rancher/v2.6/en/installation/resources/encryption/tls-secrets/) +- [Troubleshooting Rancher Kubernetes Installations]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/_index.md index 827db99094e..18038f5f6f7 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/_index.md @@ -146,6 +146,6 @@ Save a copy of the following files in a secure location: ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) page. +See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) page. ### [Next: Install Rancher](../install-rancher) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/_index.md index 082dec158ac..8338901c524 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/prepare-nodes/_index.md @@ -23,9 +23,9 @@ The etcd database requires an odd number of nodes so that it can always elect a These hosts will connect to the internet through an HTTP proxy. -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -38,11 +38,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nginx/) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nlb/) > **Important:** > Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications. @@ -58,4 +58,4 @@ You will need to specify this hostname in a later step when you install Rancher, For a how-to guide for setting up a DNS record to route domain traffic to an Amazon ELB load balancer, refer to the [official AWS documentation.](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-elb-load-balancer) -### [Next: Set up a Kubernetes cluster]({{}}/rancher/v2.5/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) +### [Next: Set up a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/other-installation-methods/behind-proxy/launch-kubernetes/) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/_index.md index fc61e42affe..04c6536d665 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/_index.md @@ -2,7 +2,7 @@ title: Install/Upgrade Rancher with RancherD weight: 3 aliases: - - /rancher/v2.5/en/installation/install-rancher-on-linux + - /rancher/v2.6/en/installation/install-rancher-on-linux --- _Available as of Rancher v2.5.4_ @@ -32,7 +32,7 @@ Configuration and upgrading are also simplified with RancherD. When you upgrade In Part I of these instructions, you'll learn how to launch RancherD on a single node. The result of following the steps in Part I is a single-node [RKE2](https://docs.rke2.io/) Kubernetes cluster with the Rancher server installed. This cluster can easily become high availability later. If Rancher only needs to manage the local Kubernetes cluster, the installation is complete. -Part II explains how to convert the single-node Rancher installation into a high-availability installation. If the Rancher server will manage downstream Kubernetes clusters, it is important to follow these steps. A discussion of recommended architecture for highly available Rancher deployments can be found in our [Best Practices Guide.]({{}}/rancher/v2.5/en/best-practices/v2.5/rancher-server) +Part II explains how to convert the single-node Rancher installation into a high-availability installation. If the Rancher server will manage downstream Kubernetes clusters, it is important to follow these steps. A discussion of recommended architecture for highly available Rancher deployments can be found in our [Best Practices Guide.]({{}}/rancher/v2.6/en/best-practices/v2.5/rancher-server) # Prerequisites @@ -40,9 +40,9 @@ Part II explains how to convert the single-node Rancher installation into a high RancherD must be launched on a Linux OS. At this time, only OSes that leverage systemd are supported. -The Linux node needs to fulfill the [installation requirements]({{}}/rancher/v2.5/en/installation/requirements) for hardware and networking. Docker is not required for RancherD installs. +The Linux node needs to fulfill the [installation requirements]({{}}/rancher/v2.6/en/installation/requirements) for hardware and networking. Docker is not required for RancherD installs. -To install RancherD on SELinux Enforcing CentOS 8 nodes or RHEL 8 nodes, some [additional steps]({{}}/rancher/v2.5/en/installation/requirements/#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required. +To install RancherD on SELinux Enforcing CentOS 8 nodes or RHEL 8 nodes, some [additional steps]({{}}/rancher/v2.6/en/installation/requirements/#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required. ### Root Access Before running the installation commands, you will need to log in as root: @@ -99,9 +99,9 @@ If you do not specify a pre-shared secret, RancherD will generate one and place To specify your own pre-shared secret as the token, set the `token` argument on startup. -Installing Rancher this way will use Rancher-generated certificates. To use your own self-signed or trusted certificates, refer to the [configuration guide.]({{}}/rancher/v2.5/en/installation/install-rancher-on-linux/rancherd-configuration/#certificates-for-the-rancher-server) +Installing Rancher this way will use Rancher-generated certificates. To use your own self-signed or trusted certificates, refer to the [configuration guide.]({{}}/rancher/v2.6/en/installation/install-rancher-on-linux/rancherd-configuration/#certificates-for-the-rancher-server) -For information on customizing the RancherD Helm chart values.yaml, refer to [this section.]({{}}/rancher/v2.5/en/installation/install-rancher-on-linux/rancherd-configuration/#customizing-the-rancherd-helm-chart) +For information on customizing the RancherD Helm chart values.yaml, refer to [this section.]({{}}/rancher/v2.6/en/installation/install-rancher-on-linux/rancherd-configuration/#customizing-the-rancherd-helm-chart) ### 2. Launch the first server node diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rancherd-configuration/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rancherd-configuration/_index.md index 2e5965b9453..0100148ff60 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rancherd-configuration/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rancherd-configuration/_index.md @@ -2,7 +2,7 @@ title: RancherD Configuration Reference weight: 1 aliases: - - /rancher/v2.5/en/installation/install-rancher-on-linux/rancherd-configuration + - /rancher/v2.6/en/installation/install-rancher-on-linux/rancherd-configuration --- > RancherD is an experimental feature. @@ -69,7 +69,7 @@ Put this manifest on your host in `/var/lib/rancher/rke2/server/manifests` befor | `addLocal` | "auto" | ***string*** - Have Rancher detect and import the local Rancher server cluster | | `auditLog.destination` | "sidecar" | ***string*** - Stream to sidecar container console or hostPath volume - *"sidecar, hostPath"* | | `auditLog.hostPath` | "/var/log/rancher/audit" | ***string*** - log file destination on host (only applies when **auditLog.destination** is set to **hostPath**) | -| `auditLog.level` | 0 | ***int*** - set the [API Audit Log level](https://rancher.com/docs/rancher/v2.5/en/installation/api-auditing). 0 is off. [0-3] | +| `auditLog.level` | 0 | ***int*** - set the [API Audit Log level](https://rancher.com/docs/rancher/v2.6/en/installation/api-auditing). 0 is off. [0-3] | | `auditLog.maxAge` | 1 | ***int*** - maximum number of days to retain old audit log files (only applies when **auditLog.destination** is set to **hostPath**) | | `auditLog.maxBackups` | 1 | int - maximum number of audit log files to retain (only applies when **auditLog.destination** is set to **hostPath**) | | `auditLog.maxSize` | 100 | ***int*** - maximum size in megabytes of the audit log file before it gets rotated (only applies when **auditLog.destination** is set to **hostPath**) | diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rollbacks/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rollbacks/_index.md index 68a8b6dab82..56388e4bd92 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rollbacks/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/rollbacks/_index.md @@ -2,7 +2,7 @@ title: Rollbacks weight: 3 aliases: - - /rancher/v2.5/en/installation/install-rancher-on-linux/rollbacks + - /rancher/v2.6/en/installation/install-rancher-on-linux/rollbacks --- > RancherD is an experimental feature. diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/upgrades/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/upgrades/_index.md index a57c16f1a6e..e3d414afc4b 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/upgrades/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/install-rancher-on-linux/upgrades/_index.md @@ -2,7 +2,7 @@ title: Upgrades weight: 2 aliases: - - /rancher/v2.5/en/installation/install-rancher-on-linux/upgrades + - /rancher/v2.6/en/installation/install-rancher-on-linux/upgrades --- > RancherD is an experimental feature. @@ -19,7 +19,7 @@ To upgrade Rancher without upgrading the underlying Kubernetes cluster, follow t > Before upgrading, we recommend that you should: > -> - Create a backup of the Rancher server using the [backup application.]({{}}/rancher/v2.5/en/backups/v2.5/back-up-rancher/) +> - Create a backup of the Rancher server using the [backup application.]({{}}/rancher/v2.6/en/backups/v2.5/back-up-rancher/) > - Review the known issues for the Rancher version you are upgrading to. The known issues are listed in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) 1. Uninstall the chart with Helm: @@ -39,7 +39,7 @@ To upgrade Rancher without upgrading the underlying Kubernetes cluster, follow t **Result:** Rancher is upgraded to the new version. -If necessary, restore Rancher from backup by following [these steps.]({{}}/rancher/v2.5/en/backups/restoring-rancher/) +If necessary, restore Rancher from backup by following [these steps.]({{}}/rancher/v2.6/en/backups/restoring-rancher/) ### Upgrading Both Rancher and the Underlying Cluster @@ -47,7 +47,7 @@ Upgrade both RancherD and the underlying Kubernetes cluster by re-running the Ra > Before upgrading, we recommend that you should: > -> - Create a backup of the Rancher server using the [backup application.]({{}}/rancher/v2.5/en/backups/v2.5/back-up-rancher/) +> - Create a backup of the Rancher server using the [backup application.]({{}}/rancher/v2.6/en/backups/v2.5/back-up-rancher/) > - Review the known issues for the Rancher version you are upgrading to. The known issues are listed in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) ``` diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/_index.md index 14aaba60458..dcad228f2cb 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/_index.md @@ -3,9 +3,9 @@ title: Installing Rancher on a Single Node Using Docker description: For development and testing environments only, use a Docker install. Install Docker on a single Linux host, and deploy Rancher with a single Docker container. weight: 2 aliases: - - /rancher/v2.5/en/installation/single-node-install/ - - /rancher/v2.5/en/installation/single-node - - /rancher/v2.5/en/installation/other-installation-methods/single-node + - /rancher/v2.6/en/installation/single-node-install/ + - /rancher/v2.6/en/installation/single-node + - /rancher/v2.6/en/installation/other-installation-methods/single-node --- Rancher can be installed by running a single Docker container. @@ -13,11 +13,11 @@ Rancher can be installed by running a single Docker container. In this installation scenario, you'll install Docker on a single Linux host, and then deploy Rancher on your host using a single Docker container. > **Want to use an external load balancer?** -> See [Docker Install with an External Load Balancer]({{}}/rancher/v2.5/en/installation/options/single-node-install-external-lb) instead. +> See [Docker Install with an External Load Balancer]({{}}/rancher/v2.6/en/installation/options/single-node-install-external-lb) instead. A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version: -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) ### Privileged Access for Rancher v2.5+ @@ -25,11 +25,11 @@ When the Rancher server is deployed in the Docker container, a local Kubernetes # Requirements for OS, Docker, Hardware, and Networking -Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) # 1. Provision Linux Host -Provision a single Linux host according to our [Requirements]({{}}/rancher/v2.5/en/installation/requirements) to launch your Rancher server. +Provision a single Linux host according to our [Requirements]({{}}/rancher/v2.6/en/installation/requirements) to launch your Rancher server. # 2. Choose an SSL Option and Install Rancher @@ -37,9 +37,9 @@ For security purposes, SSL (Secure Sockets Layer) is required when using Rancher > **Do you want to...** > -> - Use a proxy? See [HTTP Proxy Configuration]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/proxy/) -> - Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate/) -> - Complete an Air Gap Installation? See [Air Gap: Docker Install]({{}}/rancher/v2.5/en/installation/air-gap-single-node/) +> - Use a proxy? See [HTTP Proxy Configuration]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) +> - Configure custom CA root certificate to access your services? See [Custom CA root certificate]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate/) +> - Complete an Air Gap Installation? See [Air Gap: Docker Install]({{}}/rancher/v2.6/en/installation/air-gap-single-node/) > - Record all transactions with the Rancher API? See [API Auditing](./advanced/#api-audit-log) Choose from the following options: @@ -71,7 +71,7 @@ In development or testing environments where your team will access your Rancher > Create a self-signed certificate using [OpenSSL](https://www.openssl.org/) or another method of your choice. > > - The certificate files must be in PEM format. -> - In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +> - In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) After creating your certificate, run the Docker command below to install Rancher. Use the `-v` flag and provide the path to your certificates to mount them in your container. @@ -101,7 +101,7 @@ In production environments where you're exposing an app publicly, use a certific > **Prerequisites:** > > - The certificate files must be in PEM format. -> - In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +> - In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) After obtaining your certificate, run the Docker command below. @@ -173,5 +173,5 @@ Refer to [this page](./troubleshooting) for frequently asked questions and troub ## What's Next? -- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.5/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. -- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.5/en/cluster-provisioning/). +- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.6/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. +- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.6/en/cluster-provisioning/). diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/_index.md index ff867857d63..bda58d0ce7a 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/_index.md @@ -3,7 +3,7 @@ title: Advanced Options for Docker Installs weight: 5 --- -When installing Rancher, there are several [advanced options]({{}}/rancher/v2.5/en/installation/options/) that can be enabled: +When installing Rancher, there are several [advanced options]({{}}/rancher/v2.6/en/installation/options/) that can be enabled: - [Custom CA Certificate](#custom-ca-certificate) - [API Audit Log](#api-audit-log) @@ -25,7 +25,7 @@ Use the command example to start a Rancher container with your private CA certif The example below is based on having the CA root certificates in the `/host/certs` directory on the host and mounting this directory on `/container/certs` inside the Rancher container. -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) ``` docker run -d --restart=unless-stopped \ @@ -42,9 +42,9 @@ The API Audit Log records all the user and system transactions made through Ranc The API Audit Log writes to `/var/log/auditlog` inside the rancher container by default. Share that directory as a volume and set your `AUDIT_LEVEL` to enable the log. -See [API Audit Log]({{}}/rancher/v2.5/en/installation/api-auditing) for more information and options. +See [API Audit Log]({{}}/rancher/v2.6/en/installation/api-auditing) for more information and options. -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) ``` docker run -d --restart=unless-stopped \ @@ -67,9 +67,9 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) -See [TLS settings]({{}}/rancher/v2.5/en/admin-settings/tls-settings) for more information and options. +See [TLS settings]({{}}/rancher/v2.6/en/admin-settings/tls-settings) for more information and options. ### Air Gap @@ -93,7 +93,7 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) ### Running `rancher/rancher` and `rancher/rancher-agent` on the Same Node @@ -112,4 +112,4 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/_index.md index d10edc10f5e..f14413abb8f 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/_index.md @@ -2,8 +2,8 @@ title: HTTP Proxy Configuration weight: 251 aliases: - - /rancher/v2.5/en/installation/proxy-configuration/ - - /rancher/v2.5/en/installation/single-node/proxy + - /rancher/v2.6/en/installation/proxy-configuration/ + - /rancher/v2.6/en/installation/single-node/proxy --- If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below. @@ -20,7 +20,7 @@ Make sure `NO_PROXY` contains the network addresses, network address ranges and ## Docker Installation -Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Docker Installation]({{}}/rancher/v2.5/en/installation/single-node-install/) are: +Passing environment variables to the Rancher container can be done using `-e KEY=VALUE` or `--env KEY=VALUE`. Required values for `NO_PROXY` in a [Docker Installation]({{}}/rancher/v2.6/en/installation/single-node-install/) are: - `localhost` - `127.0.0.1` @@ -42,4 +42,4 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/_index.md index 8ef7afd2e77..4cb6badd53e 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-rollbacks/_index.md @@ -2,11 +2,11 @@ title: Rolling Back Rancher Installed with Docker weight: 1015 aliases: - - /rancher/v2.5/en/upgrades/single-node-rollbacks - - /rancher/v2.5/en/upgrades/rollbacks/single-node-rollbacks + - /rancher/v2.6/en/upgrades/single-node-rollbacks + - /rancher/v2.6/en/upgrades/rollbacks/single-node-rollbacks --- -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]({{}}/rancher/v2.5/en/upgrades/upgrades/single-node-upgrade). Rolling back restores: +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]({{}}/rancher/v2.6/en/upgrades/upgrades/single-node-upgrade). Rolling back restores: - Your previous version of Rancher. - Your data backup created before upgrade. @@ -59,9 +59,9 @@ If you have issues upgrading Rancher, roll it back to its latest known healthy s ``` You can obtain the name for your Rancher container by entering `docker ps`. -1. Move the backup tarball that you created during completion of [Docker Upgrade]({{}}/rancher/v2.5/en/upgrades/upgrades/single-node-upgrade/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. +1. Move the backup tarball that you created during completion of [Docker Upgrade]({{}}/rancher/v2.6/en/upgrades/upgrades/single-node-upgrade/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Docker Upgrade]({{}}/rancher/v2.5/en/upgrades/upgrades/single-node-upgrade/), it will have a name similar to (`rancher-data-backup--.tar.gz`). + If you followed the naming convention we suggested in [Docker Upgrade]({{}}/rancher/v2.6/en/upgrades/upgrades/single-node-upgrade/), it will have a name similar to (`rancher-data-backup--.tar.gz`). 1. Run the following command to replace the data in the `rancher-data` container with the data in the backup tarball, replacing the placeholder. Don't forget to close the quotes. @@ -79,7 +79,7 @@ If you have issues upgrading Rancher, roll it back to its latest known healthy s --privileged \ rancher/rancher: ``` - As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) + As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) >**Note:** _Do not_ stop the rollback after initiating it, even if the rollback process seems longer than expected. Stopping the rollback may result in database issues during future upgrades. diff --git a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md index a4b9b4b9583..bc50af19b0e 100644 --- a/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md +++ b/content/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-upgrades/_index.md @@ -2,19 +2,19 @@ title: Upgrading Rancher Installed with Docker weight: 1010 aliases: - - /rancher/v2.5/en/upgrades/single-node-upgrade/ - - /rancher/v2.5/en/upgrades/upgrades/single-node-air-gap-upgrade - - /rancher/v2.5/en/upgrades/upgrades/single-node - - /rancher/v2.5/en/upgrades/upgrades/single-node-upgrade/ - - /rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/upgrades/single-node/ + - /rancher/v2.6/en/upgrades/single-node-upgrade/ + - /rancher/v2.6/en/upgrades/upgrades/single-node-air-gap-upgrade + - /rancher/v2.6/en/upgrades/upgrades/single-node + - /rancher/v2.6/en/upgrades/upgrades/single-node-upgrade/ + - /rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/upgrades/single-node/ --- The following instructions will guide you through upgrading a Rancher server that was installed with Docker. # Prerequisites -- **Review the [known upgrade issues]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/upgrades/#known-upgrade-issues) in the Rancher documentation for the most noteworthy issues to consider when upgrading Rancher. A more complete list of known issues for each Rancher version can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) Note that upgrades to or from any chart in the [rancher-alpha repository]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren’t supported. -- **For [air gap installs only,]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version.** Follow the guide to [populate your private registry]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. +- **Review the [known upgrade issues]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/upgrades/#known-upgrade-issues) in the Rancher documentation for the most noteworthy issues to consider when upgrading Rancher. A more complete list of known issues for each Rancher version can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12) Note that upgrades to or from any chart in the [rancher-alpha repository]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#helm-chart-repositories/) aren’t supported. +- **For [air gap installs only,]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) collect and populate images for the new Rancher server version.** Follow the guide to [populate your private registry]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/populate-private-registry/) with the images for the Rancher version that you want to upgrade to. # Placeholder Review @@ -106,7 +106,7 @@ Pull the image of the Rancher version that you want to upgrade to. Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. ``` docker pull rancher/rancher: @@ -118,11 +118,11 @@ Start a new Rancher server container using the data from the `rancher-data` cont >**Important:** _Do not_ stop the upgrade after initiating it, even if the upgrade process seems longer than expected. Stopping the upgrade may result in database migration errors during future upgrades. -If you used a proxy, see [HTTP Proxy Configuration.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/proxy/) +If you used a proxy, see [HTTP Proxy Configuration.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/proxy/) -If you configured a custom CA root certificate to access your services, see [Custom CA root certificate.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) +If you configured a custom CA root certificate to access your services, see [Custom CA root certificate.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) -If you are recording all transactions with the Rancher API, see [API Auditing]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) +If you are recording all transactions with the Rancher API, see [API Auditing]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) To see the command to use when starting the new Rancher server container, choose from the following options: @@ -142,7 +142,7 @@ If you have selected to use the Rancher generated self-signed certificate, you a Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -152,7 +152,7 @@ docker run -d --volumes-from rancher-data \ rancher/rancher: ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} @@ -170,7 +170,7 @@ Placeholder | Description `` | The path to your full certificate chain. `` | The path to the private key for your certificate. `` | The path to the certificate authority's certificate. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -183,7 +183,7 @@ docker run -d --volumes-from rancher-data \ rancher/rancher: ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} @@ -193,14 +193,14 @@ As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/ If you have selected to use a certificate signed by a recognized CA, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificates that you had originally installed with. Remember to include `--no-cacerts` as an argument to the container to disable the default CA certificate generated by Rancher. ->**Reminder of the Cert Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +>**Reminder of the Cert Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) Placeholder | Description ------------|------------- `` | The path to the directory containing your certificate files. `` | The path to your full certificate chain. `` | The path to the private key for your certificate. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -213,7 +213,7 @@ docker run -d --volumes-from rancher-data \ --no-cacerts ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} ### Option D: Let's Encrypt Certificate @@ -231,7 +231,7 @@ If you have selected to use [Let's Encrypt](https://letsencrypt.org/) certificat Placeholder | Description ------------|------------- -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. `` | The domain address that you had originally started with ``` @@ -243,7 +243,7 @@ docker run -d --volumes-from rancher-data \ --acme-domain ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} @@ -263,7 +263,7 @@ If you have selected to use the Rancher generated self-signed certificate, you a Placeholder | Description ------------|------------- `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to to upgrade to. ``` docker run -d --volumes-from rancher-data \ @@ -275,7 +275,7 @@ Placeholder | Description /rancher/rancher: ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} ### Option B: Bring Your Own Certificate: Self-Signed @@ -284,7 +284,7 @@ As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/ If you have selected to bring your own self-signed certificate, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificate that you had originally installed with. ->**Reminder of the Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +>**Reminder of the Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates in the chain. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) Placeholder | Description ------------|------------- @@ -293,7 +293,7 @@ Placeholder | Description `` | The path to the private key for your certificate. `` | The path to the certificate authority's certificate. `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. ``` docker run -d --restart=unless-stopped \ @@ -306,7 +306,7 @@ docker run -d --restart=unless-stopped \ --privileged \ /rancher/rancher: ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} ### Option C: Bring Your Own Certificate: Signed by Recognized CA @@ -315,7 +315,7 @@ As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/ If you have selected to use a certificate signed by a recognized CA, you add the `--volumes-from rancher-data` to the command that you had started your original Rancher server container and need to have access to the same certificates that you had originally installed with. - >**Reminder of the Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) + >**Reminder of the Prerequisite:** The certificate files must be in PEM format. In your certificate file, include all intermediate certificates provided by the recognized CA. Order your certificates with your certificate first, followed by the intermediates. For an example, see [Certificate Troubleshooting.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) Placeholder | Description ------------|------------- @@ -323,7 +323,7 @@ Placeholder | Description `` | The path to your full certificate chain. `` | The path to the private key for your certificate. `` | Your private registry URL and port. -`` | The release tag of the [Rancher version]({{}}/rancher/v2.5/en/installation/resources/chart-options/) that you want to upgrade to. +`` | The release tag of the [Rancher version]({{}}/rancher/v2.6/en/installation/resources/chart-options/) that you want to upgrade to. > **Note:** Use the `--no-cacerts` as argument to the container to disable the default CA certificate generated by Rancher. @@ -339,7 +339,7 @@ docker run -d --volumes-from rancher-data \ --privileged /rancher/rancher: ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) {{% /accordion %}} {{% /tab %}} {{% /tabs %}} @@ -361,4 +361,4 @@ Remove the previous Rancher server container. If you only stop the previous Ranc # Rolling Back -If your upgrade does not complete successfully, you can roll back Rancher server and its data back to its last healthy state. For more information, see [Docker Rollback]({{}}/rancher/v2.5/en/upgrades/rollbacks/single-node-rollbacks/). +If your upgrade does not complete successfully, you can roll back Rancher server and its data back to its last healthy state. For more information, see [Docker Rollback]({{}}/rancher/v2.6/en/upgrades/rollbacks/single-node-rollbacks/). diff --git a/content/rancher/v2.6/en/installation/requirements/_index.md b/content/rancher/v2.6/en/installation/requirements/_index.md index b91223043ca..362ea505386 100644 --- a/content/rancher/v2.6/en/installation/requirements/_index.md +++ b/content/rancher/v2.6/en/installation/requirements/_index.md @@ -6,7 +6,7 @@ weight: 1 This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster. -> It is important to note that if you install Rancher on a Kubernetes cluster, requirements are different from the [node requirements for downstream user clusters,]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/) which will run your apps and services. +> It is important to note that if you install Rancher on a Kubernetes cluster, requirements are different from the [node requirements for downstream user clusters,]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/) which will run your apps and services. Make sure the node(s) for the Rancher server fulfill the following requirements: @@ -24,7 +24,7 @@ Make sure the node(s) for the Rancher server fulfill the following requirements: - [Node IP Addresses](#node-ip-addresses) - [Port Requirements](#port-requirements) -For a list of best practices that we recommend for running the Rancher server in production, refer to the [best practices section.]({{}}/rancher/v2.5/en/best-practices/deployment-types/) +For a list of best practices that we recommend for running the Rancher server in production, refer to the [best practices section.]({{}}/rancher/v2.6/en/best-practices/deployment-types/) The Rancher UI works best in Firefox or Chrome. @@ -44,7 +44,7 @@ The `ntp` (Network Time Protocol) package should be installed. This prevents err Some distributions of Linux may have default firewall rules that block communication with Helm. We recommend disabling firewalld. For Kubernetes 1.19, firewalld must be turned off. -If you plan to run Rancher on ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.5/en/installation/options/arm64-platform/) +If you plan to run Rancher on ARM64, see [Running on ARM64 (Experimental).]({{}}/rancher/v2.6/en/installation/options/arm64-platform/) ### RKE Specific Requirements @@ -78,11 +78,11 @@ For details on which OS versions were tested with RKE2, refer to the [support ma Docker is not required for RKE2 installs. -The Ingress should be deployed as DaemonSet to ensure your load balancer can successfully route traffic to all nodes. Currently, RKE2 deploys nginx-ingress as a deployment by default, so you will need to deploy it as a DaemonSet by following [these steps.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/#5-configure-nginx-to-be-a-daemonset) +The Ingress should be deployed as DaemonSet to ensure your load balancer can successfully route traffic to all nodes. Currently, RKE2 deploys nginx-ingress as a deployment by default, so you will need to deploy it as a DaemonSet by following [these steps.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/#5-configure-nginx-to-be-a-daemonset) ### Installing Docker -Docker is required for Helm chart installs, and it can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts]({{}}/rancher/v2.5/en/installation/requirements/installing-docker) to install Docker with one command. +Docker is required for Helm chart installs, and it can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts]({{}}/rancher/v2.6/en/installation/requirements/installing-docker) to install Docker with one command. Docker is not required for RancherD installs. # Hardware Requirements @@ -113,7 +113,7 @@ These requirements apply to RKE Kubernetes clusters, as well as to hosted Kubern ### K3s Kubernetes -These CPU and memory requirements apply to each host in a [K3s Kubernetes cluster where the Rancher server is installed.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) +These CPU and memory requirements apply to each host in a [K3s Kubernetes cluster where the Rancher server is installed.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) | Deployment Size | Clusters | Nodes | vCPUs | RAM | Database Size | | --------------- | ---------- | ------------ | -------| ---------| ------------------------- | @@ -147,7 +147,7 @@ These CPU and memory requirements apply to each instance with RKE2 installed. Mi ### Docker -These CPU and memory requirements apply to a host with a [single-node]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) installation of Rancher. +These CPU and memory requirements apply to a host with a [single-node]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) installation of Rancher. | Deployment Size | Clusters | Nodes | vCPUs | RAM | | --------------- | -------- | --------- | ----- | ---- | @@ -166,10 +166,10 @@ For hosted Kubernetes clusters (EKS, GKE, AKS) and RKE2 Kubernetes installations ### Ingress for RKE2 -Currently, RKE2 deploys nginx-ingress as a deployment by default, so you will need to deploy it as a DaemonSet by following [these steps.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/ha-rke2/#5-configure-nginx-to-be-a-daemonset) +Currently, RKE2 deploys nginx-ingress as a deployment by default, so you will need to deploy it as a DaemonSet by following [these steps.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/#5-configure-nginx-to-be-a-daemonset) ### Ingress for EKS -For an example of how to deploy an nginx-ingress-controller with a LoadBalancer service, refer to [this section.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/amazon-eks/#5-install-an-ingress) +For an example of how to deploy an nginx-ingress-controller with a LoadBalancer service, refer to [this section.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/amazon-eks/#5-install-an-ingress) # Disks @@ -185,7 +185,7 @@ Each node used should have a static IP configured, regardless of whether you are ### Port Requirements -To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. [Port Requirements]({{}}/rancher/v2.5/en/installation/requirements/ports) lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types. +To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. [Port Requirements]({{}}/rancher/v2.6/en/installation/requirements/ports) lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types. # RancherD on SELinux Enforcing CentOS 8 or RHEL 8 Nodes diff --git a/content/rancher/v2.6/en/installation/requirements/ports/_index.md b/content/rancher/v2.6/en/installation/requirements/ports/_index.md index ad874040492..c930e57a1d2 100644 --- a/content/rancher/v2.6/en/installation/requirements/ports/_index.md +++ b/content/rancher/v2.6/en/installation/requirements/ports/_index.md @@ -172,9 +172,9 @@ The following tables break down the port requirements for Rancher nodes, for inb Downstream Kubernetes clusters run your apps and services. This section describes what ports need to be opened on the nodes in downstream clusters so that Rancher can communicate with them. -The port requirements differ depending on how the downstream cluster was launched. Each of the tabs below list the ports that need to be opened for different [cluster types]({{}}/rancher/v2.5/en/cluster-provisioning/). +The port requirements differ depending on how the downstream cluster was launched. Each of the tabs below list the ports that need to be opened for different [cluster types]({{}}/rancher/v2.6/en/cluster-provisioning/). -The following diagram depicts the ports that are opened for each [cluster type]({{}}/rancher/v2.5/en/cluster-provisioning). +The following diagram depicts the ports that are opened for each [cluster type]({{}}/rancher/v2.6/en/cluster-provisioning).
Port Requirements for the Rancher Management Plane
@@ -188,7 +188,7 @@ The following diagram depicts the ports that are opened for each [cluster type]( {{% accordion label="Click to expand" %}} -The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) with nodes created in an [Infrastructure Provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/). +The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) with nodes created in an [Infrastructure Provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/). >**Note:** >The required ports are automatically opened by Rancher during creation of clusters in cloud providers like Amazon EC2 or DigitalOcean. @@ -201,7 +201,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet {{% accordion label="Click to expand" %}} -The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) with [Custom Nodes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes/). +The following table depicts the port requirements for [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) with [Custom Nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes/). {{< ports-custom-nodes >}} @@ -211,7 +211,7 @@ The following table depicts the port requirements for [Rancher Launched Kubernet {{% accordion label="Click to expand" %}} -The following table depicts the port requirements for [hosted clusters]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters). +The following table depicts the port requirements for [hosted clusters]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters). {{< ports-imported-hosted >}} @@ -223,7 +223,7 @@ Note: Registered clusters were called imported clusters before Rancher v2.5. {{% accordion label="Click to expand" %}} -The following table depicts the port requirements for [registered clusters]({{}}/rancher/v2.5/en/cluster-provisioning/imported-clusters/). +The following table depicts the port requirements for [registered clusters]({{}}/rancher/v2.6/en/cluster-provisioning/imported-clusters/). {{< ports-imported-hosted >}} @@ -236,7 +236,7 @@ The following table depicts the port requirements for [registered clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/) to provision cluster nodes in Rancher, you can choose to let Rancher create a security group called `rancher-nodes`. The following rules are automatically added to this security group. +When using the [AWS EC2 node driver]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) to provision cluster nodes in Rancher, you can choose to let Rancher create a security group called `rancher-nodes`. The following rules are automatically added to this security group. | Type | Protocol | Port Range | Source/Destination | Rule Type | |-----------------|:--------:|:-----------:|------------------------|:---------:| diff --git a/content/rancher/v2.6/en/installation/resources/_index.md b/content/rancher/v2.6/en/installation/resources/_index.md index d5e06681c11..43b6750f09c 100644 --- a/content/rancher/v2.6/en/installation/resources/_index.md +++ b/content/rancher/v2.6/en/installation/resources/_index.md @@ -2,18 +2,18 @@ title: Resources weight: 5 aliases: -- /rancher/v2.5/en/installation/options +- /rancher/v2.6/en/installation/options --- ### Docker Installations -The [single-node Docker installation]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. +The [single-node Docker installation]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) is for Rancher users that are wanting to test out Rancher. Instead of running on a Kubernetes cluster using Helm, you install the Rancher server component on a single node using a `docker run` command. Since there is only one node and a single Docker container, if the node goes down, there is no copy of the etcd data available on other nodes and you will lose all the data of your Rancher server. ### Air Gapped Installations -Follow [these steps]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap) to install the Rancher server in an air gapped environment. +Follow [these steps]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap) to install the Rancher server in an air gapped environment. An air gapped environment could be where Rancher server will be installed offline, behind a firewall, or behind a proxy. @@ -21,8 +21,8 @@ An air gapped environment could be where Rancher server will be installed offlin When installing Rancher, there are several advanced options that can be enabled during installation. Within each install guide, these options are presented. Learn more about these options: -- [Custom CA Certificate]({{}}/rancher/v2.5/en/installation/options/custom-ca-root-certificate/) -- [API Audit Log]({{}}/rancher/v2.5/en/installation/options/api-audit-log/) -- [TLS Settings]({{}}/rancher/v2.5/en/installation/options/tls-settings/) -- [etcd configuration]({{}}/rancher/v2.5/en/installation/options/etcd/) -- [Local System Charts for Air Gap Installations]({{}}/rancher/v2.5/en/installation/options/local-system-charts) | v2.3.0 | +- [Custom CA Certificate]({{}}/rancher/v2.6/en/installation/options/custom-ca-root-certificate/) +- [API Audit Log]({{}}/rancher/v2.6/en/installation/options/api-audit-log/) +- [TLS Settings]({{}}/rancher/v2.6/en/installation/options/tls-settings/) +- [etcd configuration]({{}}/rancher/v2.6/en/installation/options/etcd/) +- [Local System Charts for Air Gap Installations]({{}}/rancher/v2.6/en/installation/options/local-system-charts) | v2.3.0 | diff --git a/content/rancher/v2.6/en/installation/resources/advanced/api-audit-log/_index.md b/content/rancher/v2.6/en/installation/resources/advanced/api-audit-log/_index.md index 3f6dd0ce9a8..5dbc856ecf0 100644 --- a/content/rancher/v2.6/en/installation/resources/advanced/api-audit-log/_index.md +++ b/content/rancher/v2.6/en/installation/resources/advanced/api-audit-log/_index.md @@ -2,8 +2,8 @@ title: Enabling the API Audit Log to Record System Events weight: 4 aliases: - - /rancher/v2.5/en/installation/options/api-audit-log/ - - /rancher/v2.5/en/installation/api-auditing + - /rancher/v2.6/en/installation/options/api-audit-log/ + - /rancher/v2.6/en/installation/api-auditing --- 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. @@ -14,9 +14,9 @@ You can enable API Auditing during Rancher installation or upgrade. The Audit Log is enabled and configured by passing environment variables to the Rancher server container. See the following to enable on your installation. -- [Docker Install]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) +- [Docker Install]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#api-audit-log) -- [Kubernetes Install]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) +- [Kubernetes Install]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#api-audit-log) ## API Audit Log Options @@ -70,7 +70,7 @@ kubectl -n cattle-system logs -f rancher-84d886bdbb-s4s69 rancher-audit-log #### Shipping the Audit Log -You can enable Rancher's built in log collection and shipping for the cluster to ship the audit and other services logs to a supported collection endpoint. See [Rancher Tools - Logging]({{}}/rancher/v2.5/en/cluster-admin/tools/logging) for details. +You can enable Rancher's built in log collection and shipping for the cluster to ship the audit and other services logs to a supported collection endpoint. See [Rancher Tools - Logging]({{}}/rancher/v2.6/en/cluster-admin/tools/logging) for details. ## Audit Log Samples diff --git a/content/rancher/v2.6/en/installation/resources/advanced/arm64-platform/_index.md b/content/rancher/v2.6/en/installation/resources/advanced/arm64-platform/_index.md index d39ba54f471..f322226e5c9 100644 --- a/content/rancher/v2.6/en/installation/resources/advanced/arm64-platform/_index.md +++ b/content/rancher/v2.6/en/installation/resources/advanced/arm64-platform/_index.md @@ -2,7 +2,7 @@ title: "Running on ARM64 (Experimental)" weight: 3 aliases: - - /rancher/v2.5/en/installation/options/arm64-platform + - /rancher/v2.6/en/installation/options/arm64-platform --- > **Important:** @@ -12,14 +12,14 @@ aliases: The following options are available when using an ARM64 platform: - Running Rancher on ARM64 based node(s) - - Only [Docker Install]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker) + - Only [Docker Install]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker) - Create custom cluster and adding ARM64 based node(s) - Kubernetes cluster version must be 1.12 or higher - - CNI Network Provider must be [Flannel]({{}}/rancher/v2.5/en/faq/networking/cni-providers/#flannel) + - CNI Network Provider must be [Flannel]({{}}/rancher/v2.6/en/faq/networking/cni-providers/#flannel) - Importing clusters that contain ARM64 based nodes - Kubernetes cluster version must be 1.12 or higher -Please see [Cluster Options]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/) how to configure the cluster options. +Please see [Cluster Options]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/) how to configure the cluster options. The following features are not tested: diff --git a/content/rancher/v2.6/en/installation/resources/advanced/etcd/_index.md b/content/rancher/v2.6/en/installation/resources/advanced/etcd/_index.md index ab4a8fd6d62..ea2bb1db430 100644 --- a/content/rancher/v2.6/en/installation/resources/advanced/etcd/_index.md +++ b/content/rancher/v2.6/en/installation/resources/advanced/etcd/_index.md @@ -2,7 +2,7 @@ title: Tuning etcd for Large Installations weight: 2 aliases: - - /rancher/v2.5/en/installation/options/etcd + - /rancher/v2.6/en/installation/options/etcd --- 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. diff --git a/content/rancher/v2.6/en/installation/resources/advanced/firewall/_index.md b/content/rancher/v2.6/en/installation/resources/advanced/firewall/_index.md index 791413826f7..8046dce750e 100644 --- a/content/rancher/v2.6/en/installation/resources/advanced/firewall/_index.md +++ b/content/rancher/v2.6/en/installation/resources/advanced/firewall/_index.md @@ -32,7 +32,7 @@ You can check the default firewall rules with this command: sudo iptables --list ``` -This section describes how to use `firewalld` to apply the [firewall port rules]({{}}/rancher/v2.5/en/installation/references) for nodes in a high-availability Rancher server cluster. +This section describes how to use `firewalld` to apply the [firewall port rules]({{}}/rancher/v2.6/en/installation/references) for nodes in a high-availability Rancher server cluster. # Prerequisite diff --git a/content/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb/_index.md b/content/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb/_index.md index 07dd7d8ba9b..a680e79df54 100644 --- a/content/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb/_index.md +++ b/content/rancher/v2.6/en/installation/resources/advanced/single-node-install-external-lb/_index.md @@ -2,10 +2,10 @@ title: Docker Install with TLS Termination at Layer-7 NGINX Load Balancer weight: 252 aliases: - - /rancher/v2.5/en/installation/single-node/single-node-install-external-lb/ - - /rancher/v2.5/en/installation/other-installation-methods/single-node-docker/single-node-install-external-lb - - /rancher/v2.5/en/installation/options/single-node-install-external-lb - - /rancher/v2.5/en/installation/single-node-install-external-lb + - /rancher/v2.6/en/installation/single-node/single-node-install-external-lb/ + - /rancher/v2.6/en/installation/other-installation-methods/single-node-docker/single-node-install-external-lb + - /rancher/v2.6/en/installation/options/single-node-install-external-lb + - /rancher/v2.6/en/installation/single-node-install-external-lb --- 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. @@ -15,11 +15,11 @@ A layer-7 load balancer can be beneficial if you want to centralize your TLS ter This install procedure walks you through deployment of Rancher using a single container, and then provides a sample configuration for a layer-7 NGINX load balancer. > **Want to skip the external load balancer?** -> See [Docker Installation]({{}}/rancher/v2.5/en/installation/single-node) instead. +> See [Docker Installation]({{}}/rancher/v2.6/en/installation/single-node) instead. ## Requirements for OS, Docker, Hardware, and Networking -Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.6/en/installation/requirements/) ## Installation Outline @@ -33,7 +33,7 @@ Make sure that your node fulfills the general [installation requirements.]({{}}/rancher/v2.5/en/installation/requirements) to launch your Rancher Server. +Provision a single Linux host according to our [Requirements]({{}}/rancher/v2.6/en/installation/requirements) to launch your Rancher Server. ## 2. Choose an SSL Option and Install Rancher @@ -166,20 +166,20 @@ http { ## What's Next? -- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.5/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. -- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.5/en/cluster-provisioning/). +- **Recommended:** Review [Single Node Backup and Restore]({{}}/rancher/v2.6/en/installation/backups-and-restoration/single-node-backup-and-restoration/). Although you don't have any data you need to back up right now, we recommend creating backups after regular Rancher use. +- Create a Kubernetes cluster: [Provisioning Kubernetes Clusters]({{}}/rancher/v2.6/en/cluster-provisioning/).
## FAQ and Troubleshooting -For help troubleshooting certificates, see [this section.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/troubleshooting) +For help troubleshooting certificates, see [this section.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/troubleshooting) ## Advanced Options ### API Auditing -If you want to record all transactions with the Rancher API, enable the [API Auditing]({{}}/rancher/v2.5/en/installation/api-auditing) feature by adding the flags below into your install command. +If you want to record all transactions with the Rancher API, enable the [API Auditing]({{}}/rancher/v2.6/en/installation/api-auditing) feature by adding the flags below into your install command. -e AUDIT_LEVEL=1 \ -e AUDIT_LOG_PATH=/var/log/auditlog/rancher-api-audit.log \ @@ -189,7 +189,7 @@ If you want to record all transactions with the Rancher API, enable the [API Aud ### Air Gap -If you are visiting this page to complete an [Air Gap Installation]({{}}/rancher/v2.5/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `` with your private registry URL in front of `rancher/rancher:latest`. +If you are visiting this page to complete an [Air Gap Installation]({{}}/rancher/v2.6/en/installation/air-gap-installation/), you must pre-pend your private registry URL to the server tag when running the installation command in the option that you choose. Add `` with your private registry URL in front of `rancher/rancher:latest`. **Example:** @@ -209,7 +209,7 @@ docker run -d --restart=unless-stopped \ rancher/rancher:latest ``` -As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) +As of Rancher v2.5, privileged access is [required.]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/#privileged-access-for-rancher-v2-5) This layer 7 NGINX configuration is tested on NGINX version 1.13 (mainline) and 1.14 (stable). diff --git a/content/rancher/v2.6/en/installation/resources/chart-options/_index.md b/content/rancher/v2.6/en/installation/resources/chart-options/_index.md index 10b887e9845..1d9bb90d743 100644 --- a/content/rancher/v2.6/en/installation/resources/chart-options/_index.md +++ b/content/rancher/v2.6/en/installation/resources/chart-options/_index.md @@ -3,4 +3,4 @@ title: Rancher Helm Chart Options weight: 50 --- -The Rancher Helm chart options reference moved to [this page.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/) \ No newline at end of file +The Rancher Helm chart options reference moved to [this page.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/) \ No newline at end of file diff --git a/content/rancher/v2.6/en/installation/resources/choosing-version/_index.md b/content/rancher/v2.6/en/installation/resources/choosing-version/_index.md index 5a1f6603686..5b20515ac05 100644 --- a/content/rancher/v2.6/en/installation/resources/choosing-version/_index.md +++ b/content/rancher/v2.6/en/installation/resources/choosing-version/_index.md @@ -2,12 +2,12 @@ title: Choosing a Rancher Version weight: 1 aliases: - - /rancher/v2.5/en/installation/options/server-tags + - /rancher/v2.6/en/installation/options/server-tags --- This section describes how to choose a Rancher version. -For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a **Helm chart** on a Kubernetes cluster. Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. +For a high-availability installation of Rancher, which is recommended for production, the Rancher server is installed using a **Helm chart** on a Kubernetes cluster. Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/options/helm-version) to choose a version of Helm to install Rancher. For Docker installations of Rancher, which is used for development and testing, you will install Rancher as a **Docker image.** @@ -16,9 +16,9 @@ The Helm chart version also applies to RancherD installs because RancherD instal {{% tabs %}} {{% tab "Helm Charts" %}} -When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher. +When installing, upgrading, or rolling back Rancher Server when it is [installed on a Kubernetes cluster]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/), Rancher server is installed using a Helm chart on a Kubernetes cluster. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must add a Helm chart repository that contains the charts for installing Rancher. -Refer to the [Helm version requirements]({{}}/rancher/v2.5/en/installation/options/helm-version) to choose a version of Helm to install Rancher. +Refer to the [Helm version requirements]({{}}/rancher/v2.6/en/installation/options/helm-version) to choose a version of Helm to install Rancher. ### Helm Chart Repositories @@ -76,10 +76,10 @@ After installing Rancher, if you want to change which Helm chart repository to i helm repo add rancher- https://releases.rancher.com/server-charts/ ``` -4. Continue to follow the steps to [upgrade Rancher]({{}}/rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha) from the new Helm chart repository. +4. Continue to follow the steps to [upgrade Rancher]({{}}/rancher/v2.6/en/installation/upgrades-rollbacks/upgrades/ha) from the new Helm chart repository. {{% /tab %}} {{% tab "Docker Images" %}} -When performing [Docker installs]({{}}/rancher/v2.5/en/installation/single-node), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. +When performing [Docker installs]({{}}/rancher/v2.6/en/installation/single-node), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. ### Server Tags diff --git a/content/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/_index.md b/content/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/_index.md index 9300424c92a..9c8f429b559 100644 --- a/content/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/_index.md +++ b/content/rancher/v2.6/en/installation/resources/custom-ca-root-certificate/_index.md @@ -2,8 +2,8 @@ title: About Custom CA Root Certificates weight: 1 aliases: - - /rancher/v2.5/en/installation/options/custom-ca-root-certificate/ - - /rancher/v2.5/en/installation/resources/choosing-version/encryption/custom-ca-root-certificate + - /rancher/v2.6/en/installation/options/custom-ca-root-certificate/ + - /rancher/v2.6/en/installation/resources/choosing-version/encryption/custom-ca-root-certificate --- 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). @@ -22,7 +22,7 @@ Examples of services that Rancher can access: For details on starting a Rancher container with your private CA certificates mounted, refer to the installation docs: -- [Docker install Custom CA certificate options]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) +- [Docker install Custom CA certificate options]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#custom-ca-certificate) -- [Kubernetes install options for Additional Trusted CAs]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#additional-trusted-cas) +- [Kubernetes install options for Additional Trusted CAs]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#additional-trusted-cas) diff --git a/content/rancher/v2.6/en/installation/resources/feature-flags/_index.md b/content/rancher/v2.6/en/installation/resources/feature-flags/_index.md index 5aaa4e2c7fa..9b04a60d3f5 100644 --- a/content/rancher/v2.6/en/installation/resources/feature-flags/_index.md +++ b/content/rancher/v2.6/en/installation/resources/feature-flags/_index.md @@ -2,10 +2,10 @@ title: Enabling Experimental Features weight: 17 aliases: - - /rancher/v2.5/en/installation/options/feature-flags/ - - /rancher/v2.5/en/admin-settings/feature-flags/ + - /rancher/v2.6/en/installation/options/feature-flags/ + - /rancher/v2.6/en/admin-settings/feature-flags/ --- -Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type]({{}}/rancher/v2.5/en/installation/options/feature-flags/enable-not-default-storage-drivers) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. +Rancher includes some features that are experimental and disabled by default. You might want to enable these features, for example, if you decide that the benefits of using an [unsupported storage type]({{}}/rancher/v2.6/en/installation/options/feature-flags/enable-not-default-storage-drivers) outweighs the risk of using an untested feature. Feature flags were introduced to allow you to try these features that are not enabled by default. The features can be enabled in three ways: @@ -28,9 +28,9 @@ For example, if you install Rancher, then set a feature flag to true with the Ra The following is a list of the feature flags available in Rancher: -- `fleet`: Rancher comes with [Fleet]({{}}/rancher/v2.5/en/deploy-across-clusters/fleet) preinstalled in v2.5+. -- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules]({{}}/rancher/v2.5/en/installation/options/feature-flags/istio-virtual-service-ui), which are traffic management features of Istio. -- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.]({{}}/rancher/v2.5/en/installation/options/feature-flags/enable-not-default-storage-drivers) In other words, it enables types for storage providers and provisioners that are not enabled by default. +- `fleet`: Rancher comes with [Fleet]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) preinstalled in v2.5+. +- `istio-virtual-service-ui`: This feature enables a [UI to create, read, update, and delete Istio virtual services and destination rules]({{}}/rancher/v2.6/en/installation/options/feature-flags/istio-virtual-service-ui), which are traffic management features of Istio. +- `unsupported-storage-drivers`: This feature [allows unsupported storage drivers.]({{}}/rancher/v2.6/en/installation/options/feature-flags/enable-not-default-storage-drivers) In other words, it enables types for storage providers and provisioners that are not enabled by default. The below table shows the availability and default value for feature flags in Rancher: @@ -70,7 +70,7 @@ Note: If you are installing an alpha version, Helm requires adding the `--devel` ### Rendering the Helm Chart for Air Gap Installations -For an air gap installation of Rancher, you need to add a Helm chart repository and render a Helm template before installing Rancher with Helm. For details, refer to the [air gap installation documentation.]({{}}/rancher/v2.5/en/installation/other-installation-methods/air-gap/install-rancher) +For an air gap installation of Rancher, you need to add a Helm chart repository and render a Helm template before installing Rancher with Helm. For details, refer to the [air gap installation documentation.]({{}}/rancher/v2.6/en/installation/other-installation-methods/air-gap/install-rancher) Here is an example of a command for passing in the feature flag names when rendering the Helm template. In the below example, two features are enabled by passing the feature flag names in a comma separated list. diff --git a/content/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers/_index.md b/content/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers/_index.md index a7a0c8f3c13..01b929930b4 100644 --- a/content/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers/_index.md +++ b/content/rancher/v2.6/en/installation/resources/feature-flags/enable-not-default-storage-drivers/_index.md @@ -2,12 +2,12 @@ title: Allow Unsupported Storage Drivers weight: 1 aliases: - - /rancher/v2.5/en/installation/options/feature-flags/enable-not-default-storage-drivers/ + - /rancher/v2.6/en/installation/options/feature-flags/enable-not-default-storage-drivers/ --- This feature allows you to use types for storage providers and provisioners that are not enabled by default. -To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.5/en/installation/options/feature-flags/) +To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.6/en/installation/options/feature-flags/) Environment Variable Key | Default Value | Description ---|---|--- diff --git a/content/rancher/v2.6/en/installation/resources/feature-flags/istio-virtual-service-ui/_index.md b/content/rancher/v2.6/en/installation/resources/feature-flags/istio-virtual-service-ui/_index.md index 3a58666d5da..37ea2b87aad 100644 --- a/content/rancher/v2.6/en/installation/resources/feature-flags/istio-virtual-service-ui/_index.md +++ b/content/rancher/v2.6/en/installation/resources/feature-flags/istio-virtual-service-ui/_index.md @@ -2,14 +2,14 @@ title: UI for Istio Virtual Services and Destination Rules weight: 2 aliases: - - /rancher/v2.5/en/installation/options/feature-flags/istio-virtual-service-ui + - /rancher/v2.6/en/installation/options/feature-flags/istio-virtual-service-ui --- 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. -> **Prerequisite:** Turning on this feature does not enable Istio. A cluster administrator needs to [enable Istio for the cluster]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup) in order to use the feature. +> **Prerequisite:** Turning on this feature does not enable Istio. A cluster administrator needs to [enable Istio for the cluster]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup) in order to use the feature. -To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.5/en/installation/options/feature-flags/) +To enable or disable this feature, refer to the instructions on [the main page about enabling experimental features.]({{}}/rancher/v2.6/en/installation/options/feature-flags/) Environment Variable Key | Default Value | Status | Available as of ---|---|---|--- diff --git a/content/rancher/v2.6/en/installation/resources/helm-version/_index.md b/content/rancher/v2.6/en/installation/resources/helm-version/_index.md index 711e575b853..514666f5c39 100644 --- a/content/rancher/v2.6/en/installation/resources/helm-version/_index.md +++ b/content/rancher/v2.6/en/installation/resources/helm-version/_index.md @@ -2,15 +2,15 @@ title: Helm Version Requirements weight: 3 aliases: - - /rancher/v2.5/en/installation/options/helm-version - - /rancher/v2.5/en/installation/options/helm2 - - /rancher/v2.5/en/installation/options/helm2/helm-init - - /rancher/v2.5/en/installation/options/helm2/helm-rancher + - /rancher/v2.6/en/installation/options/helm-version + - /rancher/v2.6/en/installation/options/helm2 + - /rancher/v2.6/en/installation/options/helm2/helm-init + - /rancher/v2.6/en/installation/options/helm2/helm-rancher --- This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster. -> The installation instructions have been updated for Helm 3. For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 Migration Docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) [This section]({{}}/rancher/v2.5/en/installation/options/helm2) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. +> The installation instructions have been updated for Helm 3. For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 Migration Docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) [This section]({{}}/rancher/v2.6/en/installation/options/helm2) provides a copy of the older high-availability Rancher installation instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible. - Helm v3.2.x or higher is required to install or upgrade Rancher v2.5. - Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using. diff --git a/content/rancher/v2.6/en/installation/resources/installing-docker/_index.md b/content/rancher/v2.6/en/installation/resources/installing-docker/_index.md index ceb75b12645..6dd1f009151 100644 --- a/content/rancher/v2.6/en/installation/resources/installing-docker/_index.md +++ b/content/rancher/v2.6/en/installation/resources/installing-docker/_index.md @@ -2,7 +2,7 @@ title: Installing Docker weight: 1 aliases: - - /rancher/v2.5/en/installation/requirements/installing-docker + - /rancher/v2.6/en/installation/requirements/installing-docker --- Docker is required to be installed on nodes where the Rancher server will be installed with Helm or Docker. Docker is not required for RancherD installs. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-RKE/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-RKE/_index.md index 55c3ab6bfb7..9ec3045307d 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-RKE/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-RKE/_index.md @@ -3,7 +3,7 @@ title: Setting up a High-availability RKE Kubernetes Cluster shortTitle: Set up RKE Kubernetes weight: 3 aliases: - - /rancher/v2.5/en/installation/k8s-install/kubernetes-rke + - /rancher/v2.6/en/installation/k8s-install/kubernetes-rke --- @@ -13,7 +13,7 @@ This section describes how to install a Kubernetes cluster. This cluster should The Rancher management server can only be run on Kubernetes cluster in an infrastructure provider where Kubernetes is installed using RKE or K3s. Use of Rancher on hosted Kubernetes providers, such as EKS, is not supported. -For systems without direct internet access, refer to [Air Gap: Kubernetes install.]({{}}/rancher/v2.5/en/installation/air-gap-high-availability/) +For systems without direct internet access, refer to [Air Gap: Kubernetes install.]({{}}/rancher/v2.6/en/installation/air-gap-high-availability/) > **Single-node Installation Tip:** > In a single-node Kubernetes cluster, the Rancher server does not have high availability, which is important for running Rancher in production. However, installing Rancher on a single-node cluster can be useful if you want to save resources by using a single node in the short term, while preserving a high-availability migration path. @@ -83,7 +83,7 @@ ingress: > > Please see the [RKE Documentation]({{}}/rke/latest/en/config-options/) for the full list of options and capabilities. > -> For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide]({{}}/rancher/v2.5/en/installation/options/etcd/). +> For tuning your etcd cluster for larger Rancher installations, see the [etcd settings guide]({{}}/rancher/v2.6/en/installation/options/etcd/). ### 2. Run RKE @@ -164,8 +164,8 @@ Save a copy of the following files in a secure location: ### Issues or errors? -See the [Troubleshooting]({{}}/rancher/v2.5/en/installation/options/troubleshooting/) page. +See the [Troubleshooting]({{}}/rancher/v2.6/en/installation/options/troubleshooting/) page. -### [Next: Install Rancher]({{}}/rancher/v2.5/en/installation/k8s-install/helm-rancher/) +### [Next: Install Rancher]({{}}/rancher/v2.6/en/installation/k8s-install/helm-rancher/) diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/_index.md index 55ed67ad198..f4549735775 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-rke2/_index.md @@ -11,7 +11,7 @@ This section describes how to install a Kubernetes cluster according to the [bes # Prerequisites -These instructions assume you have set up three nodes, a load balancer, and a DNS record, as described in [this section.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) +These instructions assume you have set up three nodes, a load balancer, and a DNS record, as described in [this section.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-rke2-ha) Note that in order for RKE2 to work correctly with the load balancer, you need to set up two listeners: one for the supervisor on port 9345, and one for the Kubernetes API on port 6443. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db/_index.md index 9c07f5478c8..bce53d8b157 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/ha-with-external-db/_index.md @@ -4,7 +4,7 @@ shortTitle: Set up K3s for Rancher weight: 2 --- -This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.]({{}}/rancher/v2.5/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) +This section describes how to install a Kubernetes cluster according to the [best practices for the Rancher server environment.]({{}}/rancher/v2.6/en/overview/architecture-recommendations/#environment-for-kubernetes-installations) For systems without direct internet access, refer to the air gap installation instructions. @@ -17,7 +17,7 @@ For systems without direct internet access, refer to the air gap installation in # Prerequisites -These instructions assume you have set up two nodes, a load balancer, a DNS record, and an external MySQL database as described in [this section.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) +These instructions assume you have set up two nodes, a load balancer, a DNS record, and an external MySQL database as described in [this section.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the [support maintenance terms.](https://rancher.com/support-maintenance-terms/) To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script. # Installing Kubernetes diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/how-ha-works/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/how-ha-works/_index.md index d501221435b..796e300cfbb 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/how-ha-works/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/how-ha-works/_index.md @@ -11,7 +11,7 @@ Then Helm is used to install Rancher on top of the Kubernetes cluster. Helm uses The Rancher server data is stored on etcd. This etcd database also runs on all three nodes, and requires an odd number of nodes so that it can always elect a leader with a majority of the etcd cluster. If the etcd database cannot elect a leader, etcd can fail, requiring the cluster to be restored from backup. -For information on how Rancher works, regardless of the installation method, refer to the [architecture section.]({{}}/rancher/v2.5/en/overview/architecture) +For information on how Rancher works, regardless of the installation method, refer to the [architecture section.]({{}}/rancher/v2.6/en/overview/architecture) ### Recommended Architecture diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/_index.md index 5445da13597..89f4a7ac795 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/_index.md @@ -4,7 +4,7 @@ shortTitle: Infrastructure Tutorials weight: 5 --- -To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) +To set up infrastructure for a high-availability K3s Kubernetes cluster with an external DB, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/) -To set up infrastructure for a high-availability RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.5/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/) +To set up infrastructure for a high-availability RKE Kubernetes cluster, refer to [this page.]({{}}/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/) diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/_index.md index f0bb8732c52..56ed90a0b6d 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/ec2-node/_index.md @@ -2,10 +2,10 @@ title: Setting up Nodes in Amazon EC2 weight: 3 aliases: - - /rancher/v2.5/en/installation/options/ec2-node + - /rancher/v2.6/en/installation/options/ec2-node --- -In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +In this tutorial, you will learn one way to set up Linux nodes for the Rancher management server. These nodes will fulfill the node requirements for [OS, Docker, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) If the Rancher server will be installed on an RKE Kubernetes cluster, you should provision three instances. @@ -15,8 +15,8 @@ If the Rancher server is installed in a single Docker container, you only need o ### 1. Optional Preparation -- **Create IAM role:** To allow Rancher to manipulate AWS resources, such as provisioning new storage or new nodes, you will need to configure Amazon as a cloud provider. There are several things you'll need to do to set up the cloud provider on EC2, but part of this process is setting up an IAM role for the Rancher server nodes. For the full details on setting up the cloud provider, refer to this [page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/cloud-providers/) -- **Create security group:** We also recommend setting up a security group for the Rancher nodes that complies with the [port requirements for Rancher nodes.]({{}}/rancher/v2.5/en/installation/requirements/#port-requirements) +- **Create IAM role:** To allow Rancher to manipulate AWS resources, such as provisioning new storage or new nodes, you will need to configure Amazon as a cloud provider. There are several things you'll need to do to set up the cloud provider on EC2, but part of this process is setting up an IAM role for the Rancher server nodes. For the full details on setting up the cloud provider, refer to this [page.]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/cloud-providers/) +- **Create security group:** We also recommend setting up a security group for the Rancher nodes that complies with the [port requirements for Rancher nodes.]({{}}/rancher/v2.6/en/installation/requirements/#port-requirements) ### 2. Provision Instances @@ -29,7 +29,7 @@ If the Rancher server is installed in a single Docker container, you only need o 1. In the **Number of instances** field, enter the number of instances. A high-availability K3s cluster requires only two instances, while a high-availability RKE cluster requires three instances. 1. Optional: If you created an IAM role for Rancher to manipulate AWS resources, select the new IAM role in the **IAM role** field. 1. Click **Next: Add Storage,** **Next: Add Tags,** and **Next: Configure Security Group.** -1. In **Step 6: Configure Security Group,** select a security group that complies with the [port requirements]({{}}/rancher/v2.5/en/installation/requirements/#port-requirements) for Rancher nodes. +1. In **Step 6: Configure Security Group,** select a security group that complies with the [port requirements]({{}}/rancher/v2.6/en/installation/requirements/#port-requirements) for Rancher nodes. 1. Click **Review and Launch.** 1. Click **Launch.** 1. Choose a new or existing key pair that you will use to connect to your instance later. If you are using an existing key pair, make sure you already have access to the private key. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/_index.md index a4f98a9d446..9b64023e7b6 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha-with-external-db/_index.md @@ -7,7 +7,7 @@ This tutorial is intended to help you provision the underlying infrastructure fo The recommended infrastructure for the Rancher-only Kubernetes cluster differs depending on whether Rancher will be installed on a K3s Kubernetes cluster, an RKE Kubernetes cluster, or a single Docker container. -For more information about each installation option, refer to [this page.]({{}}/rancher/v2.5/en/installation) +For more information about each installation option, refer to [this page.]({{}}/rancher/v2.6/en/installation) > **Note:** These nodes must be in the same region. You may place these servers in separate availability zones (datacenter). @@ -20,9 +20,9 @@ To install the Rancher management server on a high-availability K3s cluster, we ### 1. Set up Linux Nodes -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node) for setting up nodes as instances in Amazon EC2. ### 2. Set up External Datastore @@ -32,7 +32,7 @@ For a high-availability K3s installation, you will need to set a [MySQL](https:/ When you install Kubernetes using the K3s installation script, you will pass in details for K3s to connect to the database. -For an example of one way to set up the MySQL database, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/rds/) for setting up MySQL on Amazon's RDS service. +For an example of one way to set up the MySQL database, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/rds/) for setting up MySQL on Amazon's RDS service. For the complete list of options that are available for configuring a K3s cluster datastore, refer to the [K3s documentation.]({{}}/k3s/latest/en/installation/datastore/) @@ -47,11 +47,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.5/en/installation/options/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/options/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nginx/) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nlb/) > **Important:** > Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/_index.md index 4a56d2e3976..f08a02bffdb 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/infra-for-ha/_index.md @@ -23,9 +23,9 @@ The etcd database requires an odd number of nodes so that it can always elect a ### 1. Set up Linux Nodes -Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.5/en/installation/requirements/) +Make sure that your nodes fulfill the general installation requirements for [OS, container runtime, hardware, and networking.]({{}}/rancher/v2.6/en/installation/requirements/) -For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.5/en/installation/options/ec2-node/) for setting up nodes as instances in Amazon EC2. +For an example of one way to set up Linux nodes, refer to this [tutorial]({{}}/rancher/v2.6/en/installation/options/ec2-node/) for setting up nodes as instances in Amazon EC2. ### 2. Set up the Load Balancer @@ -38,11 +38,11 @@ When Rancher is installed (also in a later step), the Rancher system creates an For your implementation, consider if you want or need to use a Layer-4 or Layer-7 load balancer: - **A layer-4 load balancer** is the simpler of the two choices, in which you are forwarding TCP traffic to your nodes. We recommend configuring your load balancer as a Layer 4 balancer, forwarding traffic to ports TCP/80 and TCP/443 to the Rancher management cluster nodes. The Ingress controller on the cluster will redirect HTTP traffic to HTTPS and terminate SSL/TLS on port TCP/443. The Ingress controller will forward traffic to port TCP/80 to the Ingress pod in the Rancher deployment. -- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.5/en/installation/options/chart-options/#external-tls-termination) +- **A layer-7 load balancer** is a bit more complicated but can offer features that you may want. For instance, a layer-7 load balancer is capable of handling TLS termination at the load balancer, as opposed to Rancher doing TLS termination itself. This can be beneficial if you want to centralize your TLS termination in your infrastructure. Layer-7 load balancing also offers the capability for your load balancer to make decisions based on HTTP attributes such as cookies, etc. that a layer-4 load balancer is not able to concern itself with. If you decide to terminate the SSL/TLS traffic on a layer-7 load balancer, you will need to use the `--set tls=external` option when installing Rancher in a later step. For more information, refer to the [Rancher Helm chart options.]({{}}/rancher/v2.6/en/installation/options/chart-options/#external-tls-termination) -For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nginx/) +For an example showing how to set up an NGINX load balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nginx/) -For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.5/en/installation/options/nlb/) +For a how-to guide for setting up an Amazon ELB Network Load Balancer, refer to [this page.]({{}}/rancher/v2.6/en/installation/options/nlb/) > **Important:** > Do not use this load balancer (i.e, the `local` cluster Ingress) to load balance applications other than Rancher following installation. Sharing this Ingress with other applications may result in websocket errors to Rancher following Ingress configuration reloads for other apps. We recommend dedicating the `local` cluster to Rancher and no other applications. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/_index.md index a19eb1b7a9f..29fa8737d4b 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nginx/_index.md @@ -2,7 +2,7 @@ title: Setting up an NGINX Load Balancer weight: 4 aliases: - - /rancher/v2.5/en/installation/options/nginx + - /rancher/v2.6/en/installation/options/nginx --- NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/_index.md index 2d3ed5bb948..6f25e1a40ca 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/nlb/_index.md @@ -2,9 +2,9 @@ title: Setting up Amazon ELB Network Load Balancer weight: 5 aliases: - - /rancher/v2.5/en/installation/ha/create-nodes-lb/nlb - - /rancher/v2.5/en/installation/k8s-install/create-nodes-lb/nlb - - /rancher/v2.5/en/installation/options/nlb + - /rancher/v2.6/en/installation/ha/create-nodes-lb/nlb + - /rancher/v2.6/en/installation/k8s-install/create-nodes-lb/nlb + - /rancher/v2.6/en/installation/options/nlb --- This how-to guide describes how to set up a Network Load Balancer (NLB) in Amazon's EC2 service that will direct traffic to multiple instances on EC2. diff --git a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/_index.md b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/_index.md index 99ef677874b..850bb961c6e 100644 --- a/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/_index.md +++ b/content/rancher/v2.6/en/installation/resources/k8s-tutorials/infrastructure-tutorials/rds/_index.md @@ -2,7 +2,7 @@ title: Setting up a MySQL Database in Amazon RDS weight: 4 aliases: - - /rancher/v2.5/en/installation/options/rds + - /rancher/v2.6/en/installation/options/rds --- This tutorial describes how to set up a MySQL database in Amazon's RDS. diff --git a/content/rancher/v2.6/en/installation/resources/local-system-charts/_index.md b/content/rancher/v2.6/en/installation/resources/local-system-charts/_index.md index 195605dfdab..9ed1b6b2237 100644 --- a/content/rancher/v2.6/en/installation/resources/local-system-charts/_index.md +++ b/content/rancher/v2.6/en/installation/resources/local-system-charts/_index.md @@ -2,9 +2,9 @@ title: Setting up Local System Charts for Air Gapped Installations weight: 120 aliases: - - /rancher/v2.5/en/installation/air-gap-single-node/config-rancher-system-charts/_index.md - - /rancher/v2.5/en/installation/air-gap-high-availability/config-rancher-system-charts/_index.md - - /rancher/v2.5/en/installation/options/local-system-charts + - /rancher/v2.6/en/installation/air-gap-single-node/config-rancher-system-charts/_index.md + - /rancher/v2.6/en/installation/air-gap-high-availability/config-rancher-system-charts/_index.md + - /rancher/v2.6/en/installation/options/local-system-charts --- 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. @@ -15,5 +15,5 @@ In an air gapped installation of Rancher, you will need to configure Rancher to A local copy of `system-charts` has been packaged into the `rancher/rancher` container. To be able to use these features in an air gap install, you will need to run the Rancher install command with an extra environment variable, `CATTLE_SYSTEM_CATALOG=bundled`, which tells Rancher to use the local copy of the charts instead of attempting to fetch them from GitHub. -Example commands for a Rancher installation with a bundled `system-charts` are included in the [air gap Docker installation]({{}}/rancher/v2.5/en/installation/air-gap-single-node/install-rancher) instructions and the [air gap Kubernetes installation]({{}}/rancher/v2.5/en/installation/air-gap-high-availability/install-rancher/) instructions. +Example commands for a Rancher installation with a bundled `system-charts` are included in the [air gap Docker installation]({{}}/rancher/v2.6/en/installation/air-gap-single-node/install-rancher) instructions and the [air gap Kubernetes installation]({{}}/rancher/v2.6/en/installation/air-gap-high-availability/install-rancher/) instructions. diff --git a/content/rancher/v2.6/en/installation/resources/tls-secrets/_index.md b/content/rancher/v2.6/en/installation/resources/tls-secrets/_index.md index 351bc9ed879..2053f1d6210 100644 --- a/content/rancher/v2.6/en/installation/resources/tls-secrets/_index.md +++ b/content/rancher/v2.6/en/installation/resources/tls-secrets/_index.md @@ -2,7 +2,7 @@ title: Adding TLS Secrets weight: 2 aliases: - - /rancher/v2.5/en/installation/resources/encryption/tls-secrets/ + - /rancher/v2.6/en/installation/resources/encryption/tls-secrets/ --- 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. @@ -37,4 +37,4 @@ kubectl -n cattle-system create secret generic tls-ca \ # Updating a Private CA Certificate -Follow the steps on [this page]({{}}/rancher/v2.x/en/installation/resources/update-ca-cert) to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. \ No newline at end of file +Follow the steps on [this page]({{}}/rancher/v2.x/en/installation/resources/update-ca-cert) to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. \ No newline at end of file diff --git a/content/rancher/v2.6/en/installation/resources/tls-settings/_index.md b/content/rancher/v2.6/en/installation/resources/tls-settings/_index.md index 67d91d72500..1a4c78eee42 100644 --- a/content/rancher/v2.6/en/installation/resources/tls-settings/_index.md +++ b/content/rancher/v2.6/en/installation/resources/tls-settings/_index.md @@ -2,9 +2,9 @@ title: TLS Settings weight: 3 aliases: - - /rancher/v2.5/en/installation/options/tls-settings/ - - /rancher/v2.5/en/admin-settings/tls-settings - - /rancher/v2.5/en/installation/resources/encryption/tls-settings + - /rancher/v2.6/en/installation/options/tls-settings/ + - /rancher/v2.6/en/admin-settings/tls-settings + - /rancher/v2.6/en/installation/resources/encryption/tls-settings --- The default TLS configuration only accepts TLS 1.2 and secure TLS cipher suites. TLS 1.3 and TLS 1.3 exclusive cipher suites are not supported. @@ -13,9 +13,9 @@ The default TLS configuration only accepts TLS 1.2 and secure TLS cipher suites. The Audit Log is enabled and configured by passing environment variables to the Rancher server container. See the following to enable on your installation. -- [TLS settings in Docker options]({{}}/rancher/v2.5/en/installation/other-installation-methods/single-node-docker/advanced/#tls-settings) +- [TLS settings in Docker options]({{}}/rancher/v2.6/en/installation/other-installation-methods/single-node-docker/advanced/#tls-settings) -- [TLS settings in Helm chart options]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/chart-options/#tls-settings) +- [TLS settings in Helm chart options]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/chart-options/#tls-settings) # TLS Environment Variables diff --git a/content/rancher/v2.6/en/installation/resources/troubleshooting/_index.md b/content/rancher/v2.6/en/installation/resources/troubleshooting/_index.md index 3f0d12ed1ae..2570af5d8fa 100644 --- a/content/rancher/v2.6/en/installation/resources/troubleshooting/_index.md +++ b/content/rancher/v2.6/en/installation/resources/troubleshooting/_index.md @@ -2,10 +2,10 @@ title: Troubleshooting the Rancher Server Kubernetes Cluster weight: 276 aliases: - - /rancher/v2.5/en/installation/k8s-install/helm-rancher/troubleshooting - - /rancher/v2.5/en/installation/ha/kubernetes-rke/troubleshooting - - /rancher/v2.5/en/installation/k8s-install/kubernetes-rke/troubleshooting - - /rancher/v2.5/en/installation/options/troubleshooting + - /rancher/v2.6/en/installation/k8s-install/helm-rancher/troubleshooting + - /rancher/v2.6/en/installation/ha/kubernetes-rke/troubleshooting + - /rancher/v2.6/en/installation/k8s-install/kubernetes-rke/troubleshooting + - /rancher/v2.6/en/installation/options/troubleshooting --- This section describes how to troubleshoot an installation of Rancher on a Kubernetes cluster. diff --git a/content/rancher/v2.6/en/installation/resources/update-ca-cert/_index.md b/content/rancher/v2.6/en/installation/resources/update-ca-cert/_index.md index 139ca70ac76..5a7a477fa82 100644 --- a/content/rancher/v2.6/en/installation/resources/update-ca-cert/_index.md +++ b/content/rancher/v2.6/en/installation/resources/update-ca-cert/_index.md @@ -3,7 +3,7 @@ title: Updating a Private CA Certificate weight: 10 --- -Follow these steps to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. +Follow these steps to update the SSL certificate of the ingress in a Rancher [high availability Kubernetes installation]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) or to switch from the default self-signed certificate to a custom certificate. A summary of the steps is as follows: @@ -104,7 +104,7 @@ When Rancher is configured with a certificate signed by a private CA, the CA cer Method 1 is the easiest one but requires all clusters to be connected to Rancher after the certificates have been rotated. This is usually the case if the process is performed right after updating the Rancher deployment (Step 3). -If the clusters have lost connection to Rancher but you have [Authorized Cluster Endpoints](https://rancher.com/docs/rancher/v2.5/en/cluster-admin/cluster-access/ace/) enabled, then go with method 2. +If the clusters have lost connection to Rancher but you have [Authorized Cluster Endpoints](https://rancher.com/docs/rancher/v2.6/en/cluster-admin/cluster-access/ace/) enabled, then go with method 2. Method 3 can be used as a fallback if method 1 and 2 are unfeasible. diff --git a/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/_index.md b/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/_index.md index 61def35eac5..e5bb9b272a0 100644 --- a/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/_index.md +++ b/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/_index.md @@ -2,9 +2,9 @@ title: Upgrading Cert-Manager weight: 4 aliases: - - /rancher/v2.5/en/installation/options/upgrading-cert-manager - - /rancher/v2.5/en/installation/options/upgrading-cert-manager/helm-2-instructions - - /rancher/v2.5/en/installation/resources/encryption/upgrading-cert-manager + - /rancher/v2.6/en/installation/options/upgrading-cert-manager + - /rancher/v2.6/en/installation/options/upgrading-cert-manager/helm-2-instructions + - /rancher/v2.6/en/installation/resources/encryption/upgrading-cert-manager --- 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: @@ -27,13 +27,13 @@ To address these changes, this guide will do two things: > The reason is that when Helm upgrades Rancher, it will reject the upgrade and show error messages if the running Rancher app does not match the chart template used to install it. Because cert-manager changed its API group and we cannot modify released charts for Rancher, there will always be a mismatch on the cert-manager's API version, therefore the upgrade will be rejected. -> For reinstalling Rancher with Helm, please check [Option B: Reinstalling Rancher Chart]({{}}/rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha/) under the upgrade Rancher section. +> For reinstalling Rancher with Helm, please check [Option B: Reinstalling Rancher Chart]({{}}/rancher/v2.6/en/installation/upgrades-rollbacks/upgrades/ha/) under the upgrade Rancher section. # Upgrade Cert-Manager The namespace used in these instructions depends on the namespace cert-manager is currently installed in. If it is in kube-system use that in the instructions below. You can verify by running `kubectl get pods --all-namespaces` and checking which namespace the cert-manager-\* pods are listed in. Do not change the namespace cert-manager is running in or this can cause issues. -> These instructions have been updated for Helm 3. If you are still using Helm 2, refer to [these instructions.]({{}}/rancher/v2.5/en/installation/options/upgrading-cert-manager/helm-2-instructions) +> These instructions have been updated for Helm 3. If you are still using Helm 2, refer to [these instructions.]({{}}/rancher/v2.6/en/installation/options/upgrading-cert-manager/helm-2-instructions) In order to upgrade cert-manager, follow these instructions: @@ -114,7 +114,7 @@ In order to upgrade cert-manager, follow these instructions: Before you can perform the upgrade, you must prepare your air gapped environment by adding the necessary container images to your private registry and downloading or rendering the required Kubernetes manifest files. -1. Follow the guide to [Prepare your Private Registry]({{}}/rancher/v2.5/en/installation/air-gap-installation/prepare-private-reg/) with the images needed for the upgrade. +1. Follow the guide to [Prepare your Private Registry]({{}}/rancher/v2.6/en/installation/air-gap-installation/prepare-private-reg/) with the images needed for the upgrade. 1. From a system connected to the internet, add the cert-manager repo to Helm diff --git a/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/helm-2-instructions/_index.md b/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/helm-2-instructions/_index.md index 761a2487d26..6e7723b0b40 100644 --- a/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/helm-2-instructions/_index.md +++ b/content/rancher/v2.6/en/installation/resources/upgrading-cert-manager/helm-2-instructions/_index.md @@ -2,8 +2,8 @@ title: Upgrading Cert-Manager with Helm 2 weight: 2040 aliases: - - /rancher/v2.5/en/installation/options/upgrading-cert-manager/helm-2-instructions - - /rancher/v2.5/en/installation/resources/choosing-version/encryption/upgrading-cert-manager/helm-2-instructions + - /rancher/v2.6/en/installation/options/upgrading-cert-manager/helm-2-instructions + - /rancher/v2.6/en/installation/resources/choosing-version/encryption/upgrading-cert-manager/helm-2-instructions --- 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: @@ -26,7 +26,7 @@ To address these changes, this guide will do two things: > The reason is that when Helm upgrades Rancher, it will reject the upgrade and show error messages if the running Rancher app does not match the chart template used to install it. Because cert-manager changed its API group and we cannot modify released charts for Rancher, there will always be a mismatch on the cert-manager's API version, therefore the upgrade will be rejected. -> For reinstalling Rancher with Helm, please check [Option B: Reinstalling Rancher Chart]({{}}/rancher/v2.5/en/installation/upgrades-rollbacks/upgrades/ha/) under the upgrade Rancher section. +> For reinstalling Rancher with Helm, please check [Option B: Reinstalling Rancher Chart]({{}}/rancher/v2.6/en/installation/upgrades-rollbacks/upgrades/ha/) under the upgrade Rancher section. ## Upgrade Cert-Manager Only @@ -80,7 +80,7 @@ In order to upgrade cert-manager, follow these instructions: Before you can perform the upgrade, you must prepare your air gapped environment by adding the necessary container images to your private registry and downloading or rendering the required Kubernetes manifest files. -1. Follow the guide to [Prepare your Private Registry]({{}}/rancher/v2.5/en/installation/air-gap-installation/prepare-private-reg/) with the images needed for the upgrade. +1. Follow the guide to [Prepare your Private Registry]({{}}/rancher/v2.6/en/installation/air-gap-installation/prepare-private-reg/) with the images needed for the upgrade. 1. From a system connected to the internet, add the cert-manager repo to Helm diff --git a/content/rancher/v2.6/en/istio/_index.md b/content/rancher/v2.6/en/istio/_index.md index 4f6111057d7..866b3746154 100644 --- a/content/rancher/v2.6/en/istio/_index.md +++ b/content/rancher/v2.6/en/istio/_index.md @@ -2,7 +2,7 @@ title: Istio weight: 14 aliases: - - /rancher/v2.5/en/dashboard/istio + - /rancher/v2.6/en/dashboard/istio --- [Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, secure, control, and troubleshoot the traffic within a complex network of microservices. @@ -17,7 +17,7 @@ This core service mesh provides features that include but are not limited to the - **Security** with resources to authenticate and authorize traffic and users, mTLS included. - **Observability** of logs, metrics, and distributed traffic flows. -After [setting up istio]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup) you can leverage Istio's control plane functionality through the Cluster Explorer, `kubectl`, or `istioctl`. +After [setting up istio]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup) you can leverage Istio's control plane functionality through the Cluster Explorer, `kubectl`, or `istioctl`. Istio needs to be set up by a `cluster-admin` before it can be used in a project. @@ -37,7 +37,7 @@ The overall architecture of Istio has been simplified. A single component, Istio Addons that were previously installed by Istio (cert-manager, Grafana, Jaeger, Kiali, Prometheus, Zipkin) will now need to be installed separately. Istio will support installation of integrations that are from the Istio Project and will maintain compatibility with those that are not. -A Prometheus integration will still be available through an installation of [Rancher Monitoring]({{}}/rancher/v2.5/en/monitoring-alerting/), or by installing your own Prometheus operator. Rancher's Istio chart will also install Kiali by default to ensure you can get a full picture of your microservices out of the box. +A Prometheus integration will still be available through an installation of [Rancher Monitoring]({{}}/rancher/v2.6/en/monitoring-alerting/), or by installing your own Prometheus operator. Rancher's Istio chart will also install Kiali by default to ensure you can get a full picture of your microservices out of the box. Istio has migrated away from Helm as a way to install Istio and now provides installation through the istioctl binary or Istio Operator. To ensure the easiest interaction with Istio, Rancher's Istio will maintain a Helm chart that utilizes the istioctl binary to manage your Istio installation. @@ -65,17 +65,17 @@ Note that this is not a production-qualified deployment of Jaeger. This deployme # Prerequisites -Before enabling Istio, we recommend that you confirm that your Rancher worker nodes have enough [CPU and memory]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/resources) to run all of the components of Istio. +Before enabling Istio, we recommend that you confirm that your Rancher worker nodes have enough [CPU and memory]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/resources) to run all of the components of Istio. If you are installing Istio on RKE2 cluster, some additional steps are required. For details, see [this section.](#additional-steps-for-installing-istio-on-an-rke2-cluster) # Setup Guide -Refer to the [setup guide]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup) for instructions on how to set up Istio and use it in a project. +Refer to the [setup guide]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup) for instructions on how to set up Istio and use it in a project. # Remove Istio -To remove Istio components from a cluster, namespace, or workload, refer to the section on [uninstalling Istio.]({{}}/rancher/v2.5/en/istio/disabling-istio/) +To remove Istio components from a cluster, namespace, or workload, refer to the section on [uninstalling Istio.]({{}}/rancher/v2.6/en/istio/disabling-istio/) # Migrate From Previous Istio Version @@ -87,7 +87,7 @@ Another option is to manually uninstall istio resources one at a time, but leave # Accessing Visualizations -> By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/rbac/) +> By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/rbac/) After Istio is set up in a cluster, Grafana, Prometheus,and Kiali are available in the Rancher UI. @@ -115,12 +115,12 @@ By default, each Rancher-provisioned cluster has one NGINX ingress controller al ![In an Istio-enabled cluster, you can have two ingresses: the default Nginx ingress, and the default Istio controller.]({{}}/img/rancher/istio-ingress.svg) - Additional Istio Ingress gateways can be enabled via the [overlay file]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/#overlay-file). + Additional Istio Ingress gateways can be enabled via the [overlay file]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/#overlay-file). ### Egress Support -By default the Egress gateway is disabled, but can be enabled on install or upgrade through the values.yaml or via the [overlay file]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/#overlay-file). +By default the Egress gateway is disabled, but can be enabled on install or upgrade through the values.yaml or via the [overlay file]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/#overlay-file). # Additional Steps for Installing Istio on an RKE2 Cluster -To install Istio on an RKE2 cluster, follow the steps in [this section.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/rke2/) +To install Istio on an RKE2 cluster, follow the steps in [this section.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/rke2/) diff --git a/content/rancher/v2.6/en/istio/configuration-reference/_index.md b/content/rancher/v2.6/en/istio/configuration-reference/_index.md index 79164a8f965..daddcfdfd68 100644 --- a/content/rancher/v2.6/en/istio/configuration-reference/_index.md +++ b/content/rancher/v2.6/en/istio/configuration-reference/_index.md @@ -2,7 +2,7 @@ title: Configuration Options weight: 3 aliases: - - /rancher/v2.5/en/istio/v2.5/configuration-reference + - /rancher/v2.6/en/istio/v2.5/configuration-reference --- - [Egress Support](#egress-support) diff --git a/content/rancher/v2.6/en/istio/configuration-reference/canal-and-project-network/_index.md b/content/rancher/v2.6/en/istio/configuration-reference/canal-and-project-network/_index.md index 77f82b11b3c..f7a1dd5d6a5 100644 --- a/content/rancher/v2.6/en/istio/configuration-reference/canal-and-project-network/_index.md +++ b/content/rancher/v2.6/en/istio/configuration-reference/canal-and-project-network/_index.md @@ -2,7 +2,7 @@ title: Additional Steps for Project Network Isolation weight: 4 aliases: - - /rancher/v2.5/en/istio/v2.5/configuration-reference/canal-and-project-network + - /rancher/v2.6/en/istio/v2.5/configuration-reference/canal-and-project-network --- In clusters where: diff --git a/content/rancher/v2.6/en/istio/configuration-reference/enable-istio-with-psp/_index.md b/content/rancher/v2.6/en/istio/configuration-reference/enable-istio-with-psp/_index.md index 7af6ae450b7..48177c1eb72 100644 --- a/content/rancher/v2.6/en/istio/configuration-reference/enable-istio-with-psp/_index.md +++ b/content/rancher/v2.6/en/istio/configuration-reference/enable-istio-with-psp/_index.md @@ -2,10 +2,10 @@ title: Enable Istio with Pod Security Policies weight: 1 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp - - /rancher/v2.5/en/istio/legacy/setup/enable-istio-in-cluster/enable-istio-with-psp - - /rancher/v2.5/en/istio/v2.5/setup/enable-istio-in-cluster/enable-istio-with-psp - - /rancher/v2.5/en/istio/v2.5/configuration-reference/enable-istio-with-psp + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster/enable-istio-with-psp + - /rancher/v2.6/en/istio/legacy/setup/enable-istio-in-cluster/enable-istio-with-psp + - /rancher/v2.6/en/istio/v2.5/setup/enable-istio-in-cluster/enable-istio-with-psp + - /rancher/v2.6/en/istio/v2.5/configuration-reference/enable-istio-with-psp --- If you have restrictive Pod Security Policies enabled, then Istio may not be able to function correctly, because it needs certain permissions in order to install itself and manage pod infrastructure. In this section, we will configure a cluster with PSPs enabled for an Istio install, and also set up the Istio CNI plugin. diff --git a/content/rancher/v2.6/en/istio/configuration-reference/rke2/_index.md b/content/rancher/v2.6/en/istio/configuration-reference/rke2/_index.md index ae4e1718794..cd784de7a4c 100644 --- a/content/rancher/v2.6/en/istio/configuration-reference/rke2/_index.md +++ b/content/rancher/v2.6/en/istio/configuration-reference/rke2/_index.md @@ -2,7 +2,7 @@ title: Additional Steps for Installing Istio on an RKE2 Cluster weight: 3 aliases: - - /rancher/v2.5/en/istio/v2.5/configuration-reference/rke2 + - /rancher/v2.6/en/istio/v2.5/configuration-reference/rke2 --- Through the **Cluster Explorer,** when installing or upgrading Istio through **Apps & Marketplace,** diff --git a/content/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape/_index.md b/content/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape/_index.md index f9f3cd833e4..8e32188dc08 100644 --- a/content/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape/_index.md +++ b/content/rancher/v2.6/en/istio/configuration-reference/selectors-and-scrape/_index.md @@ -2,8 +2,8 @@ title: Selectors and Scrape Configs weight: 2 aliases: - - /rancher/v2.5/en/istio/v2.5/configuration-reference/selectors-and-scrape - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/node-selectors + - /rancher/v2.6/en/istio/v2.5/configuration-reference/selectors-and-scrape + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/node-selectors --- The Monitoring app sets `prometheus.prometheusSpec.ignoreNamespaceSelectors=false`, which enables monitoring across all namespaces by default. diff --git a/content/rancher/v2.6/en/istio/disabling-istio/_index.md b/content/rancher/v2.6/en/istio/disabling-istio/_index.md index d0fe6ec9c63..d263688393d 100644 --- a/content/rancher/v2.6/en/istio/disabling-istio/_index.md +++ b/content/rancher/v2.6/en/istio/disabling-istio/_index.md @@ -2,7 +2,7 @@ title: Disabling Istio weight: 4 aliases: - - /rancher/v2.5/en/istio/v2.5/disabling-istio + - /rancher/v2.6/en/istio/v2.5/disabling-istio --- This section describes how to uninstall Istio in a cluster or disable a namespace, or workload. diff --git a/content/rancher/v2.6/en/istio/rbac/_index.md b/content/rancher/v2.6/en/istio/rbac/_index.md index 2ba726b15eb..d0f87ab77d7 100644 --- a/content/rancher/v2.6/en/istio/rbac/_index.md +++ b/content/rancher/v2.6/en/istio/rbac/_index.md @@ -2,8 +2,8 @@ title: Role-based Access Control weight: 3 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/rbac - - /rancher/v2.5/en/istio/v2.5/rbac + - /rancher/v2.6/en/cluster-admin/tools/istio/rbac + - /rancher/v2.6/en/istio/v2.5/rbac --- This section describes the permissions required to access Istio features. diff --git a/content/rancher/v2.6/en/istio/release-notes/_index.md b/content/rancher/v2.6/en/istio/release-notes/_index.md index 9569861b218..e1b101fa9bf 100644 --- a/content/rancher/v2.6/en/istio/release-notes/_index.md +++ b/content/rancher/v2.6/en/istio/release-notes/_index.md @@ -1,8 +1,8 @@ --- title: Release Notes aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/release-notes - - /rancher/v2.5/en/istio/v2.5/release-notes + - /rancher/v2.6/en/cluster-admin/tools/istio/release-notes + - /rancher/v2.6/en/istio/v2.5/release-notes --- # Istio 1.5.9 release notes diff --git a/content/rancher/v2.6/en/istio/resources/_index.md b/content/rancher/v2.6/en/istio/resources/_index.md index c9cf095969a..8dd81d292a8 100644 --- a/content/rancher/v2.6/en/istio/resources/_index.md +++ b/content/rancher/v2.6/en/istio/resources/_index.md @@ -2,10 +2,10 @@ title: CPU and Memory Allocations weight: 1 aliases: - - /rancher/v2.5/en/project-admin/istio/configuring-resource-allocations/ - - /rancher/v2.5/en/project-admin/istio/config/ - - /rancher/v2.5/en/cluster-admin/tools/istio/resources - - /rancher/v2.5/en/istio/v2.5/resources + - /rancher/v2.6/en/project-admin/istio/configuring-resource-allocations/ + - /rancher/v2.6/en/project-admin/istio/config/ + - /rancher/v2.6/en/cluster-admin/tools/istio/resources + - /rancher/v2.6/en/istio/v2.5/resources --- This section describes the minimum recommended computing resources for the Istio components in a cluster. @@ -39,7 +39,7 @@ You can find more information about Istio configuration in the [official Istio d To configure the resources allocated to an Istio component, 1. In the Rancher **Cluster Explorer**, navigate to your Istio installation in **Apps & Marketplace** -1. Click **Upgrade** to edit the base components via changes the values.yaml or add an [overlay file]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/#overlay-file). For more information about editing the overlay file, see [this section.](./#editing-the-overlay-file) +1. Click **Upgrade** to edit the base components via changes the values.yaml or add an [overlay file]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/#overlay-file). For more information about editing the overlay file, see [this section.](./#editing-the-overlay-file) 1. Change the CPU or memory allocations, the nodes where each component will be scheduled to, or the node tolerations. 1. Click **Upgrade.** to rollout changes diff --git a/content/rancher/v2.6/en/istio/setup/_index.md b/content/rancher/v2.6/en/istio/setup/_index.md index d91e57aba5c..6b5edfb2170 100644 --- a/content/rancher/v2.6/en/istio/setup/_index.md +++ b/content/rancher/v2.6/en/istio/setup/_index.md @@ -2,8 +2,8 @@ title: Setup Guide weight: 2 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup - - /rancher/v2.5/en/istio/v2.5/setup/ + - /rancher/v2.6/en/cluster-admin/tools/istio/setup + - /rancher/v2.6/en/istio/v2.5/setup/ --- This section describes how to enable Istio and start using it in your projects. @@ -12,20 +12,20 @@ If you use Istio for traffic management, you will need to allow external traffic # Prerequisites -This guide assumes you have already [installed Rancher,]({{}}/rancher/v2.5/en/installation) and you have already [provisioned a separate Kubernetes cluster]({{}}/rancher/v2.5/en/cluster-provisioning) on which you will install Istio. +This guide assumes you have already [installed Rancher,]({{}}/rancher/v2.6/en/installation) and you have already [provisioned a separate Kubernetes cluster]({{}}/rancher/v2.6/en/cluster-provisioning) on which you will install Istio. -The nodes in your cluster must meet the [CPU and memory requirements.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/resources/) +The nodes in your cluster must meet the [CPU and memory requirements.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/resources/) The workloads and services that you want to be controlled by Istio must meet [Istio's requirements.](https://istio.io/docs/setup/additional-setup/requirements/) # Install -> **Quick Setup** If you don't need external traffic to reach Istio, and you just want to set up Istio for monitoring and tracing traffic within the cluster, skip the steps for [setting up the Istio gateway]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/gateway) and [setting up Istio's components for traffic management.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/set-up-traffic-management) +> **Quick Setup** If you don't need external traffic to reach Istio, and you just want to set up Istio for monitoring and tracing traffic within the cluster, skip the steps for [setting up the Istio gateway]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/gateway) and [setting up Istio's components for traffic management.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/set-up-traffic-management) -1. [Enable Istio in the cluster.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster) -1. [Enable Istio in all the namespaces where you want to use it.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace) -1. [Add deployments and services that have the Istio sidecar injected.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/deploy-workloads) -1. [Set up the Istio gateway. ]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/gateway) -1. [Set up Istio's components for traffic management.]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/set-up-traffic-management) -1. [Generate traffic and see Istio in action.]({{}}/rancher/v2.5/en/istio/v2.5/setup/view-traffic/ ) +1. [Enable Istio in the cluster.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster) +1. [Enable Istio in all the namespaces where you want to use it.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace) +1. [Add deployments and services that have the Istio sidecar injected.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/deploy-workloads) +1. [Set up the Istio gateway. ]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/gateway) +1. [Set up Istio's components for traffic management.]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/set-up-traffic-management) +1. [Generate traffic and see Istio in action.]({{}}/rancher/v2.6/en/istio/v2.5/setup/view-traffic/ ) diff --git a/content/rancher/v2.6/en/istio/setup/deploy-workloads/_index.md b/content/rancher/v2.6/en/istio/setup/deploy-workloads/_index.md index 4222e2c4e55..b315afb15ff 100644 --- a/content/rancher/v2.6/en/istio/setup/deploy-workloads/_index.md +++ b/content/rancher/v2.6/en/istio/setup/deploy-workloads/_index.md @@ -2,8 +2,8 @@ title: 3. Add Deployments and Services with the Istio Sidecar weight: 4 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/deploy-workloads - - /rancher/v2.5/en/istio/v2.5/setup/deploy-workloads + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/deploy-workloads + - /rancher/v2.6/en/istio/v2.5/setup/deploy-workloads --- > **Prerequisite:** To enable Istio for a workload, the cluster and namespace must have the Istio app installed. @@ -347,4 +347,4 @@ spec: --- ``` -### [Next: Set up the Istio Gateway]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/gateway) +### [Next: Set up the Istio Gateway]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/gateway) diff --git a/content/rancher/v2.6/en/istio/setup/enable-istio-in-cluster/_index.md b/content/rancher/v2.6/en/istio/setup/enable-istio-in-cluster/_index.md index 1f7f9546c31..f2849cfe036 100644 --- a/content/rancher/v2.6/en/istio/setup/enable-istio-in-cluster/_index.md +++ b/content/rancher/v2.6/en/istio/setup/enable-istio-in-cluster/_index.md @@ -2,27 +2,27 @@ title: 1. Enable Istio in the Cluster weight: 1 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster - - /rancher/v2.5/en/istio/v2.5/setup/enable-istio-in-cluster + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/enable-istio-in-cluster + - /rancher/v2.6/en/istio/v2.5/setup/enable-istio-in-cluster --- >**Prerequisites:** > >- Only a user with the `cluster-admin` [Kubernetes default role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) assigned can configure and install Istio in a Kubernetes cluster. ->- If you have pod security policies, you will need to install Istio with the CNI enabled. For details, see [this section.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/enable-istio-with-psp) ->- To install Istio on an RKE2 cluster, additional steps are required. For details, see [this section.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/rke2/) ->- To install Istio in a cluster where project network isolation is enabled, additional steps are required. For details, see [this section.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/canal-and-project-network) +>- If you have pod security policies, you will need to install Istio with the CNI enabled. For details, see [this section.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/enable-istio-with-psp) +>- To install Istio on an RKE2 cluster, additional steps are required. For details, see [this section.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/rke2/) +>- To install Istio in a cluster where project network isolation is enabled, additional steps are required. For details, see [this section.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/canal-and-project-network) 1. From the **Cluster Explorer**, navigate to available **Charts** in **Apps & Marketplace** 1. Select the Istio chart from the rancher provided charts 1. If you have not already installed your own monitoring app, you will be prompted to install the rancher-monitoring app. Optional: Set your Selector or Scrape config options on rancher-monitoring app install. -1. Optional: Configure member access and [resource limits]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/resources/) for the Istio components. Ensure you have enough resources on your worker nodes to enable Istio. +1. Optional: Configure member access and [resource limits]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/resources/) for the Istio components. Ensure you have enough resources on your worker nodes to enable Istio. 1. Optional: Make additional configuration changes to values.yaml if needed. -1. Optional: Add additional resources or configuration via the [overlay file.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/#overlay-file) +1. Optional: Add additional resources or configuration via the [overlay file.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/#overlay-file) 1. Click **Install**. **Result:** Istio is installed at the cluster level. # Additional Config Options -For more information on configuring Istio, refer to the [configuration reference.]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference) +For more information on configuring Istio, refer to the [configuration reference.]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference) diff --git a/content/rancher/v2.6/en/istio/setup/enable-istio-in-namespace/_index.md b/content/rancher/v2.6/en/istio/setup/enable-istio-in-namespace/_index.md index e0671cc9f0a..2470eca15fa 100644 --- a/content/rancher/v2.6/en/istio/setup/enable-istio-in-namespace/_index.md +++ b/content/rancher/v2.6/en/istio/setup/enable-istio-in-namespace/_index.md @@ -2,8 +2,8 @@ title: 2. Enable Istio in a Namespace weight: 2 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace - - /rancher/v2.5/en/istio/v2.5/setup/enable-istio-in-namespace + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/enable-istio-in-namespace + - /rancher/v2.6/en/istio/v2.5/setup/enable-istio-in-namespace --- You will need to manually enable Istio in each namespace that you want to be tracked or controlled by Istio. When Istio is enabled in a namespace, the Envoy sidecar proxy will be automatically injected into all new workloads that are deployed in the namespace. @@ -41,4 +41,4 @@ To add the annotation to a workload, > **NOTE:** If you are having issues with a Job you deployed not completing, you will need to add this annotation to your pod using the provided steps. Since Istio Sidecars run indefinitely, a Job cannot be considered complete even after its task has completed. -### [Next: Select the Nodes ]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/node-selectors) \ No newline at end of file +### [Next: Select the Nodes ]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/node-selectors) \ No newline at end of file diff --git a/content/rancher/v2.6/en/istio/setup/gateway/_index.md b/content/rancher/v2.6/en/istio/setup/gateway/_index.md index 9de3c567a77..99c20e08062 100644 --- a/content/rancher/v2.6/en/istio/setup/gateway/_index.md +++ b/content/rancher/v2.6/en/istio/setup/gateway/_index.md @@ -2,8 +2,8 @@ title: 4. Set up the Istio Gateway weight: 5 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/gateway - - /rancher/v2.5/en/istio/v2.5/setup/gateway + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/gateway + - /rancher/v2.6/en/istio/v2.5/setup/gateway --- The gateway to each cluster can have its own port or load balancer, which is unrelated to a service mesh. By default, each Rancher-provisioned cluster has one NGINX ingress controller allowing traffic into the cluster. @@ -140,4 +140,4 @@ In the gateway resource, the selector refers to Istio's default ingress controll 1. Scroll down to the `istio-system` namespace. 1. Within `istio-system`, there is a workload named `istio-ingressgateway`. Click the name of this workload and go to the **Labels and Annotations** section. You should see that it has the key `istio` and the value `ingressgateway`. This confirms that the selector in the Gateway resource matches Istio's default ingress controller. -### [Next: Set up Istio's Components for Traffic Management]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/set-up-traffic-management) +### [Next: Set up Istio's Components for Traffic Management]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/set-up-traffic-management) diff --git a/content/rancher/v2.6/en/istio/setup/set-up-traffic-management/_index.md b/content/rancher/v2.6/en/istio/setup/set-up-traffic-management/_index.md index 4aa72b7174b..c22321c376f 100644 --- a/content/rancher/v2.6/en/istio/setup/set-up-traffic-management/_index.md +++ b/content/rancher/v2.6/en/istio/setup/set-up-traffic-management/_index.md @@ -2,8 +2,8 @@ title: 5. Set up Istio's Components for Traffic Management weight: 6 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/set-up-traffic-management - - /rancher/v2.5/en/istio/v2.5/setup/set-up-traffic-management + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/set-up-traffic-management + - /rancher/v2.6/en/istio/v2.5/setup/set-up-traffic-management --- A central advantage of traffic management in Istio is that it allows dynamic request routing. Some common applications for dynamic request routing include canary deployments and blue/green deployments. The two key resources in Istio traffic management are *virtual services* and *destination rules*. @@ -74,4 +74,4 @@ spec: **Result:** When you generate traffic to this service (for example, by refreshing the ingress gateway URL), the Kiali traffic graph will reflect that traffic to the `reviews` service is divided evenly between `v1` and `v3`. -### [Next: Generate and View Traffic]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/setup/view-traffic) +### [Next: Generate and View Traffic]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/setup/view-traffic) diff --git a/content/rancher/v2.6/en/istio/setup/view-traffic/_index.md b/content/rancher/v2.6/en/istio/setup/view-traffic/_index.md index 120be163d66..c3e6c09a612 100644 --- a/content/rancher/v2.6/en/istio/setup/view-traffic/_index.md +++ b/content/rancher/v2.6/en/istio/setup/view-traffic/_index.md @@ -2,9 +2,9 @@ title: 6. Generate and View Traffic weight: 7 aliases: - - /rancher/v2.5/en/cluster-admin/tools/istio/setup/view-traffic - - /rancher/v2.5/en/istio/setup/view-traffic - - /rancher/v2.5/en/istio/v2.5/setup/view-traffic + - /rancher/v2.6/en/cluster-admin/tools/istio/setup/view-traffic + - /rancher/v2.6/en/istio/setup/view-traffic + - /rancher/v2.6/en/istio/v2.5/setup/view-traffic --- This section describes how to view the traffic that is being managed by Istio. @@ -13,7 +13,7 @@ This section describes how to view the traffic that is being managed by Istio. The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you are able to view graphs for each namespace. The Kiali graph provides a powerful way to visualize the topology of your Istio service mesh. It shows you which services communicate with each other. ->**Prerequisite:** To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs]({{}}/rancher/v2.5/en/istio/v2.5/configuration-reference/selectors-and-scrape) options. +>**Prerequisite:** To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs]({{}}/rancher/v2.6/en/istio/v2.5/configuration-reference/selectors-and-scrape) options. To see the traffic graph, diff --git a/content/rancher/v2.6/en/k8s-in-rancher/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/_index.md index f048d0f174f..915ac7aa9dc 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/_index.md @@ -2,24 +2,24 @@ title: Kubernetes Resources weight: 18 aliases: - - /rancher/v2.5/en/concepts/ - - /rancher/v2.5/en/tasks/ - - /rancher/v2.5/en/concepts/resources/ + - /rancher/v2.6/en/concepts/ + - /rancher/v2.6/en/tasks/ + - /rancher/v2.6/en/concepts/resources/ --- > The Cluster Explorer is a new feature in Rancher v2.5 that allows you to view and manipulate all of the custom resources and CRDs in a Kubernetes cluster from the Rancher UI. This section will be updated to reflect the way that Kubernetes resources are handled in Rancher v2.5. ## Workloads -Deploy applications to your cluster nodes using [workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/), which are objects that contain pods that run your apps, along with metadata that set rules for the deployment's behavior. Workloads can be deployed within the scope of the entire clusters or within a namespace. +Deploy applications to your cluster nodes using [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/), which are objects that contain pods that run your apps, along with metadata that set rules for the deployment's behavior. Workloads can be deployed within the scope of the entire clusters or within a namespace. -When deploying a workload, you can deploy from any image. There are a variety of [workload types]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/#workload-types) to choose from which determine how your application should run. +When deploying a workload, you can deploy from any image. There are a variety of [workload types]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/#workload-types) to choose from which determine how your application should run. Following a workload deployment, you can continue working with it. You can: -- [Upgrade]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/upgrade-workloads) the workload to a newer version of the application it's running. -- [Roll back]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/rollback-workloads) a workload to a previous version, if an issue occurs during upgrade. -- [Add a sidecar]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/add-a-sidecar), which is a workload that supports a primary workload. +- [Upgrade]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads) the workload to a newer version of the application it's running. +- [Roll back]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads) a workload to a previous version, if an issue occurs during upgrade. +- [Add a sidecar]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar), which is a workload that supports a primary workload. ## Load Balancing and Ingress @@ -31,10 +31,10 @@ If you want your applications to be externally accessible, you must add a load b Rancher supports two types of load balancers: -- [Layer-4 Load Balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) -- [Layer-7 Load Balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) +- [Layer-4 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) +- [Layer-7 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) -For more information, see [load balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). +For more information, see [load balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). #### Ingress @@ -42,7 +42,7 @@ Load Balancers can only handle one IP address per service, which means if you ru Ingress is a set of rules that act as a load balancer. Ingress works in conjunction with one or more ingress controllers to dynamically route service requests. When the ingress receives a request, the ingress controller(s) in your cluster program the load balancer to direct the request to the correct service based on service subdomains or path rules that you've configured. -For more information, see [Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress). +For more information, see [Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress). When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. @@ -50,19 +50,19 @@ When using ingresses in a project, you can program the ingress hostname to an ex After you expose your cluster to external requests using a load balancer and/or ingress, it's only available by IP address. To create a resolveable hostname, you must create a service record, which is a record that maps an IP address, external hostname, DNS record alias, workload(s), or labelled pods to a specific hostname. -For more information, see [Service Discovery]({{}}/rancher/v2.5/en/k8s-in-rancher/service-discovery). +For more information, see [Service Discovery]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery). ## Pipelines -After your project has been [configured to a version control provider]({{}}/rancher/v2.5/en/project-admin/pipelines/#1-configure-version-control-providers), you can add the repositories and start configuring a pipeline for each repository. +After your project has been [configured to a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines/#1-configure-version-control-providers), you can add the repositories and start configuring a pipeline for each repository. -For more information, see [Pipelines]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/). +For more information, see [Pipelines]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/). ## Applications Besides launching individual components of an application, you can use the Rancher catalog to start launching applications, which are Helm charts. -For more information, see [Applications in a Project]({{}}/rancher/v2.5/en/catalog/apps/). +For more information, see [Applications in a Project]({{}}/rancher/v2.6/en/catalog/apps/). ## Kubernetes Resources @@ -70,7 +70,7 @@ Within the context of a Rancher project or namespace, _resources_ are files and Resources include: -- [Certificates]({{}}/rancher/v2.5/en/k8s-in-rancher/certificates/): Files used to encrypt/decrypt data entering or leaving the cluster. -- [ConfigMaps]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps/): Files that store general configuration information, such as a group of config files. -- [Secrets]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/): Files that store sensitive data like passwords, tokens, or keys. -- [Registries]({{}}/rancher/v2.5/en/k8s-in-rancher/registries/): Files that carry credentials used to authenticate with private registries. +- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/): Files used to encrypt/decrypt data entering or leaving the cluster. +- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/): Files that store general configuration information, such as a group of config files. +- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/): Files that store sensitive data like passwords, tokens, or keys. +- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/): Files that carry credentials used to authenticate with private registries. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/certificates/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/certificates/_index.md index e522f576a40..e95ffe90cd1 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/certificates/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/certificates/_index.md @@ -3,8 +3,8 @@ title: Encrypting HTTP Communication description: Learn how to add an SSL (Secure Sockets Layer) certificate or TLS (Transport Layer Security) certificate to either a project, a namespace, or both, so that you can add it to deployments weight: 3060 aliases: - - /rancher/v2.5/en/tasks/projects/add-ssl-certificates/ - - /rancher/v2.5/en/k8s-in-rancher/certificates + - /rancher/v2.6/en/tasks/projects/add-ssl-certificates/ + - /rancher/v2.6/en/k8s-in-rancher/certificates --- When you create an ingress within Rancher/Kubernetes, you must provide it with a secret that includes a TLS private key and certificate, which are used to encrypt and decrypt communications that come through the ingress. You can make certificates available for ingress use by navigating to its project or namespace, and then uploading the certificate. You can then add the certificate to the ingress deployment. @@ -43,4 +43,4 @@ Add SSL certificates to either projects, namespaces, or both. A project scoped c ## What's Next? -Now you can add the certificate when launching an ingress within the current project or namespace. For more information, see [Adding Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress/). +Now you can add the certificate when launching an ingress within the current project or namespace. For more information, see [Adding Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/). diff --git a/content/rancher/v2.6/en/k8s-in-rancher/configmaps/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/configmaps/_index.md index 972d89ef30b..f02531faa2d 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/configmaps/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/configmaps/_index.md @@ -2,8 +2,8 @@ title: ConfigMaps weight: 3061 aliases: - - /rancher/v2.5/en/tasks/projects/add-configmaps - - /rancher/v2.5/en/k8s-in-rancher/configmaps + - /rancher/v2.6/en/tasks/projects/add-configmaps + - /rancher/v2.6/en/k8s-in-rancher/configmaps --- While most types of Kubernetes secrets store sensitive information, [ConfigMaps](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/) store general configuration information, such as a group of config files. Because ConfigMaps don't store sensitive information, they can be updated automatically, and therefore don't require their containers to be restarted following update (unlike most secret types, which require manual updates and a container restart to take effect). @@ -26,7 +26,7 @@ ConfigMaps accept key value pairs in common string formats, like config files or 1. Click **Save**. - >**Note:** Don't use ConfigMaps to store sensitive data [use a secret]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/). + >**Note:** Don't use ConfigMaps to store sensitive data [use a secret]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/). > >**Tip:** You can add multiple key value pairs to the ConfigMap by copying and pasting. > @@ -41,4 +41,4 @@ Now that you have a ConfigMap added to a namespace, you can add it to a workload - Application environment variables. - Specifying parameters for a Volume mounted to the workload. -For more information on adding ConfigMaps to a workload, see [Deploying Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/). +For more information on adding ConfigMaps to a workload, see [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). diff --git a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/_index.md index 0f2ace17871..b6a28466084 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/_index.md @@ -3,7 +3,7 @@ title: The Horizontal Pod Autoscaler description: Learn about the horizontal pod autoscaler (HPA). How to manage HPAs and how to test them with a service deployment weight: 3026 aliases: - - /rancher/v2.5/en/k8s-in-rancher/horizontal-pod-autoscaler + - /rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler --- The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. @@ -19,12 +19,12 @@ The way that you manage HPAs is different based on your version of the Kubernete - **For Kubernetes API version autoscaling/V2beta1:** This version of the Kubernetes API lets you autoscale your pods based on the CPU and memory utilization of your application. - **For Kubernetes API Version autoscaling/V2beta2:** This version of the Kubernetes API lets you autoscale your pods based on CPU and memory utilization, in addition to custom metrics. -You can create, manage, and delete HPAs using the Rancher UI. From the Rancher UI you can configure the HPA to scale based on CPU and memory utilization. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui). To scale the HPA based on custom metrics, you still need to use `kubectl`. For more information, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +You can create, manage, and delete HPAs using the Rancher UI. From the Rancher UI you can configure the HPA to scale based on CPU and memory utilization. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui). To scale the HPA based on custom metrics, you still need to use `kubectl`. For more information, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). Clusters created in Rancher v2.0.7 and higher automatically have all the requirements needed (metrics-server and Kubernetes cluster configuration) to use HPA. ## Testing HPAs with a Service Deployment -You can see your HPA's current number of replicas by going to your project and clicking **Resources > HPA.** For more information, refer to [Get HPA Metrics and Status]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/). +You can see your HPA's current number of replicas by going to your project and clicking **Resources > HPA.** For more information, refer to [Get HPA Metrics and Status]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/). You can also use `kubectl` to get the status of HPAs that you test with your load testing tool. For more information, refer to [Testing HPAs with kubectl] -({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/). +({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/). diff --git a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/_index.md index aef393f459c..799eaf441d5 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/hpa-background/_index.md @@ -2,7 +2,7 @@ title: Background Information on HPAs weight: 3027 aliases: - - /rancher/v2.5/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background + - /rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/hpa-background --- The [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) (HPA) is a Kubernetes feature that allows you to configure your cluster to automatically scale the services it's running up or down. This section provides explanation on how HPA works with Kubernetes. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/_index.md index 3d551beef6d..b92e58f6911 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/_index.md @@ -2,7 +2,7 @@ title: Managing HPAs with kubectl weight: 3029 aliases: - - /rancher/v2.5/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl + - /rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-kubectl --- This section describes HPA management with `kubectl`. This document has instructions for how to: @@ -14,7 +14,7 @@ This section describes HPA management with `kubectl`. This document has instruct - Configure your HPAs to scale using custom metrics, if you use a third-party tool such as Prometheus for metrics -You can create, view, and delete HPAs from the Rancher UI. You can also configure them to scale based on CPU or memory usage from the Rancher UI. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui). For scaling HPAs based on other metrics than CPU or memory, you still need `kubectl`. +You can create, view, and delete HPAs from the Rancher UI. You can also configure them to scale based on CPU or memory usage from the Rancher UI. For more information, refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui). For scaling HPAs based on other metrics than CPU or memory, you still need `kubectl`. ##### Basic kubectl Command for Managing HPAs diff --git a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/_index.md index 7de4240a971..8cac03a9fcf 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-rancher-ui/_index.md @@ -2,12 +2,12 @@ title: Managing HPAs with the Rancher UI weight: 3028 aliases: - - /rancher/v2.5/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui + - /rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/manage-hpa-with-rancher-ui --- The Rancher UI supports creating, managing, and deleting HPAs. You can configure CPU or memory usage as the metric that the HPA uses to scale. -If you want to create HPAs that scale based on other metrics than CPU and memory, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +If you want to create HPAs that scale based on other metrics than CPU and memory, refer to [Configuring HPA to Scale Using Custom Metrics with Prometheus]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). ## Creating an HPA @@ -25,7 +25,7 @@ If you want to create HPAs that scale based on other metrics than CPU and memory 1. Specify the **Minimum Scale** and **Maximum Scale** for the HPA. -1. Configure the metrics for the HPA. You can choose memory or CPU usage as the metric that will cause the HPA to scale the service up or down. In the **Quantity** field, enter the percentage of the workload's memory or CPU usage that will cause the HPA to scale the service. To configure other HPA metrics, including metrics available from Prometheus, you need to [manage HPAs using kubectl]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). +1. Configure the metrics for the HPA. You can choose memory or CPU usage as the metric that will cause the HPA to scale the service up or down. In the **Quantity** field, enter the percentage of the workload's memory or CPU usage that will cause the HPA to scale the service. To configure other HPA metrics, including metrics available from Prometheus, you need to [manage HPAs using kubectl]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/#configuring-hpa-to-scale-using-custom-metrics-with-prometheus). 1. Click **Create** to create the HPA. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/_index.md index 28dd9c5e195..ad4c1dd5674 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/testing-hpa/_index.md @@ -3,10 +3,10 @@ title: Testing HPAs with kubectl weight: 3031 aliases: - - /rancher/v2.5/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa + - /rancher/v2.6/en/k8s-in-rancher/horizontal-pod-autoscaler/testing-hpa --- -This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.5/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/). +This document describes how to check the status of your HPAs after scaling them up or down with your load testing tool. For information on how to check the status from the Rancher UI (at least version 2.3.x), refer to [Managing HPAs with the Rancher UI]({{}}/rancher/v2.6/en/k8s-in-rancher/horitzontal-pod-autoscaler/manage-hpa-with-kubectl/). For HPA to work correctly, service deployments should have resources request definitions for containers. Follow this hello-world example to test if HPA is working correctly. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/_index.md index ae0b9946a2b..e84bb5f143e 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/_index.md @@ -3,7 +3,7 @@ title: Set Up Load Balancer and Ingress Controller within Rancher description: Learn how you can set up load balancers and ingress controllers to redirect service requests within Rancher, and learn about the limitations of load balancers weight: 3040 aliases: - - /rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress + - /rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress --- Within Rancher, you can set up load balancers and ingress controllers to redirect service requests. @@ -16,10 +16,10 @@ If you want your applications to be externally accessible, you must add a load b Rancher supports two types of load balancers: -- [Layer-4 Load Balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) -- [Layer-7 Load Balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) +- [Layer-4 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-4-load-balancer) +- [Layer-7 Load Balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#layer-7-load-balancer) -For more information, see [load balancers]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). +For more information, see [load balancers]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers). ### Load Balancer Limitations @@ -30,9 +30,9 @@ Load Balancers have a couple of limitations you should be aware of: - If you want to use a load balancer with a Hosted Kubernetes cluster (i.e., clusters hosted in GKE, EKS, or AKS), the load balancer must be running within that cloud provider's infrastructure. Please review the compatibility tables regarding support for load balancers based on how you've provisioned your clusters: - - [Support for Layer-4 Load Balancing]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-4-load-balancing) + - [Support for Layer-4 Load Balancing]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-4-load-balancing) - - [Support for Layer-7 Load Balancing]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-7-load-balancing) + - [Support for Layer-7 Load Balancing]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/#support-for-layer-7-load-balancing) ## Ingress @@ -58,6 +58,6 @@ Ingress can provide other functionality as well, such as SSL termination, name-b > >Refrain from adding an Ingress to the `local` cluster. The Nginx Ingress Controller that Rancher uses acts as a global entry point for _all_ clusters managed by Rancher, including the `local` cluster. Therefore, when users try to access an application, your Rancher connection may drop due to the Nginx configuration being reloaded. We recommend working around this issue by deploying applications only in clusters that you launch using Rancher. -- For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress). +- For more information on how to set up ingress in Rancher, see [Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress). - For complete information about ingress and ingress controllers, see the [Kubernetes Ingress Documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/) - When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md index 3e5952c588c..82884b42375 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress/_index.md @@ -3,8 +3,8 @@ title: Adding Ingresses to Your Project description: Ingresses can be added for workloads to provide load balancing, SSL termination and host/path-based routing. Learn how to add Rancher ingress to your project weight: 3042 aliases: - - /rancher/v2.5/en/tasks/workloads/add-ingress/ - - /rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/ingress + - /rancher/v2.6/en/tasks/workloads/add-ingress/ + - /rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/ingress --- Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry. @@ -58,7 +58,7 @@ Use this option to set an ingress rule for handling requests that don't match an 1. Select a service or workload from the **Target** drop-down list. ### Certificates ->**Note:** You must have an SSL certificate that the ingress can use to encrypt/decrypt communications. For more information see [Adding SSL Certificates]({{}}/rancher/v2.5/en/k8s-in-rancher/certificates/). +>**Note:** You must have an SSL certificate that the ingress can use to encrypt/decrypt communications. For more information see [Adding SSL Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/). 1. Click **Add Certificate**. 1. Select a **Certificate** from the drop-down list. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/_index.md index 4cef71f20a3..5e9767c5306 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers/_index.md @@ -3,8 +3,8 @@ title: "Layer 4 and Layer 7 Load Balancing" description: "Kubernetes supports load balancing in two ways: Layer-4 Load Balancing and Layer-7 Load Balancing. Learn about the support for each way in different deployments" weight: 3041 aliases: - - /rancher/v2.5/en/concepts/load-balancing/ - - /rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers + - /rancher/v2.6/en/concepts/load-balancing/ + - /rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/load-balancers --- Kubernetes supports load balancing in two ways: Layer-4 Load Balancing and Layer-7 Load Balancing. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/registries/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/registries/_index.md index 15e226ea4f1..bc18733e76f 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/registries/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/registries/_index.md @@ -3,9 +3,9 @@ title: Kubernetes Registry and Docker Registry description: Learn about the Docker registry and Kubernetes registry, their use cases and how to use a private registry with the Rancher UI weight: 3063 aliases: - - /rancher/v2.5/en/tasks/projects/add-registries/ - - /rancher/v2.5/en/k8s-in-rancher/registries - - /rancher/v2.5/en/k8s-resources/k8s-in-rancher/registries + - /rancher/v2.6/en/tasks/projects/add-registries/ + - /rancher/v2.6/en/k8s-in-rancher/registries + - /rancher/v2.6/en/k8s-resources/k8s-in-rancher/registries --- Registries are Kubernetes secrets containing credentials used to authenticate with [private Docker registries](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). diff --git a/content/rancher/v2.6/en/k8s-in-rancher/secrets/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/secrets/_index.md index ca4ea2c8f57..edbfdfafe3a 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/secrets/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/secrets/_index.md @@ -2,13 +2,13 @@ title: Secrets weight: 3062 aliases: - - /rancher/v2.5/en/tasks/projects/add-a-secret - - /rancher/v2.5/en/k8s-in-rancher/secrets + - /rancher/v2.6/en/tasks/projects/add-a-secret + - /rancher/v2.6/en/k8s-in-rancher/secrets --- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets) store sensitive data like passwords, tokens, or keys. They may contain one or more key value pairs. -> This page is about secrets in general. For details on setting up a private registry, refer to the section on [registries.]({{}}/rancher/v2.5/en/k8s-in-rancher/registries) +> This page is about secrets in general. For details on setting up a private registry, refer to the section on [registries.]({{}}/rancher/v2.6/en/k8s-in-rancher/registries) When configuring a workload, you'll be able to choose which secrets to include. Like config maps, secrets can be referenced by workloads as either an environment variable or a volume mount. @@ -44,4 +44,4 @@ Mounted secrets will be updated automatically unless they are mounted as subpath Now that you have a secret added to the project or namespace, you can add it to a workload that you deploy. -For more information on adding secret to a workload, see [Deploying Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/). +For more information on adding secret to a workload, see [Deploying Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/). diff --git a/content/rancher/v2.6/en/k8s-in-rancher/service-discovery/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/service-discovery/_index.md index 9546aa81865..75bf1fb1992 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/service-discovery/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/service-discovery/_index.md @@ -2,8 +2,8 @@ title: Service Discovery weight: 3045 aliases: - - /rancher/v2.5/en/tasks/workloads/add-a-dns-record/ - - /rancher/v2.5/en/k8s-in-rancher/service-discovery + - /rancher/v2.6/en/tasks/workloads/add-a-dns-record/ + - /rancher/v2.6/en/k8s-in-rancher/service-discovery --- For every workload created, a complementing Service Discovery entry is created. This Service Discovery entry enables DNS resolution for the workload's pods using the following naming convention: diff --git a/content/rancher/v2.6/en/k8s-in-rancher/workloads/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/workloads/_index.md index a4ae02e731c..86d5fd486a9 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/workloads/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/workloads/_index.md @@ -3,9 +3,9 @@ title: "Kubernetes Workloads and Pods" description: "Learn about the two constructs with which you can build any complex containerized application in Kubernetes: Kubernetes workloads and pods" weight: 3025 aliases: - - /rancher/v2.5/en/concepts/workloads/ - - /rancher/v2.5/en/tasks/workloads/ - - /rancher/v2.5/en/k8s-in-rancher/workloads + - /rancher/v2.6/en/concepts/workloads/ + - /rancher/v2.6/en/tasks/workloads/ + - /rancher/v2.6/en/k8s-in-rancher/workloads --- You can build any complex containerized application in Kubernetes using two basic constructs: pods and workloads. Once you build an application, you can expose it for access either within the same cluster or on the Internet using a third construct: services. @@ -72,9 +72,9 @@ There are several types of services available in Rancher. The descriptions below This section of the documentation contains instructions for deploying workloads and using workload options. -- [Deploy Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/) -- [Upgrade Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/upgrade-workloads/) -- [Rollback Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/rollback-workloads/) +- [Deploy Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/) +- [Upgrade Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/) +- [Rollback Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/) ## Related Links diff --git a/content/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar/_index.md index 3d1889b919c..cbe4b975241 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar/_index.md @@ -2,8 +2,8 @@ title: Adding a Sidecar weight: 3029 aliases: - - /rancher/v2.5/en/tasks/workloads/add-a-sidecar/ - - /rancher/v2.5/en/k8s-in-rancher/workloads/add-a-sidecar + - /rancher/v2.6/en/tasks/workloads/add-a-sidecar/ + - /rancher/v2.6/en/k8s-in-rancher/workloads/add-a-sidecar --- A _sidecar_ is a container that extends or enhances the main container in a pod. The main container and the sidecar share a pod, and therefore share the same network space and storage. You can add sidecars to existing workloads by using the **Add a Sidecar** option. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/_index.md index fa184d73319..22587d513a0 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/_index.md @@ -3,8 +3,8 @@ title: Deploying Workloads description: Read this step by step guide for deploying workloads. Deploy a workload to run an application in one or more containers. weight: 3026 aliases: - - /rancher/v2.5/en/tasks/workloads/deploy-workloads/ - - /rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads + - /rancher/v2.6/en/tasks/workloads/deploy-workloads/ + - /rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads --- Deploy a workload to run an application in one or more containers. @@ -15,25 +15,25 @@ Deploy a workload to run an application in one or more containers. 1. Enter a **Name** for the workload. -1. Select a [workload type]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/). The workload defaults to a scalable deployment, by can change the workload type by clicking **More options.** +1. Select a [workload type]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/). The workload defaults to a scalable deployment, by can change the workload type by clicking **More options.** 1. From the **Docker Image** field, enter the name of the Docker image that you want to deploy to the project, optionally prefacing it with the registry host (e.g. `quay.io`, `registry.gitlab.com`, etc.). During deployment, Rancher pulls this image from the specified public or private registry. If no registry host is provided, Rancher will pull the image from [Docker Hub](https://hub.docker.com/explore/). Enter the name exactly as it appears in the registry server, including any required path, and optionally including the desired tag (e.g. `registry.gitlab.com/user/path/image:tag`). If no tag is provided, the `latest` tag will be automatically used. 1. Either select an existing namespace, or click **Add to a new namespace** and enter a new namespace. -1. Click **Add Port** to enter a port mapping, which enables access to the application inside and outside of the cluster . For more information, see [Services]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/#services). +1. Click **Add Port** to enter a port mapping, which enables access to the application inside and outside of the cluster . For more information, see [Services]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/#services). 1. Configure the remaining options: - **Environment Variables** - Use this section to either specify environment variables for your workload to consume on the fly, or to pull them from another source, such as a secret or [ConfigMap]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps/). + Use this section to either specify environment variables for your workload to consume on the fly, or to pull them from another source, such as a secret or [ConfigMap]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/). - **Node Scheduling** - **Health Check** - **Volumes** - Use this section to add storage for your workload. You can manually specify the volume that you want to add, use a persistent volume claim to dynamically create a volume for the workload, or read data for a volume to use from a file such as a [ConfigMap]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps/). + Use this section to add storage for your workload. You can manually specify the volume that you want to add, use a persistent volume claim to dynamically create a volume for the workload, or read data for a volume to use from a file such as a [ConfigMap]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/). When you are deploying a Stateful Set, you should use a Volume Claim Template when using Persistent Volumes. This will ensure that Persistent Volumes are created dynamically when you scale your Stateful Set. @@ -45,7 +45,7 @@ Deploy a workload to run an application in one or more containers. > >- In [Amazon AWS](https://aws.amazon.com/), the nodes must be in the same Availability Zone and possess IAM permissions to attach/unattach volumes. > - >- The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/ec2/) or [Creating a Custom Cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/custom-nodes). + >- The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/ec2/) or [Creating a Custom Cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/custom-nodes). 1. Click **Show Advanced Options** and configure: diff --git a/content/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/_index.md index 4b13395a9bc..0e78abd4c32 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads/_index.md @@ -2,8 +2,8 @@ title: Rolling Back Workloads weight: 3027 aliases: - - /rancher/v2.5/en/tasks/workloads/rollback-workloads/ - - /rancher/v2.5/en/k8s-in-rancher/workloads/rollback-workloads + - /rancher/v2.6/en/tasks/workloads/rollback-workloads/ + - /rancher/v2.6/en/k8s-in-rancher/workloads/rollback-workloads --- Sometimes there is a need to rollback to the previous version of the application, either for debugging purposes or because an upgrade did not go as planned. diff --git a/content/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/_index.md b/content/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/_index.md index 0457f33243a..8eb677ed28f 100644 --- a/content/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/_index.md +++ b/content/rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads/_index.md @@ -2,8 +2,8 @@ title: Upgrading Workloads weight: 3028 aliases: - - /rancher/v2.5/en/tasks/workloads/upgrade-workloads/ - - /rancher/v2.5/en/k8s-in-rancher/workloads/upgrade-workloads + - /rancher/v2.6/en/tasks/workloads/upgrade-workloads/ + - /rancher/v2.6/en/k8s-in-rancher/workloads/upgrade-workloads --- When a new version of an application image is released on Docker Hub, you can upgrade any workloads running a previous version of the application to the new one. diff --git a/content/rancher/v2.6/en/logging/_index.md b/content/rancher/v2.6/en/logging/_index.md index a1d205f91d8..3fee0f952f2 100644 --- a/content/rancher/v2.6/en/logging/_index.md +++ b/content/rancher/v2.6/en/logging/_index.md @@ -5,14 +5,14 @@ description: Rancher integrates with popular logging services. Learn the require metaDescription: "Rancher integrates with popular logging services. Learn the requirements and benefits of integrating with logging services, and enable logging on your cluster." weight: 15 aliases: - - /rancher/v2.5/en/dashboard/logging - - /rancher/v2.5/en/logging/v2.5 - - /rancher/v2.5/en/cluster-admin/tools/logging + - /rancher/v2.6/en/dashboard/logging + - /rancher/v2.6/en/logging/v2.5 + - /rancher/v2.6/en/cluster-admin/tools/logging --- The [Banzai Cloud Logging operator](https://banzaicloud.com/docs/one-eye/logging-operator/) now powers Rancher's logging solution in place of the former, in-house solution. -For an overview of the changes in v2.5, see [this section.](/{{}}/rancher/v2.5/en/logging/architecture/#changes-in-rancher-v2-5) For information about migrating from Logging V1, see [this page.](./migrating) +For an overview of the changes in v2.5, see [this section.](/{{}}/rancher/v2.6/en/logging/architecture/#changes-in-rancher-v2-5) For information about migrating from Logging V1, see [this page.](./migrating) - [Enabling Logging](#enabling-logging) - [Uninstall Logging](#uninstall-logging) diff --git a/content/rancher/v2.6/en/logging/helm-chart-options/_index.md b/content/rancher/v2.6/en/logging/helm-chart-options/_index.md index a3786c264b4..6231b5e14cb 100644 --- a/content/rancher/v2.6/en/logging/helm-chart-options/_index.md +++ b/content/rancher/v2.6/en/logging/helm-chart-options/_index.md @@ -48,7 +48,7 @@ _Available as of v2.5.8_ [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on CentOS 7 and 8. -To use Logging v2 with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.5/en/security/selinux/#installing-the-rancher-selinux-rpm) +To use Logging v2 with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.6/en/security/selinux/#installing-the-rancher-selinux-rpm) Then, when installing the logging application, configure the chart to be SELinux aware by changing `global.seLinux.enabled` to `true` in the `values.yaml`. diff --git a/content/rancher/v2.6/en/logging/migrating/_index.md b/content/rancher/v2.6/en/logging/migrating/_index.md index 0f05903b436..1b88dcf1ee8 100644 --- a/content/rancher/v2.6/en/logging/migrating/_index.md +++ b/content/rancher/v2.6/en/logging/migrating/_index.md @@ -2,7 +2,7 @@ title: Migrating to Rancher v2.5 Logging weight: 2 aliases: - - /rancher/v2.5/en/logging/v2.5/migrating + - /rancher/v2.6/en/logging/v2.5/migrating --- Starting in v2.5, the logging feature available within Rancher has been completely overhauled. The [logging operator](https://github.com/banzaicloud/logging-operator) from Banzai Cloud has been adopted; Rancher configures this tooling for use when deploying logging. @@ -25,7 +25,7 @@ Among the many features and changes in the new logging functionality is the remo # Installation -To install logging in Rancher v2.5+, refer to the [installation instructions]({{}}/rancher/v2.5/en/logging/#enabling-logging). +To install logging in Rancher v2.5+, refer to the [installation instructions]({{}}/rancher/v2.6/en/logging/#enabling-logging). ### Terminology diff --git a/content/rancher/v2.6/en/monitoring-alerting/_index.md b/content/rancher/v2.6/en/monitoring-alerting/_index.md index f9682dbc192..3f90cc70ac8 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/_index.md @@ -4,9 +4,9 @@ shortTitle: Monitoring/Alerting description: Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring weight: 13 aliases: - - /rancher/v2.5/en/dashboard/monitoring-alerting - - /rancher/v2.5/en/dashboard/notifiers - - /rancher/v2.5/en/cluster-admin/tools/monitoring/ + - /rancher/v2.6/en/dashboard/monitoring-alerting + - /rancher/v2.6/en/dashboard/notifiers + - /rancher/v2.6/en/cluster-admin/tools/monitoring/ --- Using Rancher, you can quickly deploy leading open-source monitoring alerting solutions onto your cluster. @@ -54,7 +54,7 @@ By viewing data that Prometheus scrapes from your cluster control plane, nodes, # Enable Monitoring -As an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. +As an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/) or [cluster owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster. > **Requirements:** > @@ -74,7 +74,7 @@ As an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-p ### Enable Monitoring for use with SSL -1. Follow the steps on [this page]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/) to create a secret in order for SSL to be used for alerts. +1. Follow the steps on [this page]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) to create a secret in order for SSL to be used for alerts. - The secret should be created in the `cattle-monitoring-system` namespace. If it doesn't exist, create it first. - Add the `ca`, `cert`, and `key` files to the secret. 1. In the Rancher UI, go to the cluster where you want to install monitoring and click **Cluster Explorer.** @@ -85,7 +85,7 @@ As an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-p **Result:** The monitoring app is deployed in the `cattle-monitoring-system` namespace. -When [creating a receiver,]({{}}/rancher/v2.5/en/monitoring-alerting/configuration/alertmanager/#creating-receivers-in-the-rancher-ui) SSL-enabled receivers such as email or webhook will have a **SSL** section with fields for **CA File Path**, **Cert File Path**, and **Key File Path**. Fill in these fields with the paths to each of `ca`, `cert`, and `key`. The path will be of the form `/etc/alertmanager/secrets/name-of-file-in-secret`. +When [creating a receiver,]({{}}/rancher/v2.6/en/monitoring-alerting/configuration/alertmanager/#creating-receivers-in-the-rancher-ui) SSL-enabled receivers such as email or webhook will have a **SSL** section with fields for **CA File Path**, **Cert File Path**, and **Key File Path**. Fill in these fields with the paths to each of `ca`, `cert`, and `key`. The path will be of the form `/etc/alertmanager/secrets/name-of-file-in-secret`. For example, if you created a secret with these key-value pairs: diff --git a/content/rancher/v2.6/en/monitoring-alerting/configuration/_index.md b/content/rancher/v2.6/en/monitoring-alerting/configuration/_index.md index 971f83ccde8..3571737590d 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/configuration/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/configuration/_index.md @@ -2,7 +2,7 @@ title: Configuration weight: 3 aliases: - - /rancher/v2.5/en/monitoring-alerting/v2.5/configuration + - /rancher/v2.6/en/monitoring-alerting/v2.5/configuration --- This page captures some of the most important options for configuring the custom resources for monitoring. @@ -71,7 +71,7 @@ If the scrape configuration you want cannot be specified via a ServiceMonitor or A [scrape_config section](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) specifies a set of targets and parameters describing how to scrape them. In the general case, one scrape configuration specifies a single job. -An example of where this might be used is with Istio. For more information, see [this section.](https://rancher.com/docs/rancher/v2.5/en/istio/v2.5/configuration-reference/selectors-and-scrape) +An example of where this might be used is with Istio. For more information, see [this section.](https://rancher.com/docs/rancher/v2.6/en/istio/v2.5/configuration-reference/selectors-and-scrape) # Examples diff --git a/content/rancher/v2.6/en/monitoring-alerting/configuration/alertmanager/_index.md b/content/rancher/v2.6/en/monitoring-alerting/configuration/alertmanager/_index.md index 6d49c373b26..cc02052b9c6 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/configuration/alertmanager/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/configuration/alertmanager/_index.md @@ -2,10 +2,10 @@ title: Alertmanager weight: 1 aliases: - - /rancher/v2.5/en/monitoring-alerting/v2.5/configuration/alertmanager - - rancher/v2.5/en/monitoring-alerting/legacy/notifiers/ - - /rancher/v2.5/en/cluster-admin/tools/notifiers - - /rancher/v2.5/en/cluster-admin/tools/alerts + - /rancher/v2.6/en/monitoring-alerting/v2.5/configuration/alertmanager + - rancher/v2.6/en/monitoring-alerting/legacy/notifiers/ + - /rancher/v2.6/en/cluster-admin/tools/notifiers + - /rancher/v2.6/en/cluster-admin/tools/alerts --- The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configuration/#configuration-file) Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus. @@ -341,4 +341,4 @@ spec: # key: string ``` -For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.]({{}}/rancher/v2.5/en/cis-scans/v2.5/#enabling-alerting-for-rancher-cis-benchmark) +For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.]({{}}/rancher/v2.6/en/cis-scans/v2.5/#enabling-alerting-for-rancher-cis-benchmark) diff --git a/content/rancher/v2.6/en/monitoring-alerting/configuration/expression/_index.md b/content/rancher/v2.6/en/monitoring-alerting/configuration/expression/_index.md index b5a31d35211..2b2698dfef4 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/configuration/expression/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/configuration/expression/_index.md @@ -2,10 +2,10 @@ title: Prometheus Expressions weight: 4 aliases: - - /rancher/v2.5/en/project-admin/tools/monitoring/expression - - /rancher/v2.5/en/cluster-admin/tools/monitoring/expression - - /rancher/v2.5/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/expression - - /rancher/v2.5/en/monitoring-alerting/v2.5/configuration/expression + - /rancher/v2.6/en/project-admin/tools/monitoring/expression + - /rancher/v2.6/en/cluster-admin/tools/monitoring/expression + - /rancher/v2.6/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/expression + - /rancher/v2.6/en/monitoring-alerting/v2.5/configuration/expression --- The PromQL expressions in this doc can be used to configure alerts. diff --git a/content/rancher/v2.6/en/monitoring-alerting/configuration/prometheusrules/_index.md b/content/rancher/v2.6/en/monitoring-alerting/configuration/prometheusrules/_index.md index c2715edaab6..2c35871942e 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/configuration/prometheusrules/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/configuration/prometheusrules/_index.md @@ -2,7 +2,7 @@ title: PrometheusRules weight: 2 aliases: - - /rancher/v2.5/en/monitoring-alerting/v2.5/configuration/prometheusrules + - /rancher/v2.6/en/monitoring-alerting/v2.5/configuration/prometheusrules --- A PrometheusRule defines a group of Prometheus alerting and/or recording rules. diff --git a/content/rancher/v2.6/en/monitoring-alerting/migrating/_index.md b/content/rancher/v2.6/en/monitoring-alerting/migrating/_index.md index 7d4253f8c64..630361d0f7f 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/migrating/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/migrating/_index.md @@ -2,7 +2,7 @@ title: Migrating to Rancher v2.5 Monitoring weight: 5 aliases: - - /rancher/v2.5/en/monitoring-alerting/v2.5/migrating + - /rancher/v2.6/en/monitoring-alerting/v2.5/migrating --- If you previously enabled Monitoring, Alerting, or Notifiers in Rancher before v2.5, there is no automatic upgrade path for switching to the new monitoring/alerting solution. Before deploying the new monitoring solution via Cluster Explore, you will need to disable and remove all existing custom alerts, notifiers and monitoring installations for the whole cluster and in all projects. @@ -25,7 +25,7 @@ Unlike in Monitoring & Alerting V1, both features are packaged in a single Helm Monitoring V2 can only be configured on the cluster level. Project-level monitoring and alerting is no longer supported. -For more information on how to configure Monitoring & Alerting V2, see [this page.]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration) +For more information on how to configure Monitoring & Alerting V2, see [this page.]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration) ### Changes to Role-based Access Control @@ -110,8 +110,8 @@ or add the Prometheus Rule through the Cluster Explorer {{< img "/img/rancher/monitoring/migration/alert_2.4_to_2.5_target.png" "">}} -For more details on how to configure PrometheusRules in Monitoring V2 see [Monitoring Configuration]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration#prometheusrules). +For more details on how to configure PrometheusRules in Monitoring V2 see [Monitoring Configuration]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration#prometheusrules). #### Migrating notifiers -There is no direct equivalent for how notifiers work in Monitoring V1. Instead you have to replicate the desired setup with [Routes and Receivers]({{}}/rancher/v2.5/en/monitoring-alerting/v2.5/configuration#alertmanager-config) in Monitoring V2. +There is no direct equivalent for how notifiers work in Monitoring V1. Instead you have to replicate the desired setup with [Routes and Receivers]({{}}/rancher/v2.6/en/monitoring-alerting/v2.5/configuration#alertmanager-config) in Monitoring V2. diff --git a/content/rancher/v2.6/en/monitoring-alerting/persist-grafana/_index.md b/content/rancher/v2.6/en/monitoring-alerting/persist-grafana/_index.md index d1c9984928e..2b09bfa9fc3 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/persist-grafana/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/persist-grafana/_index.md @@ -2,7 +2,7 @@ title: Persistent Grafana Dashboards weight: 4 aliases: - - /rancher/v2.5/en/monitoring-alerting/v2.5/persist-grafana + - /rancher/v2.6/en/monitoring-alerting/v2.5/persist-grafana --- To allow the Grafana dashboard to persist after the Grafana instance restarts, add the dashboard configuration JSON into a ConfigMap. ConfigMaps also allow the dashboards to be deployed with a GitOps or CD based approach. This allows the dashboard to be put under version control. @@ -16,7 +16,7 @@ To allow the Grafana dashboard to persist after the Grafana instance restarts, a > > - The monitoring application needs to be installed. > - To create the persistent dashboard, you must have at least the **Manage Config Maps** Rancher RBAC permissions assigned to you in the project or namespace that contains the Grafana Dashboards. This correlates to the `monitoring-dashboard-edit` or `monitoring-dashboard-admin` Kubernetes native RBAC Roles exposed by the Monitoring chart. -> - To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.]({{}}/rancher/v2.5/en/monitoring-alerting/rbac/#users-with-rancher-cluster-manager-based-permissions) +> - To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.]({{}}/rancher/v2.6/en/monitoring-alerting/rbac/#users-with-rancher-cluster-manager-based-permissions) ### 1. Get the JSON model of the dashboard that you want to persist diff --git a/content/rancher/v2.6/en/monitoring-alerting/rbac/_index.md b/content/rancher/v2.6/en/monitoring-alerting/rbac/_index.md index bd43af05add..bab36068771 100644 --- a/content/rancher/v2.6/en/monitoring-alerting/rbac/_index.md +++ b/content/rancher/v2.6/en/monitoring-alerting/rbac/_index.md @@ -2,8 +2,8 @@ title: RBAC weight: 3 aliases: - - /rancher/v2.5/en/cluster-admin/tools/monitoring/rbac - - /rancher/v2.5/en/monitoring-alerting/v2.5/rbac + - /rancher/v2.6/en/cluster-admin/tools/monitoring/rbac + - /rancher/v2.6/en/monitoring-alerting/v2.5/rbac --- This section describes the expectations for RBAC for Rancher Monitoring. diff --git a/content/rancher/v2.6/en/opa-gatekeper/_index.md b/content/rancher/v2.6/en/opa-gatekeper/_index.md index 86136b6faac..3dcf0c923a0 100644 --- a/content/rancher/v2.6/en/opa-gatekeper/_index.md +++ b/content/rancher/v2.6/en/opa-gatekeper/_index.md @@ -2,8 +2,8 @@ title: OPA Gatekeeper weight: 16 aliases: - - /rancher/v2.5/en/cluster-admin/tools/opa-gatekeeper - - /rancher/v2.5/en/opa-gatekeeper/Open%20Policy%20Agent + - /rancher/v2.6/en/cluster-admin/tools/opa-gatekeeper + - /rancher/v2.6/en/opa-gatekeeper/Open%20Policy%20Agent --- To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. [OPA (Open Policy Agent)](https://www.openpolicyagent.org/) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates. diff --git a/content/rancher/v2.6/en/overview/_index.md b/content/rancher/v2.6/en/overview/_index.md index a455410599d..20c68062441 100644 --- a/content/rancher/v2.6/en/overview/_index.md +++ b/content/rancher/v2.6/en/overview/_index.md @@ -30,21 +30,21 @@ The Rancher API server is built on top of an embedded Kubernetes API server and ### Authorization and Role-Based Access Control -- **User management:** The Rancher API server [manages user identities]({{}}/rancher/v2.5/en/admin-settings/authentication/) that correspond to external authentication providers like Active Directory or GitHub, in addition to local users. -- **Authorization:** The Rancher API server manages [access control]({{}}/rancher/v2.5/en/admin-settings/rbac/) and [security]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/) policies. +- **User management:** The Rancher API server [manages user identities]({{}}/rancher/v2.6/en/admin-settings/authentication/) that correspond to external authentication providers like Active Directory or GitHub, in addition to local users. +- **Authorization:** The Rancher API server manages [access control]({{}}/rancher/v2.6/en/admin-settings/rbac/) and [security]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/) policies. ### Working with Kubernetes -- **Provisioning Kubernetes clusters:** The Rancher API server can [provision Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/) on existing nodes, or perform [Kubernetes upgrades.]({{}}/rancher/v2.5/en/cluster-admin/upgrading-kubernetes) -- **Catalog management:** Rancher provides the ability to use a [catalog of Helm charts]({{}}/rancher/v2.5/en/catalog/) that make it easy to repeatedly deploy applications. -- **Managing projects:** A project is a group of multiple namespaces and access control policies within a cluster. A project is a Rancher concept, not a Kubernetes concept, which allows you manage multiple namespaces as a group and perform Kubernetes operations in them. The Rancher UI provides features for [project administration]({{}}/rancher/v2.5/en/project-admin/) and for [managing applications within projects.]({{}}/rancher/v2.5/en/k8s-in-rancher/) -- **Pipelines:** Setting up a [pipeline]({{}}/rancher/v2.5/en/project-admin/pipelines/) can help developers deliver new software as quickly and efficiently as possible. Within Rancher, you can configure pipelines for each of your Rancher projects. -- **Istio:** Our [integration with Istio]({{}}/rancher/v2.5/en/cluster-admin/tools/istio/) is designed so that a Rancher operator, such as an administrator or cluster owner, can deliver Istio to developers. Then developers can use Istio to enforce security policies, troubleshoot problems, or manage traffic for green/blue deployments, canary deployments, or A/B testing. +- **Provisioning Kubernetes clusters:** The Rancher API server can [provision Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/) on existing nodes, or perform [Kubernetes upgrades.]({{}}/rancher/v2.6/en/cluster-admin/upgrading-kubernetes) +- **Catalog management:** Rancher provides the ability to use a [catalog of Helm charts]({{}}/rancher/v2.6/en/catalog/) that make it easy to repeatedly deploy applications. +- **Managing projects:** A project is a group of multiple namespaces and access control policies within a cluster. A project is a Rancher concept, not a Kubernetes concept, which allows you manage multiple namespaces as a group and perform Kubernetes operations in them. The Rancher UI provides features for [project administration]({{}}/rancher/v2.6/en/project-admin/) and for [managing applications within projects.]({{}}/rancher/v2.6/en/k8s-in-rancher/) +- **Pipelines:** Setting up a [pipeline]({{}}/rancher/v2.6/en/project-admin/pipelines/) can help developers deliver new software as quickly and efficiently as possible. Within Rancher, you can configure pipelines for each of your Rancher projects. +- **Istio:** Our [integration with Istio]({{}}/rancher/v2.6/en/cluster-admin/tools/istio/) is designed so that a Rancher operator, such as an administrator or cluster owner, can deliver Istio to developers. Then developers can use Istio to enforce security policies, troubleshoot problems, or manage traffic for green/blue deployments, canary deployments, or A/B testing. ### Working with Cloud Infrastructure -- **Tracking nodes:** The Rancher API server tracks identities of all the [nodes]({{}}/rancher/v2.5/en/cluster-admin/nodes/) in all clusters. -- **Setting up infrastructure:** When configured to use a cloud provider, Rancher can dynamically provision [new nodes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/) and [persistent storage]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/) in the cloud. +- **Tracking nodes:** The Rancher API server tracks identities of all the [nodes]({{}}/rancher/v2.6/en/cluster-admin/nodes/) in all clusters. +- **Setting up infrastructure:** When configured to use a cloud provider, Rancher can dynamically provision [new nodes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/) and [persistent storage]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) in the cloud. ### Cluster Visibility @@ -54,10 +54,10 @@ The Rancher API server is built on top of an embedded Kubernetes API server and # Editing Downstream Clusters with Rancher -The options and settings available for an existing cluster change based on the method that you used to provision it. For example, only clusters [provisioned by RKE]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) have **Cluster Options** available for editing. +The options and settings available for an existing cluster change based on the method that you used to provision it. For example, only clusters [provisioned by RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) have **Cluster Options** available for editing. -After a cluster is created with Rancher, a cluster administrator can manage cluster membership, enable pod security policies, and manage node pools, among [other options.]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/) +After a cluster is created with Rancher, a cluster administrator can manage cluster membership, enable pod security policies, and manage node pools, among [other options.]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/) The following table summarizes the options and settings available for each cluster type: -{{% include file="/rancher/v2.5/en/cluster-provisioning/cluster-capabilities-table" %}} +{{% include file="/rancher/v2.6/en/cluster-provisioning/cluster-capabilities-table" %}} diff --git a/content/rancher/v2.6/en/overview/architecture-recommendations/_index.md b/content/rancher/v2.6/en/overview/architecture-recommendations/_index.md index 30fdd1ab0a5..186ef9429e9 100644 --- a/content/rancher/v2.6/en/overview/architecture-recommendations/_index.md +++ b/content/rancher/v2.6/en/overview/architecture-recommendations/_index.md @@ -60,7 +60,7 @@ We recommend the following configurations for the load balancer and Ingress cont It is strongly recommended to install Rancher on a Kubernetes cluster on hosted infrastructure such as Amazon's EC2 or Google Compute Engine. -For the best performance and greater security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.5/en/cluster-provisioning/) for running your workloads. +For the best performance and greater security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. # Recommended Node Roles for Kubernetes Installations @@ -102,10 +102,10 @@ With that said, it is safe to use all three roles on three nodes when setting up Because no additional workloads will be deployed on the Rancher server cluster, in most cases it is not necessary to use the same architecture that we recommend for the scalability and reliability of downstream clusters. -For more best practices for downstream clusters, refer to the [production checklist]({{}}/rancher/v2.5/en/cluster-provisioning/production) or our [best practices guide.]({{}}/rancher/v2.5/en/best-practices/v2.5/) +For more best practices for downstream clusters, refer to the [production checklist]({{}}/rancher/v2.6/en/cluster-provisioning/production) or our [best practices guide.]({{}}/rancher/v2.6/en/best-practices/v2.5/) # Architecture for an Authorized Cluster Endpoint -If you are using an [authorized cluster endpoint,]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) we recommend creating an FQDN pointing to a load balancer which balances traffic across your nodes with the `controlplane` role. +If you are using an [authorized cluster endpoint,]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) we recommend creating an FQDN pointing to a load balancer which balances traffic across your nodes with the `controlplane` role. -If you are using private CA signed certificates on the load balancer, you have to supply the CA certificate, which will be included in the generated kubeconfig file to validate the certificate chain. See the documentation on [kubeconfig files]({{}}/rancher/v2.5/en/k8s-in-rancher/kubeconfig/) and [API keys]({{}}/rancher/v2.5/en/user-settings/api-keys/#creating-an-api-key) for more information. \ No newline at end of file +If you are using private CA signed certificates on the load balancer, you have to supply the CA certificate, which will be included in the generated kubeconfig file to validate the certificate chain. See the documentation on [kubeconfig files]({{}}/rancher/v2.6/en/k8s-in-rancher/kubeconfig/) and [API keys]({{}}/rancher/v2.6/en/user-settings/api-keys/#creating-an-api-key) for more information. \ No newline at end of file diff --git a/content/rancher/v2.6/en/overview/architecture/_index.md b/content/rancher/v2.6/en/overview/architecture/_index.md index 6ec1dfd588b..dccfc8b72fb 100644 --- a/content/rancher/v2.6/en/overview/architecture/_index.md +++ b/content/rancher/v2.6/en/overview/architecture/_index.md @@ -5,13 +5,13 @@ weight: 1 This section focuses on the Rancher server, its components, and how Rancher communicates with downstream Kubernetes clusters. -For information on the different ways that Rancher can be installed, refer to the [overview of installation options.]({{}}/rancher/v2.5/en/installation/#overview-of-installation-options) +For information on the different ways that Rancher can be installed, refer to the [overview of installation options.]({{}}/rancher/v2.6/en/installation/#overview-of-installation-options) -For a list of main features of the Rancher API server, refer to the [overview section.]({{}}/rancher/v2.5/en/overview/#features-of-the-rancher-api-server) +For a list of main features of the Rancher API server, refer to the [overview section.]({{}}/rancher/v2.6/en/overview/#features-of-the-rancher-api-server) -For guidance about setting up the underlying infrastructure for the Rancher server, refer to the [architecture recommendations.]({{}}/rancher/v2.5/en/overview/architecture-recommendations) +For guidance about setting up the underlying infrastructure for the Rancher server, refer to the [architecture recommendations.]({{}}/rancher/v2.6/en/overview/architecture-recommendations) -> This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.5/en/overview/concepts) page. +> This section assumes a basic familiarity with Docker and Kubernetes. For a brief explanation of how Kubernetes components work together, refer to the [concepts]({{}}/rancher/v2.6/en/overview/concepts) page. This section covers the following topics: @@ -31,9 +31,9 @@ The majority of Rancher 2.x software runs on the Rancher Server. Rancher Server The figure below illustrates the high-level architecture of Rancher 2.x. The figure depicts a Rancher Server installation that manages two downstream Kubernetes clusters: one created by RKE and another created by Amazon EKS (Elastic Kubernetes Service). -For the best performance and security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.5/en/cluster-provisioning/) for running your workloads. +For the best performance and security, we recommend a dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters]({{}}/rancher/v2.6/en/cluster-provisioning/) for running your workloads. -The diagram below shows how users can manipulate both [Rancher-launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters and [hosted Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/) clusters through Rancher's authentication proxy: +The diagram below shows how users can manipulate both [Rancher-launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters and [hosted Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/) clusters through Rancher's authentication proxy:
Managing Kubernetes Clusters through Rancher's Authentication Proxy
@@ -45,7 +45,7 @@ A high-availability Kubernetes installation is recommended for production. A Docker installation of Rancher is recommended only for development and testing purposes. The ability to migrate Rancher to a high-availability cluster depends on the Rancher version: -The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.5/en/backups/migrating-rancher) +The Rancher backup operator can be used to migrate Rancher from the single Docker container install to an installation on a high-availability Kubernetes cluster. For details, refer to the documentation on [migrating Rancher to a new cluster.]({{}}/rancher/v2.6/en/backups/migrating-rancher) The Rancher server, regardless of the installation method, should always run on nodes that are separate from the downstream user clusters that it manages. If Rancher is installed on a high-availability Kubernetes cluster, it should run on a separate cluster from the cluster(s) it manages. @@ -75,7 +75,7 @@ The authentication proxy forwards all Kubernetes API calls to downstream cluster Rancher communicates with Kubernetes clusters using a [service account,](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) which provides an identity for processes that run in a pod. -By default, Rancher generates a [kubeconfig file]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/) that contains credentials for proxying through the Rancher server to connect to the Kubernetes API server on a downstream user cluster. The kubeconfig file (`kube_config_rancher-cluster.yml`) contains full access to the cluster. +By default, Rancher generates a [kubeconfig file]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) that contains credentials for proxying through the Rancher server to connect to the Kubernetes API server on a downstream user cluster. The kubeconfig file (`kube_config_rancher-cluster.yml`) contains full access to the cluster. ### 2. Cluster Controllers and Cluster Agents @@ -107,7 +107,7 @@ The `cattle-node-agent` is deployed using a [DaemonSet](https://kubernetes.io/do An authorized cluster endpoint allows users to connect to the Kubernetes API server of a downstream cluster without having to route their requests through the Rancher authentication proxy. -> The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters) to provision the cluster. It is not available for registered clusters, or for clusters in a hosted Kubernetes provider, such as Amazon's EKS. +> The authorized cluster endpoint only works on Rancher-launched Kubernetes clusters. In other words, it only works in clusters where Rancher [used RKE]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters) to provision the cluster. It is not available for registered clusters, or for clusters in a hosted Kubernetes provider, such as Amazon's EKS. There are two main reasons why a user might need the authorized cluster endpoint: @@ -122,7 +122,7 @@ Like the authorized cluster endpoint, the `kube-api-auth` authentication service With this endpoint enabled for the downstream cluster, Rancher generates an extra Kubernetes context in the kubeconfig file in order to connect directly to the cluster. This file has the credentials for `kubectl` and `helm`. -You will need to use a context defined in this kubeconfig file to access the cluster if Rancher goes down. Therefore, we recommend exporting the kubeconfig file so that if Rancher goes down, you can still use the credentials in the file to access your cluster. For more information, refer to the section on accessing your cluster with [kubectl and the kubeconfig file.]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl) +You will need to use a context defined in this kubeconfig file to access the cluster if Rancher goes down. Therefore, we recommend exporting the kubeconfig file so that if Rancher goes down, you can still use the credentials in the file to access your cluster. For more information, refer to the section on accessing your cluster with [kubectl and the kubeconfig file.]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl) # Important Files @@ -134,7 +134,7 @@ The files mentioned below are needed to maintain, troubleshoot and upgrade your > **Note:** The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file. -For more information on connecting to a cluster without the Rancher authentication proxy and other configuration options, refer to the [kubeconfig file]({{}}/rancher/v2.5/en/cluster-admin/cluster-access/kubectl/) documentation. +For more information on connecting to a cluster without the Rancher authentication proxy and other configuration options, refer to the [kubeconfig file]({{}}/rancher/v2.6/en/cluster-admin/cluster-access/kubectl/) documentation. # Tools for Provisioning Kubernetes Clusters @@ -178,4 +178,4 @@ The GitHub repositories for Rancher can be found at the following links: - [Rancher CLI](https://github.com/rancher/cli) - [Catalog applications](https://github.com/rancher/helm) -This is a partial list of the most important Rancher repositories. For more details about Rancher source code, refer to the section on [contributing to Rancher.]({{}}/rancher/v2.5/en/contributing/#repositories) To see all libraries and projects used in Rancher, see the [`go.mod` file](https://github.com/rancher/rancher/blob/master/go.mod) in the `rancher/rancher` repository. +This is a partial list of the most important Rancher repositories. For more details about Rancher source code, refer to the section on [contributing to Rancher.]({{}}/rancher/v2.6/en/contributing/#repositories) To see all libraries and projects used in Rancher, see the [`go.mod` file](https://github.com/rancher/rancher/blob/master/go.mod) in the `rancher/rancher` repository. diff --git a/content/rancher/v2.6/en/overview/concepts/_index.md b/content/rancher/v2.6/en/overview/concepts/_index.md index 0fe2f4e91ad..8685be27915 100644 --- a/content/rancher/v2.6/en/overview/concepts/_index.md +++ b/content/rancher/v2.6/en/overview/concepts/_index.md @@ -61,7 +61,7 @@ Each [worker node](https://kubernetes.io/docs/concepts/architecture/nodes/) runs - **Kubelets:** An agent that monitors the state of the node, ensuring your containers are healthy. - **Workloads:** The containers and pods that hold your apps, as well as other types of deployments. -Worker nodes also run storage and networking drivers, and ingress controllers when required. You create as many worker nodes as necessary to run your [workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/). +Worker nodes also run storage and networking drivers, and ingress controllers when required. You create as many worker nodes as necessary to run your [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/). # About Helm diff --git a/content/rancher/v2.6/en/pipelines/_index.md b/content/rancher/v2.6/en/pipelines/_index.md index de7742f8c42..4cec6a34a2e 100644 --- a/content/rancher/v2.6/en/pipelines/_index.md +++ b/content/rancher/v2.6/en/pipelines/_index.md @@ -2,10 +2,10 @@ title: Pipelines weight: 10 aliases: - - /rancher/v2.5/en/k8s-in-rancher/pipelines + - /rancher/v2.6/en/k8s-in-rancher/pipelines --- -> As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by [Fleet,]({{}}/rancher/v2.5/en/deploy-across-clusters/fleet) available in Cluster Explorer. +> As of Rancher v2.5, Git-based deployment pipelines are now recommended to be handled with Rancher Continuous Delivery powered by [Fleet,]({{}}/rancher/v2.6/en/deploy-across-clusters/fleet) available in Cluster Explorer. Rancher's pipeline provides a simple CI/CD experience. Use it to automatically checkout code, run builds or scripts, publish Docker images or catalog applications, and deploy the updated software to users. @@ -37,7 +37,7 @@ This section covers the following topics: # Concepts -For an explanation of concepts and terminology used in this section, refer to [this page.]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/concepts) +For an explanation of concepts and terminology used in this section, refer to [this page.]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/concepts) # How Pipelines Work @@ -45,7 +45,7 @@ After enabling the ability to use pipelines in a project, you can configure mult A pipeline is configured off of a group of files that are checked into source code repositories. Users can configure their pipelines either through the Rancher UI or by adding a `.rancher-pipeline.yml` into the repository. -Before pipelines can be configured, you will need to configure authentication to your version control provider, e.g. GitHub, GitLab, Bitbucket. If you haven't configured a version control provider, you can always use [Rancher's example repositories]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/example-repos/) to view some common pipeline deployments. +Before pipelines can be configured, you will need to configure authentication to your version control provider, e.g. GitHub, GitLab, Bitbucket. If you haven't configured a version control provider, you can always use [Rancher's example repositories]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/example-repos/) to view some common pipeline deployments. When you configure a pipeline in one of your projects, a namespace specifically for the pipeline is automatically created. The following components are deployed to it: @@ -63,13 +63,13 @@ When you configure a pipeline in one of your projects, a namespace specifically Minio storage is used to store the logs for pipeline executions. - >**Note:** The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/storage). + >**Note:** The managed Jenkins instance works statelessly, so don't worry about its data persistency. The Docker Registry and Minio instances use ephemeral volumes by default, which is fine for most use cases. If you want to make sure pipeline logs can survive node failures, you can configure persistent volumes for them, as described in [data persistency for pipeline components]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/storage). # Roles-based Access Control for Pipelines If you can access a project, you can enable repositories to start building pipelines. -Only [administrators]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/), [cluster owners or members]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owners]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles) can configure version control providers and manage global pipeline execution settings. +Only [administrators]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), [cluster owners or members]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owners]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) can configure version control providers and manage global pipeline execution settings. Project members can only configure repositories and pipelines. @@ -192,7 +192,7 @@ Now that repositories are added to your project, you can start configuring the p 1. Find the repository that you want to set up a pipeline for. -1. Configure the pipeline through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. Pipeline configuration is split into stages and steps. Stages must fully complete before moving onto the next stage, but steps in a stage run concurrently. For each stage, you can add different step types. Note: As you build out each step, there are different advanced options based on the step type. Advanced options include trigger rules, environment variables, and secrets. For more information on configuring the pipeline through the UI or the YAML file, refer to the [pipeline configuration reference.]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/config) +1. Configure the pipeline through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. Pipeline configuration is split into stages and steps. Stages must fully complete before moving onto the next stage, but steps in a stage run concurrently. For each stage, you can add different step types. Note: As you build out each step, there are different advanced options based on the step type. Advanced options include trigger rules, environment variables, and secrets. For more information on configuring the pipeline through the UI or the YAML file, refer to the [pipeline configuration reference.]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/config) * If you are going to use the UI, select the vertical **⋮ > Edit Config** to configure the pipeline using the UI. After the pipeline is configured, you must view the YAML file and push it to the repository. * If you are going to use the YAML file, select the vertical **⋮ > View/Edit YAML** to configure the pipeline. If you choose to use a YAML file, you need to push it to the repository after any changes in order for it to be updated in the repository. When editing the pipeline configuration, it takes a few moments for Rancher to check for an existing pipeline configuration. @@ -212,7 +212,7 @@ Now that repositories are added to your project, you can start configuring the p # Pipeline Configuration Reference -Refer to [this page]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/config) for details on how to configure a pipeline to: +Refer to [this page]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/config) for details on how to configure a pipeline to: - Run a script - Build and publish images @@ -251,7 +251,7 @@ Available Events: * **Pull Request**: Whenever a pull request is made to the repository, the pipeline is triggered. * **Tag**: When a tag is created in the repository, the pipeline is triggered. -> **Note:** This option doesn't exist for Rancher's [example repositories]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/example-repos/). +> **Note:** This option doesn't exist for Rancher's [example repositories]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/example-repos/). ### Modifying the Event Triggers for the Repository diff --git a/content/rancher/v2.6/en/pipelines/concepts/_index.md b/content/rancher/v2.6/en/pipelines/concepts/_index.md index 46b5a18004a..afac35a0d75 100644 --- a/content/rancher/v2.6/en/pipelines/concepts/_index.md +++ b/content/rancher/v2.6/en/pipelines/concepts/_index.md @@ -2,7 +2,7 @@ title: Concepts weight: 1 aliases: - - /rancher/v2.5/en/k8s-in-rancher/pipelines/concepts + - /rancher/v2.6/en/k8s-in-rancher/pipelines/concepts --- The purpose of this page is to explain common concepts and terminology related to pipelines. diff --git a/content/rancher/v2.6/en/pipelines/config/_index.md b/content/rancher/v2.6/en/pipelines/config/_index.md index a2ae7bc3c3d..6edfacf24e0 100644 --- a/content/rancher/v2.6/en/pipelines/config/_index.md +++ b/content/rancher/v2.6/en/pipelines/config/_index.md @@ -2,7 +2,7 @@ title: Pipeline Configuration Reference weight: 1 aliases: - - /rancher/v2.5/en/k8s-in-rancher/pipelines/config + - /rancher/v2.6/en/k8s-in-rancher/pipelines/config --- In this section, you'll learn how to configure pipelines. @@ -303,7 +303,7 @@ timeout: 30 # Notifications -You can enable notifications to any [notifiers]({{}}/rancher/v2.5/en/cluster-admin/tools/notifiers/) based on the build status of a pipeline. Before enabling notifications, Rancher recommends [setting up notifiers]({{}}/rancher/v2.5/en/monitoring-alerting/legacy/notifiers/) so it will be easy to add recipients immediately. +You can enable notifications to any [notifiers]({{}}/rancher/v2.6/en/cluster-admin/tools/notifiers/) based on the build status of a pipeline. Before enabling notifications, Rancher recommends [setting up notifiers]({{}}/rancher/v2.6/en/monitoring-alerting/legacy/notifiers/) so it will be easy to add recipients immediately. ### Configuring Notifications by UI @@ -311,7 +311,7 @@ You can enable notifications to any [notifiers]({{}}/rancher/v2.5/en/cl 1. Select the conditions for the notification. You can select to get a notification for the following statuses: `Failed`, `Success`, `Changed`. For example, if you want to receive notifications when an execution fails, select **Failed**. -1. If you don't have any existing [notifiers]({{}}/rancher/v2.5/en/cluster-admin/tools/notifiers), Rancher will provide a warning that no notifiers are set up and provide a link to be able to go to the notifiers page. Follow the [instructions]({{}}/rancher/v2.5/en/monitoring-alerting/legacy/notifiers/) to add a notifier. If you already have notifiers, you can add them to the notification by clicking the **Add Recipient** button. +1. If you don't have any existing [notifiers]({{}}/rancher/v2.6/en/cluster-admin/tools/notifiers), Rancher will provide a warning that no notifiers are set up and provide a link to be able to go to the notifiers page. Follow the [instructions]({{}}/rancher/v2.6/en/monitoring-alerting/legacy/notifiers/) to add a notifier. If you already have notifiers, you can add them to the notification by clicking the **Add Recipient** button. > **Note:** Notifiers are configured at a cluster level and require a different level of permissions. @@ -513,7 +513,7 @@ stages: # Secrets -If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using Kubernetes [secrets]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/). +If you need to use security-sensitive information in your pipeline scripts (like a password), you can pass them in using Kubernetes [secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/). ### Prerequisite Create a secret in the same project as your pipeline, or explicitly in the namespace where pipeline build pods run. @@ -640,8 +640,8 @@ If you want to use a version control provider with a certificate from a custom/i The internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes. -For details on setting up persistent storage for pipelines, refer to [this page.]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/storage) +For details on setting up persistent storage for pipelines, refer to [this page.]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/storage) # Example rancher-pipeline.yml -An example pipeline configuration file is on [this page.]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/example) +An example pipeline configuration file is on [this page.]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/example) diff --git a/content/rancher/v2.6/en/pipelines/example-repos/_index.md b/content/rancher/v2.6/en/pipelines/example-repos/_index.md index 5ce002a9ca3..f13014575b7 100644 --- a/content/rancher/v2.6/en/pipelines/example-repos/_index.md +++ b/content/rancher/v2.6/en/pipelines/example-repos/_index.md @@ -2,8 +2,8 @@ title: Example Repositories weight: 500 aliases: - - /rancher/v2.5/en/tools/pipelines/quick-start-guide/ - - /rancher/v2.5/en/k8s-in-rancher/pipelines/example-repos + - /rancher/v2.6/en/tools/pipelines/quick-start-guide/ + - /rancher/v2.6/en/k8s-in-rancher/pipelines/example-repos --- Rancher ships with several example repositories that you can use to familiarize yourself with pipelines. We recommend configuring and testing the example repository that most resembles your environment before using pipelines with your own repositories in a production environment. Use this example repository as a sandbox for repo configuration, build demonstration, etc. Rancher includes example repositories for: @@ -12,7 +12,7 @@ Rancher ships with several example repositories that you can use to familiarize - Maven - php -> **Note:** The example repositories are only available if you have not [configured a version control provider]({{}}/rancher/v2.5/en/project-admin/pipelines). +> **Note:** The example repositories are only available if you have not [configured a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines). To start using these example repositories, @@ -74,4 +74,4 @@ After enabling an example repository, run the pipeline to see how it works. ### What's Next? -For detailed information about setting up your own pipeline for your repository, [configure a version control provider]({{}}/rancher/v2.5/en/project-admin/pipelines), enable a repository and finally configure your pipeline. +For detailed information about setting up your own pipeline for your repository, [configure a version control provider]({{}}/rancher/v2.6/en/project-admin/pipelines), enable a repository and finally configure your pipeline. diff --git a/content/rancher/v2.6/en/pipelines/example/_index.md b/content/rancher/v2.6/en/pipelines/example/_index.md index a793d4a4646..4defd45cc49 100644 --- a/content/rancher/v2.6/en/pipelines/example/_index.md +++ b/content/rancher/v2.6/en/pipelines/example/_index.md @@ -2,13 +2,13 @@ title: Example YAML File weight: 501 aliases: - - /rancher/v2.5/en/tools/pipelines/reference/ - - /rancher/v2.5/en/k8s-in-rancher/pipelines/example + - /rancher/v2.6/en/tools/pipelines/reference/ + - /rancher/v2.6/en/k8s-in-rancher/pipelines/example --- Pipelines can be configured either through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`. -In the [pipeline configuration reference]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines/config), we provide examples of how to configure each feature using the Rancher UI or using YAML configuration. +In the [pipeline configuration reference]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines/config), we provide examples of how to configure each feature using the Rancher UI or using YAML configuration. Below is a full example `rancher-pipeline.yml` for those who want to jump right in. diff --git a/content/rancher/v2.6/en/pipelines/storage/_index.md b/content/rancher/v2.6/en/pipelines/storage/_index.md index d01833de791..2f41e97b5ca 100644 --- a/content/rancher/v2.6/en/pipelines/storage/_index.md +++ b/content/rancher/v2.6/en/pipelines/storage/_index.md @@ -2,16 +2,16 @@ title: Configuring Persistent Data for Pipeline Components weight: 600 aliases: - - /rancher/v2.5/en/k8s-in-rancher/pipelines/storage + - /rancher/v2.6/en/k8s-in-rancher/pipelines/storage --- The pipelines' internal Docker registry and the Minio workloads use ephemeral volumes by default. This default storage works out-of-the-box and makes testing easy, but you lose the build images and build logs if the node running the Docker Registry or Minio fails. In most cases this is fine. If you want build images and logs to survive node failures, you can configure the Docker Registry and Minio to use persistent volumes. -This section assumes that you understand how persistent storage works in Kubernetes. For more information, refer to the section on [how storage works.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/how-storage-works/) +This section assumes that you understand how persistent storage works in Kubernetes. For more information, refer to the section on [how storage works.]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/how-storage-works/) >**Prerequisites (for both parts A and B):** > ->[Persistent volumes]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/) must be available for the cluster. +>[Persistent volumes]({{}}/rancher/v2.6/en/cluster-admin/volumes-and-storage/) must be available for the cluster. ### A. Configuring Persistent Data for Docker Registry diff --git a/content/rancher/v2.6/en/project-admin/_index.md b/content/rancher/v2.6/en/project-admin/_index.md index ff000ecd21b..8ebee475a2a 100644 --- a/content/rancher/v2.6/en/project-admin/_index.md +++ b/content/rancher/v2.6/en/project-admin/_index.md @@ -2,7 +2,7 @@ title: Project Administration weight: 9 aliases: - - /rancher/v2.5/en/project-admin/editing-projects/ + - /rancher/v2.6/en/project-admin/editing-projects/ --- _Projects_ are objects introduced in Rancher that help organize namespaces in your Kubernetes cluster. You can use projects to create multi-tenant clusters, which allows a group of users to share the same underlying resources without interacting with each other's applications. @@ -18,19 +18,19 @@ Rancher projects resolve this issue by allowing you to apply resources and acces You can use projects to perform actions like: -- [Assign users access to a group of namespaces]({{}}/rancher/v2.5/en/project-admin/project-members) -- Assign users [specific roles in a project]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles). A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles/) -- [Set resource quotas]({{}}/rancher/v2.5/en/project-admin/resource-quotas/) -- [Manage namespaces]({{}}/rancher/v2.5/en/project-admin/namespaces/) -- [Configure tools]({{}}/rancher/v2.5/en/project-admin/tools/) -- [Set up pipelines for continuous integration and deployment]({{}}/rancher/v2.5/en/project-admin/pipelines) -- [Configure pod security policies]({{}}/rancher/v2.5/en/project-admin/pod-security-policies) +- [Assign users access to a group of namespaces]({{}}/rancher/v2.6/en/project-admin/project-members) +- Assign users [specific roles in a project]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). A role can be owner, member, read-only, or [custom]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles/) +- [Set resource quotas]({{}}/rancher/v2.6/en/project-admin/resource-quotas/) +- [Manage namespaces]({{}}/rancher/v2.6/en/project-admin/namespaces/) +- [Configure tools]({{}}/rancher/v2.6/en/project-admin/tools/) +- [Set up pipelines for continuous integration and deployment]({{}}/rancher/v2.6/en/project-admin/pipelines) +- [Configure pod security policies]({{}}/rancher/v2.6/en/project-admin/pod-security-policies) ### Authorization -Non-administrative users are only authorized for project access after an [administrator]({{}}/rancher/v2.5/en/admin-settings/rbac/global-permissions/), [cluster owner or member]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles) adds them to the project's **Members** tab. +Non-administrative users are only authorized for project access after an [administrator]({{}}/rancher/v2.6/en/admin-settings/rbac/global-permissions/), [cluster owner or member]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#cluster-roles), or [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles) adds them to the project's **Members** tab. -Whoever creates the project automatically becomes a [project owner]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/#project-roles). +Whoever creates the project automatically becomes a [project owner]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/#project-roles). ## Switching between Projects diff --git a/content/rancher/v2.6/en/project-admin/namespaces/_index.md b/content/rancher/v2.6/en/project-admin/namespaces/_index.md index fc7a7a07cf2..d6044e08442 100644 --- a/content/rancher/v2.6/en/project-admin/namespaces/_index.md +++ b/content/rancher/v2.6/en/project-admin/namespaces/_index.md @@ -9,25 +9,25 @@ Although you assign resources at the project level so that each namespace in the Resources that you can assign directly to namespaces include: -- [Workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/) -- [Load Balancers/Ingress]({{}}/rancher/v2.5/en/k8s-in-rancher/load-balancers-and-ingress/) -- [Service Discovery Records]({{}}/rancher/v2.5/en/k8s-in-rancher/service-discovery/) -- [Persistent Volume Claims]({{}}/rancher/v2.5/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/) -- [Certificates]({{}}/rancher/v2.5/en/k8s-in-rancher/certificates/) -- [ConfigMaps]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps/) -- [Registries]({{}}/rancher/v2.5/en/k8s-in-rancher/registries/) -- [Secrets]({{}}/rancher/v2.5/en/k8s-in-rancher/secrets/) +- [Workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/) +- [Load Balancers/Ingress]({{}}/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/) +- [Service Discovery Records]({{}}/rancher/v2.6/en/k8s-in-rancher/service-discovery/) +- [Persistent Volume Claims]({{}}/rancher/v2.6/en/k8s-in-rancher/volumes-and-storage/persistent-volume-claims/) +- [Certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/) +- [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps/) +- [Registries]({{}}/rancher/v2.6/en/k8s-in-rancher/registries/) +- [Secrets]({{}}/rancher/v2.6/en/k8s-in-rancher/secrets/) To manage permissions in a vanilla Kubernetes cluster, cluster admins configure role-based access policies for each namespace. With Rancher, user permissions are assigned on the project level instead, and permissions are automatically inherited by any namespace owned by the particular project. -> **Note:** If you create a namespace with `kubectl`, it may be unusable because `kubectl` doesn't require your new namespace to be scoped within a project that you have access to. If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.5/en/project-admin/namespaces) to ensure that you will have permission to access the namespace. +> **Note:** If you create a namespace with `kubectl`, it may be unusable because `kubectl` doesn't require your new namespace to be scoped within a project that you have access to. If your permissions are restricted to the project level, it is better to [create a namespace through Rancher]({{}}/rancher/v2.6/en/project-admin/namespaces) to ensure that you will have permission to access the namespace. ### Creating Namespaces Create a new namespace to isolate apps and resources in a project. ->**Tip:** When working with project resources that you can assign to a namespace (i.e., [workloads]({{}}/rancher/v2.5/en/k8s-in-rancher/workloads/deploy-workloads/), [certificates]({{}}/rancher/v2.5/en/k8s-in-rancher/certificates/), [ConfigMaps]({{}}/rancher/v2.5/en/k8s-in-rancher/configmaps), etc.) you can create a namespace on the fly. +>**Tip:** When working with project resources that you can assign to a namespace (i.e., [workloads]({{}}/rancher/v2.6/en/k8s-in-rancher/workloads/deploy-workloads/), [certificates]({{}}/rancher/v2.6/en/k8s-in-rancher/certificates/), [ConfigMaps]({{}}/rancher/v2.6/en/k8s-in-rancher/configmaps), etc.) you can create a namespace on the fly. 1. From the **Global** view, open the project where you want to create a namespace. @@ -35,7 +35,7 @@ Create a new namespace to isolate apps and resources in a project. 1. From the main menu, select **Namespace**. The click **Add Namespace**. -1. **Optional:** If your project has [Resource Quotas]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume). +1. **Optional:** If your project has [Resource Quotas]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) in effect, you can override the default resource **Limits** (which places a cap on the resources that the namespace can consume). 1. Enter a **Name** and then click **Create**. @@ -54,7 +54,7 @@ Cluster admins and members may occasionally need to move a namespace to another >**Notes:** > >- Don't move the namespaces in the `System` project. Moving these namespaces can adversely affect cluster networking. - >- You cannot move a namespace into a project that already has a [resource quota]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/) configured. + >- You cannot move a namespace into a project that already has a [resource quota]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/) configured. >- If you move a namespace from a project that has a quota set to a project with no quota set, the quota is removed from the namespace. 1. Choose a new project for the new namespace and then click **Move**. Alternatively, you can remove the namespace from all projects by selecting **None**. @@ -65,4 +65,4 @@ Cluster admins and members may occasionally need to move a namespace to another You can always override the namespace default limit to provide a specific namespace with access to more (or less) project resources. -For more information, see how to [edit namespace resource quotas]({{}}/rancher/v2.5/en/project-admin//resource-quotas/override-namespace-default/). \ No newline at end of file +For more information, see how to [edit namespace resource quotas]({{}}/rancher/v2.6/en/project-admin//resource-quotas/override-namespace-default/). \ No newline at end of file diff --git a/content/rancher/v2.6/en/project-admin/pipelines/_index.md b/content/rancher/v2.6/en/project-admin/pipelines/_index.md index 19bf7432643..0ba4497c48e 100644 --- a/content/rancher/v2.6/en/project-admin/pipelines/_index.md +++ b/content/rancher/v2.6/en/project-admin/pipelines/_index.md @@ -3,9 +3,9 @@ title: Rancher's CI/CD Pipelines description: Use Rancher’s CI/CD pipeline to automatically checkout code, run builds or scripts, publish Docker images, and deploy software to users weight: 4000 aliases: - - /rancher/v2.5/en/concepts/ci-cd-pipelines/ - - /rancher/v2.5/en/tasks/pipelines/ - - /rancher/v2.5/en/tools/pipelines/configurations/ + - /rancher/v2.6/en/concepts/ci-cd-pipelines/ + - /rancher/v2.6/en/tasks/pipelines/ + - /rancher/v2.6/en/tools/pipelines/configurations/ --- Using Rancher, you can integrate with a GitHub repository to setup a continuous integration (CI) pipeline. @@ -17,4 +17,4 @@ After configuring Rancher and GitHub, you can deploy containers running Jenkins - Run unit tests. - Run regression tests. -For details, refer to the [pipelines]({{}}/rancher/v2.5/en/k8s-in-rancher/pipelines) section. \ No newline at end of file +For details, refer to the [pipelines]({{}}/rancher/v2.6/en/k8s-in-rancher/pipelines) section. \ No newline at end of file diff --git a/content/rancher/v2.6/en/project-admin/pod-security-policies/_index.md b/content/rancher/v2.6/en/project-admin/pod-security-policies/_index.md index dbed390d6f4..992fe2e41b1 100644 --- a/content/rancher/v2.6/en/project-admin/pod-security-policies/_index.md +++ b/content/rancher/v2.6/en/project-admin/pod-security-policies/_index.md @@ -3,14 +3,14 @@ title: Pod Security Policies weight: 5600 --- -> These cluster options are only available for [clusters in which Rancher has launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/). +> These cluster options are only available for [clusters in which Rancher has launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/). You can always assign a pod security policy (PSP) to an existing project if you didn't assign one during creation. ### Prerequisites -- Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.5/en/admin-settings/pod-security-policies/). -- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [the documentation about adding a pod security policy to a cluster]({{}}/rancher/v2.5/en/cluster-admin/pod-security-policy). +- Create a Pod Security Policy within Rancher. Before you can assign a default PSP to an existing project, you must have a PSP available for assignment. For instruction, see [Creating Pod Security Policies]({{}}/rancher/v2.6/en/admin-settings/pod-security-policies/). +- Assign a default Pod Security Policy to the project's cluster. You can't assign a PSP to a project until one is already applied to the cluster. For more information, see [the documentation about adding a pod security policy to a cluster]({{}}/rancher/v2.6/en/cluster-admin/pod-security-policy). ### Applying a Pod Security Policy diff --git a/content/rancher/v2.6/en/project-admin/project-members/_index.md b/content/rancher/v2.6/en/project-admin/project-members/_index.md index 2d0aceb9751..c862d413b97 100644 --- a/content/rancher/v2.6/en/project-admin/project-members/_index.md +++ b/content/rancher/v2.6/en/project-admin/project-members/_index.md @@ -2,19 +2,19 @@ title: Adding Users to Projects weight: 2505 aliases: - - /rancher/v2.5/en/tasks/projects/add-project-members/ - - /rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/project-members/ + - /rancher/v2.6/en/tasks/projects/add-project-members/ + - /rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/project-members/ --- If you want to provide a user with access and permissions to _specific_ projects and resources within a cluster, assign the user a project membership. You can add members to a project as it is created, or add them to an existing project. ->**Tip:** Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members]({{}}/rancher/v2.5/en/cluster-provisioning/cluster-members/) instead. +>**Tip:** Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members]({{}}/rancher/v2.6/en/cluster-provisioning/cluster-members/) instead. ### Adding Members to a New Project -You can add members to a project as you create it (recommended if possible). For details on creating a new project, refer to the [cluster administration section.]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/) +You can add members to a project as you create it (recommended if possible). For details on creating a new project, refer to the [cluster administration section.]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/) ### Adding Members to an Existing Project @@ -36,7 +36,7 @@ Following project creation, you can add users as project members so that they ca 1. Assign the user or group **Project** roles. - [What are Project Roles?]({{}}/rancher/v2.5/en/admin-settings/rbac/cluster-project-roles/) + [What are Project Roles?]({{}}/rancher/v2.6/en/admin-settings/rbac/cluster-project-roles/) >**Notes:** > @@ -44,8 +44,8 @@ Following project creation, you can add users as project members so that they ca > >- For `Custom` roles, you can modify the list of individual roles available for assignment. > - > - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.5/en/admin-settings/rbac/default-custom-roles). - > - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.5/en/admin-settings/rbac/locked-roles/). + > - To add roles to the list, [Add a Custom Role]({{}}/rancher/v2.6/en/admin-settings/rbac/default-custom-roles). + > - To remove roles from the list, [Lock/Unlock Roles]({{}}/rancher/v2.6/en/admin-settings/rbac/locked-roles/). **Result:** The chosen users are added to the project. diff --git a/content/rancher/v2.6/en/project-admin/resource-quotas/_index.md b/content/rancher/v2.6/en/project-admin/resource-quotas/_index.md index d63f81dfadd..3d6f758aaee 100644 --- a/content/rancher/v2.6/en/project-admin/resource-quotas/_index.md +++ b/content/rancher/v2.6/en/project-admin/resource-quotas/_index.md @@ -2,20 +2,20 @@ title: Project Resource Quotas weight: 2515 aliases: - - /rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas + - /rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas --- In situations where several teams share a cluster, one team may overconsume the resources available: CPU, memory, storage, services, Kubernetes objects like pods or secrets, and so on. To prevent this overconsumption, you can apply a _resource quota_, which is a Rancher feature that limits the resources available to a project or namespace. This page is a how-to guide for creating resource quotas in existing projects. -Resource quotas can also be set when a new project is created. For details, refer to the section on [creating new projects.]({{}}/rancher/v2.5/en/cluster-admin/projects-and-namespaces/#creating-projects) +Resource quotas can also be set when a new project is created. For details, refer to the section on [creating new projects.]({{}}/rancher/v2.6/en/cluster-admin/projects-and-namespaces/#creating-projects) Resource quotas in Rancher include the same functionality as the [native version of Kubernetes](https://kubernetes.io/docs/concepts/policy/resource-quotas/). In Rancher, resource quotas have been extended so that you can apply them to projects. For details on how resource quotas work with projects in Rancher, refer to [this page.](./quotas-for-projects) ### Applying Resource Quotas to Existing Projects -Edit [resource quotas]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) when: +Edit [resource quotas]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) when: - You want to limit the resources that a project and its namespaces can use. - You want to scale the resources available to a project up or down when a research quota is already in effect. diff --git a/content/rancher/v2.6/en/project-admin/resource-quotas/override-container-default/_index.md b/content/rancher/v2.6/en/project-admin/resource-quotas/override-container-default/_index.md index 71a9db0d183..26cca4aaa6b 100644 --- a/content/rancher/v2.6/en/project-admin/resource-quotas/override-container-default/_index.md +++ b/content/rancher/v2.6/en/project-admin/resource-quotas/override-container-default/_index.md @@ -9,7 +9,7 @@ To avoid setting these limits on each and every container during workload creati ### Editing the Container Default Resource Limit -Edit [container default resource limit]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/) when: +Edit [container default resource limit]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/) when: - You have a CPU or Memory resource quota set on a project, and want to supply the corresponding default values for a container. - You want to edit the default container resource limit. diff --git a/content/rancher/v2.6/en/project-admin/resource-quotas/override-namespace-default/_index.md b/content/rancher/v2.6/en/project-admin/resource-quotas/override-namespace-default/_index.md index fd741be9d3b..8b41b160d67 100644 --- a/content/rancher/v2.6/en/project-admin/resource-quotas/override-namespace-default/_index.md +++ b/content/rancher/v2.6/en/project-admin/resource-quotas/override-namespace-default/_index.md @@ -5,16 +5,16 @@ weight: 2 Although the **Namespace Default Limit** propagates from the project to each namespace when created, in some cases, you may need to increase (or decrease) the quotas for a specific namespace. In this situation, you can override the default limits by editing the namespace. -In the diagram below, the Rancher administrator has a resource quota in effect for their project. However, the administrator wants to override the namespace limits for `Namespace 3` so that it has more resources available. Therefore, the administrator [raises the namespace limits]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/) for `Namespace 3` so that the namespace can access more resources. +In the diagram below, the Rancher administrator has a resource quota in effect for their project. However, the administrator wants to override the namespace limits for `Namespace 3` so that it has more resources available. Therefore, the administrator [raises the namespace limits]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/) for `Namespace 3` so that the namespace can access more resources. Namespace Default Limit Override ![Namespace Default Limit Override]({{}}/img/rancher/rancher-resource-quota-override.svg) -How to: [Editing Namespace Resource Quotas]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/) +How to: [Editing Namespace Resource Quotas]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/) ### Editing Namespace Resource Quotas -If there is a [resource quota]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) configured for a project, you can override the namespace default limit to provide a specific namespace with access to more (or less) project resources. +If there is a [resource quota]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas) configured for a project, you can override the namespace default limit to provide a specific namespace with access to more (or less) project resources. 1. From the **Global** view, open the cluster that contains the namespace for which you want to edit the resource quota. @@ -24,7 +24,7 @@ If there is a [resource quota]({{}}/rancher/v2.5/en/k8s-in-rancher/proj 1. Edit the Resource Quota **Limits**. These limits determine the resources available to the namespace. The limits must be set within the configured project limits. - For more information about each **Resource Type**, see [Resource Quotas]({{}}/rancher/v2.5/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/). + For more information about each **Resource Type**, see [Resource Quotas]({{}}/rancher/v2.6/en/k8s-in-rancher/projects-and-namespaces/resource-quotas/). >**Note:** > diff --git a/content/rancher/v2.6/en/project-admin/tools/_index.md b/content/rancher/v2.6/en/project-admin/tools/_index.md index 26142e90099..63483dbd18d 100644 --- a/content/rancher/v2.6/en/project-admin/tools/_index.md +++ b/content/rancher/v2.6/en/project-admin/tools/_index.md @@ -16,9 +16,9 @@ Rancher contains a variety of tools that aren't included in Kubernetes to assist Notifiers and alerts are two features that work together to inform you of events in the Rancher system. -[Notifiers]({{}}/rancher/v2.5/en/cluster-admin/tools/notifiers) are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action. Notifications can be sent with Slack, email, PagerDuty, WeChat, and webhooks. +[Notifiers]({{}}/rancher/v2.6/en/cluster-admin/tools/notifiers) are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action. Notifications can be sent with Slack, email, PagerDuty, WeChat, and webhooks. -[Alerts]({{}}/rancher/v2.5/en/cluster-admin/tools/alerts) are rules that trigger those notifications. Before you can receive alerts, you must configure one or more notifier in Rancher. The scope for alerts can be set at either the cluster or project level. +[Alerts]({{}}/rancher/v2.6/en/cluster-admin/tools/alerts) are rules that trigger those notifications. Before you can receive alerts, you must configure one or more notifier in Rancher. The scope for alerts can be set at either the cluster or project level. ## Logging @@ -32,8 +32,8 @@ Logging is helpful because it allows you to: Rancher can integrate with Elasticsearch, splunk, kafka, syslog, and fluentd. -For details, refer to the [logging section.]({{}}/rancher/v2.5/en/cluster-admin/tools/logging) +For details, refer to the [logging section.]({{}}/rancher/v2.6/en/cluster-admin/tools/logging) ## Monitoring -Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. For details, refer to the [monitoring section.]({{}}/rancher/v2.5/en/cluster-admin/tools/monitoring) +Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution. For details, refer to the [monitoring section.]({{}}/rancher/v2.6/en/cluster-admin/tools/monitoring) diff --git a/content/rancher/v2.6/en/quick-start-guide/_index.md b/content/rancher/v2.6/en/quick-start-guide/_index.md index f8ee9eb6a4d..65fa4db14f4 100644 --- a/content/rancher/v2.6/en/quick-start-guide/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/_index.md @@ -4,14 +4,14 @@ metaDescription: Use this section to jump start your Rancher deployment and test short title: Use this section to jump start your Rancher deployment and testing. It contains instructions for a simple Rancher setup and some common use cases. weight: 2 --- ->**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.5/en/installation/). +>**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation]({{}}/rancher/v2.6/en/installation/). Howdy buckaroos! Use this section of the docs to jump start your deployment and testing of Rancher 2.x! It contains instructions for a simple Rancher setup and some common use cases. We plan on adding more content to this section in the future. We have Quick Start Guides for: -- [Deploying Rancher Server]({{}}/rancher/v2.5/en/quick-start-guide/deployment/): Get started running Rancher using the method most convenient for you. +- [Deploying Rancher Server]({{}}/rancher/v2.6/en/quick-start-guide/deployment/): Get started running Rancher using the method most convenient for you. -- [Deploying Workloads]({{}}/rancher/v2.5/en/quick-start-guide/workload/): Deploy a simple [workload](https://kubernetes.io/docs/concepts/workloads/) and expose it, letting you access it from outside the cluster. +- [Deploying Workloads]({{}}/rancher/v2.6/en/quick-start-guide/workload/): Deploy a simple [workload](https://kubernetes.io/docs/concepts/workloads/) and expose it, letting you access it from outside the cluster. -- [Using the CLI]({{}}/rancher/v2.5/en/quick-start-guide/cli/): Use `kubectl` or Rancher command line interface (CLI) to interact with your Rancher instance. +- [Using the CLI]({{}}/rancher/v2.6/en/quick-start-guide/cli/): Use `kubectl` or Rancher command line interface (CLI) to interact with your Rancher instance. diff --git a/content/rancher/v2.6/en/quick-start-guide/cli/_index.md b/content/rancher/v2.6/en/quick-start-guide/cli/_index.md index 319967f3478..c0787bc4c08 100644 --- a/content/rancher/v2.6/en/quick-start-guide/cli/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/cli/_index.md @@ -24,7 +24,7 @@ Run `kubectl cluster-info` or `kubectl get pods` successfully. _Requirements_ -If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.5/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires the [Rancher cli](../cli) to be present in your PATH when you run `kubectl`. Otherwise, you’ll see error like: +If admins have [enforced TTL on kubeconfig tokens]({{}}/rancher/v2.6/en/api/api-tokens/#setting-ttl-on-kubeconfig-tokens), the kubeconfig file requires the [Rancher cli](../cli) to be present in your PATH when you run `kubectl`. Otherwise, you’ll see error like: `Unable to connect to the server: getting credentials: exec: exec: "rancher": executable file not found in $PATH`. This feature enables kubectl to authenticate with the Rancher server and get a new kubeconfig token when required. The following auth providers are currently supported: diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/_index.md index 769fc462319..1a0bc66ec49 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/_index.md @@ -57,7 +57,7 @@ Two Kubernetes clusters are deployed into your AWS account, one running Rancher ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). ## Destroying the Environment diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/_index.md index 382f45db3fa..02384c1b601 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/_index.md @@ -57,7 +57,7 @@ Two Kubernetes clusters are deployed into your DigitalOcean account, one running ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). ## Destroying the Environment diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/google-gcp-qs/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/google-gcp-qs/_index.md index 96ff2cbbc3b..fe13ba86aca 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/google-gcp-qs/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/google-gcp-qs/_index.md @@ -58,7 +58,7 @@ Two Kubernetes clusters are deployed into your GCP account, one running Rancher ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.6/en/quick-start-guide/workload). ## Destroying the Environment diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/microsoft-azure-qs/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/microsoft-azure-qs/_index.md index 29a316b16eb..c3d758f9ccf 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/microsoft-azure-qs/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/microsoft-azure-qs/_index.md @@ -62,7 +62,7 @@ Two Kubernetes clusters are deployed into your Azure account, one running Ranche ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{< baseurl >}}/rancher/v2.6/en/quick-start-guide/workload). ## Destroying the Environment diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md index 83e895694ff..436ef3c52fb 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-manual-setup/_index.md @@ -36,9 +36,9 @@ This Quick Start Guide is divided into different tasks for easier consumption. >**Note:** > When using a cloud-hosted virtual machine you need to allow inbound TCP communication to ports 80 and 443. Please see your cloud-host's documentation for information regarding port configuration. > - > For a full list of port requirements, refer to [Docker Installation]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/). + > For a full list of port requirements, refer to [Docker Installation]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/). - Provision the host according to our [Requirements]({{}}/rancher/v2.5/en/installation/requirements/). + Provision the host according to our [Requirements]({{}}/rancher/v2.6/en/installation/requirements/). ### 2. Install Rancher @@ -113,4 +113,4 @@ Congratulations! You have created your first cluster. #### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). diff --git a/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/_index.md b/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/_index.md index 664f4bb5bd2..3f22066b26a 100644 --- a/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/_index.md @@ -36,7 +36,7 @@ The following steps quickly deploy a Rancher Server with a single node cluster a ### What's Next? -Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.5/en/quick-start-guide/workload). +Use Rancher to create a deployment. For more information, see [Creating Deployments]({{}}/rancher/v2.6/en/quick-start-guide/workload). ## Destroying the Environment diff --git a/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md b/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md index 853de3fb6bd..0c716d1c14c 100644 --- a/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-ingress/_index.md @@ -77,6 +77,6 @@ Congratulations! You have successfully deployed a workload exposed via an ingres When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following: -- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) -- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) -- [Vagrant: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) +- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) +- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) +- [Vagrant: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) diff --git a/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md b/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md index 6defc26b8fd..b8561f3a272 100644 --- a/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md +++ b/content/rancher/v2.6/en/quick-start-guide/workload/quickstart-deploy-workload-nodeport/_index.md @@ -151,6 +151,6 @@ Congratulations! You have successfully deployed a workload exposed via a NodePor When you're done using your sandbox, destroy the Rancher Server and your cluster. See one of the following: -- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) -- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) -- [Vagrant: Destroying the Environment]({{}}/rancher/v2.5/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) +- [Amazon AWS: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/amazon-aws-qs/#destroying-the-environment) +- [DigitalOcean: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/digital-ocean-qs/#destroying-the-environment) +- [Vagrant: Destroying the Environment]({{}}/rancher/v2.6/en/quick-start-guide/deployment/quickstart-vagrant/#destroying-the-environment) diff --git a/content/rancher/v2.6/en/security/_index.md b/content/rancher/v2.6/en/security/_index.md index 8586f78b957..916ef9284ff 100644 --- a/content/rancher/v2.6/en/security/_index.md +++ b/content/rancher/v2.6/en/security/_index.md @@ -20,7 +20,7 @@ weight: 20 -Security is at the heart of all Rancher features. From integrating with all the popular authentication tools and services, to an enterprise grade [RBAC capability,]({{}}/rancher/v2.5/en/admin-settings/rbac) Rancher makes your Kubernetes clusters even more secure. +Security is at the heart of all Rancher features. From integrating with all the popular authentication tools and services, to an enterprise grade [RBAC capability,]({{}}/rancher/v2.6/en/admin-settings/rbac) Rancher makes your Kubernetes clusters even more secure. On this page, we provide security-related documentation along with resources to help you secure your Rancher installation and your downstream Kubernetes clusters: @@ -45,13 +45,13 @@ The Benchmark provides recommendations of two types: Scored and Not Scored. We r When Rancher runs a CIS security scan on a cluster, it generates a report showing the results of each test, including a summary with the number of passed, skipped and failed tests. The report also includes remediation steps for any failed tests. -For details, refer to the section on [security scans.]({{}}/rancher/v2.5/en/cis-scans) +For details, refer to the section on [security scans.]({{}}/rancher/v2.6/en/cis-scans) ### SELinux RPM [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on CentOS 7 and 8. -We provide two RPMs (Red Hat packages) that enable Rancher products to function properly on SELinux-enforcing hosts: `rancher-selinux` and `rke2-selinux`. For details, see [this page.]({{}}/rancher/v2.5/en/security/selinux) +We provide two RPMs (Red Hat packages) that enable Rancher products to function properly on SELinux-enforcing hosts: `rancher-selinux` and `rke2-selinux`. For details, see [this page.]({{}}/rancher/v2.6/en/security/selinux) ### Rancher Hardening Guide diff --git a/content/rancher/v2.6/en/security/cve/_index.md b/content/rancher/v2.6/en/security/cve/_index.md index d1d9e258167..62b11d159ae 100644 --- a/content/rancher/v2.6/en/security/cve/_index.md +++ b/content/rancher/v2.6/en/security/cve/_index.md @@ -15,4 +15,4 @@ Rancher is committed to informing the community of security issues in our produc | [CVE-2019-12274](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-12274) | Nodes using the built-in node drivers using a file path option allows the machine to read arbitrary files including sensitive ones from inside the Rancher server container. | 5 Jun 2019 | [Rancher v2.2.4](https://github.com/rancher/rancher/releases/tag/v2.2.4), [Rancher v2.1.10](https://github.com/rancher/rancher/releases/tag/v2.1.10) and [Rancher v2.0.15](https://github.com/rancher/rancher/releases/tag/v2.0.15) | | [CVE-2019-11202](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-11202) | The default admin, that is shipped with Rancher, will be re-created upon restart of Rancher despite being explicitly deleted. | 16 Apr 2019 | [Rancher v2.2.2](https://github.com/rancher/rancher/releases/tag/v2.2.2), [Rancher v2.1.9](https://github.com/rancher/rancher/releases/tag/v2.1.9) and [Rancher v2.0.14](https://github.com/rancher/rancher/releases/tag/v2.0.14) | | [CVE-2019-6287](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6287) | Project members continue to get access to namespaces from projects that they were removed from if they were added to more than one project. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) | -| [CVE-2018-20321](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20321) | Any project member with access to the `default` namespace can mount the `netes-default` service account in a pod and then use that pod to execute administrative privileged commands against the Kubernetes cluster. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) - Rolling back from these versions or greater have specific [instructions]({{}}/rancher/v2.5/en/upgrades/rollbacks/). | \ No newline at end of file +| [CVE-2018-20321](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20321) | Any project member with access to the `default` namespace can mount the `netes-default` service account in a pod and then use that pod to execute administrative privileged commands against the Kubernetes cluster. | 29 Jan 2019 | [Rancher v2.1.6](https://github.com/rancher/rancher/releases/tag/v2.1.6) and [Rancher v2.0.11](https://github.com/rancher/rancher/releases/tag/v2.0.11) - Rolling back from these versions or greater have specific [instructions]({{}}/rancher/v2.6/en/upgrades/rollbacks/). | \ No newline at end of file diff --git a/content/rancher/v2.6/en/security/rancher-2.5/1.5-hardening-2.5/_index.md b/content/rancher/v2.6/en/security/rancher-2.5/1.5-hardening-2.5/_index.md index 939089cadae..d4b6968d7c5 100644 --- a/content/rancher/v2.6/en/security/rancher-2.5/1.5-hardening-2.5/_index.md +++ b/content/rancher/v2.6/en/security/rancher-2.5/1.5-hardening-2.5/_index.md @@ -19,7 +19,7 @@ This hardening guide is intended to be used for RKE clusters and associated with This document provides prescriptive guidance for hardening a RKE cluster to be used for installing Rancher v2.5 with Kubernetes v1.15 or provisioning a RKE cluster with Kubernetes 1.15 to be used within Rancher v2.5. It outlines the configurations required to address Kubernetes benchmark controls from the Center for Information Security (CIS). -For more detail about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.5 Benchmark - Self-Assessment Guide - Rancher v2.5]({{< baseurl >}}/rancher/v2.5/en/security/rancher-2.5/1.5-benchmark-2.5/). +For more detail about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.5 Benchmark - Self-Assessment Guide - Rancher v2.5]({{< baseurl >}}/rancher/v2.6/en/security/rancher-2.5/1.5-benchmark-2.5/). #### Known Issues @@ -434,7 +434,7 @@ dns: null The reference RKE Template provides the configuration needed to achieve a hardened install of Kubenetes. RKE Templates are used to provision Kubernetes and define Rancher settings. Follow the Rancher -[documentaion](https://rancher.com/docs/rancher/v2.5/en/installation) for additional installation and RKE Template details. +[documentaion](https://rancher.com/docs/rancher/v2.6/en/installation) for additional installation and RKE Template details. ``` yaml # diff --git a/content/rancher/v2.6/en/security/rancher-2.5/1.6-hardening-2.5/_index.md b/content/rancher/v2.6/en/security/rancher-2.5/1.6-hardening-2.5/_index.md index 59588fa422c..d5b7512ebab 100644 --- a/content/rancher/v2.6/en/security/rancher-2.5/1.6-hardening-2.5/_index.md +++ b/content/rancher/v2.6/en/security/rancher-2.5/1.6-hardening-2.5/_index.md @@ -19,7 +19,7 @@ This hardening guide is intended to be used for RKE clusters and associated with This document provides prescriptive guidance for hardening a RKE cluster to be used for installing Rancher v2.5.4 with Kubernetes v1.18 or provisioning a RKE cluster with Kubernetes v1.18 to be used within Rancher v2.5.4. It outlines the configurations required to address Kubernetes benchmark controls from the Center for Information Security (CIS). -For more detail about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.5.4]({{< baseurl >}}/rancher/v2.5/en/security/rancher-2.5/1.6-benchmark-2.5/). +For more detail about evaluating a hardened cluster against the official CIS benchmark, refer to the [CIS 1.6 Benchmark - Self-Assessment Guide - Rancher v2.5.4]({{< baseurl >}}/rancher/v2.6/en/security/rancher-2.5/1.6-benchmark-2.5/). #### Known Issues @@ -396,7 +396,7 @@ upgrade_strategy: The reference RKE Template provides the configuration needed to achieve a hardened install of Kubenetes. RKE Templates are used to provision Kubernetes and define Rancher settings. Follow the Rancher -[documentaion](https://rancher.com/docs/rancher/v2.5/en/installation) for additional installation and RKE Template details. +[documentaion](https://rancher.com/docs/rancher/v2.6/en/installation) for additional installation and RKE Template details. ```yaml # diff --git a/content/rancher/v2.6/en/security/rancher-2.5/_index.md b/content/rancher/v2.6/en/security/rancher-2.5/_index.md index 299b1ba66c0..720535d064e 100644 --- a/content/rancher/v2.6/en/security/rancher-2.5/_index.md +++ b/content/rancher/v2.6/en/security/rancher-2.5/_index.md @@ -54,4 +54,4 @@ _Available as of v2.5.8_ [Security-Enhanced Linux (SELinux)](https://en.wikipedia.org/wiki/Security-Enhanced_Linux) is a security enhancement to Linux. After being historically used by government agencies, SELinux is now industry standard and is enabled by default on CentOS 7 and 8. -To use Rancher with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.5/en/security/selinux/#installing-the-rancher-selinux-rpm) +To use Rancher with SELinux, we recommend installing the `rancher-selinux` RPM according to the instructions on [this page.]({{}}/rancher/v2.6/en/security/selinux/#installing-the-rancher-selinux-rpm) diff --git a/content/rancher/v2.6/en/security/security-scan/_index.md b/content/rancher/v2.6/en/security/security-scan/_index.md index 0538df7a3f7..c5a3cdb21d4 100644 --- a/content/rancher/v2.6/en/security/security-scan/_index.md +++ b/content/rancher/v2.6/en/security/security-scan/_index.md @@ -3,4 +3,4 @@ title: Security Scans weight: 299 --- -The documentation about CIS security scans has moved [here.]({{}}/rancher/v2.5/en/cis-scans) +The documentation about CIS security scans has moved [here.]({{}}/rancher/v2.6/en/cis-scans) diff --git a/content/rancher/v2.6/en/system-tools/_index.md b/content/rancher/v2.6/en/system-tools/_index.md index 35b1b4770ea..6d0de7671d1 100644 --- a/content/rancher/v2.6/en/system-tools/_index.md +++ b/content/rancher/v2.6/en/system-tools/_index.md @@ -3,7 +3,7 @@ title: System Tools weight: 22 --- -System Tools is a tool to perform operational tasks on [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters or [installations of Rancher on an RKE cluster.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) The tasks include: +System Tools is a tool to perform operational tasks on [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters or [installations of Rancher on an RKE cluster.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) The tasks include: * Collect logging and system metrics from nodes. * Remove Kubernetes resources created by Rancher. @@ -41,7 +41,7 @@ After you download the tools, complete the following actions: # Logs -The logs subcommand will collect log files of core Kubernetes cluster components from nodes in [Rancher-launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) or nodes on an [RKE Kubernetes cluster that Rancher is installed on.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/). See [Troubleshooting]({{}}//rancher/v2.5/en/troubleshooting/) for a list of core Kubernetes cluster components. +The logs subcommand will collect log files of core Kubernetes cluster components from nodes in [Rancher-launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) or nodes on an [RKE Kubernetes cluster that Rancher is installed on.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/). See [Troubleshooting]({{}}//rancher/v2.6/en/troubleshooting/) for a list of core Kubernetes cluster components. System Tools will use the provided kubeconfig file to deploy a DaemonSet, that will copy all the logfiles from the core Kubernetes cluster components and add them to a single tar file (`cluster-logs.tar` by default). If you only want to collect logging from a single node, you can specify the node by using `--node NODENAME` or `-n NODENAME`. @@ -61,7 +61,7 @@ The following are the options for the logs command: # Stats -The stats subcommand will display system metrics from nodes in [Rancher-launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) or nodes in an [RKE Kubernetes cluster that Rancher is installed on.]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/). +The stats subcommand will display system metrics from nodes in [Rancher-launched Kubernetes clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) or nodes in an [RKE Kubernetes cluster that Rancher is installed on.]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/). System Tools will deploy a DaemonSet, and run a predefined command based on `sar` (System Activity Report) to show system metrics. @@ -81,7 +81,7 @@ The following are the options for the stats command: # Remove ->**Warning:** This command will remove data from your etcd nodes. Make sure you have created a [backup of etcd]({{}}/rancher/v2.5/en/backups/backups) before executing the command. +>**Warning:** This command will remove data from your etcd nodes. Make sure you have created a [backup of etcd]({{}}/rancher/v2.6/en/backups/backups) before executing the command. When you install Rancher on a Kubernetes cluster, it will create Kubernetes resources to run and to store configuration data. If you want to remove Rancher from your cluster, you can use the `remove` subcommand to remove the Kubernetes resources. When you use the `remove` subcommand, the following resources will be removed: @@ -101,7 +101,7 @@ When you install Rancher on a Kubernetes cluster, it will create Kubernetes reso When you run the command below, all the resources listed [above](#remove) will be removed from the cluster. ->**Warning:** This command will remove data from your etcd nodes. Make sure you have created a [backup of etcd]({{}}/rancher/v2.5/en/backups/backups) before executing the command. +>**Warning:** This command will remove data from your etcd nodes. Make sure you have created a [backup of etcd]({{}}/rancher/v2.6/en/backups/backups) before executing the command. ``` ./system-tools remove --kubeconfig --namespace diff --git a/content/rancher/v2.6/en/troubleshooting/_index.md b/content/rancher/v2.6/en/troubleshooting/_index.md index bb761060cca..b78c97efe98 100644 --- a/content/rancher/v2.6/en/troubleshooting/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/_index.md @@ -5,7 +5,7 @@ weight: 26 This section contains information to help you troubleshoot issues when using Rancher. -- [Kubernetes components]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-components/) +- [Kubernetes components]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/) If you need help troubleshooting core Kubernetes cluster components like: * `etcd` @@ -16,23 +16,23 @@ This section contains information to help you troubleshoot issues when using Ran * `kube-proxy` * `nginx-proxy` -- [Kubernetes resources]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-resources/) +- [Kubernetes resources]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-resources/) Options for troubleshooting Kubernetes resources like Nodes, Ingress Controller and Rancher Agents are described in this section. -- [Networking]({{}}/rancher/v2.5/en/troubleshooting/networking/) +- [Networking]({{}}/rancher/v2.6/en/troubleshooting/networking/) Steps to troubleshoot networking issues can be found here. -- [DNS]({{}}/rancher/v2.5/en/troubleshooting/dns/) +- [DNS]({{}}/rancher/v2.6/en/troubleshooting/dns/) When you experience name resolution issues in your cluster. -- [Troubleshooting Rancher installed on Kubernetes]({{}}/rancher/v2.5/en/troubleshooting/rancherha/) +- [Troubleshooting Rancher installed on Kubernetes]({{}}/rancher/v2.6/en/troubleshooting/rancherha/) - If you experience issues with your [Rancher server installed on Kubernetes]({{}}/rancher/v2.5/en/installation/install-rancher-on-k8s/) + If you experience issues with your [Rancher server installed on Kubernetes]({{}}/rancher/v2.6/en/installation/install-rancher-on-k8s/) -- [Logging]({{}}/rancher/v2.5/en/troubleshooting/logging/) +- [Logging]({{}}/rancher/v2.6/en/troubleshooting/logging/) Read more about what log levels can be configured and how to configure a log level. diff --git a/content/rancher/v2.6/en/troubleshooting/dns/_index.md b/content/rancher/v2.6/en/troubleshooting/dns/_index.md index c7834da7c9f..47be0497c40 100644 --- a/content/rancher/v2.6/en/troubleshooting/dns/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/dns/_index.md @@ -7,7 +7,7 @@ The commands/steps listed on this page can be used to check name resolution issu Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml` for Rancher HA) or are using the embedded kubectl via the UI. -Before running the DNS checks, check the [default DNS provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/options/#default-dns-provider) for your cluster and make sure that [the overlay network is functioning correctly]({{}}/rancher/v2.5/en/troubleshooting/networking/#check-if-overlay-network-is-functioning-correctly) as this can also be the reason why DNS resolution (partly) fails. +Before running the DNS checks, check the [default DNS provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/options/#default-dns-provider) for your cluster and make sure that [the overlay network is functioning correctly]({{}}/rancher/v2.6/en/troubleshooting/networking/#check-if-overlay-network-is-functioning-correctly) as this can also be the reason why DNS resolution (partly) fails. ### Check if DNS pods are running @@ -196,7 +196,7 @@ services: > **Note:** As the `kubelet` is running inside a container, the path for files located in `/etc` and `/usr` are in `/host/etc` and `/host/usr` inside the `kubelet` container. -See [Editing Cluster as YAML]({{}}/rancher/v2.5/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: +See [Editing Cluster as YAML]({{}}/rancher/v2.6/en/cluster-admin/editing-clusters/#editing-clusters-with-yaml) how to apply this change. When the provisioning of the cluster has finished, you have to remove the kube-dns pod to activate the new setting in the pod: ``` kubectl delete pods -n kube-system -l k8s-app=kube-dns diff --git a/content/rancher/v2.6/en/troubleshooting/kubernetes-components/_index.md b/content/rancher/v2.6/en/troubleshooting/kubernetes-components/_index.md index a92e51f7698..0b6fd969dbc 100644 --- a/content/rancher/v2.6/en/troubleshooting/kubernetes-components/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/kubernetes-components/_index.md @@ -3,14 +3,14 @@ title: Kubernetes Components weight: 100 --- -The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters. +The commands and steps listed in this section apply to the core Kubernetes components on [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. This section includes troubleshooting tips in the following categories: -- [Troubleshooting etcd Nodes]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-components/etcd) -- [Troubleshooting Controlplane Nodes]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-components/controlplane) -- [Troubleshooting nginx-proxy Nodes]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-components/nginx-proxy) -- [Troubleshooting Worker Nodes and Generic Components]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-components/worker-and-generic) +- [Troubleshooting etcd Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/etcd) +- [Troubleshooting Controlplane Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane) +- [Troubleshooting nginx-proxy Nodes]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/nginx-proxy) +- [Troubleshooting Worker Nodes and Generic Components]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-components/worker-and-generic) # Kubernetes Component Diagram diff --git a/content/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane/_index.md b/content/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane/_index.md index d4d7d347e55..201c6e30aaf 100644 --- a/content/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/kubernetes-components/controlplane/_index.md @@ -29,7 +29,7 @@ bdf3898b8063 rancher/hyperkube:v1.11.5-rancher1 "/opt/rke-tools/en..." # Controlplane Container Logging -> **Note:** If you added multiple nodes with the `controlplane` role, both `kube-controller-manager` and `kube-scheduler` use a leader election process to determine the leader. Only the current leader will log the performed actions. See [Kubernetes leader election]({{}}/rancher/v2.5/en/troubleshooting/kubernetes-resources/#kubernetes-leader-election) how to retrieve the current leader. +> **Note:** If you added multiple nodes with the `controlplane` role, both `kube-controller-manager` and `kube-scheduler` use a leader election process to determine the leader. Only the current leader will log the performed actions. See [Kubernetes leader election]({{}}/rancher/v2.6/en/troubleshooting/kubernetes-resources/#kubernetes-leader-election) how to retrieve the current leader. The logging of the containers can contain information on what the problem could be. diff --git a/content/rancher/v2.6/en/troubleshooting/kubernetes-resources/_index.md b/content/rancher/v2.6/en/troubleshooting/kubernetes-resources/_index.md index f32e0ed0cab..c45b092bbde 100644 --- a/content/rancher/v2.6/en/troubleshooting/kubernetes-resources/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/kubernetes-resources/_index.md @@ -3,7 +3,7 @@ title: Kubernetes resources weight: 101 --- -The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to [Rancher Launched Kubernetes]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/) clusters. +The commands/steps listed on this page can be used to check the most important Kubernetes resources and apply to [Rancher Launched Kubernetes]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/) clusters. Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml` for Rancher HA) or are using the embedded kubectl via the UI. @@ -266,6 +266,6 @@ kubectl get pods --all-namespaces -o go-template='{{range .items}}{{if eq .statu ### Job does not complete -If you have enabled Istio, and you are having issues with a Job you deployed not completing, you will need to add an annotation to your pod using [these steps.]({{}}/rancher/v2.5/en/istio/setup/enable-istio-in-namespace) +If you have enabled Istio, and you are having issues with a Job you deployed not completing, you will need to add an annotation to your pod using [these steps.]({{}}/rancher/v2.6/en/istio/setup/enable-istio-in-namespace) Since Istio Sidecars run indefinitely, a Job cannot be considered complete even after its task has completed. This is a temporary workaround and will disable Istio for any traffic to/from the annotated Pod. Keep in mind this may not allow you to continue to use a Job for integration testing, as the Job will not have access to the service mesh. \ No newline at end of file diff --git a/content/rancher/v2.6/en/troubleshooting/networking/_index.md b/content/rancher/v2.6/en/troubleshooting/networking/_index.md index ac1f7a48ce1..4aff8504815 100644 --- a/content/rancher/v2.6/en/troubleshooting/networking/_index.md +++ b/content/rancher/v2.6/en/troubleshooting/networking/_index.md @@ -9,7 +9,7 @@ Make sure you configured the correct kubeconfig (for example, `export KUBECONFIG ### Double check if all the required ports are opened in your (host) firewall -Double check if all the [required ports]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) are opened in your (host) firewall. The overlay network uses UDP in comparison to all other required ports which are TCP. +Double check if all the [required ports]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) are opened in your (host) firewall. The overlay network uses UDP in comparison to all other required ports which are TCP. ### Check if overlay network is functioning correctly The pod can be scheduled to any of the hosts you used for your cluster, but that means that the NGINX ingress controller needs to be able to route the request from `NODE_1` to `NODE_2`. This happens over the overlay network. If the overlay network is not functioning, you will experience intermittent TCP/HTTP connection failures due to the NGINX ingress controller not being able to route to the pod. @@ -84,7 +84,7 @@ To test the overlay network, you can launch the following `DaemonSet` definition wk1 can reach wk1 => End network overlay test ``` - If you see error in the output, there is some issue with the route between the pods on the two hosts. In the above output the node `wk2` has no connectivity over the overlay network. This could be because the [required ports]({{}}/rancher/v2.5/en/cluster-provisioning/node-requirements/#networking-requirements) for overlay networking are not opened for `wk2`. + If you see error in the output, there is some issue with the route between the pods on the two hosts. In the above output the node `wk2` has no connectivity over the overlay network. This could be because the [required ports]({{}}/rancher/v2.6/en/cluster-provisioning/node-requirements/#networking-requirements) for overlay networking are not opened for `wk2`. 6. You can now clean up the DaemonSet by running `kubectl delete ds/overlaytest`. diff --git a/content/rancher/v2.6/en/user-settings/_index.md b/content/rancher/v2.6/en/user-settings/_index.md index 6d47ef975c9..aca89943f2e 100644 --- a/content/rancher/v2.6/en/user-settings/_index.md +++ b/content/rancher/v2.6/en/user-settings/_index.md @@ -2,7 +2,7 @@ title: User Settings weight: 23 aliases: - - /rancher/v2.5/en/tasks/user-settings/ + - /rancher/v2.6/en/tasks/user-settings/ --- Within Rancher, each user has a number of settings associated with their login: personal preferences, API keys, etc. You can configure these settings by choosing from the **User Settings** menu. You can open this menu by clicking your avatar, located within the main menu. @@ -11,8 +11,8 @@ Within Rancher, each user has a number of settings associated with their login: The available user settings are: -- [API & Keys]({{}}/rancher/v2.5/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key. -- [Cloud Credentials]({{}}/rancher/v2.5/en/user-settings/cloud-credentials/): Manage cloud credentials [used by node templates]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to [provision nodes for clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters). -- [Node Templates]({{}}/rancher/v2.5/en/user-settings/node-templates): Manage templates [used by Rancher to provision nodes for clusters]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters). -- [Preferences]({{}}/rancher/v2.5/en/user-settings/preferences): Sets superficial preferences for the Rancher UI. +- [API & Keys]({{}}/rancher/v2.6/en/user-settings/api-keys/): If you want to interact with Rancher programmatically, you need an API key. Follow the directions in this section to obtain a key. +- [Cloud Credentials]({{}}/rancher/v2.6/en/user-settings/cloud-credentials/): Manage cloud credentials [used by node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) to [provision nodes for clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). +- [Node Templates]({{}}/rancher/v2.6/en/user-settings/node-templates): Manage templates [used by Rancher to provision nodes for clusters]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters). +- [Preferences]({{}}/rancher/v2.6/en/user-settings/preferences): Sets superficial preferences for the Rancher UI. - Log Out: Ends your user session. diff --git a/content/rancher/v2.6/en/user-settings/api-keys/_index.md b/content/rancher/v2.6/en/user-settings/api-keys/_index.md index eac95192d91..49aae28a87f 100644 --- a/content/rancher/v2.6/en/user-settings/api-keys/_index.md +++ b/content/rancher/v2.6/en/user-settings/api-keys/_index.md @@ -2,8 +2,8 @@ title: API Keys weight: 7005 aliases: - - /rancher/v2.5/en/concepts/api-keys/ - - /rancher/v2.5/en/tasks/user-settings/api-keys/ + - /rancher/v2.6/en/concepts/api-keys/ + - /rancher/v2.6/en/tasks/user-settings/api-keys/ --- ## API Keys and User Authentication @@ -31,7 +31,7 @@ API Keys are composed of four components: Expiration period will be bound by `v3/settings/auth-token-max-ttl-minutes`. If it exceeds the max-ttl, API key will be created with max-ttl as the expiration period. - A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authorized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints]({{}}/rancher/v2.5/en/overview/architecture/#4-authorized-cluster-endpoint) for more information. + A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authorized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints]({{}}/rancher/v2.6/en/overview/architecture/#4-authorized-cluster-endpoint) for more information. 4. Click **Create**. @@ -45,7 +45,7 @@ API Keys are composed of four components: - Enter your API key information into the application that will send requests to the Rancher API. - Learn more about the Rancher endpoints and parameters by selecting **View in API** for an object in the Rancher UI. -- API keys are used for API calls and [Rancher CLI]({{}}/rancher/v2.5/en/cli). +- API keys are used for API calls and [Rancher CLI]({{}}/rancher/v2.6/en/cli). ## Deleting API Keys diff --git a/content/rancher/v2.6/en/user-settings/cloud-credentials/_index.md b/content/rancher/v2.6/en/user-settings/cloud-credentials/_index.md index 2af7a737491..6698277ea86 100644 --- a/content/rancher/v2.6/en/user-settings/cloud-credentials/_index.md +++ b/content/rancher/v2.6/en/user-settings/cloud-credentials/_index.md @@ -3,7 +3,7 @@ title: Managing Cloud Credentials weight: 7011 --- -When you create a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. +When you create a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. Node templates can use cloud credentials to access the credential information required to provision nodes in the infrastructure providers. The same cloud credential can be used by multiple node templates. By using a cloud credential, you do not have to re-enter access keys for the same cloud provider. Cloud credentials are stored as Kubernetes secrets. @@ -11,7 +11,7 @@ Cloud credentials are only used by node templates if there are fields marked as You can create cloud credentials in two contexts: -- [During creation of a node template]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for a cluster. +- [During creation of a node template]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) for a cluster. - In the **User Settings** All cloud credentials are bound to the user profile of who created it. They **cannot** be shared across users. @@ -21,11 +21,11 @@ All cloud credentials are bound to the user profile of who created it. They **ca 1. From your user settings, select **User Avatar > Cloud Credentials**. 1. Click **Add Cloud Credential**. 1. Enter a name for the cloud credential. -1. Select a **Cloud Credential Type** from the drop down. The values of this dropdown is based on the `active` [node drivers]({{}}/rancher/v2.5/en/admin-settings/drivers/node-drivers/) in Rancher. +1. Select a **Cloud Credential Type** from the drop down. The values of this dropdown is based on the `active` [node drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/) in Rancher. 1. Based on the selected cloud credential type, enter the required values to authenticate with the infrastructure provider. 1. Click **Create**. -**Result:** The cloud credential is created and can immediately be used to [create node templates]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). +**Result:** The cloud credential is created and can immediately be used to [create node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates). ## Updating a Cloud Credential @@ -35,11 +35,11 @@ When access credentials are changed or compromised, updating a cloud credential 1. Choose the cloud credential you want to edit and click the **⋮ > Edit**. 1. Update the credential information and click **Save**. -**Result:** The cloud credential is updated with the new access credentials. All existing node templates using this cloud credential will automatically use the updated information whenever [new nodes are added]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/). +**Result:** The cloud credential is updated with the new access credentials. All existing node templates using this cloud credential will automatically use the updated information whenever [new nodes are added]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/). ## Deleting a Cloud Credential -In order to delete cloud credentials, there must not be any node template associated with it. If you are unable to delete the cloud credential, [delete any node templates]({{}}/rancher/v2.5/en/user-settings/node-templates/#deleting-a-node-template) that are still associated to that cloud credential. +In order to delete cloud credentials, there must not be any node template associated with it. If you are unable to delete the cloud credential, [delete any node templates]({{}}/rancher/v2.6/en/user-settings/node-templates/#deleting-a-node-template) that are still associated to that cloud credential. 1. From your user settings, select **User Avatar > Cloud Credentials**. 1. You can either individually delete a cloud credential or bulk delete. diff --git a/content/rancher/v2.6/en/user-settings/node-templates/_index.md b/content/rancher/v2.6/en/user-settings/node-templates/_index.md index 03546f4b6ca..d68aa56afae 100644 --- a/content/rancher/v2.6/en/user-settings/node-templates/_index.md +++ b/content/rancher/v2.6/en/user-settings/node-templates/_index.md @@ -3,9 +3,9 @@ title: Managing Node Templates weight: 7010 --- -When you provision a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts: +When you provision a cluster [hosted by an infrastructure provider]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools), [node templates]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts: -- While [provisioning a node pool cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools). +- While [provisioning a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). - At any time, from your [user settings](#creating-a-node-template-from-user-settings). When you create a node template, it is bound to your user profile. Node templates cannot be shared among users. You can delete stale node templates that you no longer user from your user settings. @@ -16,14 +16,14 @@ When you create a node template, it is bound to your user profile. Node template 1. Click **Add Template**. 1. Select one of the cloud providers available. Then follow the instructions on screen to configure the template. -**Result:** The template is configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools). +**Result:** The template is configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). ## Updating a Node Template 1. From your user settings, select **User Avatar > Node Templates**. 1. Choose the node template that you want to edit and click the **⋮ > Edit**. - > **Note:** As of v2.2.0, the default `active` [node drivers]({{}}/rancher/v2.5/en/admin-settings/drivers/node-drivers/) and any node driver, that has fields marked as `password`, are required to use [cloud credentials]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/#cloud-credentials). If you have upgraded to v2.2.0, existing node templates will continue to work with the previous account access information, but when you edit the node template, you will be required to create a cloud credential and the node template will start using it. + > **Note:** As of v2.2.0, the default `active` [node drivers]({{}}/rancher/v2.6/en/admin-settings/drivers/node-drivers/) and any node driver, that has fields marked as `password`, are required to use [cloud credentials]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools/#cloud-credentials). If you have upgraded to v2.2.0, existing node templates will continue to work with the previous account access information, but when you edit the node template, you will be required to create a cloud credential and the node template will start using it. 1. Edit the required information and click **Save**. @@ -37,7 +37,7 @@ When creating new node templates from your user settings, you can clone an exist 1. Find the template you want to clone. Then select **⋮ > Clone**. 1. Complete the rest of the form. -**Result:** The template is cloned and configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools). +**Result:** The template is cloned and configured. You can use the template later when you [provision a node pool cluster]({{}}/rancher/v2.6/en/cluster-provisioning/rke-clusters/node-pools). ## Deleting a Node Template