/
controller.go
307 lines (259 loc) · 9.33 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
/*
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 (
"fmt"
"reflect"
"regexp"
"github.com/pkg/errors"
"github.com/coreos/pkg/capnslog"
opkit "github.com/rook/operator-kit"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/clusterd"
ceph "github.com/rook/rook/pkg/daemon/ceph/client"
cephconfig "github.com/rook/rook/pkg/daemon/ceph/config"
"github.com/rook/rook/pkg/operator/k8sutil"
v1 "k8s.io/api/core/v1"
apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/tools/cache"
)
const ClientSecretName = "-client-key"
var logger = capnslog.NewPackageLogger("github.com/rook/rook", "op-client")
// ClientResource represents the Client custom resource object
var ClientResource = opkit.CustomResource{
Name: "cephclient",
Plural: "cephclients",
Group: cephv1.CustomResourceGroup,
Version: cephv1.Version,
Scope: apiextensionsv1beta1.NamespaceScoped,
Kind: reflect.TypeOf(cephv1.CephClient{}).Name(),
}
// ClientController represents a controller object for client custom resources
type ClientController struct {
context *clusterd.Context
namespace string
}
// NewClientController create controller for watching client custom resources created
func NewClientController(context *clusterd.Context, namespace string) *ClientController {
return &ClientController{
context: context,
namespace: namespace,
}
}
// Watch watches for instances of Client custom resources and acts on them
func (c *ClientController) StartWatch(stopCh chan struct{}) error {
resourceHandlerFuncs := cache.ResourceEventHandlerFuncs{
AddFunc: c.onAdd,
UpdateFunc: c.onUpdate,
DeleteFunc: c.onDelete,
}
logger.Infof("start watching client resources in namespace %q", c.namespace)
watcher := opkit.NewWatcher(ClientResource, c.namespace, resourceHandlerFuncs, c.context.RookClientset.CephV1().RESTClient())
go watcher.Watch(&cephv1.CephClient{}, stopCh)
return nil
}
func (c *ClientController) onAdd(obj interface{}) {
logger.Infof("new client onAdd() called")
client, err := getClientObject(obj)
if err != nil {
logger.Errorf("failed to get client object. %v", err)
return
}
err = createClient(c.context, client)
if err != nil {
logger.Errorf("failed to create client %q. %v", client.ObjectMeta.Name, err)
}
}
func genClientEntity(p *cephv1.CephClient, context *clusterd.Context) (clientEntity string, caps []string, err error) {
clientEntity = fmt.Sprintf("client.%s", p.Name)
caps = []string{}
// validate the client settings
if err := ValidateClient(context, p); err != nil {
return clientEntity, caps, errors.Wrapf(err, "invalid client %q arguments", p.Name)
}
for name, cap := range p.Spec.Caps {
caps = append(caps, name, cap)
}
return clientEntity, caps, nil
}
// Create the client
func createClient(context *clusterd.Context, p *cephv1.CephClient) error {
logger.Infof("creating client %s in namespace %s", p.Name, p.Namespace)
clientEntity, caps, err := genClientEntity(p, context)
if err != nil {
return errors.Wrapf(err, "failed to generate client entity %q", p.Name)
}
// Check if client was created manually, create if necessary or update caps and create secret
key, err := ceph.AuthGetKey(context, p.Namespace, clientEntity)
if err != nil {
// Example in pkg/operator/ceph/config/keyring/store.go:65
key, err = ceph.AuthGetOrCreateKey(context, p.Namespace, clientEntity, caps)
if err != nil {
return errors.Wrapf(err, "failed to create client %q", p.Name)
}
} else {
err = ceph.AuthUpdateCaps(context, p.Namespace, clientEntity, caps)
if err != nil {
return errors.Wrapf(err, "client %q exists, failed to update client caps", p.Name)
}
}
secret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("%s%s", p.Name, ClientSecretName),
Namespace: p.Namespace,
},
StringData: map[string]string{
p.Name: key,
},
Type: k8sutil.RookType,
}
secretName := secret.ObjectMeta.Name
_, err = context.Clientset.CoreV1().Secrets(p.Namespace).Get(secretName, metav1.GetOptions{})
if err != nil {
if kerrors.IsNotFound(err) {
logger.Debugf("creating secret for %s", secretName)
if _, err := context.Clientset.CoreV1().Secrets(p.Namespace).Create(secret); err != nil {
return errors.Wrapf(err, "failed to create secret for %q", secretName)
}
return nil
}
return errors.Wrapf(err, "failed to get secret for %q", secretName)
}
logger.Debugf("updating secret for %s", secretName)
if _, err := context.Clientset.CoreV1().Secrets(p.Namespace).Update(secret); err != nil {
return errors.Wrapf(err, "failed to update secret for %q", secretName)
}
logger.Infof("created client %s", p.Name)
return nil
}
func updateClient(context *clusterd.Context, p *cephv1.CephClient) error {
logger.Infof("updating client %s in namespace %s", p.Name, p.Namespace)
clientEntity, caps, err := genClientEntity(p, context)
if err != nil {
return errors.Wrapf(err, "failed to generate client entity %q", p.Name)
}
err = ceph.AuthUpdateCaps(context, p.Namespace, clientEntity, caps)
if err != nil {
return errors.Wrapf(err, "failed to update client %q", p.Name)
}
logger.Infof("updated client %s", p.Name)
return nil
}
func (c *ClientController) onUpdate(oldObj, newObj interface{}) {
oldClient, err := getClientObject(oldObj)
if err != nil {
logger.Errorf("failed to get old client object. %v", err)
return
}
client, err := getClientObject(newObj)
if err != nil {
logger.Errorf("failed to get new client object. %v", err)
return
}
if oldClient.Name != client.Name {
logger.Errorf("failed to update client %q. name update not allowed", client.Name)
return
}
if !clientChanged(oldClient.Spec, client.Spec) {
logger.Debugf("client %q not changed", client.Name)
return
}
logger.Infof("updating client %s", client.Name)
if err := updateClient(c.context, client); err != nil {
logger.Errorf("failed to update client %q. %v", client.ObjectMeta.Name, err)
}
}
func (c *ClientController) ParentClusterChanged(cluster cephv1.ClusterSpec, clusterInfo *cephconfig.ClusterInfo) {
logger.Debugf("No need to update the client after the parent cluster changed")
}
func clientChanged(old, new cephv1.ClientSpec) bool {
for name, cap := range new.Caps {
if cap != old.Caps[name] {
return true
}
}
return false
}
func (c *ClientController) onDelete(obj interface{}) {
client, err := getClientObject(obj)
if err != nil {
logger.Errorf("failed to get client object. %v", err)
return
}
logger.Infof("Going to remove client object %s", client.Name)
if err := deleteClient(c.context, client); err != nil {
logger.Errorf("failed to delete client %q. %v", client.ObjectMeta.Name, err)
}
logger.Infof("Removed client %s", client.Name)
}
// Delete the client
func deleteClient(context *clusterd.Context, p *cephv1.CephClient) error {
clientEntity := fmt.Sprintf("client.%s", p.Name)
if err := ceph.AuthDelete(context, p.Namespace, clientEntity); err != nil {
return errors.Wrapf(err, "failed to delete client %q", p.Name)
}
secretName := fmt.Sprintf("%s-client-key", p.Name)
if err := context.Clientset.CoreV1().Secrets(p.Namespace).Delete(secretName, &metav1.DeleteOptions{}); err != nil && !kerrors.IsNotFound(err) {
return errors.Errorf("failed to remote client %q secret %q", p.Name, secretName)
}
return nil
}
// Check if the client exists
func clientExists(context *clusterd.Context, p *cephv1.CephClient) (bool, error) {
_, err := ceph.AuthGetKey(context, p.Namespace, p.Name)
if err != nil {
return false, err
}
return true, nil
}
// Validate the client arguments
func ValidateClient(context *clusterd.Context, p *cephv1.CephClient) error {
if p.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(p.Name)) {
return errors.Errorf("ignoring reserved name %q", p.Name)
}
if p.Namespace == "" {
return errors.New("missing namespace")
}
if err := ValidateClientSpec(context, p.Namespace, &p.Spec); err != nil {
return err
}
return nil
}
// ValidateClientSpec checks if caps were passed for new or updated client
func ValidateClientSpec(context *clusterd.Context, namespace string, p *cephv1.ClientSpec) error {
if p.Caps == nil {
return errors.New("no caps specified")
}
for _, cap := range p.Caps {
if cap == "" {
return errors.New("no caps specified")
}
}
return nil
}
func getClientObject(obj interface{}) (client *cephv1.CephClient, err error) {
var ok bool
client, ok = obj.(*cephv1.CephClient)
if ok {
// the client object is of the latest type, simply return it
return client.DeepCopy(), nil
}
return nil, errors.Errorf("not a known client object: %+v", obj)
}