controllers

Documentation

Index

• type KeycloakClient
• type OrganizationReconciler
  • func (r *OrganizationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *OrganizationReconciler) SetupWithManager(mgr ctrl.Manager) error
• type PeriodicSyncer
  • func (r *PeriodicSyncer) Sync(ctx context.Context) error
• type TeamReconciler
  • func (r *TeamReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *TeamReconciler) SetupWithManager(mgr ctrl.Manager) error
• type UserReconciler
  • func (r *UserReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *UserReconciler) SetupWithManager(mgr ctrl.Manager) error

Types

type KeycloakClient

type KeycloakClient interface {
	PutGroup(ctx context.Context, group keycloak.Group) (keycloak.Group, error)
	DeleteGroup(ctx context.Context, path ...string) error
	ListGroups(ctx context.Context) ([]keycloak.Group, error)

	PutUser(ctx context.Context, user keycloak.User) (keycloak.User, error)
}

KeycloakClient is an abstraction to interact with the Keycloak API

type OrganizationReconciler

type OrganizationReconciler struct {
	client.Client
	Recorder record.EventRecorder
	Scheme   *runtime.Scheme

	Keycloak KeycloakClient
}

OrganizationReconciler reconciles a Organization object

func (*OrganizationReconciler) Reconcile

func (r *OrganizationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile reacts on changes of Organizations and OrganizationMembers and mirrors these changes to groups in Keycloak

func (*OrganizationReconciler) SetupWithManager

func (r *OrganizationReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type PeriodicSyncer

type PeriodicSyncer struct {
	client.Client
	Recorder record.EventRecorder

	Keycloak KeycloakClient

	// SyncClusterRoles to give to group members when importing
	SyncClusterRoles           []string
	SyncClusterRolesUserPrefix string
}

PeriodicSyncer reconciles a Organization object

func (*PeriodicSyncer) Sync

func (r *PeriodicSyncer) Sync(ctx context.Context) error

Sync lists all Keycloak groups in the realm and creates corresponding Organizations if they do not exist

type TeamReconciler

type TeamReconciler struct {
	client.Client
	Recorder record.EventRecorder
	Scheme   *runtime.Scheme

	Keycloak KeycloakClient
}

TeamReconciler reconciles a Team object

func (*TeamReconciler) Reconcile

func (r *TeamReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile reacts on changes of teams and mirrors these changes to groups in Keycloak

func (*TeamReconciler) SetupWithManager

func (r *TeamReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type UserReconciler

type UserReconciler struct {
	client.Client
	Recorder record.EventRecorder
	Scheme   *runtime.Scheme

	Keycloak KeycloakClient
}

UserReconciler reconciles a User object

func (*UserReconciler) Reconcile

func (r *UserReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile reacts on changes of users and mirrors these changes to Keycloak

func (*UserReconciler) SetupWithManager

func (r *UserReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.