starlingx/docs
Code Issues Proposed changes

Documentation changes for OIDC

Browse Source 
Two updates were made:

1 - OIDC has been up versioned recently, then the dex version was
updated.
2 - The edited note lets the user know when they update their system
the OIDC service parameters with underscores will be automatically
migrated(renamed) to the latest format with dashes:

+---------------------+---------------------+
|    Legacy Format    |    Latest Format    |
+---------------------+---------------------+
| oidc_client_id      | oidc-client-id      |
| oidc_groups_claim   | oidc-groups-claim   |
| oidc_issuer_url     | oidc-issuer-url     |
| oidc_username_claim | oidc-username-claim |
+---------------------+---------------------+

Story: 2011085
Task: 50524
Change-Id: Iaf7d194b18918977bc121e82584a1c2de2dbd628
Signed-off-by: Joaci Morais <Joaci.deMorais@windriver.com>
This commit is contained in:
Joaci Morais 2024-07-08 12:06:37 -03:00 committed by Joaci Morais
parent 7987a03f77
commit 2dcd4bf282
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/source/_includes/oidc-service-parameters-migration.rest Normal file
View File

5
doc/source/security/kubernetes/configure-kubernetes-for-oidc-token-validation-after-bootstrapping-the-system.rst
View File

@ -68,6 +68,11 @@ you can do so at any time using service parameters.
oidc_groups_claim. These are equivalent to: oidc-client-id, oidc-issuer-url,
oidc-username-claim and oidc-groups-claim.
.. only:: partner
.. include:: /_includes/oidc-service-parameters-migration.rest
#. Apply the service parameters.
.. code-block:: none

8
doc/source/security/kubernetes/configure-oidc-auth-applications.rst
View File

@ -356,10 +356,10 @@ Configure OIDC Auth Applications
The overall Dex documentation is available on `dexidp.io
<https://dexidp.io/docs/>`__. The configuration of dex server version
v2.37.0 is described on github
(https://github.com/dexidp/dex/blob/v2.37.0/config.yaml.dist) with example
v2.40.0 is described on github
(https://github.com/dexidp/dex/blob/v2.40.0/config.yaml.dist) with example
``config.dev.yaml``
(https://github.com/dexidp/dex/blob/v2.37.0/config.dev.yaml).
(https://github.com/dexidp/dex/blob/v2.40.0/config.dev.yaml).
The examples below configure a token expiry of ten hours, the |LDAP|
connectors to the remote servers using HTTPS (LDAPS) using the servers |CA|
@ -599,7 +599,7 @@ are:
image:
repository: ghcr.io/dexidp/dex
pullPolicy: IfNotPresent
tag: v2.37.0
tag: v2.40.0
imagePullSecrets:
- name: default-registry-key
env: