ContainerImage.Pinniped/site/content/docs/howto/configure-supervisor-with-okta.md

title	description	cascade	menu
Configure the Pinniped Supervisor to use Okta as an OIDC Provider	Set up the Pinniped Supervisor to use Okta login.	layout docs	docs name weight parent Configure Supervisor With Okta 35 howtos

The Supervisor is an OpenID Connect (OIDC) issuer that supports connecting a single "upstream" OIDC identity provider to many "downstream" cluster clients.

This guide shows you how to configure the Supervisor so that users can authenticate to their Kubernetes cluster using their Okta credentials.

Prerequisites

This how-to guide assumes that you have already [installed the Pinniped Supervisor]({{< ref "install-supervisor" >}}) with working ingress, and that you have [configured a FederationDomain to issue tokens for your downstream clusters]({{< ref "configure-supervisor" >}}).

Create an Okta Application

Follow the instructions for setting up an app using authcode flow and create an app. Optionally follow the instructions for customizing tokens returned from Okta with a groups claim if you want to pass users' Okta group information through to your Kubernetes clusters.

For example, to create an app:

1. In the Okta Admin Console, navigate to Applications > Applications.
2. Create a new app:
   1. Click Create App Integration.
   2. For Sign-on method, select OIDC.
   3. For Application type, app Web Application, then click next.
   4. Enter a name for your app, such as "My Kubernetes Clusters".
   5. Enter the sign-in redirect URI. This is the spec.issuer you configured in your FederationDomain appended with /callback.
   6. Optionally select Limit access to selected groups to restrict which Okta users can log in to Kubernetes using this integration.
   7. Save the app and make note of the Client ID and Client secret.
   8. Navigate to the Sign On tab > OpenID Connect ID Token and click Edit. Fill in the Groups claim filter. For example, for all groups to be present under the claim name groups, fill in "groups" in the first box, then select "Matches regex" and ".*".

Configure the Supervisor

Create an OIDCIdentityProvider in the same namespace as the Supervisor.

For example, this OIDCIdentityProvider and corresponding Secret use Okta's email claim as the Kubernetes username:

apiVersion: idp.supervisor.pinniped.dev/v1alpha1
kind: OIDCIdentityProvider
metadata:
  namespace: pinniped-supervisor
  name: okta
spec:

  # Specify the upstream issuer URL (no trailing slash).
  issuer: https://my-company.okta.com

  # Request any scopes other than "openid" for claims besides
  # the default claims in your token. The "openid" scope is always
  # included.
  #
  # To learn more about how to customize the claims returned, see here:
  # https://developer.okta.com/docs/guides/customize-tokens-returned-from-okta/overview/
  authorizationConfig:
    additionalScopes: [groups, email]

  # Specify how Okta claims are mapped to Kubernetes identities.
  claims:

    # Specify the name of the claim in your Okta token that will be mapped
    # to the "username" claim in downstream tokens minted by the Supervisor.
    username: email

    # Specify the name of the claim in Okta that represents the groups
    # that the user belongs to. This matches what you specified above
    # with the Groups claim filter.
    groups: groups

  # Specify the name of the Kubernetes Secret that contains your Okta
  # application's client credentials (created below).
  client:
    secretName: okta-client-credentials
---
apiVersion: v1
kind: Secret
metadata:
  namespace: pinniped-supervisor
  name: okta-client-credentials
type: secrets.pinniped.dev/oidc-client
stringData:

  # The "Client ID" that you got from Okta.
  clientID: "<your-client-id>"

  # The "Client secret" that you got from Okta.
  clientSecret: "<your-client-secret>"

Once your OIDCIdentityProvider has been created, you can validate your configuration by running:

kubectl describe OIDCIdentityProvider -n pinniped-supervisor okta

Look at the status field. If it was configured correctly, you should see phase: Ready.

Next steps

Now that you have configured the Supervisor to use Okta, you may want to [configure the Concierge to validate JWTs issued by the Supervisor]({{< ref "configure-concierge-jwt" >}}).