-
Notifications
You must be signed in to change notification settings - Fork 2
/
doguInstallManager.go
488 lines (399 loc) · 17.3 KB
/
doguInstallManager.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
package controllers
import (
"context"
"encoding/json"
"fmt"
cesappcore "github.com/cloudogu/cesapp-lib/core"
cesregistry "github.com/cloudogu/cesapp-lib/registry"
cesremote "github.com/cloudogu/cesapp-lib/remote"
"github.com/cloudogu/k8s-apply-lib/apply"
k8sv1 "github.com/cloudogu/k8s-dogu-operator/api/v1"
"github.com/cloudogu/k8s-dogu-operator/controllers/config"
"github.com/cloudogu/k8s-dogu-operator/controllers/dependency"
"github.com/cloudogu/k8s-dogu-operator/controllers/limit"
"github.com/cloudogu/k8s-dogu-operator/controllers/registry"
"github.com/cloudogu/k8s-dogu-operator/controllers/resource"
"github.com/cloudogu/k8s-dogu-operator/controllers/serviceaccount"
"github.com/go-logr/logr"
"sigs.k8s.io/yaml"
imagev1 "github.com/google/go-containerregistry/pkg/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/kubernetes"
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"
)
const (
annotationKubernetesVolumeDriver = "volume.kubernetes.io/storage-provisioner"
annotationKubernetesBetaVolumeDriver = "volume.beta.kubernetes.io/storage-provisioner"
longhornDiverID = "driver.longhorn.io"
longhornStorageClassName = "longhorn"
)
const k8sDoguOperatorFieldManagerName = "k8s-dogu-operator"
// doguInstallManager is a central unit in the process of handling the installation process of a custom dogu resource.
type doguInstallManager struct {
client client.Client
scheme *runtime.Scheme
resourceGenerator doguResourceGenerator
doguRemoteRegistry cesremote.Registry
doguLocalRegistry cesregistry.DoguRegistry
imageRegistry imageRegistry
doguRegistrator doguRegistrator
dependencyValidator dependencyValidator
serviceAccountCreator serviceAccountCreator
doguSecretHandler doguSecretHandler
fileExtractor fileExtractor
applier applier
}
// NewDoguInstallManager creates a new instance of doguInstallManager.
func NewDoguInstallManager(client client.Client, operatorConfig *config.OperatorConfig, cesRegistry cesregistry.Registry) (*doguInstallManager, error) {
doguRemoteRegistry, err := cesremote.New(operatorConfig.GetRemoteConfiguration(), operatorConfig.GetRemoteCredentials())
if err != nil {
return nil, fmt.Errorf("failed to create new remote dogu registry: %w", err)
}
imageRegistry := registry.NewCraneContainerImageRegistry(operatorConfig.DockerRegistry.Username, operatorConfig.DockerRegistry.Password)
resourceGenerator := resource.NewResourceGenerator(client.Scheme(), limit.NewDoguDeploymentLimitPatcher(cesRegistry))
restConfig := ctrl.GetConfigOrDie()
clientSet, err := kubernetes.NewForConfig(restConfig)
if err != nil {
return nil, fmt.Errorf("failed to find cluster config: %w", err)
}
fileExtract := newPodFileExtractor(client, restConfig, clientSet)
applier, scheme, err := apply.New(restConfig, k8sDoguOperatorFieldManagerName)
if err != nil {
return nil, fmt.Errorf("failed to create K8s applier: %w", err)
}
err = k8sv1.AddToScheme(scheme)
if err != nil {
return nil, fmt.Errorf("failed to add applier scheme to dogu CRD scheme handling: %w", err)
}
doguRegistrator := newCESDoguRegistrator(client, cesRegistry, resourceGenerator)
dependencyValidator := dependency.NewCompositeDependencyValidator(operatorConfig.Version, cesRegistry.DoguRegistry())
executor := resource.NewCommandExecutor(clientSet, clientSet.CoreV1().RESTClient())
serviceAccountCreator := serviceaccount.NewCreator(cesRegistry, executor)
return &doguInstallManager{
client: client,
scheme: client.Scheme(),
resourceGenerator: resourceGenerator,
doguRemoteRegistry: doguRemoteRegistry,
doguLocalRegistry: cesRegistry.DoguRegistry(),
imageRegistry: imageRegistry,
doguRegistrator: doguRegistrator,
dependencyValidator: dependencyValidator,
serviceAccountCreator: serviceAccountCreator,
doguSecretHandler: resource.NewDoguSecretsWriter(client, cesRegistry),
fileExtractor: fileExtract,
applier: applier,
}, nil
}
// Install installs a given Dogu Resource. This includes fetching the dogu.json and the container image. With the
// information Install creates a Deployment and a Service
func (m *doguInstallManager) Install(ctx context.Context, doguResource *k8sv1.Dogu) error {
logger := log.FromContext(ctx)
doguResource.Status = k8sv1.DoguStatus{RequeueTime: doguResource.Status.RequeueTime, Status: k8sv1.DoguStatusInstalling, StatusMessages: []string{}}
err := doguResource.Update(ctx, m.client)
if err != nil {
return fmt.Errorf("failed to update dogu status: %w", err)
}
// Set the finalizer at the beginning of the install procedure.
// This is required because an error during installation would leave a dogu resource with its
// k8s resources in the cluster. A delete would tidy up those resources but would not start the
// delete procedure from the controller.
logger.Info("Add dogu finalizer...")
controllerutil.AddFinalizer(doguResource, finalizerName)
err = m.client.Update(ctx, doguResource)
if err != nil {
return fmt.Errorf("failed to update dogu: %w", err)
}
// we need to retrieve the config map with the custom descriptor to delete it after ending the installation
doguConfigMap, err := m.getDoguConfigMap(ctx, doguResource)
if err != nil {
return fmt.Errorf("failed to get dogu config map: %w", err)
}
logger.Info("Fetching dogu...")
dogu, err := m.getDoguDescriptor(ctx, doguResource)
if err != nil {
return fmt.Errorf("failed to get dogu: %w", err)
}
logger.Info("Check dogu dependencies...")
err = m.dependencyValidator.ValidateDependencies(dogu)
if err != nil {
return err
}
logger.Info("Register dogu...")
err = m.doguRegistrator.RegisterDogu(ctx, doguResource, dogu)
if err != nil {
return fmt.Errorf("failed to register dogu: %w", err)
}
logger.Info("Write dogu secrets from setup...")
err = m.doguSecretHandler.WriteDoguSecretsToRegistry(ctx, doguResource)
if err != nil {
return fmt.Errorf("failed to write dogu secrets from setup: %w", err)
}
logger.Info("Create service accounts...")
err = m.serviceAccountCreator.CreateAll(ctx, doguResource.Namespace, dogu)
if err != nil {
return fmt.Errorf("failed to create service accounts: %w", err)
}
logger.Info("Pull image config...")
imageConfig, err := m.imageRegistry.PullImageConfig(ctx, dogu.Image+":"+dogu.Version)
if err != nil {
return fmt.Errorf("failed to pull image config: %w", err)
}
customK8sResources, err := m.fileExtractor.ExtractK8sResourcesFromContainer(ctx, doguResource, dogu)
if err != nil {
return fmt.Errorf("failed to pull customK8sResources: %w", err)
}
customDeployment, err := m.applyCustomK8sResources(logger, customK8sResources, doguResource)
if err != nil {
return err
}
logger.Info("Create dogu resources...")
err = m.createDoguResources(ctx, doguResource, dogu, imageConfig, customDeployment)
if err != nil {
return fmt.Errorf("failed to create dogu resources: %w", err)
}
doguResource.Status = k8sv1.DoguStatus{Status: k8sv1.DoguStatusInstalled, StatusMessages: []string{}}
err = doguResource.Update(ctx, m.client)
if err != nil {
return fmt.Errorf("failed to update dogu status: %w", err)
}
err = deleteDoguConfigMap(ctx, m.client, doguConfigMap)
if err != nil {
return err
}
return nil
}
func (m *doguInstallManager) applyCustomK8sResources(logger logr.Logger, customK8sResources map[string]string, doguResource *k8sv1.Dogu) (*appsv1.Deployment, error) {
if len(customK8sResources) == 0 {
logger.Info("No custom K8s resources found")
return nil, nil
}
targetNamespace := doguResource.ObjectMeta.Namespace
namespaceTemplate := struct {
Namespace string
}{
Namespace: targetNamespace,
}
dCollector := &deploymentCollector{collected: []*appsv1.Deployment{}}
for file, yamlDocs := range customK8sResources {
logger.Info(fmt.Sprintf("Applying custom K8s resources from file %s", file))
err := apply.NewBuilder(m.applier).
WithNamespace(targetNamespace).
WithOwner(doguResource).
WithTemplate(file, namespaceTemplate).
WithCollector(dCollector).
WithYamlResource(file, []byte(yamlDocs)).
WithApplyFilter(&deploymentAntiFilter{}).
ExecuteApply()
if err != nil {
return nil, err
}
}
if len(dCollector.collected) > 1 {
return nil, fmt.Errorf("expected exactly one Deployment but found %d - not sure how to continue", len(dCollector.collected))
}
if len(dCollector.collected) == 1 {
return dCollector.collected[0], nil
}
return nil, nil
}
type deploymentCollector struct {
collected []*appsv1.Deployment
}
type deploymentAntiFilter struct{}
func (dc *deploymentAntiFilter) Predicate(doc apply.YamlDocument) (bool, error) {
var deployment = &appsv1.Deployment{}
err := yaml.Unmarshal(doc, deployment)
if err != nil {
return false, fmt.Errorf("failed to unmarshal object [%s] into deployment: %w", string(doc), err)
}
return deployment.Kind != "Deployment", nil
}
func (dc *deploymentCollector) Predicate(doc apply.YamlDocument) (bool, error) {
var deployment = &appsv1.Deployment{}
err := yaml.Unmarshal(doc, deployment)
if err != nil {
return false, fmt.Errorf("failed to unmarshal object [%s] into deployment: %w", string(doc), err)
}
return deployment.Kind == "Deployment", nil
}
func (dc *deploymentCollector) Collect(doc apply.YamlDocument) {
var deployment = &appsv1.Deployment{}
// ignore error because it has already been parsed in Predicate()
_ = yaml.Unmarshal(doc, deployment)
dc.collected = append(dc.collected, deployment)
}
func (m *doguInstallManager) getDoguDescriptorFromConfigMap(doguConfigMap *corev1.ConfigMap) (*cesappcore.Dogu, error) {
jsonStr := doguConfigMap.Data["dogu.json"]
dogu := &cesappcore.Dogu{}
err := json.Unmarshal([]byte(jsonStr), dogu)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal custom dogu descriptor: %w", err)
}
return dogu, nil
}
func (m *doguInstallManager) getDoguDescriptorFromRemoteRegistry(doguResource *k8sv1.Dogu) (*cesappcore.Dogu, error) {
ctrl.Log.Info(doguResource.Spec.Name)
dogu, err := m.doguRemoteRegistry.Get(doguResource.Spec.Name)
if err != nil {
return nil, fmt.Errorf("failed to get dogu from remote dogu registry: %w", err)
}
return dogu, nil
}
func (m *doguInstallManager) getDoguConfigMap(ctx context.Context, doguResource *k8sv1.Dogu) (*corev1.ConfigMap, error) {
configMap := &corev1.ConfigMap{}
err := m.client.Get(ctx, doguResource.GetDescriptorObjectKey(), configMap)
if err != nil {
if apierrors.IsNotFound(err) {
return nil, nil
} else {
return nil, fmt.Errorf("failed to get custom dogu descriptor: %w", err)
}
} else {
return configMap, nil
}
}
func (m *doguInstallManager) getDoguDescriptorWithConfigMap(ctx context.Context, doguResource *k8sv1.Dogu, doguConfigMap *corev1.ConfigMap) (*cesappcore.Dogu, error) {
logger := log.FromContext(ctx)
if doguConfigMap != nil {
logger.Info("Fetching dogu from custom configmap...")
return m.getDoguDescriptorFromConfigMap(doguConfigMap)
} else {
logger.Info("Fetching dogu from dogu registry...")
return m.getDoguDescriptorFromRemoteRegistry(doguResource)
}
}
func (m *doguInstallManager) getDoguDescriptor(ctx context.Context, doguResource *k8sv1.Dogu) (*cesappcore.Dogu, error) {
doguConfigMap, err := m.getDoguConfigMap(ctx, doguResource)
if err != nil {
return nil, fmt.Errorf("failed to get dogu config map: %w", err)
}
dogu, err := m.getDoguDescriptorWithConfigMap(ctx, doguResource, doguConfigMap)
if err != nil {
return nil, fmt.Errorf("failed to get dogu: %w", err)
}
return dogu, nil
}
func (m *doguInstallManager) createDoguResources(ctx context.Context, doguResource *k8sv1.Dogu, dogu *cesappcore.Dogu, imageConfig *imagev1.ConfigFile, patchingDeployment *appsv1.Deployment) error {
err := m.createVolumes(ctx, doguResource, dogu)
if err != nil {
return fmt.Errorf("failed to create volumes for dogu %s: %w", dogu.Name, err)
}
err = m.createDeployment(ctx, doguResource, dogu, patchingDeployment)
if err != nil {
return fmt.Errorf("failed to create deployment for dogu %s: %w", dogu.Name, err)
}
err = m.createService(ctx, doguResource, imageConfig)
if err != nil {
return fmt.Errorf("failed to create service for dogu %s: %w", dogu.Name, err)
}
err = m.createExposedServices(ctx, doguResource, dogu)
if err != nil {
return fmt.Errorf("failed to create exposed services for dogu %s: %w", dogu.Name, err)
}
return nil
}
func (m *doguInstallManager) createVolumes(ctx context.Context, doguResource *k8sv1.Dogu, dogu *cesappcore.Dogu) error {
if len(dogu.Volumes) > 0 {
// check if pvc already exists
doguPVCClaim := &corev1.PersistentVolumeClaim{}
doguPVCKey := client.ObjectKey{
Namespace: doguResource.Namespace,
Name: doguResource.Name,
}
err := m.client.Get(ctx, doguPVCKey, doguPVCClaim)
if err != nil {
if apierrors.IsNotFound(err) {
return m.createPvcForDogu(ctx, doguResource)
}
return fmt.Errorf("failed to get prebuilt dogu pvc for dogu %s: %w", dogu.Name, err)
}
return m.validateDoguPvc(ctx, dogu, doguResource, doguPVCClaim)
}
return nil
}
func (m *doguInstallManager) createPvcForDogu(ctx context.Context, doguResource *k8sv1.Dogu) error {
logger := log.FromContext(ctx)
desiredPvc, err := m.resourceGenerator.GetDoguPVC(doguResource)
if err != nil {
return fmt.Errorf("failed to generate pvc: %w", err)
}
err = m.client.Create(ctx, desiredPvc)
if err != nil {
return fmt.Errorf("failed to create pvc: %w", err)
}
logger.Info(fmt.Sprintf("PersistentVolumeClaim %s/%s has been : %s", desiredPvc.Namespace, desiredPvc.Name, controllerutil.OperationResultCreated))
return nil
}
func (m *doguInstallManager) validateDoguPvc(ctx context.Context, dogu *cesappcore.Dogu, doguResource *k8sv1.Dogu, doguPVCClaim *corev1.PersistentVolumeClaim) error {
logger := log.FromContext(ctx)
logger.Info(fmt.Sprintf("PVC for dogu [%s] already exists. Verifing pvc...", dogu.GetFullName()))
if doguPVCClaim.Annotations[annotationKubernetesBetaVolumeDriver] != longhornDiverID {
return fmt.Errorf("pvc for dogu [%s] is not valid as annotation [%s] does not exist or is not [%s]", dogu.GetFullName(), annotationKubernetesBetaVolumeDriver, longhornDiverID)
}
if doguPVCClaim.Annotations[annotationKubernetesVolumeDriver] != longhornDiverID {
return fmt.Errorf("pvc for dogu [%s] is not valid as annotation [%s] does not exist or is not [%s]", dogu.GetFullName(), annotationKubernetesVolumeDriver, longhornDiverID)
}
if doguPVCClaim.Labels["dogu"] != doguResource.Name {
return fmt.Errorf("pvc for dogu [%s] is not valid as pvc does not contain label [dogu] with value [%s]", dogu.GetFullName(), doguResource.Name)
}
if *doguPVCClaim.Spec.StorageClassName != longhornStorageClassName {
return fmt.Errorf("pvc for dogu [%s] is not valid as pvc has invalid storage class: the storage class must be [%s]", dogu.GetFullName(), longhornStorageClassName)
}
err := ctrl.SetControllerReference(doguResource, doguPVCClaim, m.scheme)
if err != nil {
return fmt.Errorf("failed to set controller reference: %w", err)
}
err = m.client.Update(ctx, doguPVCClaim)
if err != nil {
return fmt.Errorf("failed to update dogu pvc %s: %w", doguPVCClaim.Name, err)
}
logger.Info(fmt.Sprintf("Existing PVC for dogu [%s] is valid.", dogu.GetFullName()))
return nil
}
func (m *doguInstallManager) createDeployment(ctx context.Context, doguResource *k8sv1.Dogu, dogu *cesappcore.Dogu, patchingDeployment *appsv1.Deployment) error {
logger := log.FromContext(ctx)
desiredDeployment, err := m.resourceGenerator.GetDoguDeployment(doguResource, dogu, patchingDeployment)
if err != nil {
return fmt.Errorf("failed to generate dogu deployment: %w", err)
}
err = m.client.Create(ctx, desiredDeployment)
if err != nil {
return fmt.Errorf("failed to create dogu deployment: %w", err)
}
logger.Info(fmt.Sprintf("Deployment %s/%s has been : %s", desiredDeployment.Namespace, desiredDeployment.Name, controllerutil.OperationResultCreated))
return nil
}
func (m *doguInstallManager) createService(ctx context.Context, doguResource *k8sv1.Dogu, imageConfig *imagev1.ConfigFile) error {
logger := log.FromContext(ctx)
desiredService, err := m.resourceGenerator.GetDoguService(doguResource, imageConfig)
if err != nil {
return fmt.Errorf("failed to generate dogu service: %w", err)
}
err = m.client.Create(ctx, desiredService)
if err != nil {
return fmt.Errorf("failed to create dogu service: %w", err)
}
logger.Info(fmt.Sprintf("Service %s/%s has been : %s", desiredService.Namespace, desiredService.Name, controllerutil.OperationResultCreated))
return nil
}
func (m *doguInstallManager) createExposedServices(ctx context.Context, doguResource *k8sv1.Dogu, dogu *cesappcore.Dogu) error {
logger := log.FromContext(ctx)
exposedServices, err := m.resourceGenerator.GetDoguExposedServices(doguResource, dogu)
if err != nil {
return fmt.Errorf("failed to generate exposed services: %w", err)
}
for _, service := range exposedServices {
err = m.client.Create(ctx, &service)
if err != nil {
return fmt.Errorf("failed to create exposed service: %w", err)
}
logger.Info(fmt.Sprintf("Exposed Service %s/%s have been : %s", service.Namespace, service.Name, controllerutil.OperationResultCreated))
}
return nil
}