mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 12:38:05 +00:00
adding freeIPA and openLDAP
This commit is contained in:
Mark Bishop
@@ -13,12 +13,17 @@ This centralized user authentication is accomplished using the Rancher authentic
|
||||
The Rancher authentication proxy integrates with the following external authentication services.
|
||||
|
||||
- Microsoft Active Directory
|
||||
- Microsoft Azure AD
|
||||
- GitHub
|
||||
- FreeIPA
|
||||
- OpenLDAP
|
||||
|
||||
However, Rancher also provides local authentication.
|
||||
|
||||
In most cases, you should use an external authentication service over local, 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 Active Directory is down.
|
||||
|
||||
For more information on how to configure external authentication or local authentication, see [Authentication](../../../tasks/global-configuration/authentication/).
|
||||
|
||||
### External Authentication Configuration and Principal Users
|
||||
|
||||
Configuration of external authentication requires:
|
||||
|
||||
@@ -2,25 +2,29 @@
|
||||
title: Authentication
|
||||
weight: 50
|
||||
---
|
||||
You have three options for user authentication in Rancher:
|
||||
|
||||
- [Active Directory]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/authentication/active-directory/)
|
||||
|
||||
Enterprises can use Active Directory (AD) for authentication, allowing users to sign in using their corporate credentials.
|
||||
You have multiple options for user authentication in Rancher:
|
||||
|
||||
- [GitHub]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/authentication/github/)
|
||||
- [Active Directory](./active-directory/)
|
||||
|
||||
Open source projects or organizations that use GitHub for source control may prefer that users sign in using their GitHub accounts.
|
||||
Enterprises can use Active Directory (AD) for authentication, allowing users to sign in using their corporate credentials.
|
||||
|
||||
<!-- - **SAML**:
|
||||
- [Azure AD](./azure-ad/)
|
||||
|
||||
- **OpenLDAP**:-->
|
||||
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.
|
||||
|
||||
- [GitHub](./github/)
|
||||
|
||||
- [Azure AD]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/authentication/azure-ad/)
|
||||
Open source projects or organizations that use GitHub for source control may prefer that users sign in using their GitHub accounts.
|
||||
|
||||
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.
|
||||
- [FreeIPA](./freeipa/)
|
||||
|
||||
- [Local Authentication]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/authentication/local-authentication/)
|
||||
Organizations can use FreeIPA for authentication, allowing users to sign in using their corporate credentials.
|
||||
|
||||
If you don't want to use external authentication, you can always add users directly to Rancher. We recommend using external authentication over local authentication.
|
||||
- [OpenLDAP](./openlap/)
|
||||
|
||||
Organizations can use OpenLDAP for authentication, allowing users to sign in using their corporate credentials.
|
||||
|
||||
- [Local Authentication](./local-authentication/)
|
||||
|
||||
If you don't want to use external authentication, you can always add users directly to Rancher. We recommend using external authentication over local authentication.
|
||||
|
||||
+2
-1
@@ -7,7 +7,8 @@ In environments using Microsoft Active Directory (AD), you can configure Rancher
|
||||
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- Create a service account in Active Directory with `read-only` access. {{< product >}} uses this account to verify group membership when a user makes a request using an API key.
|
||||
>- Have an Active Directory server configured.
|
||||
>- Create a service account in Active Directory 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]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication/#external-authentication-configuration-and-principal-users).
|
||||
|
||||
1. Sign into Rancher using a local user assigned `administrator` global permissions (i.e., the _local principal_).
|
||||
|
||||
@@ -5,6 +5,8 @@ weight: 3075
|
||||
|
||||
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.
|
||||
|
||||
>**Prerequisite:** Have an instance of Azure AD configured.
|
||||
|
||||
>**Note:** Most of this procedure, with the exception of [Configure Azure AD in Rancher](#configure-azure-ad-in-rancher), takes place from the [Microsoft Azure Portal](https://portal.azure.com/).
|
||||
|
||||
## Azure Active Directory Configuration Outline
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Configuring FreeIPA
|
||||
weight: 5000
|
||||
---
|
||||
|
||||
If your organization uses FreeIPA for user authentication, you can configure Rancher to allow your users to login using their FreeIPA credentials.
|
||||
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- 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]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication/#external-authentication-configuration-and-principal-users).
|
||||
|
||||
1. Sign into Rancher using a local user assigned the `administrator` role (i.e., the _local principal_).
|
||||
|
||||
2. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
3. Select **FreeIPA**.
|
||||
|
||||
4. Complete the **Configure an FreeIPA server** form.
|
||||
|
||||
You may need to log in to your domain controller to find the information requested in the form.
|
||||
|
||||
>**Using TLS?**
|
||||
>Make sure you have an LDAP certificate installed.
|
||||
<br/>
|
||||
<br/>
|
||||
>**User Search Base vs. Group Search Base**
|
||||
>
|
||||
>When configuring FreeIPA authentication, you must enter a search base for your users. This search base allows Rancher to search for users that are in your FreeIPA.
|
||||
<br/>
|
||||
<br/>
|
||||
> **Note:** This field is only for search bases and not for search filters.
|
||||
>
|
||||
>- If your users and groups are in the search base, complete only the User Search Base.
|
||||
>- If your groups are in a different search base, you can optionally complete the Group Search Base. This field is dedicated to searching groups, but is not required.
|
||||
|
||||
5. If your FreeIPA deviates from the standard AD schema, complete the **Customize Schema** form to match it. Otherwise, skip this step.
|
||||
|
||||
>**Search Attribute** As of Rancher v2.0.1, the Search Attribute field defaults with three specific values by default: `sAMAccountName|sn|givenName`. After FreeIPA is configured, when a user enters text to add users or groups, Rancher automatically queries the FreeIPA server and attempts to match fields by sAMAccountName, last name, or first name. Rancher specifically searches for users/groups that begin with the text entered in the search field.
|
||||
>
|
||||
>The default field value `sAMAccountName|sn|givenName`, but you can configure this field to a subset of these fields. The pipe (`|`) between the fields separates these fields.
|
||||
>
|
||||
> * `sAMAccountName`: Username
|
||||
> * `sn`: Last Name
|
||||
> * `givenName`: First Name
|
||||
>
|
||||
> With this search attribute, Rancher creates search filters for users and groups, but you *cannot* add your own search filters in this field.
|
||||
|
||||
6. Enter your FreeIPA username and password in **Test and enable authentication** to confirm that Rancher is configured to use FreeIPA authentication.
|
||||
|
||||
**Result:**
|
||||
|
||||
- FreeIPA authentication is configured.
|
||||
- You are signed into Rancher with your FreeIPA account (i.e., the _external principal_).
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Configuring OpenLDAP
|
||||
weight: 5000
|
||||
---
|
||||
|
||||
If your organization uses OpenLDAP for user authentication, you can configure Rancher to allow your users to login using their OpenLDAP credentials.
|
||||
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- You must have an [OpenLDAP Server](https://www.openldap.org/) configured.
|
||||
>- Create a service account in OpenLDAP 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]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication/#external-authentication-configuration-and-principal-users).
|
||||
|
||||
1. Sign into Rancher using a local user assigned the `administrator` role (i.e., the _local principal_).
|
||||
|
||||
2. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
3. Select **OpenLDAP**.
|
||||
|
||||
4. Complete the **Configure an OpenLDAP server** form.
|
||||
|
||||
You may need to log in to your domain controller to find the information requested in the form.
|
||||
|
||||
>**Using TLS?**
|
||||
>Make sure you have an LDAP certificate installed.
|
||||
<br/>
|
||||
<br/>
|
||||
>**User Search Base vs. Group Search Base**
|
||||
>
|
||||
>When configuring OpenLDAP authentication, you must enter a search base for your users. This search base allows Rancher to search for users that are in your OpenLDAP.
|
||||
<br/>
|
||||
<br/>
|
||||
> **Note:** This field is only for search bases and not for search filters.
|
||||
>
|
||||
>- If your users and groups are in the search base, complete only the User Search Base.
|
||||
>- If your groups are in a different search base, you can optionally complete the Group Search Base. This field is dedicated to searching groups, but is not required.
|
||||
|
||||
5. If your OpenLDAP deviates from the standard OpenLDAP schema, complete the **Customize Schema** form to match it. Otherwise, skip this step.
|
||||
|
||||
>**Search Attribute** As of Rancher v2.0.1, the Search Attribute field defaults with three specific values by default: `sAMAccountName|sn|givenName`. After OpenLDAP is configured, when a user enters text to add users or groups, Rancher automatically queries the OpenLDAP server and attempts to match fields by sAMAccountName, last name, or first name. Rancher specifically searches for users/groups that begin with the text entered in the search field.
|
||||
>
|
||||
>The default field value `sAMAccountName|sn|givenName`, but you can configure this field to a subset of these fields. The pipe (`|`) between the fields separates these fields.
|
||||
>
|
||||
> * `sAMAccountName`: Username
|
||||
> * `sn`: Last Name
|
||||
> * `givenName`: First Name
|
||||
>
|
||||
> With this search attribute, Rancher creates search filters for users and groups, but you *cannot* add your own search filters in this field.
|
||||
|
||||
6. Enter your OpenLDAP username and password in **Test and enable authentication** to confirm that Rancher is configured to use OpenLDAP authentication.
|
||||
|
||||
**Result:**
|
||||
|
||||
- OpenLDAP authentication is configured.
|
||||
- You are signed into Rancher with your OpenLDAP account (i.e., the _external principal_).
|
||||
Reference in New Issue
Block a user