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] Include image.tag value in Keycloak README.md #31474

Closed
wants to merge 1 commit into from

Conversation

EddyMM
Copy link

@EddyMM EddyMM commented Jan 20, 2025

Description of the change

Explicitly mention in the README.md that the image tag for a custom Keycloak image can be specified using the image.tag value.

Including the tag in the image.repository value results in the helm chart's image.tag value overwriting it.

Without Tag:

image:
  repository: docker.io/../custom-keycloak:26.1.0

Helm Diff:

image: docker.io/.../custom-keycloak:26.1.0-debian-12-r0

With Tag:

image:
  repository: docker.io/../custom-keycloak
  tag: 26.1.0

Helm Diff:

image: docker.io/.../custom-keycloak:26.1.0

Benefits

  • Consumers of bitnami/keycloak will know which image value to use to specify (tag in this case) for the custom keycloak image they're using

Additional information

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)

Explicitly mention in the README.md that the image tag for a custom Keycloak image can be specified using the `image.tag` value.

Including the tag in the `image.repository` value results in the helm chart's `image.tag` value overwriting it.

Signed-off-by: Eddy Mwiti <[email protected]>
@github-actions github-actions bot added keycloak triage Triage is needed labels Jan 20, 2025
@github-actions github-actions bot requested a review from carrodher January 20, 2025 09:03
@EddyMM EddyMM marked this pull request as ready for review January 20, 2025 09:23
@carrodher
Copy link
Member

The image.tag field is omitted from the table with all the parameters on purpose to standardize the README for other products like Tanzu Application Catalog where those tags can point to different distros and not only Debian 12, see #19841.

@EddyMM
Copy link
Author

EddyMM commented Jan 20, 2025

Thanks for clarifying @carrodher . Is there any other documentation for someone to discover the image.tag if not from the README?

@carrodher
Copy link
Member

carrodher commented Jan 20, 2025

All parameters are defined in the values.yaml, which provides a short explanation; see

## @skip image.tag Keycloak image tag (immutable tags are recommended)

In fact, that's the metadata used to autogenerate the table that appears in the README, so the information is the same.

@EddyMM
Copy link
Author

EddyMM commented Jan 20, 2025

Got it, thanks Carlos.

@EddyMM EddyMM closed this Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants