September 11 2024 by Thomas Darimont
Three months ago, the Keycloak project conducted a survey to gather insights on realm configuration tooling within our community. The number of responses overwhelmed us! With a total of 433 (!) submissions, it highlighted the diverse range of options our community uses for configuring realms.
Thank You for your valuable feedback!
The survey revealed a variety of tools employed by the community for realm configuration, including:
Self-developed Realm Configuration Management
Custom Operator for Realm Import/Update and Client Provisioning
From the submissions, we observed the following distribution of tool usage among respondents:
Terraform Keycloak Provider ~51% of the votes
Keycloak-Config-CLI ~16% of the votes
Self-developed Realm Configuration Management ~7% of the votes
Keycloak JSON Realm Import/Export ~6% of the votes
Keycloak Admin CLI ~4% of the votes
These top five tools accounted for 84% of all responses.
While each tool has its strengths and weaknesses, the survey highlighted several common challenges:
Using the Admin API can be awkward and inconsistent, for example, with references using IDs versus aliases.
Recognizing changes in the configuration, such as when new roles are added to service accounts via the Admin UI, can be challenging or impossible.
Many tools depend heavily on the Keycloak version used and are often not compatible with new releases.
Managing components that are automatically created by Keycloak, like service accounts, is challenging with existing configuration tools.
Lack of support for configuration linting, validation and code completion
Based on the feedback, here are some key lessons learned and the next steps:
Tool Compatibility: We aim at improving compatibility with newer Keycloak releases to ensure seamless integration.
Admin API Enhancements: We’ll address inconsistencies and usability issues in the Admin API to streamline configuration tasks.
Ease Change Management: Enhance tools and APIs to improve the recognition and change management of realm configurations.
We are committed to addressing these areas and working closely with the community to enhance the realm configuration experience in Keycloak. Your continued feedback and support are invaluable as we move forward. Stay tuned for updates and improvements!
If you have any further questions or suggestions about this blog post, please join the related discussion on GitHub.
Thank you very much for your support!