/
helloworld_controller.go
509 lines (448 loc) · 20.8 KB
/
helloworld_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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/*
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package controllers
import (
"context"
"fmt"
"os"
"strings"
"time"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/client-go/tools/record"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/log"
examplesv1alpha1 "github.com/brusdev/hello-world-operator/api/v1alpha1"
)
const helloworldFinalizer = "examples.brus.dev/finalizer"
// Definitions to manage status conditions
const (
// typeAvailableHelloWorld represents the status of the Deployment reconciliation
typeAvailableHelloWorld = "Available"
// typeDegradedHelloWorld represents the status used when the custom resource is deleted and the finalizer operations are must to occur.
typeDegradedHelloWorld = "Degraded"
)
// HelloWorldReconciler reconciles a HelloWorld object
type HelloWorldReconciler struct {
client.Client
Scheme *runtime.Scheme
Recorder record.EventRecorder
}
// The following markers are used to generate the rules permissions (RBAC) on config/rbac using controller-gen
// when the command <make manifests> is executed.
// To know more about markers see: https://book.kubebuilder.io/reference/markers.html
//+kubebuilder:rbac:groups=examples.brus.dev,resources=helloworlds,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=examples.brus.dev,resources=helloworlds/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=examples.brus.dev,resources=helloworlds/finalizers,verbs=update
//+kubebuilder:rbac:groups=core,resources=events,verbs=create;patch
//+kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=core,resources=pods,verbs=get;list;watch
//+kubebuilder:rbac:groups=core,resources=services,verbs=get;list;watch;create;update;patch;delete
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
// It is essential for the controller's reconciliation loop to be idempotent. By following the Operator
// pattern you will create Controllers which provide a reconcile function
// responsible for synchronizing resources until the desired state is reached on the cluster.
// Breaking this recommendation goes against the design principles of controller-runtime.
// and may lead to unforeseen consequences such as resources becoming stuck and requiring manual intervention.
// For further info:
// - About Operator Pattern: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
// - About Controllers: https://kubernetes.io/docs/concepts/architecture/controller/
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.1/pkg/reconcile
func (r *HelloWorldReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
log := log.FromContext(ctx)
// Fetch the HelloWorld instance
// The purpose is check if the Custom Resource for the Kind HelloWorld
// is applied on the cluster if not we return nil to stop the reconciliation
helloworld := &examplesv1alpha1.HelloWorld{}
err := r.Get(ctx, req.NamespacedName, helloworld)
if err != nil {
if apierrors.IsNotFound(err) {
// If the custom resource is not found then, it usually means that it was deleted or not created
// In this way, we will stop the reconciliation
log.Info("helloworld resource not found. Ignoring since object must be deleted")
return ctrl.Result{}, nil
}
// Error reading the object - requeue the request.
log.Error(err, "Failed to get helloworld")
return ctrl.Result{}, err
}
// Let's just set the status as Unknown when no status are available
if helloworld.Status.Conditions == nil || len(helloworld.Status.Conditions) == 0 {
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeAvailableHelloWorld, Status: metav1.ConditionUnknown, Reason: "Reconciling", Message: "Starting reconciliation"})
if err = r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
// Let's re-fetch the helloworld Custom Resource after update the status
// so that we have the latest state of the resource on the cluster and we will avoid
// raise the issue "the object has been modified, please apply
// your changes to the latest version and try again" which would re-trigger the reconciliation
// if we try to update it again in the following operations
if err := r.Get(ctx, req.NamespacedName, helloworld); err != nil {
log.Error(err, "Failed to re-fetch helloworld")
return ctrl.Result{}, err
}
}
// Let's add a finalizer. Then, we can define some operations which should
// occurs before the custom resource to be deleted.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers
if !controllerutil.ContainsFinalizer(helloworld, helloworldFinalizer) {
log.Info("Adding Finalizer for HelloWorld")
if ok := controllerutil.AddFinalizer(helloworld, helloworldFinalizer); !ok {
log.Error(err, "Failed to add finalizer into the custom resource")
return ctrl.Result{Requeue: true}, nil
}
if err = r.Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update custom resource to add finalizer")
return ctrl.Result{}, err
}
}
// Check if the HelloWorld instance is marked to be deleted, which is
// indicated by the deletion timestamp being set.
isHelloWorldMarkedToBeDeleted := helloworld.GetDeletionTimestamp() != nil
if isHelloWorldMarkedToBeDeleted {
if controllerutil.ContainsFinalizer(helloworld, helloworldFinalizer) {
log.Info("Performing Finalizer Operations for HelloWorld before delete CR")
// Let's add here an status "Downgrade" to define that this resource begin its process to be terminated.
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeDegradedHelloWorld,
Status: metav1.ConditionUnknown, Reason: "Finalizing",
Message: fmt.Sprintf("Performing finalizer operations for the custom resource: %s ", helloworld.Name)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
// Perform all operations required before remove the finalizer and allow
// the Kubernetes API to remove the custom resource.
r.doFinalizerOperationsForHelloWorld(helloworld)
// TODO(user): If you add operations to the doFinalizerOperationsForHelloWorld method
// then you need to ensure that all worked fine before deleting and updating the Downgrade status
// otherwise, you should requeue here.
// Re-fetch the helloworld Custom Resource before update the status
// so that we have the latest state of the resource on the cluster and we will avoid
// raise the issue "the object has been modified, please apply
// your changes to the latest version and try again" which would re-trigger the reconciliation
if err := r.Get(ctx, req.NamespacedName, helloworld); err != nil {
log.Error(err, "Failed to re-fetch helloworld")
return ctrl.Result{}, err
}
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeDegradedHelloWorld,
Status: metav1.ConditionTrue, Reason: "Finalizing",
Message: fmt.Sprintf("Finalizer operations for custom resource %s name were successfully accomplished", helloworld.Name)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
log.Info("Removing Finalizer for HelloWorld after successfully perform the operations")
if ok := controllerutil.RemoveFinalizer(helloworld, helloworldFinalizer); !ok {
log.Error(err, "Failed to remove finalizer for HelloWorld")
return ctrl.Result{Requeue: true}, nil
}
if err := r.Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to remove finalizer for HelloWorld")
return ctrl.Result{}, err
}
}
return ctrl.Result{}, nil
}
// Check if the deployment already exists, if not create a new one
found := &appsv1.Deployment{}
err = r.Get(ctx, types.NamespacedName{Name: helloworld.Name, Namespace: helloworld.Namespace}, found)
if err != nil && apierrors.IsNotFound(err) {
// Define a new deployment
dep, err := r.deploymentForHelloWorld(helloworld)
if err != nil {
log.Error(err, "Failed to define new Deployment resource for HelloWorld")
// The following implementation will update the status
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeAvailableHelloWorld,
Status: metav1.ConditionFalse, Reason: "Reconciling",
Message: fmt.Sprintf("Failed to create Deployment for the custom resource (%s): (%s)", helloworld.Name, err)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
return ctrl.Result{}, err
}
log.Info("Creating a new Deployment",
"Deployment.Namespace", dep.Namespace, "Deployment.Name", dep.Name)
if err = r.Create(ctx, dep); err != nil {
log.Error(err, "Failed to create new Deployment",
"Deployment.Namespace", dep.Namespace, "Deployment.Name", dep.Name)
return ctrl.Result{}, err
}
// Deployment created successfully
// We will requeue the reconciliation so that we can ensure the state
// and move forward for the next operations
return ctrl.Result{RequeueAfter: time.Minute}, nil
} else if err != nil {
log.Error(err, "Failed to get Deployment")
// Let's return the error for the reconciliation be re-trigged again
return ctrl.Result{}, err
}
// The CRD API is defining that the HelloWorld type, have a HelloWorldSpec.Size field
// to set the quantity of Deployment instances is the desired state on the cluster.
// Therefore, the following code will ensure the Deployment size is the same as defined
// via the Size spec of the Custom Resource which we are reconciling.
size := helloworld.Spec.Size
text := helloworld.Spec.Text
foundContainer := &found.Spec.Template.Spec.Containers[0]
if *found.Spec.Replicas != size || len(foundContainer.Env) != 1 || foundContainer.Env[0].Value != text {
found.Spec.Replicas = &size
foundContainer.Env = []corev1.EnvVar{
{
Name: "HELLO_TEXT",
Value: helloworld.Spec.Text,
},
}
log.Info("Updating Deployment",
"Deployment.Namespace", found.Namespace, "Deployment.Name", found.Name)
if err = r.Update(ctx, found); err != nil {
log.Error(err, "Failed to update Deployment",
"Deployment.Namespace", found.Namespace, "Deployment.Name", found.Name)
// Re-fetch the helloworld Custom Resource before update the status
// so that we have the latest state of the resource on the cluster and we will avoid
// raise the issue "the object has been modified, please apply
// your changes to the latest version and try again" which would re-trigger the reconciliation
if err := r.Get(ctx, req.NamespacedName, helloworld); err != nil {
log.Error(err, "Failed to re-fetch helloworld")
return ctrl.Result{}, err
}
// The following implementation will update the status
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeAvailableHelloWorld,
Status: metav1.ConditionFalse, Reason: "Resizing",
Message: fmt.Sprintf("Failed to update the size for the custom resource (%s): (%s)", helloworld.Name, err)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
return ctrl.Result{}, err
}
// Now, that we update the size we want to requeue the reconciliation
// so that we can ensure that we have the latest state of the resource before
// update. Also, it will help ensure the desired state on the cluster
return ctrl.Result{Requeue: true}, nil
}
foundService := &corev1.Service{}
err = r.Get(ctx, types.NamespacedName{Name: helloworld.Name, Namespace: helloworld.Namespace}, foundService)
if err != nil && apierrors.IsNotFound(err) {
// Define a new service
svc := &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: helloworld.Name,
Namespace: helloworld.Namespace,
},
Spec: corev1.ServiceSpec{
Selector: labelsForHelloWorld(helloworld.Name),
Ports: []corev1.ServicePort{
{
Protocol: "TCP",
Port: 8080,
TargetPort: intstr.FromInt(8080),
},
},
},
}
// Set the ownerRef for the Service
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/
if err := ctrl.SetControllerReference(helloworld, svc, r.Scheme); err != nil {
log.Error(err, "Failed to define new Service resource for HelloWorld")
// The following implementation will update the status
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeAvailableHelloWorld,
Status: metav1.ConditionFalse, Reason: "Reconciling",
Message: fmt.Sprintf("Failed to create Service for the custom resource (%s): (%s)", helloworld.Name, err)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
return ctrl.Result{}, err
}
log.Info("Creating a new Service",
"Service.Namespace", svc.Namespace, "Service.Name", svc.Name)
if err = r.Create(ctx, svc); err != nil {
log.Error(err, "Failed to create new Service",
"Service.Namespace", svc.Namespace, "Service.Name", svc.Name)
return ctrl.Result{}, err
}
// Service created successfully
// We will requeue the reconciliation so that we can ensure the state
// and move forward for the next operations
return ctrl.Result{RequeueAfter: time.Minute}, nil
} else if err != nil {
log.Error(err, "Failed to get Service")
// Let's return the error for the reconciliation be re-trigged again
return ctrl.Result{}, err
}
// The following implementation will update the status
meta.SetStatusCondition(&helloworld.Status.Conditions, metav1.Condition{Type: typeAvailableHelloWorld,
Status: metav1.ConditionTrue, Reason: "Reconciling",
Message: fmt.Sprintf("Deployment for custom resource (%s) with %d replicas created successfully", helloworld.Name, size)})
if err := r.Status().Update(ctx, helloworld); err != nil {
log.Error(err, "Failed to update HelloWorld status")
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
// finalizeHelloWorld will perform the required operations before delete the CR.
func (r *HelloWorldReconciler) doFinalizerOperationsForHelloWorld(cr *examplesv1alpha1.HelloWorld) {
// TODO(user): Add the cleanup steps that the operator
// needs to do before the CR can be deleted. Examples
// of finalizers include performing backups and deleting
// resources that are not owned by this CR, like a PVC.
// Note: It is not recommended to use finalizers with the purpose of delete resources which are
// created and managed in the reconciliation. These ones, such as the Deployment created on this reconcile,
// are defined as depended of the custom resource. See that we use the method ctrl.SetControllerReference.
// to set the ownerRef which means that the Deployment will be deleted by the Kubernetes API.
// More info: https://kubernetes.io/docs/tasks/administer-cluster/use-cascading-deletion/
// The following implementation will raise an event
r.Recorder.Event(cr, "Warning", "Deleting",
fmt.Sprintf("Custom Resource %s is being deleted from the namespace %s",
cr.Name,
cr.Namespace))
}
// deploymentForHelloWorld returns a HelloWorld Deployment object
func (r *HelloWorldReconciler) deploymentForHelloWorld(
helloworld *examplesv1alpha1.HelloWorld) (*appsv1.Deployment, error) {
ls := labelsForHelloWorld(helloworld.Name)
replicas := helloworld.Spec.Size
// Get the Operand image
image, err := imageForHelloWorld()
if err != nil {
return nil, err
}
dep := &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: helloworld.Name,
Namespace: helloworld.Namespace,
},
Spec: appsv1.DeploymentSpec{
Replicas: &replicas,
Selector: &metav1.LabelSelector{
MatchLabels: ls,
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: ls,
},
Spec: corev1.PodSpec{
// TODO(user): Uncomment the following code to configure the nodeAffinity expression
// according to the platforms which are supported by your solution. It is considered
// best practice to support multiple architectures. build your manager image using the
// makefile target docker-buildx. Also, you can use docker manifest inspect <image>
// to check what are the platforms supported.
// More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
//Affinity: &corev1.Affinity{
// NodeAffinity: &corev1.NodeAffinity{
// RequiredDuringSchedulingIgnoredDuringExecution: &corev1.NodeSelector{
// NodeSelectorTerms: []corev1.NodeSelectorTerm{
// {
// MatchExpressions: []corev1.NodeSelectorRequirement{
// {
// Key: "kubernetes.io/arch",
// Operator: "In",
// Values: []string{"amd64", "arm64", "ppc64le", "s390x"},
// },
// {
// Key: "kubernetes.io/os",
// Operator: "In",
// Values: []string{"linux"},
// },
// },
// },
// },
// },
// },
//},
SecurityContext: &corev1.PodSecurityContext{
RunAsNonRoot: &[]bool{true}[0],
// IMPORTANT: seccomProfile was introduced with Kubernetes 1.19
// If you are looking for to produce solutions to be supported
// on lower versions you must remove this option.
SeccompProfile: &corev1.SeccompProfile{
Type: corev1.SeccompProfileTypeRuntimeDefault,
},
},
Containers: []corev1.Container{{
Image: image,
Name: "helloworld",
ImagePullPolicy: corev1.PullIfNotPresent,
Env: []corev1.EnvVar{
{
Name: "HELLO_TEXT",
Value: helloworld.Spec.Text,
},
},
// Ensure restrictive context for the container
// More info: https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
SecurityContext: &corev1.SecurityContext{
RunAsNonRoot: &[]bool{true}[0],
AllowPrivilegeEscalation: &[]bool{false}[0],
Capabilities: &corev1.Capabilities{
Drop: []corev1.Capability{
"ALL",
},
},
},
}},
},
},
},
}
// Set the ownerRef for the Deployment
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/
if err := ctrl.SetControllerReference(helloworld, dep, r.Scheme); err != nil {
return nil, err
}
return dep, nil
}
// labelsForHelloWorld returns the labels for selecting the resources
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/
func labelsForHelloWorld(name string) map[string]string {
var imageTag string
image, err := imageForHelloWorld()
if err == nil {
imageTag = strings.Split(image, ":")[1]
}
return map[string]string{"app.kubernetes.io/name": "HelloWorld",
"app.kubernetes.io/instance": name,
"app.kubernetes.io/version": imageTag,
"app.kubernetes.io/part-of": "hello-world-operator",
"app.kubernetes.io/created-by": "controller-manager",
}
}
// imageForHelloWorld gets the Operand image which is managed by this controller
// from the HELLOWORLD_IMAGE environment variable defined in the config/manager/manager.yaml
func imageForHelloWorld() (string, error) {
var imageEnvVar = "HELLOWORLD_IMAGE"
image, found := os.LookupEnv(imageEnvVar)
if !found {
return "", fmt.Errorf("Unable to find %s environment variable with the image", imageEnvVar)
}
return image, nil
}
// SetupWithManager sets up the controller with the Manager.
// Note that the Deployment will be also watched in order to ensure its
// desirable state on the cluster
func (r *HelloWorldReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&examplesv1alpha1.HelloWorld{}).
Owns(&appsv1.Deployment{}).
Complete(r)
}