diff --git a/content/rancher/v2.x/en/admin-settings/authentication/_index.md b/content/rancher/v2.x/en/admin-settings/authentication/_index.md index 9f9d8c6063c..31ea97a8d8e 100644 --- a/content/rancher/v2.x/en/admin-settings/authentication/_index.md +++ b/content/rancher/v2.x/en/admin-settings/authentication/_index.md @@ -26,7 +26,7 @@ The Rancher authentication proxy integrates with the following external authenti | [Microsoft AD FS]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/microsoft-adfs/) | v2.0.7 | | [PingIdentity]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/ping-federate/) | v2.0.7 | | [Keycloak]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/keycloak/) | v2.1.0 | - +| [Okta]({{< baseurl >}}/rancher/v2.x/en/admin-settings/authentication/okta/) | v2.2.0 |
However, Rancher also provides local authentication. diff --git a/content/rancher/v2.x/en/admin-settings/authentication/okta/_index.md b/content/rancher/v2.x/en/admin-settings/authentication/okta/_index.md new file mode 100644 index 00000000000..c45f01ddf46 --- /dev/null +++ b/content/rancher/v2.x/en/admin-settings/authentication/okta/_index.md @@ -0,0 +1,53 @@ +--- +title: Configuring OKTA (SAML) +weight: 1200 +--- +_Available as of v2.2.0_ + +If your organization uses OKTA Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials. + +## Prerequisites + + +In Okta, create a SAML Application with the settings below. See the [Okta documentation](https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta) for help. + +>**Note:** You should set `Single Sign on URL` and `Audience URI (SP Entity ID)` as the following description. + + Setting | Value + ------------|------------ + `Single Sign on URL` | `https://[rancher server address]/v1-saml/okta/saml/acs` + `Audience URI (SP Entity ID)` | `https://[rancher server address]/v1-saml/okta/saml/metadata` + + +## Configuring OKTA in Rancher + + +1. From the **Global** view, select **Security > Authentication** from the main menu. + +1. Select **OKTA**. + +1. Complete the **Configure Okta Account** form. The examples below describe how you can map OKTA attributes to fields within Rancher. + + + | Field | Description | + | ------------------------- | ----------------------------------------------------------------------------- | + | Display Name Field | The attribute that contains the display name of users. | + | User Name Field | The attribute that contains the user name/given name. | + | UID Field | An attribute that is unique to every user. Either it can be the same as `User Name Field` or you can define a different one according to your own request. | + | Groups Field | Make entries for managing group memberships. | + | Rancher API Host | The URL for your Rancher Server. | + | Private Key / Certificate | A key/certificate pair to create a secure shell between Rancher and your IdP. | + | Metadata XML | The `metadata.xml` file that you restored from your IdP server. | + + >**Tip:** You can generate a key/certificate pair using an openssl command. For example: + > + > openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout myservice.key -out myservice.cert + + +1. After you complete the **Configure Okta Account** form, click **Authenticate with Okta**, which is at the bottom of the page. + + Rancher redirects you to the IdP login page. Enter credentials that authenticate with Okta IdP to validate your Rancher Okta configuration. + + >**Note:** If nothing seems to happen, it's likely because your browser blocked the pop-up. Make sure you disable the pop-up blocker for your rancher domain and whitelist it in any other extensions you might utilize. + +**Result:** Rancher is configured to work with Okta. Your users can now sign into Rancher using their Okta logins.