-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
controller.go
370 lines (318 loc) · 13.3 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
359
360
361
362
363
364
365
366
367
368
369
370
/*
Copyright 2019 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 client to manage a rook client.
package client
import (
"context"
"fmt"
"reflect"
"regexp"
"strings"
"github.com/pkg/errors"
"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"
"sigs.k8s.io/controller-runtime/pkg/source"
"github.com/coreos/pkg/capnslog"
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/mon"
opcontroller "github.com/rook/rook/pkg/operator/ceph/controller"
"github.com/rook/rook/pkg/operator/ceph/reporting"
"github.com/rook/rook/pkg/operator/k8sutil"
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/runtime"
"k8s.io/apimachinery/pkg/types"
)
const (
controllerName = "ceph-client-controller"
)
var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName)
var cephClientKind = reflect.TypeOf(cephv1.CephClient{}).Name()
// Sets the type meta for the controller main object
var controllerTypeMeta = metav1.TypeMeta{
Kind: cephClientKind,
APIVersion: fmt.Sprintf("%s/%s", cephv1.CustomResourceGroup, cephv1.Version),
}
// ReconcileCephClient reconciles a CephClient object
type ReconcileCephClient struct {
client client.Client
scheme *runtime.Scheme
context *clusterd.Context
clusterInfo *cephclient.ClusterInfo
opManagerContext context.Context
}
// Add creates a new CephClient 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 &ReconcileCephClient{
client: mgr.GetClient(),
scheme: mgr.GetScheme(),
context: context,
opManagerContext: opManagerContext,
}
}
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 CephClient CRD object
err = c.Watch(&source.Kind{Type: &cephv1.CephClient{TypeMeta: controllerTypeMeta}}, &handler.EnqueueRequestForObject{}, opcontroller.WatchControllerPredicate())
if err != nil {
return err
}
// Watch secrets
err = c.Watch(&source.Kind{Type: &v1.Secret{TypeMeta: metav1.TypeMeta{Kind: "Secret", APIVersion: v1.SchemeGroupVersion.String()}}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &cephv1.CephClient{},
}, opcontroller.WatchPredicateForNonCRDObject(&cephv1.CephClient{TypeMeta: controllerTypeMeta}, mgr.GetScheme()))
if err != nil {
return err
}
return nil
}
// Reconcile reads that state of the cluster for a CephClient object and makes changes based on the state read
// and what is in the CephClient.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 *ReconcileCephClient) 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, err := r.reconcile(request)
if err != nil {
logger.Errorf("failed to reconcile %v", err)
}
return reconcileResponse, err
}
func (r *ReconcileCephClient) reconcile(request reconcile.Request) (reconcile.Result, error) {
// Fetch the CephClient instance
cephClient := &cephv1.CephClient{}
err := r.client.Get(r.opManagerContext, request.NamespacedName, cephClient)
if err != nil {
if kerrors.IsNotFound(err) {
logger.Debug("cephClient resource not found. Ignoring since object must be deleted.")
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, errors.Wrap(err, "failed to get cephClient")
}
// Set a finalizer so we can do cleanup before the object goes away
err = opcontroller.AddFinalizerIfNotPresent(r.opManagerContext, r.client, cephClient)
if err != nil {
return reconcile.Result{}, errors.Wrap(err, "failed to add finalizer")
}
// The CR was just created, initializing status fields
if cephClient.Status == nil {
r.updateStatus(r.client, request.NamespacedName, cephv1.ConditionProgressing)
}
// Make sure a CephCluster is present otherwise do nothing
_, 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
// We skip the deletePool() function since everything is gone already
//
// Also, only remove the finalizer if the CephCluster is gone
// If not, we should wait for it to be ready
// This handles the case where the operator is not ready to accept Ceph command but the cluster exists
if !cephClient.GetDeletionTimestamp().IsZero() && !cephClusterExists {
// Remove finalizer
err = opcontroller.RemoveFinalizer(r.opManagerContext, r.client, cephClient)
if err != nil {
return opcontroller.ImmediateRetryResult, errors.Wrap(err, "failed to remove finalizer")
}
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, nil
}
return reconcileResponse, nil
}
// Populate clusterInfo during each reconcile
r.clusterInfo, _, _, err = mon.LoadClusterInfo(r.context, r.opManagerContext, request.NamespacedName.Namespace)
if err != nil {
return reconcile.Result{}, errors.Wrap(err, "failed to populate cluster info")
}
r.clusterInfo.Context = r.opManagerContext
// DELETE: the CR was deleted
if !cephClient.GetDeletionTimestamp().IsZero() {
logger.Debugf("deleting pool %q", cephClient.Name)
err := r.deleteClient(cephClient)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to delete ceph client %q", cephClient.Name)
}
// Remove finalizer
err = opcontroller.RemoveFinalizer(r.opManagerContext, r.client, cephClient)
if err != nil {
return reconcile.Result{}, errors.Wrap(err, "failed to remove finalizer")
}
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, nil
}
// validate the client settings
err = ValidateClient(r.context, cephClient)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to validate client %q arguments", cephClient.Name)
}
// Create or Update client
err = r.createOrUpdateClient(cephClient)
if err != nil {
if strings.Contains(err.Error(), opcontroller.UninitializedCephConfigError) {
logger.Info(opcontroller.OperatorNotInitializedMessage)
return opcontroller.WaitForRequeueIfOperatorNotInitialized, nil
}
r.updateStatus(r.client, request.NamespacedName, cephv1.ConditionFailure)
return reconcile.Result{}, errors.Wrapf(err, "failed to create or update client %q", cephClient.Name)
}
// Success! Let's update the status
r.updateStatus(r.client, request.NamespacedName, cephv1.ConditionReady)
// Return and do not requeue
logger.Debug("done reconciling")
return reconcile.Result{}, nil
}
// Create the client
func (r *ReconcileCephClient) createOrUpdateClient(cephClient *cephv1.CephClient) error {
logger.Infof("creating client %s in namespace %s", cephClient.Name, cephClient.Namespace)
// Generate the CephX details
clientEntity, caps := genClientEntity(cephClient)
// Check if client was created manually, create if necessary or update caps and create secret
key, err := cephclient.AuthGetKey(r.context, r.clusterInfo, clientEntity)
if err != nil {
key, err = cephclient.AuthGetOrCreateKey(r.context, r.clusterInfo, clientEntity, caps)
if err != nil {
return errors.Wrapf(err, "failed to create client %q", cephClient.Name)
}
} else {
err = cephclient.AuthUpdateCaps(r.context, r.clusterInfo, clientEntity, caps)
if err != nil {
return errors.Wrapf(err, "client %q exists, failed to update client caps", cephClient.Name)
}
}
// Generate Kubernetes Secret
secret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: generateCephUserSecretName(cephClient),
Namespace: cephClient.Namespace,
},
StringData: map[string]string{
cephClient.Name: key,
},
Type: k8sutil.RookType,
}
// Set CephClient owner ref to the Secret
err = controllerutil.SetControllerReference(cephClient, secret, r.scheme)
if err != nil {
return errors.Wrapf(err, "failed to set owner reference to ceph client secret %q", secret.Name)
}
// Create or Update Kubernetes Secret
_, err = r.context.Clientset.CoreV1().Secrets(cephClient.Namespace).Get(r.clusterInfo.Context, secret.Name, metav1.GetOptions{})
if err != nil {
if kerrors.IsNotFound(err) {
logger.Debugf("creating secret for %q", secret.Name)
if _, err := r.context.Clientset.CoreV1().Secrets(cephClient.Namespace).Create(r.clusterInfo.Context, secret, metav1.CreateOptions{}); err != nil {
return errors.Wrapf(err, "failed to create secret for %q", secret.Name)
}
logger.Infof("created client %q", cephClient.Name)
return nil
}
return errors.Wrapf(err, "failed to get secret for %q", secret.Name)
}
logger.Debugf("updating secret for %s", secret.Name)
_, err = r.context.Clientset.CoreV1().Secrets(cephClient.Namespace).Update(r.clusterInfo.Context, secret, metav1.UpdateOptions{})
if err != nil {
return errors.Wrapf(err, "failed to update secret for %q", secret.Name)
}
logger.Infof("updated client %q", cephClient.Name)
return nil
}
// Delete the client
func (r *ReconcileCephClient) deleteClient(cephClient *cephv1.CephClient) error {
logger.Infof("deleting client object %q", cephClient.Name)
if err := cephclient.AuthDelete(r.context, r.clusterInfo, generateClientName(cephClient.Name)); err != nil {
return errors.Wrapf(err, "failed to delete client %q", cephClient.Name)
}
logger.Infof("deleted client %q", cephClient.Name)
return nil
}
// ValidateClient the client arguments
func ValidateClient(context *clusterd.Context, cephClient *cephv1.CephClient) error {
// Validate name
if cephClient.Name == "" {
return errors.New("missing name")
}
reservedNames := regexp.MustCompile("^admin$|^rgw.*$|^rbd-mirror$|^osd.[0-9]*$|^bootstrap-(mds|mgr|mon|osd|rgw|^rbd-mirror)$")
if reservedNames.Match([]byte(cephClient.Name)) {
return errors.Errorf("ignoring reserved name %q", cephClient.Name)
}
// Validate Spec
if cephClient.Spec.Caps == nil {
return errors.New("no caps specified")
}
for _, cap := range cephClient.Spec.Caps {
if cap == "" {
return errors.New("no caps specified")
}
}
return nil
}
func genClientEntity(cephClient *cephv1.CephClient) (string, []string) {
caps := []string{}
for name, cap := range cephClient.Spec.Caps {
caps = append(caps, name, cap)
}
return generateClientName(cephClient.Name), caps
}
func generateClientName(name string) string {
return fmt.Sprintf("client.%s", name)
}
// updateStatus updates an object with a given status
func (r *ReconcileCephClient) updateStatus(client client.Client, name types.NamespacedName, status cephv1.ConditionType) {
cephClient := &cephv1.CephClient{}
if err := client.Get(r.opManagerContext, name, cephClient); err != nil {
if kerrors.IsNotFound(err) {
logger.Debug("CephClient resource not found. Ignoring since object must be deleted.")
return
}
logger.Warningf("failed to retrieve ceph client %q to update status to %q. %v", name, status, err)
return
}
if cephClient.Status == nil {
cephClient.Status = &cephv1.CephClientStatus{}
}
cephClient.Status.Phase = status
if cephClient.Status.Phase == cephv1.ConditionReady {
cephClient.Status.Info = generateStatusInfo(cephClient)
}
if err := reporting.UpdateStatus(client, cephClient); err != nil {
logger.Errorf("failed to set ceph client %q status to %q. %v", name, status, err)
return
}
logger.Debugf("ceph client %q status updated to %q", name, status)
}
func generateStatusInfo(client *cephv1.CephClient) map[string]string {
m := make(map[string]string)
m["secretName"] = generateCephUserSecretName(client)
return m
}
func generateCephUserSecretName(client *cephv1.CephClient) string {
return fmt.Sprintf("rook-ceph-client-%s", client.Name)
}