Adding MS ADFS Setup Documentation Enhancements
Chris Kim
@@ -6,121 +6,27 @@ _Available as of v2.0.7_
|
||||
|
||||
If your organization uses Microsoft Active Directory Federation Services (AD FS) for user authentication, you can configure Rancher to allow your users to log in using their AD FS credentials.
|
||||
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- You must have Rancher installed.
|
||||
> - Your Rancher Server URL will be substituted for `<rancher-server>` in the following guides.
|
||||
>- You must have a [Microsoft AD FS Server](https://docs.microsoft.com/en-us/windows-server/identity/active-directory-federation-services) configured.
|
||||
> - Your AD FS Server IP/DNS Name will be substituted for `<ad-server>` in the following guides.
|
||||
>- You must be able to add `Relying Party Trusts` on your AD FS Server.
|
||||
>- You must have a global admin account on your Rancher installation.
|
||||
|
||||
### Setup Outline
|
||||
|
||||
Setting up Microsoft AD FS with Rancher Server requires configuring AD FS on your Active Directory server, and configuring Rancher to expect AD FS queries.
|
||||
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.
|
||||
|
||||
- [Microsoft AD FS Setup]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/#microsoft-ad-fs-setup)
|
||||
- [Microsoft AD FS Setup]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/microsoft-adfs-setup)
|
||||
|
||||
Set up Microsoft AD FS to expect Rancher for authentication
|
||||
|
||||
- [Rancher AD FS Setup]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/#rancher-setup)
|
||||
- [Rancher AD FS Setup]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup)
|
||||
|
||||
Configure Rancher Server to use Microsoft AD FS for authentication
|
||||
|
||||
|
||||
>**Prerequisites:**
|
||||
>
|
||||
>- You must have a [Microsoft AD FS Server](https://docs.microsoft.com/en-us/windows-server/identity/active-directory-federation-services) configured.
|
||||
>- Export a `federationmetadata.xml` file from your AD FS Server. For more information, see the [PingIdentity video](https://docs.pingidentity.com/bundle/ping_sm_videoLibrary/page/p1_IdentityBridgeADFS.html).
|
||||
|
||||
## Microsoft AD FS Setup
|
||||
|
||||
1. Open the `AD FS Management Console`
|
||||
|
||||
|
||||
1. Select `Add Relying Party Trust...` in the right actions menu.
|
||||
|
||||
|
||||
1. Select `Enter data about the relying party manually` as the option for obtaining data about the relying party
|
||||
|
||||
|
||||
1. Enter a `Display name` for your Relying Party Trust
|
||||
|
||||
|
||||
1. Select `AD FS profile` as the configuration profile for your relying party trust
|
||||
|
||||
|
||||
1. Leave the `optional token encryption certificate` empty, as Rancher ADFS will not be using one.
|
||||
|
||||
|
||||
1. Select `Enable support for the SAML 2.0 WebSSO protocol`
|
||||
and enter `https://<rancher-server>/v1-saml/adfs/saml/acs` for the service URL
|
||||
|
||||
|
||||
1. Add `https://<rancher-server>/v1-saml/adfs/saml/metadata` as the Relying party trust identifier
|
||||
|
||||
|
||||
1. This tutorial will not cover multi-factor authentication; please refer to the Microsoft documentation if you would like to configure mutli-factor authentication.
|
||||
|
||||
|
||||
1. Select `Permit all users to access this relying party`
|
||||
|
||||
|
||||
1. After reviewing your settings, select `Next` to add the relying party trust
|
||||
|
||||
|
||||
1. Select `Open the Edit Claim Rules...` and click `Close`
|
||||
|
||||
|
||||
1. Click `Add Rule...`
|
||||
|
||||
|
||||
1. Select `Send LDAP Attributes as Claims` as the Claim rule template
|
||||
|
||||
|
||||
1. Set the `Claim rule name` to your desired name, and select `Active Directory` as the Attribute store. Create the following mapping to reflect the table below
|
||||
|
||||
| LDAP Attribute | Outgoing Claim Type |
|
||||
| -------------------------------------------- | ------------------- |
|
||||
| Given-Name | Given Name |
|
||||
| User-Principal-Name | UPN |
|
||||
| Token-Groups - Qualified by Long Domain Name | Group |
|
||||
| SAM-Account-Name | Name |
|
||||
|
||||
|
||||
1. Download the `federationmetadata.xml` from your AD server at:
|
||||
```
|
||||
https://<ad-server>/federationmetadata/2007-06/federationmetadata.xml
|
||||
```
|
||||
|
||||
|
||||
## Rancher Setup
|
||||
|
||||
1. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
1. Select **Microsoft Active Directory Federation Services**.
|
||||
|
||||
1. Complete the **Configure AD FS Account** form. Microsoft AD FS lets you specify an existing Active Directory (AD) server. The examples below describe how you can map AD attributes to fields within Rancher.
|
||||
|
||||
1. **Display Name Field**: Enter the AD attribute that contains the display name of users (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`).
|
||||
|
||||
1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`).
|
||||
|
||||
1. **UID Field**: Enter an AD attribute that is unique to every user (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn`).
|
||||
|
||||
1. **Groups Field**: Make entries for managing group memberships (example: `http://schemas.xmlsoap.org/claims/Group`).
|
||||
|
||||
1. **Rancher API Host**: Enter the URL for your Rancher Server.
|
||||
|
||||
1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your AD FS.
|
||||
|
||||
You can generate one using an openssl command. For example:
|
||||
|
||||
```
|
||||
openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com"
|
||||
```
|
||||
1. **Metadata XML**: The `federationmetadata.xml` file exported from your AD FS server. You can find this file at `https://your-AD-Server/federationmetadata/2007-06/federationmetadata.xml`.
|
||||
|
||||
|
||||
1. After you complete the **Configure AD FS Account** form, click **Authenticate with AD FS**, which is at the bottom of the page.
|
||||
|
||||
Rancher redirects you to the AD FS login page. Enter credentials that authenticate with Microsoft AD FS to validate your Rancher AD FS configuration.
|
||||
|
||||
>**Note:** You may have to disable your popup blocker to see the AD FS login page.
|
||||
|
||||
**Result:** Rancher is configured to work with MS FS. Your users can now sign into Rancher using their MS FS logins.
|
||||
|
||||
>**Active Directory Federation Service Caveats:**
|
||||
>
|
||||
>- AD FS does not support search or lookup. When adding users to [clusters]({{< baseurl >}}/rancher/v2.x/en/k8s-in-rancher/editing-clusters/) or [projects]({{< baseurl >}}/rancher/v2.x/en/k8s-in-rancher/projects-and-namespaces/editing-projects/), the exact IDs must be entered correctly.
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
title: 1 - Microsoft AD FS Setup
|
||||
weight: 1205
|
||||
---
|
||||
|
||||
## Microsoft AD FS Setup
|
||||
|
||||
1. Open the **AD FS Management** console.
|
||||
|
||||
|
||||
1. Select **Add Relying Party Trust...** in the right actions menu.
|
||||
|
||||
|
||||
1. Select **Enter data about the relying party manually** as the option for obtaining data about the relying party.
|
||||
|
||||
|
||||
1. Enter your desired **Display name** for your Relying Party Trust. For example, `Rancher`.
|
||||
|
||||
|
||||
1. Select **AD FS profile** as the configuration profile for your relying party trust.
|
||||
|
||||
|
||||
1. Leave the **optional token encryption certificate** empty, as Rancher ADFS will not be using one.
|
||||
|
||||
|
||||
1. Select **Enable support for the SAML 2.0 WebSSO protocol**
|
||||
and enter `https://<rancher-server>/v1-saml/adfs/saml/acs` for the service URL.
|
||||
|
||||
|
||||
1. Add `https://<rancher-server>/v1-saml/adfs/saml/metadata` as the **Relying party trust identifier**
|
||||
|
||||
|
||||
1. This tutorial will not cover multi-factor authentication; please refer to the Microsoft documentation if you would like to configure multi-factor authentication.
|
||||
|
||||
|
||||
1. You may select either of these options depending on your desired use case. However, for the purposes of this guide, select **Permit all users to access this relying party**.
|
||||
|
||||
|
||||
1. After reviewing your settings, select **Next** to add the relying party trust.
|
||||
|
||||
|
||||
1. Select **Open the Edit Claim Rules...** and click **Close**.
|
||||
|
||||
|
||||
1. On the **Issuance Transform Rules** tab, click **Add Rule...**.
|
||||
|
||||
|
||||
1. Select **Send LDAP Attributes as Claims** as the Claim rule template.
|
||||
|
||||
|
||||
1. Set the **Claim rule name** to your desired name (for example, `Rancher Attributes`) and select **Active Directory** as the Attribute store. Create the following mapping to reflect the table below:
|
||||
|
||||
| LDAP Attribute | Outgoing Claim Type |
|
||||
| -------------------------------------------- | ------------------- |
|
||||
| Given-Name | Given Name |
|
||||
| User-Principal-Name | UPN |
|
||||
| Token-Groups - Qualified by Long Domain Name | Group |
|
||||
| SAM-Account-Name | Name |
|
||||
|
||||
|
||||
1. Download the `federationmetadata.xml` from your AD server at:
|
||||
```
|
||||
https://<ad-server>/federationmetadata/2007-06/federationmetadata.xml
|
||||
```
|
||||
|
||||
### [Next: Rancher AD FS Setup]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/rancher-adfs-setup/)
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: 2 - Rancher AD FS Setup
|
||||
weight: 1205
|
||||
---
|
||||
_Available as of v2.0.7_
|
||||
|
||||
>**Important Notes For Configuring Your AD FS Server:**
|
||||
>
|
||||
>- The SAML 2.0 WebSSO Protocol Service URL is: `https://<rancher-server>/v1-saml/adfs/saml/acs`
|
||||
>- The Relying Party Trust Identifier URL is: `https://<rancher-server>/v1-saml/adfs/saml/metadata`
|
||||
>- You must export the `federationmetadata.xml` file from your AD FS server. This can be found at: `https://<ad-server>/federationmetadata/2007-06/federationmetadata.xml`
|
||||
|
||||
## Rancher Setup
|
||||
|
||||
1. From the **Global** view, select **Security > Authentication** from the main menu.
|
||||
|
||||
1. Select **Microsoft Active Directory Federation Services**.
|
||||
|
||||
1. Complete the **Configure AD FS Account** form. Microsoft AD FS lets you specify an existing Active Directory (AD) server. The examples below describe how you can map AD attributes to fields within Rancher.
|
||||
|
||||
1. **Display Name Field**: Enter the AD attribute that contains the display name of users (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`).
|
||||
|
||||
1. **User Name Field**: Enter the AD attribute that contains the user name/given name (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`).
|
||||
|
||||
1. **UID Field**: Enter an AD attribute that is unique to every user (example: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn`).
|
||||
|
||||
1. **Groups Field**: Make entries for managing group memberships (example: `http://schemas.xmlsoap.org/claims/Group`).
|
||||
|
||||
1. **Rancher API Host**: Enter the URL for your Rancher Server.
|
||||
|
||||
1. **Private Key** and **Certificate**: This is a key-certificate pair to create a secure shell between Rancher and your AD FS. Ensure you set the Common Name (CN) to your rancher server URL.
|
||||
|
||||
You can generate one using an openssl command. For example:
|
||||
|
||||
```
|
||||
openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com"
|
||||
```
|
||||
1. **Metadata XML**: The `federationmetadata.xml` file exported from your AD FS server. You can find this file at `https://<ad-server>/federationmetadata/2007-06/federationmetadata.xml`.
|
||||
|
||||
|
||||
1. After you complete the **Configure AD FS Account** form, click **Authenticate with AD FS**, which is at the bottom of the page.
|
||||
|
||||
Rancher redirects you to the AD FS login page. Enter credentials that authenticate with Microsoft AD FS to validate your Rancher AD FS configuration.
|
||||
|
||||
>**Note:** You may have to disable your popup blocker to see the AD FS login page.
|
||||
|
||||
**Result:** Rancher is configured to work with MS FS. Your users can now sign into Rancher using their MS FS logins.
|
||||
|
Before Width: | Height: | Size: 205 KiB After Width: | Height: | Size: 831 KiB |
|
Before Width: | Height: | Size: 260 KiB After Width: | Height: | Size: 1.2 MiB |
|
Before Width: | Height: | Size: 192 KiB After Width: | Height: | Size: 889 KiB |
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 231 KiB After Width: | Height: | Size: 883 KiB |
|
Before Width: | Height: | Size: 222 KiB After Width: | Height: | Size: 429 KiB |
|
Before Width: | Height: | Size: 333 KiB After Width: | Height: | Size: 1.5 MiB |
|
Before Width: | Height: | Size: 222 KiB After Width: | Height: | Size: 452 KiB |
|
Before Width: | Height: | Size: 262 KiB After Width: | Height: | Size: 1.1 MiB |
|
Before Width: | Height: | Size: 277 KiB After Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 237 KiB After Width: | Height: | Size: 1.5 MiB |
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 1.1 MiB |
|
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 613 KiB |
|
Before Width: | Height: | Size: 305 KiB After Width: | Height: | Size: 349 KiB |