This repository has been archived by the owner on Nov 16, 2022. It is now read-only.
/
keycloakclient_controller.go
250 lines (212 loc) · 8.05 KB
/
keycloakclient_controller.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
package keycloakclient
import (
"context"
"fmt"
"time"
"github.com/keycloak/keycloak-operator/pkg/apis/keycloak/v1alpha1"
kc "github.com/keycloak/keycloak-operator/pkg/apis/keycloak/v1alpha1"
"github.com/keycloak/keycloak-operator/pkg/common"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
var log = logf.Log.WithName("controller_keycloakclient")
const (
ClientFinalizer = "client.cleanup"
RequeueDelayError = 5 * time.Second
ControllerName = "keycloakclient-controller"
)
// Add creates a new KeycloakClient Controller and adds it to the Manager. The Manager will set fields on the Controller
// and Start it when the Manager is Started.
func Add(mgr manager.Manager) error {
return add(mgr, newReconciler(mgr))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager) reconcile.Reconciler {
ctx := context.Background()
ctx, cancel := context.WithCancel(ctx)
return &ReconcileKeycloakClient{
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
cancel: cancel,
context: ctx,
recorder: mgr.GetEventRecorderFor(ControllerName),
}
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(ControllerName, mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for changes to primary resource KeycloakClient
err = c.Watch(&source.Kind{Type: &kc.KeycloakClient{}}, &handler.EnqueueRequestForObject{})
if err != nil {
return err
}
// Make sure to watch the credential secrets
err = c.Watch(&source.Kind{Type: &corev1.Secret{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &kc.KeycloakClient{},
})
if err != nil {
return err
}
return nil
}
// blank assignment to verify that ReconcileKeycloakClient implements reconcile.Reconciler
var _ reconcile.Reconciler = &ReconcileKeycloakClient{}
// ReconcileKeycloakClient reconciles a KeycloakClient object
type ReconcileKeycloakClient struct {
// This client, initialized using mgr.Client() above, is a split client
// that reads objects from the cache and writes to the apiserver
client client.Client
scheme *runtime.Scheme
context context.Context
cancel context.CancelFunc
recorder record.EventRecorder
}
// Reconcile reads that state of the cluster for a KeycloakClient object and makes changes based on the state read
// and what is in the KeycloakClient.Spec
func (r *ReconcileKeycloakClient) Reconcile(request reconcile.Request) (reconcile.Result, error) {
reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
reqLogger.Info("Reconciling KeycloakClient")
// Fetch the KeycloakClient instance
instance := &kc.KeycloakClient{}
err := r.client.Get(context.TODO(), request.NamespacedName, instance)
if err != nil {
if errors.IsNotFound(err) {
// Request object not found, could have been deleted after reconcile request.
// Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
// Return and don't requeue
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, err
}
r.adjustCrDefaults(instance)
// The client may be applicable to multiple keycloak instances,
// process all of them
realms, err := common.GetMatchingRealms(r.context, r.client, instance.Spec.RealmSelector)
if err != nil {
return r.ManageError(instance, err)
}
log.Info(fmt.Sprintf("found %v matching realm(s) for client %v/%v", len(realms.Items), instance.Namespace, instance.Name))
for _, realm := range realms.Items {
keycloaks, err := common.GetMatchingKeycloaks(r.context, r.client, realm.Spec.InstanceSelector)
if err != nil {
return r.ManageError(instance, err)
}
log.Info(fmt.Sprintf("found %v matching keycloak(s) for realm %v/%v", len(keycloaks.Items), realm.Namespace, realm.Name))
for _, keycloak := range keycloaks.Items {
// Get an authenticated keycloak api client for the instance
keycloakFactory := common.LocalConfigKeycloakFactory{}
authenticated, err := keycloakFactory.AuthenticatedClient(keycloak, false)
if err != nil {
return r.ManageError(instance, err)
}
// Compute the current state of the realm
log.Info(fmt.Sprintf("got authenticated client for keycloak at %v", authenticated.Endpoint()))
clientState := common.NewClientState(r.context, realm.DeepCopy(), keycloak)
log.Info(fmt.Sprintf("read client state for keycloak %v/%v, realm %v/%v, client %v/%v",
keycloak.Namespace,
keycloak.Name,
realm.Namespace,
realm.Name,
instance.Namespace,
instance.Name))
err = clientState.Read(r.context, instance, authenticated, r.client)
if err != nil {
return r.ManageError(instance, err)
}
// Figure out the actions to keep the realms up to date with
// the desired state
reconciler := NewKeycloakClientReconciler(keycloak)
desiredState := reconciler.Reconcile(clientState, instance)
actionRunner := common.NewClusterAndKeycloakActionRunner(r.context, r.client, r.scheme, instance, authenticated)
// Run all actions to keep the realms updated
err = actionRunner.RunAll(desiredState)
if err != nil {
return r.ManageError(instance, err)
}
}
}
return reconcile.Result{Requeue: false}, r.manageSuccess(instance, instance.DeletionTimestamp != nil)
}
// Fills the CR with default values. Nils are not acceptable for Kubernetes.
func (r *ReconcileKeycloakClient) adjustCrDefaults(cr *kc.KeycloakClient) {
if cr.Spec.Client.Attributes == nil {
cr.Spec.Client.Attributes = make(map[string]string)
}
if cr.Spec.Client.Access == nil {
cr.Spec.Client.Access = make(map[string]bool)
}
if cr.Spec.Client.AuthenticationFlowBindingOverrides == nil {
cr.Spec.Client.AuthenticationFlowBindingOverrides = make(map[string]string)
}
}
func (r *ReconcileKeycloakClient) manageSuccess(client *kc.KeycloakClient, deleted bool) error {
client.Status.Ready = true
client.Status.Message = ""
client.Status.Phase = v1alpha1.PhaseReconciling
err := r.client.Status().Update(r.context, client)
if err != nil {
log.Error(err, "unable to update status")
}
// Finalizer already set?
finalizerExists := false
for _, finalizer := range client.Finalizers {
if finalizer == ClientFinalizer {
finalizerExists = true
break
}
}
// Resource created and finalizer exists: nothing to do
if !deleted && finalizerExists {
return nil
}
// Resource created and finalizer does not exist: add finalizer
if !deleted && !finalizerExists {
client.Finalizers = append(client.Finalizers, ClientFinalizer)
log.Info(fmt.Sprintf("added finalizer to keycloak client %v/%v",
client.Namespace,
client.Spec.Client.ClientID))
return r.client.Update(r.context, client)
}
// Otherwise remove the finalizer
newFinalizers := []string{}
for _, finalizer := range client.Finalizers {
if finalizer == ClientFinalizer {
log.Info(fmt.Sprintf("removed finalizer from keycloak client %v/%v",
client.Namespace,
client.Spec.Client.ClientID))
continue
}
newFinalizers = append(newFinalizers, finalizer)
}
client.Finalizers = newFinalizers
return r.client.Update(r.context, client)
}
func (r *ReconcileKeycloakClient) ManageError(realm *kc.KeycloakClient, issue error) (reconcile.Result, error) {
r.recorder.Event(realm, "Warning", "ProcessingError", issue.Error())
realm.Status.Message = issue.Error()
realm.Status.Ready = false
realm.Status.Phase = v1alpha1.PhaseFailing
err := r.client.Status().Update(r.context, realm)
if err != nil {
log.Error(err, "unable to update status")
}
return reconcile.Result{
RequeueAfter: RequeueDelayError,
Requeue: true,
}, nil
}