-
Notifications
You must be signed in to change notification settings - Fork 5
/
openstackkeypair_controller.go
326 lines (289 loc) · 11.7 KB
/
openstackkeypair_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
/*
Copyright 2023.
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 controller
import (
"context"
"errors"
"fmt"
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/openstack/compute/v2/extensions/keypairs"
"github.com/gophercloud/gophercloud/pagination"
openstackv1 "github.com/k-orc/openstack-resource-controller/api/v1alpha1"
"github.com/k-orc/openstack-resource-controller/pkg/apply"
"github.com/k-orc/openstack-resource-controller/pkg/cloud"
"github.com/k-orc/openstack-resource-controller/pkg/conditions"
"github.com/k-orc/openstack-resource-controller/pkg/labels"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/record"
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/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
const (
OpenStackKeypairFinalizer = "openstackkeypair.k-orc.cloud"
)
// OpenStackKeypairReconciler reconciles a OpenStackKeypair object
type OpenStackKeypairReconciler struct {
client.Client
Scheme *runtime.Scheme
Recorder record.EventRecorder
}
//+kubebuilder:rbac:groups=openstack.k-orc.cloud,resources=openstackkeypairs,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=openstack.k-orc.cloud,resources=openstackkeypairs/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=openstack.k-orc.cloud,resources=openstackkeypairs/finalizers,verbs=update
//+kubebuilder:rbac:groups="",resources=events,verbs=create;patch
func (r *OpenStackKeypairReconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Result, reterr error) {
logger := log.FromContext(ctx)
logger = logger.WithValues("OpenStackKeypair", req.Name)
resource := &openstackv1.OpenStackKeypair{}
err := r.Client.Get(ctx, req.NamespacedName, resource)
if err != nil {
if apierrors.IsNotFound(err) {
logger.Info("resource not found in the API")
return ctrl.Result{}, nil
}
return ctrl.Result{}, err
}
if resource.DeletionTimestamp.IsZero() {
finalizerUpdated := controllerutil.AddFinalizer(resource, OpenStackKeypairFinalizer)
newLabels := map[string]string{
openstackv1.OpenStackDependencyLabelCloud(resource.Spec.Cloud): "",
}
labelsMerger, labelsUpdated := labels.ReplacePrefixed(openstackv1.OpenStackLabelPrefix, resource.Labels, newLabels)
if finalizerUpdated || labelsUpdated {
logger.Info("applying labels and finalizer")
patch := &openstackv1.OpenStackKeypair{}
patch.TypeMeta = resource.TypeMeta
patch.Finalizers = resource.GetFinalizers()
patch.Labels = labelsMerger
return ctrl.Result{}, apply.Apply(ctx, r.Client, resource, patch, "spec")
}
}
statusPatchResource := &openstackv1.OpenStackKeypair{
Status: *resource.Status.DeepCopy(),
TypeMeta: resource.TypeMeta,
}
defer func() {
if reterr != nil {
if updated, condition := conditions.SetNotReadyConditionTransientError(resource, statusPatchResource, reterr.Error()); updated {
conditions.EmitEventForCondition(r.Recorder, resource, corev1.EventTypeWarning, condition)
}
}
if err := apply.ApplyStatus(ctx, r.Client, resource, statusPatchResource); err != nil && !(apierrors.IsNotFound(err) && len(resource.Finalizers) == 0) {
reterr = errors.Join(reterr, err)
}
}()
if len(resource.Status.Conditions) == 0 {
conditions.InitialiseRequiredConditions(resource, statusPatchResource)
}
// Get the OpenStackCloud resource
openStackCloud := &openstackv1.OpenStackCloud{}
{
openStackCloudRef := client.ObjectKey{
Namespace: req.Namespace,
Name: resource.Spec.Cloud,
}
err := r.Client.Get(ctx, openStackCloudRef, openStackCloud)
if err != nil && !apierrors.IsNotFound(err) {
return ctrl.Result{}, fmt.Errorf("fetching OpenStackCloud %s: %w", resource.Spec.Cloud, err)
}
// XXX(mbooth): We should check IsReady(openStackCloud) here, but we can't because this breaks us while the cloud is Deleting.
// We probably need another Condition 'Deleting' so an object can be both Ready and Deleting during the cleanup phase.
if err != nil {
conditions.SetNotReadyConditionWaiting(resource, statusPatchResource, []conditions.Dependency{
{ObjectKey: openStackCloudRef, Resource: "OpenStackCloud"},
})
return ctrl.Result{}, nil
}
}
computeClient, err := cloud.NewServiceClient(ctx, r.Client, openStackCloud, "compute")
if err != nil {
err = fmt.Errorf("unable to build an OpenStack client: %w", err)
logger.Info(err.Error())
return ctrl.Result{}, err
}
if !resource.DeletionTimestamp.IsZero() {
return r.reconcileDelete(log.IntoContext(ctx, logger), computeClient, resource, statusPatchResource)
}
return r.reconcile(log.IntoContext(ctx, logger), computeClient, resource, statusPatchResource)
}
// reconcile handles creation. No modification is accepted.
// TODO: restrict unhandled modification through a webhook
// TODO: potentially handle (some?) modifications accepted in OpenStack
func (r *OpenStackKeypairReconciler) reconcile(ctx context.Context, computeClient *gophercloud.ServiceClient, resource, statusPatchResource *openstackv1.OpenStackKeypair) (_ ctrl.Result, reterr error) {
logger := log.FromContext(ctx)
var (
keypair *keypairs.KeyPair
err error
)
if openstackID := coalesce(resource.Spec.Name, resource.Status.Resource.Name); openstackID != "" {
logger = logger.WithValues("OpenStackID", openstackID)
keypair, err = keypairs.Get(computeClient, openstackID, keypairs.GetOpts{
UserID: resource.Spec.Resource.UserID,
}).Extract()
if err != nil {
return ctrl.Result{}, err
}
logger.Info("OpenStack resource found")
} else {
keypair, err = r.findOrphan(log.IntoContext(ctx, logger), computeClient, resource, resource.Spec.Resource.UserID, resource.Spec.Resource.Name)
if err != nil {
return ctrl.Result{}, fmt.Errorf("unable to find adoption candidates: %w", err)
}
if keypair != nil {
logger = logger.WithValues("OpenStackID", keypair.Name)
logger.Info("OpenStack resource adopted")
} else {
createOpts := keypairs.CreateOpts{
Name: resource.Spec.Resource.Name,
UserID: resource.Spec.Resource.UserID,
Type: resource.Spec.Resource.Type,
PublicKey: resource.Spec.Resource.PublicKey,
}
keypair, err = keypairs.Create(computeClient, createOpts).Extract()
if err != nil {
return ctrl.Result{}, err
}
logger = logger.WithValues("OpenStackID", keypair.Name)
logger.Info("OpenStack resource created")
}
}
statusPatchResource.Status.Resource = openstackv1.OpenStackKeypairResourceStatus{
Name: keypair.Name,
PublicKey: keypair.PublicKey,
Fingerprint: keypair.Fingerprint,
UserID: keypair.UserID,
Type: keypair.Type,
}
if updated, condition := conditions.SetReadyCondition(resource, statusPatchResource); updated {
conditions.EmitEventForCondition(r.Recorder, resource, corev1.EventTypeNormal, condition)
}
return ctrl.Result{}, nil
}
func (r *OpenStackKeypairReconciler) reconcileDelete(ctx context.Context, computeClient *gophercloud.ServiceClient, resource, statusPatchResource *openstackv1.OpenStackKeypair) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if resource.Status.Resource.Name == "" {
logger.Info("deletion was requested on a resource that hasn't been successfully created or adopted yet.")
} else {
logger = logger.WithValues("OpenStackID", resource.Status.Resource.Name)
if !resource.Spec.Unmanaged {
if err := keypairs.Delete(computeClient, resource.Status.Resource.Name, keypairs.DeleteOpts{
UserID: resource.Status.Resource.UserID,
}).ExtractErr(); err != nil {
var gerr gophercloud.ErrDefault404
if errors.As(err, &gerr) {
logger.Info("deletion was requested on a resource that can't be found in OpenStack.")
} else {
logger.Info("failed to delete resource in OpenStack; requeuing.")
return ctrl.Result{}, err
}
}
}
}
if updated := controllerutil.RemoveFinalizer(resource, OpenStackKeypairFinalizer); updated {
logger.Info("removing finalizer")
if updated, condition := conditions.SetNotReadyConditionDeleting(resource, statusPatchResource, "Removing finalizer"); updated {
conditions.EmitEventForCondition(r.Recorder, resource, corev1.EventTypeNormal, condition)
}
patch := &openstackv1.OpenStackKeypair{}
patch.TypeMeta = resource.TypeMeta
patch.Finalizers = resource.GetFinalizers()
return ctrl.Result{}, apply.Apply(ctx, r.Client, resource, patch, "spec")
}
return ctrl.Result{}, nil
}
func (r *OpenStackKeypairReconciler) findOrphan(ctx context.Context, computeClient *gophercloud.ServiceClient, resource client.Object, userID, name string) (*keypairs.KeyPair, error) {
adoptedIDs := make(map[string]struct{})
{
list := &openstackv1.OpenStackKeypairList{}
if err := r.Client.List(ctx, list,
client.InNamespace(resource.GetNamespace()),
); err != nil {
return nil, fmt.Errorf("listing OpenStackKeypairs: %w", err)
}
for _, obj := range list.Items {
if obj.GetName() != resource.GetName() && obj.Status.Resource.Name != "" {
adoptedIDs[obj.Status.Resource.Name] = struct{}{}
}
}
}
var candidates []keypairs.KeyPair
err := keypairs.List(computeClient, keypairs.ListOpts{
UserID: userID,
}).EachPage(func(page pagination.Page) (bool, error) {
items, err := keypairs.ExtractKeyPairs(page)
if err != nil {
return false, fmt.Errorf("extracting resources: %w", err)
}
for i := range items {
if _, ok := adoptedIDs[items[i].Name]; !ok && items[i].Name == name {
candidates = append(candidates, items[i])
}
}
return true, nil
})
if err != nil {
return nil, err
}
switch n := len(candidates); n {
case 0:
return nil, nil
case 1:
return &candidates[0], nil
default:
return nil, fmt.Errorf("found %d possible candidates", n)
}
}
// SetupWithManager sets up the controller with the Manager.
func (r *OpenStackKeypairReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&openstackv1.OpenStackKeypair{}).
WithEventFilter(apply.IgnoreManagedFieldsOnly{}).
Watches(&openstackv1.OpenStackCloud{}, handler.EnqueueRequestsFromMapFunc(func(ctx context.Context, o client.Object) []reconcile.Request {
// Fetch a list of all OpenStackKeypairs that reference this OpenStackCloud.
kclient := mgr.GetClient()
logger := mgr.GetLogger()
keypair := &openstackv1.OpenStackKeypairList{}
if err := kclient.List(ctx, keypair,
client.InNamespace(o.GetNamespace()),
client.HasLabels{openstackv1.OpenStackDependencyLabelCloud(o.GetName())},
); err != nil {
logger.Error(err, "unable to list OpenStackKeypairs")
return nil
}
// Reconcile each OpenStackKeypair that is not Ready and that references this OpenStackCloud.
reqs := make([]reconcile.Request, 0, len(keypair.Items))
for _, k := range keypair.Items {
if conditions.IsReady(&k) {
continue
}
reqs = append(reqs, reconcile.Request{
NamespacedName: client.ObjectKey{
Namespace: k.GetNamespace(),
Name: k.GetName(),
},
})
logger.V(5).Info("update of OpenStackCloud triggers reconcile of OpenStackKeypair",
"namespace", o.GetNamespace(),
"cloud", o.GetName(),
"keypair", k.GetName())
}
return reqs
})).
Complete(r)
}