Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update deprecated keycloak admin deprecated env variables: https://ww… #75279

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

singatias
Copy link

@singatias singatias commented Nov 27, 2024

Screenshot 2024-11-26 at 16 40 05

Description of the change

Minor changes to change KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD environment and secret variables to update to the new values KC_BOOTSTRAP_ADMIN_USERNAME, KC_BOOTSTRAP_ADMIN_PASSWORD

Benefits

remove the deprecation message and reduce the upcoming maintenance when the env variables are removed

Possible drawbacks

could be confusing for people who update the container and don't pay attention to the env variable changes

Applicable issues

none

Additional information

I noticed the deprecation messages on my new instance of Keycloak and decided to make the changes since they were minor

Related chart PR: bitnami/charts#30636

@singatias singatias force-pushed the feature/keycloak-admin-envs-deprecation-patch branch from 9f878fd to 5033367 Compare November 27, 2024 20:38
@singatias singatias marked this pull request as ready for review November 27, 2024 20:38
@carrodher carrodher added verify Execute verification workflow for these changes in-progress labels Nov 28, 2024
@github-actions github-actions bot removed the triage Triage is needed label Nov 28, 2024
@github-actions github-actions bot removed the request for review from carrodher November 28, 2024 07:49
@github-actions github-actions bot requested a review from migruiz4 November 28, 2024 07:49
@migruiz4
Copy link
Member

migruiz4 commented Nov 29, 2024

Hi @singatias, thank you for your contribution!

The changes looks good to me with some suggestions, but we need to wait until Keycloak 25.x is removed from our catalog order in order to merge these changes.

That is the reason why our CI pipeline fails, since those new variables are only supported on Keycloak 26.x.

My request for this code review:

  • Please remove your changes from the keycloak/25 folder to avoid future conflicts when it is removed soon.
  • Please add a note under the Notable Changes section in the README
  • Additionally, add a warning under the keycloak_validate section to warn users that still use the deprecated env variables.
keycloak_validate() {
    ...
    [[ -n "${KEYCLOAK_ADMIN:-}" || -n "${KEYCLOAK_ADMIN_USER:-}" ]] && warn "The KEYCLOAK_ADMIN environment variable has been removed, please use KC_BOOTSTRAP_ADMIN_USERNAME instead."
    [[ -n "${KEYCLOAK_ADMIN_PASSWORD:-}" ]] && warn "The KEYCLOAK_ADMIN environment variable has been removed, please use KC_BOOTSTRAP_ADMIN_PASSWORD instead."

Update readme notables changes and envrionment variables

Signed-off-by: Mathias Beaulieu-Duncan <[email protected]>
@singatias
Copy link
Author

Hi @singatias, thank you for your contribution!

The changes looks good to me with some suggestions, but we need to wait until Keycloak 25.x is removed from our catalog order in order to merge these changes.

That is the reason why our CI pipeline fails, since those new variables are only supported on Keycloak 26.x.

My request for this code review:

  • Please remove your changes from the keycloak/25 folder to avoid future conflicts when it is removed soon.
  • Please add a note under the Notable Changes section in the README
  • Additionally, add a warning under the keycloak_validate section to warn users that still use the deprecated env variables.
keycloak_validate() {
    ...
    [[ -n "${KEYCLOAK_ADMIN:-}" || -n "${KEYCLOAK_ADMIN_USER:-}" ]] && warn "The KEYCLOAK_ADMIN environment variable has been removed, please use KC_BOOTSTRAP_ADMIN_USERNAME instead."
    [[ -n "${KEYCLOAK_ADMIN_PASSWORD:-}" ]] && warn "The KEYCLOAK_ADMIN environment variable has been removed, please use KC_BOOTSTRAP_ADMIN_PASSWORD instead."

Thank you for guiding me. Let me know if there is anything else :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in-progress keycloak verify Execute verification workflow for these changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants