Skip to content

Documentation for Federated (OIDC) Keystone adoption - #1397

Merged
openshift-merge-bot[bot] merged 1 commit into
openstack-k8s-operators:mainfrom
afaranha:oidc_adoption
Jun 5, 2026
Merged

Documentation for Federated (OIDC) Keystone adoption#1397
openshift-merge-bot[bot] merged 1 commit into
openstack-k8s-operators:mainfrom
afaranha:oidc_adoption

Conversation

@afaranha

Copy link
Copy Markdown
Contributor

Documentation for Federated (OIDC) Keystone adoption

Original Patch: #1062

Jira: https://issues.redhat.com/browse/OSPRH-19960
Jira: https://redhat.atlassian.net/browse/OSPRH-19963

@jistr jistr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label May 20, 2026
@jistr
jistr requested a review from klgill May 20, 2026 06:38

@klgill klgill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some style edits.

Comment thread docs_user/modules/proc_configuring-federation-for-keystone.adoc

.Prerequisites

* You have Keycloak reachable from your {rhos_long} cluster.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* You have Keycloak reachable from your {rhos_long} cluster.
* Keycloak is reachable from your {rhos_long} cluster.

+
where:

`<keycloak-ca.crt>`:: Replace with the path to the CA file you want to use.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<keycloak-ca.crt>`:: Replace with the path to the CA file you want to use.
`<keycloak-ca.crt>`:: Specifies the path to the CA file that you want to use.

+
where:

`<client_secret>`:: Replace with your client ID to use for the OIDC provider handshake. You must get this from your SSO administrator.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<client_secret>`:: Replace with your client ID to use for the OIDC provider handshake. You must get this from your SSO administrator.
`<client_secret>`:: Specifies the client ID to use for the OIDC provider handshake. You must get the client ID from your SSO administrator.

where:

`<client_secret>`:: Replace with your client ID to use for the OIDC provider handshake. You must get this from your SSO administrator.
`<crypto_passphrase>`:: Replace with the client secret to use for the OIDC provider handshake. You must get this from your SSO administrator after providing your redirect URLs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<crypto_passphrase>`:: Replace with the client secret to use for the OIDC provider handshake. You must get this from your SSO administrator after providing your redirect URLs.
`<crypto_passphrase>`:: Specifies the client secret to use for the OIDC provider handshake. You must get the client secret from your SSO administrator after providing your redirect URLs.


`<client_secret>`:: Replace with your client ID to use for the OIDC provider handshake. You must get this from your SSO administrator.
`<crypto_passphrase>`:: Replace with the client secret to use for the OIDC provider handshake. You must get this from your SSO administrator after providing your redirect URLs.
`<LocationMatch>` and `<Location>`:: Replace with the chosen string that creates your unique redirect URL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<LocationMatch>` and `<Location>`:: Replace with the chosen string that creates your unique redirect URL.
`<LocationMatch>` and `<Location>`:: Specifies the chosen string that creates your unique redirect URL.

`<crypto_passphrase>`:: Replace with the client secret to use for the OIDC provider handshake. You must get this from your SSO administrator after providing your redirect URLs.
`<LocationMatch>` and `<Location>`:: Replace with the chosen string that creates your unique redirect URL.

. Patch the `OpenStackControlPlane` custom resource (CR) to enable OIDC federation for Keystone:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Patch the `OpenStackControlPlane` custom resource (CR) to enable OIDC federation for Keystone:
. Patch the `OpenStackControlPlane` custom resource (CR) to enable OIDC federation for Keystone. Ensure that you merge the patch with any existing custom configuration for the {identity_service}:

I think this information would be good for the customer to know upfront.

Comment on lines +100 to +101
+
* Ensure you merge the patch with any existing custom configuration for the {identity_service}.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
+
* Ensure you merge the patch with any existing custom configuration for the {identity_service}.

I moved the text above the code block.

Jira: https://redhat.atlassian.net/browse/OSPRH-19963
Signed-off-by: Andre Aranha <afariasa@redhat.com>
Co-authored-by: Grzegorz Grasza <xek@redhat.com>
@openshift-ci openshift-ci Bot removed the lgtm label Jun 4, 2026

@afaranha afaranha left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all feedback applied

@klgill klgill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@vakwetu

vakwetu commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

/approve

@jistr jistr added the approved label Jun 5, 2026
@openshift-ci

openshift-ci Bot commented Jun 5, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: vakwetu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot
openshift-merge-bot Bot merged commit f00c5db into openstack-k8s-operators:main Jun 5, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants