Initial CR creation assistance for onboarding the use of the operator

[Cinderhaze]

Is your feature request related to a problem? Please describe.
When onboarding to the edp-keycloak-operator, There is a lot of detail that needs to be translated into CRs to describe our keycloak realms.. Some additional tooling could help initially onboard from a UI based approach to a CRD/gitOps approach.

Describe the solution you'd like
Helm chart with pre-formated setup to populate a set of files similar to the keycloak wizard for creating a realm/client.
or
Utility/script turn a realm-export into an equivalent set of CRs to aid the initial setup/conversion to using the edp-keycloak-operator
or
Utility/script to look at a specified realm and it's contents on a given keycloakRef and generate the CRs describing what is in keycloak

Are there any existing solutions to help with initial onboarding? If so, can they be added as a reference to the documentation somewhere?

[Cinderhaze]

I think a similar request is in a comment to issue 88 -> #88 (comment)

That is requesting a helm template to describe the CRs that they can use across different installations.

[daniil-nedostup]

Hi @Cinderhaze!

Thank you for the detailed description of the problem.

Unfortunately, I'm not aware of any existing tools or scripts that can automatically convert Keycloak resources created manually via the UI into Custom Resources compatible with the edp-keycloak-operator.

However, I can suggest a Helm-based approach, which was also mentioned in issue #88 (comment). We recommend using the edp-cluster-add-ons repository to store and manage Keycloak resources in a structured and automated way. This repository contains a collection of Helm charts that can be deployed via helm install or kubectl apply commands, or with Argo CD - eliminating the need to apply each CR manually.

For Keycloak-specific resources, we use the kuberocketci-rbac chart, which includes all the necessary Keycloak resources required for the proper operation of the KubeRocketCI platform. You can refer to this chart as an example. It is installed right after the Keycloak instance and edp-keycloak-operator are deployed, so there is no need to apply individual resources one by one manually.

You're welcome to reuse the kuberocketci-rbac chart to manage your own Keycloak resources. Alternatively, you can create your own Helm chart in a separate repository to store and apply them in a GitOps-friendly way - without the need to manage each CR manually.

Let us know if this approach could work for your case!