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

[bitnami/keycloak] Update KEYCLOAK_ADMIN env variables deprecation #30636

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

Conversation

singatias
Copy link

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 deprecation message and reduce the upcoming maintenance when the env variables will be removed

Possible drawbacks

the new variables env could be invalid on a an older keycloak image

Applicable issues

none

Additional information

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

I could be wrong about bumping the major version of the chart, but technically, if someone upgrades their Keycloak instance using an older overridden version of the Keycloak image from before the environment variables were changed, it could be defective. Let me know if this need to be change or feel free to edit it before merging.

Checklist

  • Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
  • Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
  • Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
  • All commits signed off and in agreement of Developer Certificate of Origin (DCO)

Environment variable 'KEYCLOAK_ADMIN' is deprecated, use 'KC_BOOTSTRAP_ADMIN_USERNAME' instead

Environment variable 'KEYCLOAK_ADMIN_PASSWORD' is deprecated, use 'KC_BOOTSTRAP_ADMIN_PASSWORD' instead

Bump major version

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

Sorry, duplicate of #30635, it was starting to get messy for such small changes

Signed-off-by: Bitnami Containers <[email protected]>
@javsalgar javsalgar added verify Execute verification workflow for these changes in-progress labels Nov 27, 2024
@github-actions github-actions bot removed the triage Triage is needed label Nov 27, 2024
@github-actions github-actions bot removed the request for review from javsalgar November 27, 2024 07:36
@github-actions github-actions bot requested a review from juan131 November 27, 2024 07:36
Signed-off-by: Bitnami Containers <[email protected]>
Copy link
Contributor

@juan131 juan131 left a comment

Choose a reason for hiding this comment

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

Hi @singatias

KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD are the actual values used by the Bitnami Keycloak container image, see:

Why is this change necessary? In case they're necessary due to upstream changes, we should start by adapting the container image 1st.

@singatias
Copy link
Author

Hi @singatias

KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD are the actual values used by the Bitnami Keycloak container image, see:

* https://github.com/bitnami/containers/blob/main/bitnami/keycloak/26/debian-12/rootfs/opt/bitnami/scripts/keycloak-env.sh#L130_L132

Why is this change necessary? In case they're necessary due to upstream changes, we should start by adapting the container image 1st.

Hi @juan131, they are not necessary yet but they are already marked as deprecated so I took proactive decision make the changes. You are correct about making changes for the container image first container PR

https://www.keycloak.org/docs/26.0.6/upgrading/#external-infinispan-in-a-single-site-setup

I'm still new to participate in big open source repository, let me know if there things I can improve on :)

@carrodher carrodher requested a review from migruiz4 November 28, 2024 07:49
@carrodher carrodher assigned migruiz4 and unassigned juan131 Nov 28, 2024
Copy link
Member

@migruiz4 migruiz4 left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution @singatias, could you please take a look at my comment?

bitnami/keycloak/Chart.yaml Outdated Show resolved Hide resolved
singatias and others added 2 commits November 30, 2024 00:31
Signed-off-by: Bitnami Containers <[email protected]>
Copy link

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

@github-actions github-actions bot added the stale 15 days without activity label Dec 16, 2024
juan131
juan131 previously approved these changes Dec 20, 2024
Copy link
Contributor

@juan131 juan131 left a comment

Choose a reason for hiding this comment

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

LGTM

@juan131
Copy link
Contributor

juan131 commented Dec 20, 2024

Sorry @singatias but we lost track of this PR, please ensure you merge the latest changes in the origin's main branch in your fork's branch and then, update the PR. Thanks in advance.

@singatias
Copy link
Author

@juan131 np, thank you for this learning experience

…min-envs-deprecation-patch

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

done :)

Signed-off-by: Bitnami Containers <[email protected]>
@github-actions github-actions bot removed the stale 15 days without activity label Dec 21, 2024
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.

5 participants