/
clusterdeployment_controller.go
406 lines (346 loc) · 14.2 KB
/
clusterdeployment_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
/*
Copyright 2019 Red Hat, Inc.
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 clusterdeployment
import (
"context"
"fmt"
"reflect"
"strings"
certmanv1alpha1 "github.com/openshift/certman-operator/pkg/apis/certman/v1alpha1"
"github.com/openshift/certman-operator/pkg/controller/controllerutils"
hivev1alpha1 "github.com/openshift/hive/pkg/apis/hive/v1alpha1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"github.com/go-logr/logr"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
"sigs.k8s.io/controller-runtime/pkg/source"
)
var log = logf.Log.WithName("controller_clusterdeployment")
const (
controllerName = "clusterdeployment"
ClusterDeploymentManagedLabel = "api.openshift.com/managed"
)
// Add creates a new ClusterDeployment 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 {
return &ReconcileClusterDeployment{
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
}
}
// 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+"-controller", mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for changes to primary resource ClusterDeployment
err = c.Watch(&source.Kind{Type: &hivev1alpha1.ClusterDeployment{}}, &handler.EnqueueRequestForObject{})
if err != nil {
return err
}
err = c.Watch(&source.Kind{Type: &certmanv1alpha1.CertificateRequest{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &hivev1alpha1.ClusterDeployment{},
})
if err != nil {
return err
}
return nil
}
var _ reconcile.Reconciler = &ReconcileClusterDeployment{}
// ReconcileClusterDeployment reconciles a ClusterDeployment object
type ReconcileClusterDeployment 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
}
// Reconcile reads that state of the cluster for a ClusterDeployment object and sets up
// any needed CertificateRequest objects.
func (r *ReconcileClusterDeployment) Reconcile(request reconcile.Request) (reconcile.Result, error) {
reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
reqLogger.Info("reconciling ClusterDeployment")
// Fetch the ClusterDeployment instance
cd := &hivev1alpha1.ClusterDeployment{}
err := r.client.Get(context.TODO(), request.NamespacedName, cd)
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.
reqLogger.Error(err, "error looking up clusterDeployment")
return reconcile.Result{}, err
}
// Do not make certificate request if the cluster is not a Red Hat managed cluster.
val, ok := cd.Labels[ClusterDeploymentManagedLabel]
if !ok || val != "true" {
reqLogger.Info("not a managed cluster")
return reconcile.Result{}, nil
}
//Do not reconcile if cluster is not installed
if !cd.Status.Installed {
reqLogger.Info(fmt.Sprintf("cluster %v is not yet in installed state", cd.Name))
return reconcile.Result{}, nil
}
// Check if CertificateResource is being deleted, if it's deleted remove the finalizer if it exists.
if !cd.DeletionTimestamp.IsZero() {
// The object is being deleted
if controllerutils.ContainsString(cd.ObjectMeta.Finalizers, certmanv1alpha1.CertmanOperatorFinalizerLabel) {
reqLogger.Info("deleting the CertificateRequest for the ClusterDeployment")
if err := r.handleDelete(cd, reqLogger); err != nil {
reqLogger.Error(err, "error deleting CertificateRequests")
return reconcile.Result{}, err
}
reqLogger.Info("removing CertmanOperator finalizer from the ClusterDeployment")
cd.ObjectMeta.Finalizers = controllerutils.RemoveString(cd.ObjectMeta.Finalizers, certmanv1alpha1.CertmanOperatorFinalizerLabel)
if err := r.client.Update(context.TODO(), cd); err != nil {
return reconcile.Result{}, err
}
}
return reconcile.Result{}, nil
}
// add finalizer
if !controllerutils.ContainsString(cd.ObjectMeta.Finalizers, certmanv1alpha1.CertmanOperatorFinalizerLabel) {
reqLogger.Info("adding CertmanOperator finalizer to the ClusterDeployment")
cd.ObjectMeta.Finalizers = append(cd.ObjectMeta.Finalizers, certmanv1alpha1.CertmanOperatorFinalizerLabel)
if err := r.client.Update(context.TODO(), cd); err != nil {
return reconcile.Result{}, err
}
}
if err := r.syncCertificateRequests(cd, reqLogger); err != nil {
reqLogger.Error(err, "error syncing CertificateRequests")
return reconcile.Result{}, err
}
reqLogger.Info("done syncing")
return reconcile.Result{}, nil
}
// syncCertificateRequests generates/updates a CertificateRequest for each CertificateBundle
// with CertificateBundle.Generate == true. Returns an error if anything fails in this process.
// Cleanup is performed by deleting old CertificateRequests.
func (r *ReconcileClusterDeployment) syncCertificateRequests(cd *hivev1alpha1.ClusterDeployment, logger logr.Logger) error {
origCD := cd
cd = cd.DeepCopy()
desiredCRs := []certmanv1alpha1.CertificateRequest{}
// get a list of current CertificateRequests
currentCRs, err := r.getCurrentCertificateRequests(cd, logger)
if err != nil {
logger.Error(err, err.Error())
return err
}
// for each certbundle with generate==true make a CertificateRequest
for _, cb := range cd.Spec.CertificateBundles {
logger.Info(fmt.Sprintf("processing certificate bundle %v", cb.Name),
"CertificateBundleName", cb.Name,
"GenerateCertificate", cb.Generate,
)
if cb.Generate == true {
domains := getDomainsForCertBundle(cb, cd, logger)
emailAddress, err := controllerutils.GetDefaultNotificationEmailAddress(r.client)
if err != nil {
logger.Error(err, err.Error())
return err
}
if len(domains) > 0 {
certReq := createCertificateRequest(cb.Name, cb.SecretRef.Name, domains, cd, emailAddress)
desiredCRs = append(desiredCRs, certReq)
} else {
err := fmt.Errorf("no domains provided for certificate bundle %v in the cluster deployment %v", cb.Name, cd.Name)
logger.Error(err, err.Error())
}
}
}
deleteCRs := []certmanv1alpha1.CertificateRequest{}
// find any extra certificateRequests and mark them for deletion
for i, currentCR := range currentCRs {
found := false
for _, desiredCR := range desiredCRs {
if desiredCR.Name == currentCR.Name {
found = true
break
}
}
if !found {
deleteCRs = append(deleteCRs, currentCRs[i])
}
}
certBundleStatusList := []hivev1alpha1.CertificateBundleStatus{}
errs := []error{}
// create/update the desired certificaterequests
for _, desiredCR := range desiredCRs {
currentCR := &certmanv1alpha1.CertificateRequest{}
searchKey := types.NamespacedName{Name: desiredCR.Name, Namespace: desiredCR.Namespace}
certBundleStatus := hivev1alpha1.CertificateBundleStatus{}
certBundleStatus.Name = strings.TrimPrefix(desiredCR.Name, cd.Name+"-")
if err := r.client.Get(context.TODO(), searchKey, currentCR); err != nil {
certBundleStatus.Generated = false
if errors.IsNotFound(err) {
// create
if err := controllerutil.SetControllerReference(cd, &desiredCR, r.scheme); err != nil {
logger.Error(err, "error setting owner reference", "certrequest", desiredCR.Name)
errs = append(errs, err)
continue
}
logger.Info(fmt.Sprintf("creating CertificateRequest resource config %v", desiredCR.Name))
if err := r.client.Create(context.TODO(), &desiredCR); err != nil {
logger.Error(err, "error creating certificaterequest")
errs = append(errs, err)
continue
}
} else {
logger.Error(err, "error checking for existing certificaterequest")
errs = append(errs, err)
}
} else {
// update or no update needed
if !reflect.DeepEqual(currentCR.Spec, desiredCR.Spec) {
certBundleStatus.Generated = false
currentCR.Spec = desiredCR.Spec
if err := r.client.Update(context.TODO(), currentCR); err != nil {
logger.Error(err, "error updating certificaterequest", "certrequest", currentCR.Name)
errs = append(errs, err)
continue
}
} else {
if currentCR.Status.Issued {
certBundleStatus.Generated = true
} else {
certBundleStatus.Generated = false
}
logger.Info("no update needed for certificaterequest", "certrequest", desiredCR.Name)
}
}
certBundleStatusList = append(certBundleStatusList, certBundleStatus)
}
cd.Status.CertificateBundles = certBundleStatusList
if len(errs) > 0 {
return fmt.Errorf("met multiple errors when sync certificaterequests")
}
// delete the certificaterequests
for _, deleteCR := range deleteCRs {
logger.Info(fmt.Sprintf("deleting CertificateRequest resource config %v", deleteCR.Name))
if err := r.client.Delete(context.TODO(), &deleteCR); err != nil {
logger.Error(err, "error deleting CertificateRequest that is no longer needed", "certrequest", deleteCR.Name)
return err
}
}
// update the clusterDeployment certificateBundleStatus
if !reflect.DeepEqual(cd.Status, origCD.Status) {
cd.Status.CertificateBundles = certBundleStatusList
err = r.client.Status().Update(context.TODO(), cd)
if err != nil {
logger.Error(err, "error when update clusterDeploymentStatus")
}
}
return nil
}
// getCurrentCertificateRequests returns an array of CertificateRequests owned by the cluster, within the clusters namespace.
func (r *ReconcileClusterDeployment) getCurrentCertificateRequests(cd *hivev1alpha1.ClusterDeployment, logger logr.Logger) ([]certmanv1alpha1.CertificateRequest, error) {
certReqsForCluster := []certmanv1alpha1.CertificateRequest{}
// get all CRs in the cluster's namespace
currentCRs := &certmanv1alpha1.CertificateRequestList{}
if err := r.client.List(context.TODO(), &client.ListOptions{Namespace: cd.Namespace}, currentCRs); err != nil {
logger.Error(err, "error listing current CertificateRequests")
return certReqsForCluster, err
}
// now filter out the ones that are owned by the cluster we're processing
for i, cr := range currentCRs.Items {
if metav1.IsControlledBy(&cr, cd) {
certReqsForCluster = append(certReqsForCluster, currentCRs.Items[i])
}
}
return certReqsForCluster, nil
}
// getDomainsForCertBundle returns a slice of domains after validating if CertificateBundleSpec.Name
// matches the default control plane name and appending any other matching domain names from the rest
// of the control plane and ingress list to the domain slice.
func getDomainsForCertBundle(cb hivev1alpha1.CertificateBundleSpec, cd *hivev1alpha1.ClusterDeployment, logger logr.Logger) []string {
// declare a slice to hold domains
domains := []string{}
dLogger := logger.WithValues("CertificateBundle", cb.Name)
// first check for the special-case default control plane reference
if cd.Spec.ControlPlaneConfig.ServingCertificates.Default == cb.Name {
controlPlaneCertDomain := fmt.Sprintf("api.%s.%s", cd.Spec.ClusterName, cd.Spec.BaseDomain)
dLogger.Info("control plane config DNS name: " + controlPlaneCertDomain)
domains = append(domains, controlPlaneCertDomain)
}
// now check the rest of the control plane
for _, additionalCert := range cd.Spec.ControlPlaneConfig.ServingCertificates.Additional {
if additionalCert.Name == cb.Name {
dLogger.Info("additional domain added to certificate request: " + additionalCert.Domain)
domains = append(domains, additionalCert.Domain)
}
}
// and lastly the ingress list
for _, ingress := range cd.Spec.Ingress {
if ingress.ServingCertificate == cb.Name {
ingressDomain := ingress.Domain
// always request wildcard certificates for the ingress domain
if !strings.HasPrefix(ingressDomain, "*.") {
ingressDomain = fmt.Sprintf("*.%s", ingress.Domain)
}
dLogger.Info("ingress domain added to certificate request: " + ingressDomain)
domains = append(domains, ingressDomain)
}
}
return domains
}
// createCertificateRequest constructs a CertificateRequest constructed by the
// certmanv1alpha1.CertificateRequest schema.
func createCertificateRequest(certBundleName string, secretName string, domains []string, cd *hivev1alpha1.ClusterDeployment, emailAddress string) certmanv1alpha1.CertificateRequest {
name := fmt.Sprintf("%s-%s", cd.Name, certBundleName)
name = strings.ToLower(name)
cr := certmanv1alpha1.CertificateRequest{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: cd.Namespace,
},
Spec: certmanv1alpha1.CertificateRequestSpec{
ACMEDNSDomain: cd.Spec.BaseDomain,
CertificateSecret: corev1.ObjectReference{
Kind: "secret",
Namespace: cd.Namespace,
Name: secretName,
},
PlatformSecrets: certmanv1alpha1.PlatformSecrets{
AWS: &certmanv1alpha1.AWSPlatformSecrets{
Credentials: corev1.LocalObjectReference{
Name: cd.Spec.PlatformSecrets.AWS.Credentials.Name,
},
},
},
DnsNames: domains,
Email: emailAddress,
APIURL: cd.Status.APIURL,
WebConsoleURL: cd.Status.WebConsoleURL,
},
}
return cr
}