Automate Keycloak version replacement
bnallapeta opened this issue · comments
Before reporting an issue
- I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.
Area
docs
Describe the bug
The current keycloak.yaml file in the Keycloak getting started guide for kubernetes contains a placeholder for $$VERSION$$ that users need to manually replace with the actual version of Keycloak they wish to deploy. This requires manual intervention and could lead to errors or the deployment of outdated versions if not replaced correctly.
Version
All versions
Expected behavior
The deployment process should be automated such that the $$VERSION$$ placeholder in the keycloak.yaml file is dynamically replaced with the latest Keycloak version available from the official releases. This should happen as part of the command used to deploy Keycloak to Kubernetes, without requiring users to manually edit the file.
Actual behavior
Currently, the user must manually find the latest Keycloak version, edit the keycloak.yaml file, and replace the $$VERSION$$ placeholder before applying the file with kubectl.
How to Reproduce?
Check the steps listed in https://www.keycloak.org/getting-started/getting-started-kube
Anything else?
Proposed keycloak/keycloak#24521 as a potential fix for this issue.
We should probably update the quickstart so it doesn't include the $$VERSION$$ placeholder at all in the latest branch.
@vmuzikar What should we replace $$VERSION$$ with? If we simply use the current latest version (21.0.5), we would need to constantly update this file with each new release.
I don't see any release specific Github workflow to automate this too. If that was part of the setup, we probably could have added a step to auto-update the version with each release.
The latest branch is updated automatically (e.g. versions in POMs) with each new release. And looks like we're already setting the version in yamls too, set-version.sh which is called during the release process.
Not sure what's happening there, we need to investigate.
@vmuzikar I think its probably because of the lack of escape character? In the PR I had submitted, I have used the escape character for $ and it works. Should I raise a PR with that change?
@bnallapeta Possibly yes, but I haven't had time yet to investigate deeper. A PR would be most welcome! :)
Closing as it is fixed already. (@vmuzikar The issues are not automatically closed when merged PR, which is likely something to fix at GH actions).