Skip to content

Add a tutorial to deploy Keycloak in cluster mode#3622

Draft
Frzk wants to merge 11 commits intomasterfrom
feat/keycloak
Draft

Add a tutorial to deploy Keycloak in cluster mode#3622
Frzk wants to merge 11 commits intomasterfrom
feat/keycloak

Conversation

@Frzk
Copy link
Copy Markdown
Contributor

@Frzk Frzk commented Mar 23, 2026

No description provided.

@Frzk Frzk self-assigned this Mar 26, 2026
@EtienneM EtienneM self-requested a review March 26, 2026 13:21
Copy link
Copy Markdown
Member

@EtienneM EtienneM left a comment

Choose a reason for hiding this comment

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

praise: that's great, I don't have much to say about this :)

Comment on lines +72 to +73
This tutorial covers the deployment of Keycloak on Scalingo. Configuring,
managing, and administrating Keycloak is out of the scope of this tutorial.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

suggestion: add a link to the Keycloak documentations for these?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've added some in 660662f

Comment on lines +147 to +151
5. (optional) Create credentials for the initial administrator user:
```bash
scalingo --app my-keycloak env-set KC_BOOTSTRAP_ADMIN_USERNAME=<admin_username>
scalingo --app my-keycloak env-set KC_BOOTSTRAP_ADMIN_PASSWORD=<admin_password>
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

question: what is the admin password if we don't set this? If it's insecure to not set an admin password, I would mark this step as mandatory

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're right, I've made them mandatory (well they technically aren't but they are if you follow the doc) in c57358e

If the user don't create them, Keycloak will ask them to create one... but the interface is only available on localhost. So it won't work.


- Review the official changelog that is published with each release. Breaking
and notable changes should catch your attention.
- Ensure your SPIs and themes are compatible with the new version.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

question: what is a SPI?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've added a link to the little explanation we have in ffd9547

Moreover, the buildpack makes use of the following environment variables. They
can be leveraged to customize your deployment:

- `KEYCLOAK_VERSION`\\
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

question: that makes me think: do we have a NewReleases configuration to track Keycloak releases?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't think so.
Actually, updating the default version in the buildpack is something I'd like to automate through GitHub Action.
In the meantime, and until it's done, you're right, let's add it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants