utils

Documentation

Index

• Constants
• func AddRoleToSubject(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, ...) error
• func DeleteRoleFromSubject(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, ...) error
• func ExtractEndpointFromSpec(r *BaseReconciler, ctx context.Context, spec v1alpha2.KeycloakEndpointSpec, ...) (*gocloak.GoCloak, string, error)
• func GetSubjectID(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient string, ...) (string, error)
• func GetSubjectRoles(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, ...) ([]*gocloak.Role, error)
• func HandleError(err error) (ctrl.Result, error)
• func HasFinalizer(i client.Object) bool
• func IgnoreNotFound(err error) error
• func IsConfigMapEmpty(cm *api.ConfigMapValue) bool
• func IsNotFound(err error) (*gocloak.APIError, bool)
• func MarkedAsDeleted(i client.Object) bool
• func NoFinalizer(i client.Object) bool
• func Now() *metav1.Time
• func Unwrap[T any](v *T) T
• type ApiHelper
  • func (api *ApiHelper) AlreadyDeleted() error
  • func (api *ApiHelper) Created() error
  • func (api *ApiHelper) Deleted() error
  • func (api *ApiHelper) Error(action, text string, err error) error
  • func (api *ApiHelper) EventUpdate(changelog diff.Changelog)
  • func (api *ApiHelper) NoChange() error
  • func (api *ApiHelper) Updated() error
  • func (api *ApiHelper) Waiting(text string) error
• type BaseReconciler
  • func NewReconciler(mgr ctrl.Manager) BaseReconciler
  • func (r *BaseReconciler) Api(ctx context.Context, i Object) *ApiHelper
  • func (r *BaseReconciler) AppendFinalizer(ctx context.Context, i client.Object) error
  • func (r *BaseReconciler) AppendOwnerReferences(ctx context.Context, i, owner client.Object) error
  • func (r *BaseReconciler) CustomPatch(ctx context.Context, i client.Object, key, value, previous string) error
  • func (r *BaseReconciler) ExtractEndpoint(ctx context.Context, i Object) (*gocloak.GoCloak, string, error)
  • func (r *BaseReconciler) RemoveFinalizer(ctx context.Context, i client.Object) error
  • func (r *BaseReconciler) SyncLDAP(ctx context.Context, gc *gocloak.GoCloak, token string, i Object, ...) error
• type LDAPSync
• type NoReschedule
  • func (nr NoReschedule) Error() string
  • func (nr NoReschedule) Is(err error) bool
• type Object
• type Reconciler
• type Reschedule
  • func (r Reschedule) Error() string
  • func (r Reschedule) Is(err error) bool

Constants

const DEFAULT_ALLOW_RULE = "default-allow-rule"

const FORBIDDEN = "Forbidden"

Functions

func AddRoleToSubject

func AddRoleToSubject(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, subject api.Subject, role gocloak.Role) error

func DeleteRoleFromSubject

func DeleteRoleFromSubject(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, subject api.Subject, role gocloak.Role) error

func ExtractEndpointFromSpec

func ExtractEndpointFromSpec(r *BaseReconciler, ctx context.Context, spec v1alpha2.KeycloakEndpointSpec, ns string) (*gocloak.GoCloak, string, error)

func GetSubjectID

func GetSubjectID(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient string, subject api.Subject) (string, error)

func GetSubjectRoles

func GetSubjectRoles(ctx context.Context, gc *gocloak.GoCloak, token, realm, idOfClient, sid string, subject api.Subject) ([]*gocloak.Role, error)

func HandleError

func HandleError(err error) (ctrl.Result, error)

func HasFinalizer

func HasFinalizer(i client.Object) bool

func IgnoreNotFound

func IgnoreNotFound(err error) error

func IsConfigMapEmpty

func IsConfigMapEmpty(cm *api.ConfigMapValue) bool

func IsNotFound

func IsNotFound(err error) (*gocloak.APIError, bool)

func MarkedAsDeleted

func MarkedAsDeleted(i client.Object) bool

func NoFinalizer

func NoFinalizer(i client.Object) bool

func Now

func Now() *metav1.Time

func Unwrap

func Unwrap[T any](v *T) T

Types

type ApiHelper

type ApiHelper struct {
	*BaseReconciler
	Context context.Context
	Object  Object
}

A api to manage log/event/status related to keycloak API resources.

func (*ApiHelper) AlreadyDeleted

func (api *ApiHelper) AlreadyDeleted() error

func (*ApiHelper) Created

func (api *ApiHelper) Created() error

func (*ApiHelper) Deleted

func (api *ApiHelper) Deleted() error

func (*ApiHelper) Error

func (api *ApiHelper) Error(action, text string, err error) error

func (*ApiHelper) EventUpdate

func (api *ApiHelper) EventUpdate(changelog diff.Changelog)

func (*ApiHelper) NoChange

func (api *ApiHelper) NoChange() error

func (*ApiHelper) Updated

func (api *ApiHelper) Updated() error

func (*ApiHelper) Waiting

func (api *ApiHelper) Waiting(text string) error

type BaseReconciler

type BaseReconciler struct {
	client.Client
	Scheme *runtime.Scheme
	record.EventRecorder
}

func NewReconciler

func NewReconciler(mgr ctrl.Manager) BaseReconciler

func (*BaseReconciler) Api

func (r *BaseReconciler) Api(ctx context.Context, i Object) *ApiHelper

func (*BaseReconciler) AppendFinalizer

func (r *BaseReconciler) AppendFinalizer(ctx context.Context, i client.Object) error

Append the finalizer to the object

func (*BaseReconciler) AppendOwnerReferences

func (r *BaseReconciler) AppendOwnerReferences(ctx context.Context, i, owner client.Object) error

func (*BaseReconciler) CustomPatch

func (r *BaseReconciler) CustomPatch(ctx context.Context, i client.Object, key, value, previous string) error

func (*BaseReconciler) ExtractEndpoint

func (r *BaseReconciler) ExtractEndpoint(ctx context.Context, i Object) (*gocloak.GoCloak, string, error)

Extract the endpoint, but deal with several kind of errors

func (*BaseReconciler) RemoveFinalizer

func (r *BaseReconciler) RemoveFinalizer(ctx context.Context, i client.Object) error

func (*BaseReconciler) SyncLDAP

func (r *BaseReconciler) SyncLDAP(ctx context.Context, gc *gocloak.GoCloak, token string, i Object, ldap LDAPSync) error

type LDAPSync

type LDAPSync struct {
	Changed      bool
	Realm        string
	FederationID string
}

type NoReschedule

type NoReschedule struct{}

A wrapper for errors that should not retrigger the reconciler.

func (NoReschedule) Error

func (nr NoReschedule) Error() string

func (NoReschedule) Is

func (nr NoReschedule) Is(err error) bool

type Object

type Object interface {
	client.Object
	ApiStatus() *api.ApiStatus
	Endpoint() api.EndpointSelector
	Realm() string
}

type Reconciler

type Reconciler interface {
	BaseReconciler
}

type Reschedule

type Reschedule struct {
	RequeueAfter time.Duration
}

func (Reschedule) Error

func (r Reschedule) Error() string

func (Reschedule) Is

func (r Reschedule) Is(err error) bool