starlingx/docs
Code Issues Proposed changes
docs/doc/source/security/kubernetes/configure-kubernetes-for-oidc-token-validation-while-bootstrapping-the-system.rst
Joao Victor Portal daa431e385 Updated OIDC app docs 
This commit does 2 changes in the OIDC app docs:

1) The docs were updated to be explicit about the OIDC app being
   compatible with LDAP servers and not only with the Windows Active
   Directory;
2) The page "Centralized OIDC Authentication Setup for Distributed
   Cloud" was renamed to "Centralized vs Distributed OIDC Authentication
   Setup" and was moved in the index of pages to be right below the
   first page "Overview of LDAP Servers". The idea is to use this page
   as a entry point for someone learning about the OIDC app, because
   every user must decide between a centralized and a distributed setup
   and because this page has links to all other pages except
   "Deprovision LDAP Server Authentication".

Story: 2010738
Task: 49455

Change-Id: I61c5b7f322ac8159b649c70eeaa0195d97ab12c7
Signed-off-by: Joao Victor Portal <Joao.VictorPortal@windriver.com>
2024-01-29 19:14:14 -03:00

2.2 KiB
Raw Blame History

Configure Kubernetes for OIDC Token Validation while Bootstrapping the System

You must configure the Kubernetes cluster's kube-apiserver to use the oidc-auth-apps identity provider for validation of tokens in Kubernetes API requests, which use authentication.

Complete these steps to configure Kubernetes for token validation during bootstrapping and deployment.

The values set in this procedure can be changed at any time using service parameters as described in Configure Kubernetes for OIDC Token Validation after Bootstrapping the System <configure-kubernetes-for-oidc-token-validation-after-bootstrapping-the-system>.

  • Configure the Kubernetes cluster kube-apiserver by adding the following parameters to the localhost.yml file, during bootstrap:

    # cd ~
# cat <<EOF > /home/sysadmin/localhost.yml
apiserver_oidc:
  client_id: <stx-oidc-client-app>
  issuer_url: https://<oam-floating-ip>:<oidc-auth-apps-dex-service-NodePort>/dex
  username_claim: <email>
  groups_claim: <groups>
EOF

    where:

    <oidc-auth-apps-dex-service-NodePort>

    is the port to be configured for the NodePort service for dex in oidc-auth-apps. The default is 30556.

    The values of the username_claim, and groups_claim parameters could vary for different user and groups configurations in your Windows Active Directory or server.

    Note

    For IPv6 deployments, ensure that the IPv6 OAM floating address in the issuer_url is, https://\[<oam-floating-ip>]:30556/dex (that is, in lower case, and wrapped in square brackets).

For more information on Authentication for subclouds, see Centralized vs Distributed OIDC Authentication Setup <centralized-vs-distributed-oidc-auth-setup>.