Skip to content

Add ability to specify multiple Keycloak client templates #49

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.

Sign up for GitHub

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

Open
HappyTetrahedron wants to merge 3 commits into from
Open

Add ability to specify multiple Keycloak client templates #49

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17d5bea
Add ability to specify multiple Keycloak clients
HappyTetrahedron Aug 28, 2026
970e1f6
Update Vault path for OIDC client secrets
HappyTetrahedron Aug 31, 2026
de09567
Code review improvements
HappyTetrahedron Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 90 additions & 46 deletions controllers/cluster_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,23 +106,58 @@ func (r *ClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
}

// Create or updated client
templatedClient, err := r.templateKeycloakClient(jvm)
templatedClients, err := r.templateKeycloakClient(jvm)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to template keycloak client: %w", err)
return ctrl.Result{}, fmt.Errorf("unable to template keycloak clients: %w", err)
}
// template client roles
rolesRaw, err := jvm.EvaluateFile(r.ClientRoleMappingTemplateFile)

@bastjan bastjan Sep 10, 2026

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.

We probably could pass the templated client while evaluating the roles so we can have different mappings for different clients.

@HappyTetrahedron HappyTetrahedron Sep 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Smart. I hope it's ok to reuse the JVM the way I did?

if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to evaluate client-roles jsonnet: %w", err)
}
var templatedRoles []roleMapping
if err := json.Unmarshal([]byte(rolesRaw), &templatedRoles); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to unmarshal client-roles jsonnet result: %w", err)
}
slices.SortFunc(templatedRoles, func(a, b roleMapping) int {
return strings.Compare(a.Role, b.Role)*10 + strings.Compare(a.Group, b.Group)
})
templatedRoles = slices.Compact(templatedRoles)

errors := []error{}
requeue := false
for _, templatedClient := range templatedClients {
req, err := r.updateSingleClient(ctx, templatedClient, templatedRoles, instance, token)
if err != nil {
errors = append(errors, err)
}
requeue = req || requeue
}

if len(errors) > 0 {
return ctrl.Result{}, multierr.Combine(errors...)
}

if requeue {
return ctrl.Result{RequeueAfter: time.Minute}, nil
}
return ctrl.Result{}, nil
}

func (r ClusterReconciler) updateSingleClient(ctx context.Context, templatedClient gocloak.Client, templatedRoles []roleMapping, instance *lieutenantv1alpha1.Cluster, token *gocloak.JWT) (requeue bool, err error) {
l := log.FromContext(ctx).WithName("ClusterReconciler.updateSingleClient")
client, err := r.findClientByClientId(ctx, token.AccessToken, r.KeycloakRealm, *templatedClient.ClientID)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to get client: %w", err)
return false, fmt.Errorf("unable to get client: %w", err)
}
if client == nil {
l.Info("Client not found, creating", "client", templatedClient)
id, err := r.KeycloakClient.CreateClient(ctx, token.AccessToken, r.KeycloakRealm, templatedClient)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to create client: %w", err)
return false, fmt.Errorf("unable to create client: %w", err)
}
l.Info("Client created, requeuing", "id", id)
return ctrl.Result{Requeue: true}, nil
return true, nil
}

l.Info("Client found, updating", "client", client.ID)
Expand All @@ -134,57 +169,42 @@ func (r *ClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
}, r.KeycloakClientIgnorePaths...)
patch, err := jsondiff.Compare(client, templatedClient, jsondiff.Ignores(ignores...))
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to compare existing and templated clients: %w", err)
return false, fmt.Errorf("unable to compare existing and templated clients: %w", err)
}
if len(patch) == 0 {
l.Info("No changes to the client detected")
} else {
l.Info("Updating client", "changes", patch)
if err := r.KeycloakClient.UpdateClient(ctx, token.AccessToken, r.KeycloakRealm, templatedClient); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to update client: %w", err)
return false, fmt.Errorf("unable to update client: %w", err)
}
}

