Add images and new adoc files about client secret rotation #1449

marcelomrwin · 2022-03-29T17:28:57Z

andymunro · 2022-03-29T20:13:12Z

@marcelomrwin
One initiial question is if the focus should be on the new Admin Console because that will be the default console at Keycloak 19. However, this feature may not be in the new console yet. @ssilvert would know. If we need both and it is on both consoles, these are the codes for the two consoles.

ifeval::["{kc_dist}" == "quarkus"]

endif::[]

ifeval::["{kc_dist}" == "wildfly"]

endif::[]

Actually, I believe we are not publishing a version of the Server Administrator Guide with WildFly-based content. @stianst will know.

server_admin/topics/clients/oidc/con-secret-rotation.adoc

server_admin/topics/clients/oidc/proc-secret-rotation.adoc

andymunro

Looks good, @marcelomrwin. I have a few changes to suggest.

mposolda

@marcelomrwin Thanks for the docs Marcelo and thanks for adding the example! Looks nice to me.

I've added few comments inline. Besides that, there are few more places, which should be updated:

profiles.adoc - The profile page of the "Server Installation guide" - the client secret rotation should be listed here as the preview feature
Release notes ( release-notes/topics/18_0_0.adoc) : The client secret rotiation worth to be mentioned here in the release notes as preview feature similar to for example "Recovery codes" .

server_admin/topics/clients/oidc/con-secret-rotation.adoc

marcelomrwin · 2022-04-11T15:52:37Z

One initiial question is if the focus should be on the new Admin Console because that will be the default console at Keycloak 19. However, this feature may not be in the new console yet. @ssilvert would know. If we need both and it is on both consoles, these are the codes for the two consoles.

ifeval::["{kc_dist}" == "quarkus"]

endif::[]

ifeval::["{kc_dist}" == "wildfly"]

endif::[]

Actually, I believe we are not publishing a version of the Server Administrator Guide with WildFly-based content. @stianst will know.

Hi @andymunro, All features were developed taking into account only the traditional UI. There is a team working to perform the migration to the new UI.

…-about-client-secret-rotation

mposolda · 2022-04-13T17:05:29Z

@marcelomrwin Thanks for the update. I have 2 points:

Release notes is still missing. You can update them in this file: https://github.com/keycloak/keycloak-documentation/blob/main/release_notes/topics/18_0_0.adoc . TIP: I suggest to add them at the beginning of this file to avoid conflicts with Doug's PR :-) That one is here fyi: [CIAM-2134] Documentation for session-limits-feature #1467
I see some test failures and looks they are regression of this PR. I guess that you can just move the image files to this directory "images" instead of "keycloak-images" : https://github.com/keycloak/keycloak-documentation/tree/main/server_admin/images . The directory "keycloak-images" is only for images, which contains keycloak logo in the header. They need to have special / different version in the "rhsso-images" where they need to have RH-SSO logo.
Since your images don't have logo, the "images" directory should be fine.

release_notes/topics/18_0_0.adoc

…-about-client-secret-rotation

mposolda

@marcelomrwin Thanks for the fix!

Add images and new adoc files about client secret rotation

c6808ab

marcelomrwin requested a review from andymunro March 29, 2022 17:29