-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
controller.go
358 lines (305 loc) · 14.6 KB
/
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
/*
Copyright 2020 The Rook Authors. All rights reserved.
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 objectrealm to manage a rook object realm.
package realm
import (
"context"
"encoding/base64"
"fmt"
"reflect"
"syscall"
"time"
opcontroller "github.com/rook/rook/pkg/operator/ceph/controller"
"github.com/rook/rook/pkg/operator/ceph/reporting"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/record"
"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"
"sigs.k8s.io/controller-runtime/pkg/source"
"github.com/coreos/pkg/capnslog"
"github.com/pkg/errors"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/clusterd"
cephclient "github.com/rook/rook/pkg/daemon/ceph/client"
"github.com/rook/rook/pkg/operator/ceph/cluster/mgr"
"github.com/rook/rook/pkg/operator/ceph/object"
"github.com/rook/rook/pkg/operator/k8sutil"
"github.com/rook/rook/pkg/util/exec"
v1 "k8s.io/api/core/v1"
kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
controllerName = "ceph-object-realm-controller"
accessKeyLength = 14
secretKeyLength = 28
)
var waitForRequeueIfRealmNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second}
var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName)
var cephObjectRealmKind = reflect.TypeOf(cephv1.CephObjectRealm{}).Name()
// Sets the type meta for the controller main object
var controllerTypeMeta = metav1.TypeMeta{
Kind: cephObjectRealmKind,
APIVersion: fmt.Sprintf("%s/%s", cephv1.CustomResourceGroup, cephv1.Version),
}
// ReconcileObjectRealm reconciles a ObjectRealm object
type ReconcileObjectRealm struct {
client client.Client
scheme *runtime.Scheme
context *clusterd.Context
clusterInfo *cephclient.ClusterInfo
opManagerContext context.Context
recorder record.EventRecorder
}
// Add creates a new CephObjectRealm 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, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) error {
return add(mgr, newReconciler(mgr, context, opManagerContext))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context) reconcile.Reconciler {
return &ReconcileObjectRealm{
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
context: context,
opManagerContext: opManagerContext,
recorder: mgr.GetEventRecorderFor("rook-" + controllerName),
}
}
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
}
logger.Info("successfully started")
// Watch for changes on the CephObjectRealm CRD object
err = c.Watch(&source.Kind{Type: &cephv1.CephObjectRealm{TypeMeta: controllerTypeMeta}}, &handler.EnqueueRequestForObject{}, opcontroller.WatchControllerPredicate())
if err != nil {
return err
}
return nil
}
// Reconcile reads that state of the cluster for a CephObjectRealm object and makes changes based on the state read
// and what is in the CephObjectRealm.Spec
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (r *ReconcileObjectRealm) Reconcile(context context.Context, request reconcile.Request) (reconcile.Result, error) {
// workaround because the rook logging mechanism is not compatible with the controller-runtime logging interface
reconcileResponse, cephObjectRealm, err := r.reconcile(request)
return reporting.ReportReconcileResult(logger, r.recorder, request, &cephObjectRealm, reconcileResponse, err)
}
func (r *ReconcileObjectRealm) reconcile(request reconcile.Request) (reconcile.Result, cephv1.CephObjectRealm, error) {
// Fetch the CephObjectRealm instance
cephObjectRealm := &cephv1.CephObjectRealm{}
err := r.client.Get(r.opManagerContext, request.NamespacedName, cephObjectRealm)
if err != nil {
if kerrors.IsNotFound(err) {
logger.Debug("CephObjectRealm %q resource not found. Ignoring since object must be deleted", request.NamespacedName.String())
return reconcile.Result{}, *cephObjectRealm, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, *cephObjectRealm, errors.Wrap(err, "failed to get CephObjectRealm")
}
// update observedGeneration local variable with current generation value,
// because generation can be changed before reconcile got completed
// CR status will be updated at end of reconcile, so to reflect the reconcile has finished
observedGeneration := cephObjectRealm.ObjectMeta.Generation
// The CR was just created, initializing status fields
if cephObjectRealm.Status == nil {
r.updateStatus(k8sutil.ObservedGenerationNotAvailable, request.NamespacedName, k8sutil.EmptyStatus)
}
// Make sure a CephCluster is present otherwise do nothing
cephCluster, isReadyToReconcile, cephClusterExists, reconcileResponse := opcontroller.IsReadyToReconcile(r.opManagerContext, r.client, request.NamespacedName, controllerName)
if !isReadyToReconcile {
// This handles the case where the Ceph Cluster is gone and we want to delete that CR
if !cephObjectRealm.GetDeletionTimestamp().IsZero() && !cephClusterExists {
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, *cephObjectRealm, nil
}
return reconcileResponse, *cephObjectRealm, nil
}
// DELETE: the CR was deleted
if !cephObjectRealm.GetDeletionTimestamp().IsZero() {
logger.Debugf("deleting realm CR %q", cephObjectRealm.Name)
r.recorder.Eventf(cephObjectRealm, v1.EventTypeNormal, string(cephv1.ReconcileStarted), "deleting CephObjectRealm %q", cephObjectRealm.Name)
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, *cephObjectRealm, nil
}
// Populate clusterInfo during each reconcile
r.clusterInfo, _, _, err = opcontroller.LoadClusterInfo(r.context, r.opManagerContext, request.NamespacedName.Namespace, &cephCluster.Spec)
if err != nil {
return reconcile.Result{}, *cephObjectRealm, errors.Wrap(err, "failed to populate cluster info")
}
// validate the realm settings
err = validateRealmCR(cephObjectRealm)
if err != nil {
r.updateStatus(k8sutil.ObservedGenerationNotAvailable, request.NamespacedName, k8sutil.ReconcileFailedStatus)
return reconcile.Result{}, *cephObjectRealm, errors.Wrapf(err, "invalid CephObjectRealm CR %q", cephObjectRealm.Name)
}
// Start object reconciliation, updating status for this
r.updateStatus(k8sutil.ObservedGenerationNotAvailable, request.NamespacedName, k8sutil.ReconcilingStatus)
// Create/Pull Ceph Realm
if cephObjectRealm.Spec.IsPullRealm() {
logger.Debug("pull section in realm %q spec found", request.NamespacedName)
_, err = r.pullCephRealm(cephObjectRealm)
if err != nil {
return reconcile.Result{}, *cephObjectRealm, err
}
} else {
_, err = r.createRealmKeys(cephObjectRealm)
if err != nil {
return r.setFailedStatus(k8sutil.ObservedGenerationNotAvailable, cephObjectRealm, request.NamespacedName, "failed to create keys for realm", err)
}
_, err = r.createCephRealm(cephObjectRealm)
if err != nil {
return r.setFailedStatus(k8sutil.ObservedGenerationNotAvailable, cephObjectRealm, request.NamespacedName, "failed to create ceph realm", err)
}
}
// update ObservedGeneration in status at the end of reconcile
// Set Ready status, we are done reconciling
r.updateStatus(observedGeneration, request.NamespacedName, k8sutil.ReadyStatus)
// Return and do not requeue
logger.Debug("realm %q done reconciling", request.NamespacedName)
return reconcile.Result{}, *cephObjectRealm, nil
}
func (r *ReconcileObjectRealm) pullCephRealm(realm *cephv1.CephObjectRealm) (reconcile.Result, error) {
realmArg := fmt.Sprintf("--rgw-realm=%s", realm.Name)
urlArg := fmt.Sprintf("--url=%s", realm.Spec.Pull.Endpoint)
logger.Debug("getting keys to pull realm for CephObjectRealm %q", realm.Name)
accessKeyArg, secretKeyArg, err := object.GetRealmKeyArgs(r.opManagerContext, r.context, realm.Name, realm.Namespace)
if err != nil {
if kerrors.IsNotFound(err) {
return waitForRequeueIfRealmNotReady, err
}
return waitForRequeueIfRealmNotReady, errors.Wrap(err, "failed to get keys for realm")
}
logger.Debugf("keys found to pull realm for CephObjectRealm %q, getting ready to pull from endpoint %q", realm.Name, realm.Spec.Pull.Endpoint)
objContext := object.NewContext(r.context, r.clusterInfo, realm.Name)
output, err := object.RunAdminCommandNoMultisite(objContext, false, "realm", "pull", realmArg, urlArg, accessKeyArg, secretKeyArg)
if err != nil {
return waitForRequeueIfRealmNotReady, errors.Wrapf(err, "realm pull failed for reason: %v", output)
}
logger.Debugf("realm pull for %q from endpoint %q succeeded", realm.Name, realm.Spec.Pull.Endpoint)
return reconcile.Result{}, nil
}
func (r *ReconcileObjectRealm) createCephRealm(realm *cephv1.CephObjectRealm) (reconcile.Result, error) {
realmArg := fmt.Sprintf("--rgw-realm=%s", realm.Name)
objContext := object.NewContext(r.context, r.clusterInfo, realm.Namespace)
_, err := object.RunAdminCommandNoMultisite(objContext, true, "realm", "get", realmArg)
if err != nil {
if code, ok := exec.ExitStatus(err); ok && code == int(syscall.ENOENT) {
logger.Debugf("ceph realm %q not found, running `radosgw-admin realm create`", realm.Name)
_, err := object.RunAdminCommandNoMultisite(objContext, false, "realm", "create", realmArg)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to create ceph realm %s", realm.Name)
}
logger.Debugf("created ceph realm %q", realm.Name)
} else {
return reconcile.Result{}, errors.Wrapf(err, "radosgw-admin realm get failed with code %d", code)
}
}
return reconcile.Result{}, nil
}
func (r *ReconcileObjectRealm) createRealmKeys(realm *cephv1.CephObjectRealm) (reconcile.Result, error) {
realmName := types.NamespacedName{Namespace: realm.Namespace, Name: realm.Name}
logger.Debugf("generating access and secret keys for new realm %q", realmName.String())
secretName := realm.Name + "-keys"
// Check if the secret exists first, and check that it has the access information needed.
secret, err := object.GetRealmKeySecret(r.opManagerContext, r.context, realmName)
if err == nil {
// secret exists, now verify access info. We don't need the args, but we do want to get the
// error if the args can't be built
_, _, err := object.GetRealmKeyArgsFromSecret(secret, realmName)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to ensure secret keys for CephObjectRealm %q", realmName.String())
}
return reconcile.Result{}, nil
}
// the realm's secret key and access key are randomly generated and then encoded to base64
accessKey, err := mgr.GeneratePassword(accessKeyLength)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "access key failed to generate")
}
accessKey = base64.StdEncoding.EncodeToString([]byte(accessKey))
secretKey, err := mgr.GeneratePassword(secretKeyLength)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to generate secret key")
}
secretKey = base64.StdEncoding.EncodeToString([]byte(secretKey))
logger.Debugf("creating secrets for new realm %q", realm.Name)
secrets := map[string][]byte{
object.AccessKeyName: []byte(accessKey),
object.SecretKeyName: []byte(secretKey),
}
secret = &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: secretName,
Namespace: realm.Namespace,
},
Data: secrets,
Type: k8sutil.RookType,
}
err = controllerutil.SetControllerReference(realm, secret, r.scheme)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to set owner reference of rgw secret %q", secret.Name)
}
if _, err = r.context.Clientset.CoreV1().Secrets(realm.Namespace).Create(r.opManagerContext, secret, metav1.CreateOptions{}); err != nil {
return reconcile.Result{}, errors.Wrap(err, "failed to save rgw secrets")
}
logger.Infof("secret keys have been created for realm %q in secret %q", realm.Name, secret.Name)
return reconcile.Result{}, nil
}
// validateRealmCR validates the realm arguments
func validateRealmCR(u *cephv1.CephObjectRealm) error {
if u.Name == "" {
return errors.New("missing name")
}
if u.Namespace == "" {
return errors.New("missing namespace")
}
return nil
}
func (r *ReconcileObjectRealm) setFailedStatus(observedGeneration int64, cephObjectRealm *cephv1.CephObjectRealm, name types.NamespacedName, errMessage string, err error) (reconcile.Result, cephv1.CephObjectRealm, error) {
r.updateStatus(observedGeneration, name, k8sutil.ReconcileFailedStatus)
return reconcile.Result{}, *cephObjectRealm, errors.Wrapf(err, "%s", errMessage)
}
// updateStatus updates an realm with a given status
func (r *ReconcileObjectRealm) updateStatus(observedGeneration int64, name types.NamespacedName, status string) {
objectRealm := &cephv1.CephObjectRealm{}
if err := r.client.Get(r.opManagerContext, name, objectRealm); err != nil {
if kerrors.IsNotFound(err) {
logger.Debug("CephObjectRealm %q resource not found. Ignoring since object must be deleted", name)
return
}
logger.Warningf("failed to retrieve object realm %q to update status to %q. %v", name, status, err)
return
}
if objectRealm.Status == nil {
objectRealm.Status = &cephv1.Status{}
}
objectRealm.Status.Phase = status
if observedGeneration != k8sutil.ObservedGenerationNotAvailable {
objectRealm.Status.ObservedGeneration = observedGeneration
}
if err := reporting.UpdateStatus(r.client, objectRealm); err != nil {
logger.Errorf("failed to set object realm %q status to %q. %v", name, status, err)
return
}
logger.Debugf("object realm %q status updated to %q", name, status)
}