client, err = r.findClientByClientId(ctx, token.AccessToken, r.KeycloakRealm, *templatedClient.ClientID)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to get client after creation or updating: %w", err)
return false, fmt.Errorf("unable to get client after creation or updating: %w", err)
}
if client == nil {
return ctrl.Result{}, fmt.Errorf("client %q not found after creation or updating", *templatedClient.ClientID)
return false, fmt.Errorf("client %q not found after creation or updating", *templatedClient.ClientID)
}

// Vault secret
if client.Secret != nil && *client.Secret != "" {
if err := r.syncVaultSecret(ctx, instance, *client.Secret); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to sync vault secret: %w", err)
if err := r.syncVaultSecret(ctx, instance, *templatedClient.ClientID, *client.Secret); err != nil {
return false, fmt.Errorf("unable to sync vault secret: %w", err)
}
} else {
l.Info("Client has no secret, might be a public client. Skipping vault secret sync.")
}

// template client roles
rolesRaw, err := jvm.EvaluateFile(r.ClientRoleMappingTemplateFile)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to evaluate client-roles jsonnet: %w", err)
}
var templatedRoles []roleMapping
if err := json.Unmarshal([]byte(rolesRaw), &templatedRoles); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to unmarshal client-roles jsonnet result: %w", err)
}
slices.SortFunc(templatedRoles, func(a, b roleMapping) int {
return strings.Compare(a.Role, b.Role)*10 + strings.Compare(a.Group, b.Group)
})
templatedRoles = slices.Compact(templatedRoles)

if err := r.syncClientRoles(ctx, token.AccessToken, *client.ID, templatedRoles); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to sync client roles: %w", err)
return false, fmt.Errorf("unable to sync client roles: %w", err)
}

if err := r.syncClientRoleGroupMappings(ctx, token.AccessToken, *client.ID, templatedRoles); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to sync client role group mappings: %w", err)
return false, fmt.Errorf("unable to sync client role group mappings: %w", err)
}

return ctrl.Result{}, nil
return false, nil
}

// SetupWithManager sets up the controller with the Manager.
Expand All @@ -195,15 +215,14 @@ func (r *ClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
}

func (r *ClusterReconciler) cleanupClient(ctx context.Context, instance *lieutenantv1alpha1.Cluster) (err error) {
l := log.FromContext(ctx).WithName("ClusterReconciler.cleanup")

jvm, err := r.jsonnetVMWithContext(instance)
if err != nil {
return fmt.Errorf("unable to create jsonnet vm: %w", err)
}

// call into jsonnet to get the templated client id
templatedClient, err := r.templateKeycloakClient(jvm)
templatedClients, err := r.templateKeycloakClient(jvm)
if err != nil {
return fmt.Errorf("unable to template keycloak client: %w", err)
}
Expand All @@ -218,6 +237,22 @@ func (r *ClusterReconciler) cleanupClient(ctx context.Context, instance *lieuten
}
}()

errors := []error{}
for _, templatedClient := range templatedClients {
err := r.cleanupSingleClient(ctx, instance, templatedClient, token)
if err != nil {
errors = append(errors, err)
}
}

if len(errors) > 0 {
return multierr.Combine(errors...)
}
return nil
}

func (r *ClusterReconciler) cleanupSingleClient(ctx context.Context, instance *lieutenantv1alpha1.Cluster, templatedClient gocloak.Client, token *gocloak.JWT) error {
l := log.FromContext(ctx).WithName("ClusterReconciler.cleanupSingleClient")
client, err := r.findClientByClientId(ctx, token.AccessToken, r.KeycloakRealm, *templatedClient.ClientID)
if err != nil {
return fmt.Errorf("unable to get client: %w", err)
Expand All @@ -236,12 +271,11 @@ func (r *ClusterReconciler) cleanupClient(ctx context.Context, instance *lieuten
if err != nil {
return fmt.Errorf("unable to login to vault: %w", err)
}
secretPath := vaultSecretPath(instance)
secretPath := vaultSecretPath(instance, *templatedClient.ClientID)
mountPath := vault.WithMountPath(r.VaultKvPath)
if _, err := r.VaultSecretsClient.KvV2Delete(ctx, secretPath, mountPath, tokenAuth); err != nil {
return fmt.Errorf("unable to delete vault secret: %w", err)
}

return nil
}

Expand Down Expand Up @@ -399,19 +433,29 @@ func (r *ClusterReconciler) jsonnetVMWithContext(instance *lieutenantv1alpha1.Cl
return jvm, nil
}

func (r *ClusterReconciler) templateKeycloakClient(jvm *jsonnet.VM) (gocloak.Client, error) {
func (r *ClusterReconciler) templateKeycloakClient(jvm *jsonnet.VM) ([]gocloak.Client, error) {
cRaw, err := jvm.EvaluateFile(r.ClientTemplateFile)
if err != nil {
return gocloak.Client{}, fmt.Errorf("unable to evaluate jsonnet: %w", err)
}
var c gocloak.Client
if err := json.Unmarshal([]byte(cRaw), &c); err != nil {
return c, fmt.Errorf("unable to unmarshal `cluster` jsonnet result: %w", err)
return []gocloak.Client{}, fmt.Errorf("unable to evaluate jsonnet: %w", err)
}
var cs []gocloak.Client
if err := json.Unmarshal([]byte(cRaw), &cs); err != nil {

@bastjan bastjan Sep 10, 2026

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.

While good enough this could be done slightly nicer with jsontext.Decoder.PeekKind().

@HappyTetrahedron HappyTetrahedron Sep 22, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

This necessitated an update to go 1.27, I hope I did that right

// Fallback: Try parsing as a single client
var c gocloak.Client
if ierr := json.Unmarshal([]byte(cRaw), &c); ierr != nil {
return []gocloak.Client{}, fmt.Errorf("unable to unmarshal `cluster` jsonnet result: %w", multierr.Combine(err, ierr))
}
if c.ClientID == nil || *c.ClientID == "" {
return []gocloak.Client{}, fmt.Errorf("invalid cluster template: `clientId` is empty")
}
return []gocloak.Client{c}, nil
}
if c.ClientID == nil || *c.ClientID == "" {
return c, fmt.Errorf("invalid cluster template: `clientId` is empty")
for i, c := range cs {
if c.ClientID == nil || *c.ClientID == "" {
return []gocloak.Client{}, fmt.Errorf("invalid cluster template: `clientId` is empty at position %d", i)
}
}
return c, nil
return cs, nil
}

func (r *ClusterReconciler) vaultRequestToken(ctx context.Context) (vault.RequestOption, error) {
Expand All @@ -430,18 +474,18 @@ func (r *ClusterReconciler) vaultRequestToken(ctx context.Context) (vault.Reques
return vault.WithToken(tres.Auth.ClientToken), nil
}

func vaultSecretPath(instance *lieutenantv1alpha1.Cluster) string {
return path.Join(instance.Spec.TenantRef.Name, instance.Name, "keycloak", "oidcClient")
func vaultSecretPath(instance *lieutenantv1alpha1.Cluster, secretIdentifier string) string {
return path.Join(instance.Spec.TenantRef.Name, instance.Name, "keycloak", "oidcClients", secretIdentifier)
}

func (r *ClusterReconciler) syncVaultSecret(ctx context.Context, instance *lieutenantv1alpha1.Cluster, secret string) error {
func (r *ClusterReconciler) syncVaultSecret(ctx context.Context, instance *lieutenantv1alpha1.Cluster, identifier string, secret string) error {
l := log.FromContext(ctx).WithName("ClusterReconciler.syncVaultSecret")

tokenAuth, err := r.vaultRequestToken(ctx)
if err != nil {
return fmt.Errorf("unable to login to vault: %w", err)
}
secretPath := vaultSecretPath(instance)
secretPath := vaultSecretPath(instance, identifier)
mountPath := vault.WithMountPath(r.VaultKvPath)

var existingSecret string
Expand Down
Loading
Loading