-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcoderprovisioner_controller.go
More file actions
1444 lines (1298 loc) · 50.4 KB
/
Copy pathcoderprovisioner_controller.go
File metadata and controls
1444 lines (1298 loc) · 50.4 KB
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package controller contains Kubernetes controllers for coder-k8s resources.
package controller
import (
"context"
"crypto/rand"
"encoding/binary"
"errors"
"fmt"
"hash/fnv"
"maps"
"net/http"
"slices"
"strings"
"sync"
"time"
"github.com/coder/coder/v2/codersdk"
"github.com/google/uuid"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
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/reconcile"
coderv1alpha1 "github.com/coder/coder-k8s/api/v1alpha1"
"github.com/coder/coder-k8s/internal/coderbootstrap"
)
const (
defaultProvisionerReplicas = int32(1)
defaultProvisionerTerminationGracePeriodSeconds = int64(600)
defaultProvisionerOrganizationName = "default"
provisionerNamePrefix = "provisioner-"
provisionerServiceAccountSuffix = "-provisioner"
provisionerKeyChecksumAnnotation = "checksum/provisioner-key"
provisionerRateLimitBackoffBase = 2 * time.Second
provisionerRateLimitBackoffCap = 2 * time.Minute
provisionerRateLimitBackoffFloor = 1 * time.Second
provisionerRateLimitJitterRatio = 0.2
externalProvisionerEntitlementRetryInterval = 2 * time.Minute
// #nosec G101 -- this is a field index key, not a credential.
provisionerControlPlaneRefNameFieldIndex = ".spec.controlPlaneRef.name"
)
var provisionerRateLimitBackoffAttempts sync.Map // map[string]int
// CoderProvisionerReconciler reconciles a CoderProvisioner object.
type CoderProvisionerReconciler struct {
client.Client
Scheme *runtime.Scheme
BootstrapClient coderbootstrap.Client
}
// +kubebuilder:rbac:groups=coder.com,resources=coderprovisioners,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=coder.com,resources=coderprovisioners/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=coder.com,resources=coderprovisioners/finalizers,verbs=update
// +kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups="",resources=pods;persistentvolumeclaims,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups="",resources=secrets;serviceaccounts,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=roles;rolebindings,verbs=get;list;watch;create;update;patch;delete
// Reconcile converges the desired CoderProvisioner spec into Deployment, RBAC, and Secret resources.
func (r *CoderProvisionerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
if r.Client == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: reconciler client must not be nil")
}
if r.Scheme == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: reconciler scheme must not be nil")
}
if r.BootstrapClient == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: reconciler bootstrap client must not be nil")
}
provisioner := &coderv1alpha1.CoderProvisioner{}
defer func() {
switch {
case err == nil:
if result.RequeueAfter == 0 {
resetProvisionerRateLimitBackoff(req.NamespacedName)
}
return
case !coderbootstrap.IsRateLimitError(err):
resetProvisionerRateLimitBackoff(req.NamespacedName)
return
}
backoff := nextProvisionerRateLimitBackoff(req.NamespacedName)
statusSnapshot := provisioner.Status.DeepCopy()
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse,
"RateLimited",
"Coder API rate limited while reconciling provisioner key",
)
if statusSnapshot != nil && !equality.Semantic.DeepEqual(*statusSnapshot, provisioner.Status) {
if statusErr := r.Status().Update(ctx, provisioner); statusErr != nil && !apierrors.IsNotFound(statusErr) {
ctrl.LoggerFrom(ctx).Error(statusErr, "failed to update coderprovisioner status after rate limit", "name", req.Name, "namespace", req.Namespace)
}
}
ctrl.LoggerFrom(ctx).Info(
"coder API rate limited during provisioner reconciliation; requeueing with backoff",
"name", req.Name,
"namespace", req.Namespace,
"requeueAfter", backoff,
)
result = ctrl.Result{RequeueAfter: backoff}
err = nil
}()
if err = r.Get(ctx, req.NamespacedName, provisioner); err != nil {
if apierrors.IsNotFound(err) {
return ctrl.Result{}, nil
}
return ctrl.Result{}, fmt.Errorf("get coderprovisioner %s: %w", req.NamespacedName, err)
}
if provisioner.Name != req.Name || provisioner.Namespace != req.Namespace {
return ctrl.Result{}, fmt.Errorf("assertion failed: fetched object %s/%s does not match request %s/%s",
provisioner.Namespace, provisioner.Name, req.Namespace, req.Name)
}
if !provisioner.DeletionTimestamp.IsZero() {
return r.reconcileDeletion(ctx, provisioner)
}
statusSnapshot := provisioner.Status.DeepCopy()
finalizerAdded, err := r.ensureCleanupFinalizer(ctx, provisioner)
if err != nil {
return ctrl.Result{}, err
}
if finalizerAdded {
return ctrl.Result{}, nil
}
controlPlane, err := r.fetchControlPlane(ctx, provisioner)
if err != nil {
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionControlPlaneReady,
metav1.ConditionFalse,
"ControlPlaneUnavailable",
fmt.Sprintf("Failed to fetch control plane: %v", err),
)
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, err
}
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionControlPlaneReady,
metav1.ConditionTrue,
"ControlPlaneAvailable",
"Referenced control plane is available and has a URL",
)
organizationName := provisionerOrganizationName(provisioner.Spec.OrganizationName)
keyName, keySecretName, keySecretKey := provisionerKeyConfig(provisioner)
sessionToken, err := r.readBootstrapSessionToken(ctx, provisioner)
if err != nil {
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionBootstrapSecretReady,
metav1.ConditionFalse,
"BootstrapSecretUnavailable",
fmt.Sprintf("Failed to read bootstrap credentials: %v", err),
)
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, err
}
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionBootstrapSecretReady,
metav1.ConditionTrue,
"BootstrapSecretAvailable",
"Bootstrap credentials secret is available",
)
entitlementResult, entitlementErr := r.reconcileExternalProvisionerEntitlement(ctx, provisioner, controlPlane, sessionToken)
if entitlementErr != nil {
if statusSnapshot == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: status snapshot must not be nil")
}
if !equality.Semantic.DeepEqual(*statusSnapshot, provisioner.Status) {
_ = r.Status().Update(ctx, provisioner)
}
return ctrl.Result{}, entitlementErr
}
if entitlementResult.RequeueAfter > 0 {
if statusSnapshot == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: status snapshot must not be nil")
}
if !equality.Semantic.DeepEqual(*statusSnapshot, provisioner.Status) {
_ = r.Status().Update(ctx, provisioner)
}
return entitlementResult, nil
}
desiredTagsHash := hashProvisionerTags(provisioner.Spec.Tags)
desiredControlPlaneRefName := provisioner.Spec.ControlPlaneRef.Name
status := provisioner.Status
orgDrift := status.OrganizationName != "" && status.OrganizationName != organizationName
keyNameDrift := status.ProvisionerKeyName != "" && status.ProvisionerKeyName != keyName
tagsDrift := status.TagsHash != "" && status.TagsHash != desiredTagsHash
controlPlaneRefDrift := status.ControlPlaneRefName != "" && status.ControlPlaneRefName != desiredControlPlaneRefName
controlPlaneURLDrift := status.ControlPlaneURL != "" && status.ControlPlaneURL != controlPlane.Status.URL
driftDetected := orgDrift || keyNameDrift || tagsDrift || controlPlaneRefDrift || controlPlaneURLDrift
appliedOrgName := provisioner.Status.OrganizationName
appliedTagsHash := provisioner.Status.TagsHash
appliedControlPlaneRefName := provisioner.Status.ControlPlaneRefName
appliedControlPlaneURL := provisioner.Status.ControlPlaneURL
// Check whether a usable provisioner key secret already exists.
// The secret is considered "usable" only if the Secret object exists
// AND it contains a non-empty value at the configured data key.
secretNamespacedName := types.NamespacedName{Name: keySecretName, Namespace: provisioner.Namespace}
existingSecret := &corev1.Secret{}
secretUsable := false
if err := r.Get(ctx, secretNamespacedName, existingSecret); err != nil {
if !apierrors.IsNotFound(err) {
return ctrl.Result{}, fmt.Errorf("get provisioner key secret %s: %w", secretNamespacedName, err)
}
} else {
secretUsable = len(existingSecret.Data[keySecretKey]) > 0
}
organizationID := provisioner.Status.OrganizationID
provisionerKeyID := provisioner.Status.ProvisionerKeyID
provisionerKeyName := provisioner.Status.ProvisionerKeyName
if provisionerKeyName == "" {
provisionerKeyName = keyName
}
log := ctrl.LoggerFrom(ctx)
keyMaterial := ""
if driftDetected {
log.Info("spec drift detected, rotating provisioner key",
"orgDrift", orgDrift, "keyNameDrift", keyNameDrift, "tagsDrift", tagsDrift,
"controlPlaneRefDrift", controlPlaneRefDrift, "controlPlaneURLDrift", controlPlaneURLDrift)
oldOrg := provisioner.Status.OrganizationName
if oldOrg == "" {
oldOrg = organizationName
}
oldKeyName := provisioner.Status.ProvisionerKeyName
if oldKeyName == "" {
oldKeyName = keyName
}
oldControlPlaneURL := provisioner.Status.ControlPlaneURL
if oldControlPlaneURL == "" {
oldControlPlaneURL = controlPlane.Status.URL
}
if deleteErr := r.BootstrapClient.DeleteProvisionerKey(
ctx,
oldControlPlaneURL,
sessionToken,
oldOrg,
oldKeyName,
); deleteErr != nil {
log.Info("failed to delete old provisioner key during drift rotation, creating new key anyway",
"oldKeyName", oldKeyName, "error", deleteErr)
}
response, ensureErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if ensureErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to ensure provisioner key %q after drift rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("ensure provisioner key %q: %w", keyName, ensureErr)
}
if response.OrganizationID != uuid.Nil {
organizationID = response.OrganizationID.String()
}
if response.KeyID != uuid.Nil {
provisionerKeyID = response.KeyID.String()
}
if response.KeyName != "" {
provisionerKeyName = response.KeyName
}
keyMaterial = response.Key
if keyMaterial == "" {
log.Info("drift-rotated key exists in coderd but returned no plaintext, rotating to recover",
"keyName", keyName)
if deleteErr := r.BootstrapClient.DeleteProvisionerKey(
ctx, controlPlane.Status.URL, sessionToken, organizationName, keyName,
); deleteErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to delete provisioner key %q for drift recovery", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("delete provisioner key %q for drift recovery: %w", keyName, deleteErr)
}
rotated, rotateErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if rotateErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to recreate provisioner key %q after drift recovery", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("recreate provisioner key %q after drift recovery: %w", keyName, rotateErr)
}
if rotated.OrganizationID != uuid.Nil {
organizationID = rotated.OrganizationID.String()
}
if rotated.KeyID != uuid.Nil {
provisionerKeyID = rotated.KeyID.String()
}
if rotated.KeyName != "" {
provisionerKeyName = rotated.KeyName
}
keyMaterial = rotated.Key
if keyMaterial == "" {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Provisioner key %q returned empty material after drift recovery rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("assertion failed: provisioner key %q returned empty material after drift recovery rotation", keyName)
}
}
appliedOrgName = organizationName
appliedTagsHash = desiredTagsHash
appliedControlPlaneRefName = desiredControlPlaneRefName
appliedControlPlaneURL = controlPlane.Status.URL
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionTrue,
"ProvisionerKeyReady",
"Provisioner key is available in coderd",
)
} else if !secretUsable {
response, ensureErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if ensureErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to ensure provisioner key %q", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("ensure provisioner key %q: %w", keyName, ensureErr)
}
if response.OrganizationID != uuid.Nil {
organizationID = response.OrganizationID.String()
}
if response.KeyID != uuid.Nil {
provisionerKeyID = response.KeyID.String()
}
if response.KeyName != "" {
provisionerKeyName = response.KeyName
}
keyMaterial = response.Key
// If the key already exists in coderd (e.g. the K8s secret was
// deleted), coderd won't return plaintext again. Rotate the key
// by deleting and recreating it to obtain fresh material.
if keyMaterial == "" {
log.Info("provisioner key exists in coderd but secret is missing, rotating key to recover",
"keyName", keyName, "secretName", keySecretName)
if deleteErr := r.BootstrapClient.DeleteProvisionerKey(
ctx, controlPlane.Status.URL, sessionToken, organizationName, keyName,
); deleteErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to delete stale provisioner key %q for rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("delete stale provisioner key %q for rotation: %w", keyName, deleteErr)
}
rotated, rotateErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if rotateErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to recreate provisioner key %q after rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("recreate provisioner key %q after rotation: %w", keyName, rotateErr)
}
if rotated.OrganizationID != uuid.Nil {
organizationID = rotated.OrganizationID.String()
}
if rotated.KeyID != uuid.Nil {
provisionerKeyID = rotated.KeyID.String()
}
if rotated.KeyName != "" {
provisionerKeyName = rotated.KeyName
}
keyMaterial = rotated.Key
if keyMaterial == "" {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Provisioner key %q returned empty key material after rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("assertion failed: provisioner key %q returned empty key material after rotation", keyName)
}
}
appliedOrgName = organizationName
appliedTagsHash = desiredTagsHash
appliedControlPlaneRefName = desiredControlPlaneRefName
appliedControlPlaneURL = controlPlane.Status.URL
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionTrue,
"ProvisionerKeyReady",
"Provisioner key is available in coderd",
)
} else if status.OrganizationName == "" || status.TagsHash == "" || status.ControlPlaneRefName == "" || status.ControlPlaneURL == "" {
// Secret is usable and no drift detected, but status metadata is empty
// (e.g. upgrade from older version). Call EnsureProvisionerKey to populate
// IDs and key name. If coderd reports an existing key (no plaintext key
// returned), rotate it best-effort so desired tags are applied before
// stamping the metadata baseline.
response, ensureErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if ensureErr != nil {
// Return a requeue so metadata population retries.
return ctrl.Result{}, fmt.Errorf("verify provisioner key metadata: %w", ensureErr)
}
if response.OrganizationID != uuid.Nil {
organizationID = response.OrganizationID.String()
}
if response.KeyID != uuid.Nil {
provisionerKeyID = response.KeyID.String()
}
if response.KeyName != "" {
provisionerKeyName = response.KeyName
}
if response.Key != "" {
// Key was freshly created with desired tags; capture material and stamp baseline.
keyMaterial = response.Key
appliedOrgName = organizationName
appliedTagsHash = desiredTagsHash
appliedControlPlaneRefName = desiredControlPlaneRefName
appliedControlPlaneURL = controlPlane.Status.URL
} else {
// Key already exists; tags may be stale. Rotate to ensure desired tags are applied.
log.Info("existing key found during metadata backfill, rotating to ensure desired tags",
"keyName", keyName)
if deleteErr := r.BootstrapClient.DeleteProvisionerKey(
ctx, controlPlane.Status.URL, sessionToken, organizationName, keyName,
); deleteErr != nil {
return ctrl.Result{}, fmt.Errorf("delete provisioner key %q for metadata backfill rotation: %w", keyName, deleteErr)
}
rotated, rotateErr := r.BootstrapClient.EnsureProvisionerKey(ctx, coderbootstrap.EnsureProvisionerKeyRequest{
CoderURL: controlPlane.Status.URL,
SessionToken: sessionToken,
OrganizationName: organizationName,
KeyName: keyName,
Tags: provisioner.Spec.Tags,
})
if rotateErr != nil {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Failed to recreate provisioner key %q after metadata backfill rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("recreate provisioner key %q after metadata backfill rotation: %w", keyName, rotateErr)
}
if rotated.OrganizationID != uuid.Nil {
organizationID = rotated.OrganizationID.String()
}
if rotated.KeyID != uuid.Nil {
provisionerKeyID = rotated.KeyID.String()
}
if rotated.KeyName != "" {
provisionerKeyName = rotated.KeyName
}
keyMaterial = rotated.Key
if keyMaterial == "" {
setCondition(provisioner, coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionFalse, "ProvisionerKeyFailed",
fmt.Sprintf("Provisioner key %q returned empty material after metadata backfill rotation", keyName))
_ = r.Status().Update(ctx, provisioner)
return ctrl.Result{}, fmt.Errorf("assertion failed: provisioner key %q returned empty material after metadata backfill rotation", keyName)
}
appliedOrgName = organizationName
appliedTagsHash = desiredTagsHash
appliedControlPlaneRefName = desiredControlPlaneRefName
appliedControlPlaneURL = controlPlane.Status.URL
}
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionProvisionerKeyReady,
metav1.ConditionTrue,
"ProvisionerKeyReady",
"Provisioner key is available in coderd",
)
}
provisionerKeySecret, err := r.ensureProvisionerKeySecret(ctx, provisioner, keySecretName, keySecretKey, keyMaterial)
if err != nil {
return ctrl.Result{}, err
}
secretValue, ok := provisionerKeySecret.Data[keySecretKey]
if !ok {
return ctrl.Result{}, fmt.Errorf("assertion failed: provisioner key secret %q is missing key %q after reconciliation", keySecretName, keySecretKey)
}
if len(secretValue) == 0 {
return ctrl.Result{}, fmt.Errorf("assertion failed: provisioner key secret %q key %q is empty after reconciliation", keySecretName, keySecretKey)
}
secretChecksum := hashProvisionerSecret(secretValue)
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionProvisionerKeySecretReady,
metav1.ConditionTrue,
"SecretReady",
"Provisioner key secret is available",
)
// Persist key-related status metadata immediately so retries after later
// reconciliation failures (for example RBAC/deployment errors) do not
// repeatedly re-run metadata backfill/rotation against coderd.
keyStatusSnapshot := provisioner.Status.DeepCopy()
if keyStatusSnapshot == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: key status snapshot must not be nil")
}
provisioner.Status.OrganizationID = organizationID
provisioner.Status.OrganizationName = appliedOrgName
provisioner.Status.ProvisionerKeyID = provisionerKeyID
provisioner.Status.ProvisionerKeyName = provisionerKeyName
provisioner.Status.TagsHash = appliedTagsHash
provisioner.Status.ControlPlaneRefName = appliedControlPlaneRefName
provisioner.Status.ControlPlaneURL = appliedControlPlaneURL
provisioner.Status.SecretRef = &coderv1alpha1.SecretKeySelector{Name: keySecretName, Key: keySecretKey}
if !equality.Semantic.DeepEqual(*keyStatusSnapshot, provisioner.Status) {
if err := r.Status().Update(ctx, provisioner); err != nil {
return ctrl.Result{}, fmt.Errorf("update coderprovisioner key status: %w", err)
}
statusSnapshot = provisioner.Status.DeepCopy()
if statusSnapshot == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: status snapshot must not be nil after key status update")
}
}
serviceAccountName := provisionerServiceAccountName(provisioner.Name)
if _, err := r.reconcileServiceAccount(ctx, provisioner, serviceAccountName); err != nil {
return ctrl.Result{}, err
}
roleName := provisionerResourceName(provisioner.Name)
role, err := r.reconcileRole(ctx, provisioner, roleName)
if err != nil {
return ctrl.Result{}, err
}
if _, err := r.reconcileRoleBinding(ctx, provisioner, roleName, role.Name, serviceAccountName); err != nil {
return ctrl.Result{}, err
}
image := provisioner.Spec.Image
if image == "" {
image = controlPlane.Spec.Image
}
if image == "" {
image = defaultCoderImage
}
secretRef := &coderv1alpha1.SecretKeySelector{Name: keySecretName, Key: keySecretKey}
deployment, err := r.reconcileDeployment(ctx, provisioner, image, controlPlane.Status.URL, secretRef, serviceAccountName, secretChecksum)
if err != nil {
return ctrl.Result{}, err
}
if err := r.reconcileStatus(
ctx,
provisioner,
deployment,
secretRef,
organizationID,
appliedOrgName,
provisionerKeyID,
provisionerKeyName,
appliedTagsHash,
appliedControlPlaneRefName,
appliedControlPlaneURL,
statusSnapshot,
); err != nil {
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
func (r *CoderProvisionerReconciler) reconcileDeletion(ctx context.Context, provisioner *coderv1alpha1.CoderProvisioner) (ctrl.Result, error) {
if !controllerutil.ContainsFinalizer(provisioner, coderv1alpha1.ProvisionerKeyCleanupFinalizer) {
return ctrl.Result{}, nil
}
log := ctrl.LoggerFrom(ctx)
// Use the last-applied organization name from status so we target the
// correct org even if spec was changed but never successfully rotated.
// Fall back to the spec-derived name only when status is empty.
organizationName := provisioner.Status.OrganizationName
if organizationName == "" {
organizationName = provisionerOrganizationName(provisioner.Spec.OrganizationName)
}
keyName := provisioner.Status.ProvisionerKeyName
if keyName == "" {
keyName, _, _ = provisionerKeyConfig(provisioner)
}
// Best-effort remote key cleanup: if the referenced control plane,
// its URL, bootstrap credentials, or any other prerequisite is
// unavailable, log a warning and proceed to finalizer removal so the
// CR does not get stuck in Terminating. This is common during
// namespace teardown, when the control plane was never ready, or
// when credentials were misconfigured.
controlPlaneURL := provisioner.Status.ControlPlaneURL
if controlPlaneURL == "" {
controlPlane, err := r.fetchControlPlane(ctx, provisioner)
if err != nil {
log.Info("unable to reach referenced CoderControlPlane during deletion, skipping remote key cleanup",
"controlPlaneRef", provisioner.Spec.ControlPlaneRef.Name, "error", err)
} else {
controlPlaneURL = controlPlane.Status.URL
}
}
if controlPlaneURL != "" {
sessionToken, tokenErr := r.readBootstrapSessionToken(ctx, provisioner)
if tokenErr != nil {
log.Info("unable to read bootstrap credentials during deletion, skipping remote key cleanup",
"credentialsSecretRef", provisioner.Spec.Bootstrap.CredentialsSecretRef.Name, "error", tokenErr)
} else {
if deleteErr := r.BootstrapClient.DeleteProvisionerKey(
ctx,
controlPlaneURL,
sessionToken,
organizationName,
keyName,
); deleteErr != nil {
// Treat key deletion failures as best-effort so the
// finalizer is still removed. Transient errors, auth
// issues, or org-lookup failures should not block CR
// cleanup.
log.Info("failed to delete remote provisioner key during deletion, proceeding with finalizer removal",
"keyName", keyName, "error", deleteErr)
}
}
}
controllerutil.RemoveFinalizer(provisioner, coderv1alpha1.ProvisionerKeyCleanupFinalizer)
if err := r.Update(ctx, provisioner); err != nil {
return ctrl.Result{}, fmt.Errorf("remove finalizer from coderprovisioner %s/%s: %w", provisioner.Namespace, provisioner.Name, err)
}
return ctrl.Result{}, nil
}
func (r *CoderProvisionerReconciler) ensureCleanupFinalizer(ctx context.Context, provisioner *coderv1alpha1.CoderProvisioner) (bool, error) {
if controllerutil.ContainsFinalizer(provisioner, coderv1alpha1.ProvisionerKeyCleanupFinalizer) {
return false, nil
}
controllerutil.AddFinalizer(provisioner, coderv1alpha1.ProvisionerKeyCleanupFinalizer)
if err := r.Update(ctx, provisioner); err != nil {
return false, fmt.Errorf("add finalizer to coderprovisioner %s/%s: %w", provisioner.Namespace, provisioner.Name, err)
}
return true, nil
}
func (r *CoderProvisionerReconciler) fetchControlPlane(ctx context.Context, provisioner *coderv1alpha1.CoderProvisioner) (*coderv1alpha1.CoderControlPlane, error) {
controlPlaneName := provisioner.Spec.ControlPlaneRef.Name
if controlPlaneName == "" {
return nil, fmt.Errorf("coderprovisioner %s/%s spec.controlPlaneRef.name is required", provisioner.Namespace, provisioner.Name)
}
controlPlane := &coderv1alpha1.CoderControlPlane{}
namespacedName := types.NamespacedName{Name: controlPlaneName, Namespace: provisioner.Namespace}
if err := r.Get(ctx, namespacedName, controlPlane); err != nil {
return nil, fmt.Errorf("get referenced codercontrolplane %s for coderprovisioner %s/%s: %w", namespacedName, provisioner.Namespace, provisioner.Name, err)
}
if controlPlane.Name != controlPlaneName || controlPlane.Namespace != provisioner.Namespace {
return nil, fmt.Errorf("assertion failed: fetched control plane %s/%s does not match expected %s/%s",
controlPlane.Namespace, controlPlane.Name, provisioner.Namespace, controlPlaneName)
}
if controlPlane.Status.URL == "" {
return nil, fmt.Errorf("codercontrolplane %s/%s status.url is empty", controlPlane.Namespace, controlPlane.Name)
}
return controlPlane, nil
}
func (r *CoderProvisionerReconciler) readBootstrapSessionToken(ctx context.Context, provisioner *coderv1alpha1.CoderProvisioner) (string, error) {
credentialsRef := provisioner.Spec.Bootstrap.CredentialsSecretRef
if credentialsRef.Name == "" {
return "", fmt.Errorf("coderprovisioner %s/%s spec.bootstrap.credentialsSecretRef.name is required", provisioner.Namespace, provisioner.Name)
}
credentialsKey := credentialsRef.Key
if credentialsKey == "" {
credentialsKey = coderv1alpha1.DefaultTokenSecretKey
}
token, err := r.readSecretValue(ctx, provisioner.Namespace, credentialsRef.Name, credentialsKey)
if err != nil {
return "", fmt.Errorf("read bootstrap credentials secret %q/%q key %q: %w", provisioner.Namespace, credentialsRef.Name, credentialsKey, err)
}
return token, nil
}
func (r *CoderProvisionerReconciler) reconcileExternalProvisionerEntitlement(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
controlPlane *coderv1alpha1.CoderControlPlane,
sessionToken string,
) (ctrl.Result, error) {
if provisioner == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: coder provisioner must not be nil")
}
if controlPlane == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: coder control plane must not be nil")
}
if strings.TrimSpace(controlPlane.Status.URL) == "" {
return ctrl.Result{}, fmt.Errorf("assertion failed: coder control plane URL must not be empty")
}
if sessionToken == "" {
return ctrl.Result{}, fmt.Errorf("assertion failed: bootstrap session token must not be empty")
}
if controlPlane.Status.EntitlementsLastChecked != nil {
recheckAfter := durationUntilNextEntitlementsCheck(controlPlane.Status.EntitlementsLastChecked, externalProvisionerEntitlementRetryInterval)
switch strings.TrimSpace(controlPlane.Status.ExternalProvisionerDaemonsEntitlement) {
case string(codersdk.EntitlementEntitled), string(codersdk.EntitlementGracePeriod):
if recheckAfter > 0 {
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionExternalProvisionersEntitled,
metav1.ConditionTrue,
"Entitled",
"Coder deployment is entitled to external provisioner daemons",
)
return ctrl.Result{}, nil
}
case string(codersdk.EntitlementNotEntitled):
if recheckAfter > 0 {
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionExternalProvisionersEntitled,
metav1.ConditionFalse,
"NotEntitled",
"Coder deployment is not entitled to external provisioner daemons; install a Premium/Enterprise license to enable external provisioners.",
)
return ctrl.Result{RequeueAfter: recheckAfter}, nil
}
}
}
entitlements, err := r.BootstrapClient.Entitlements(ctx, controlPlane.Status.URL, sessionToken)
if err != nil {
reason := "EntitlementsQueryFailed"
message := "Failed to query Coder entitlements; retrying."
var apiErr *codersdk.Error
if errors.As(err, &apiErr) {
switch apiErr.StatusCode() {
case http.StatusNotFound:
reason = "NotSupported"
message = "Coder deployment does not expose /api/v2/entitlements; cannot verify license."
case http.StatusUnauthorized, http.StatusForbidden:
reason = "Forbidden"
message = "Bootstrap token is not authorized to read entitlements; retrying."
}
}
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionExternalProvisionersEntitled,
metav1.ConditionFalse,
reason,
message,
)
return ctrl.Result{RequeueAfter: externalProvisionerEntitlementRetryInterval}, nil
}
if entitlements.Features == nil {
return ctrl.Result{}, fmt.Errorf("assertion failed: entitlements features must not be nil")
}
feature, ok := entitlements.Features[codersdk.FeatureExternalProvisionerDaemons]
if !ok || !feature.Entitlement.Entitled() {
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionExternalProvisionersEntitled,
metav1.ConditionFalse,
"NotEntitled",
"Coder deployment is not entitled to external provisioner daemons; install a Premium/Enterprise license to enable external provisioners.",
)
return ctrl.Result{RequeueAfter: externalProvisionerEntitlementRetryInterval}, nil
}
setCondition(
provisioner,
coderv1alpha1.CoderProvisionerConditionExternalProvisionersEntitled,
metav1.ConditionTrue,
"Entitled",
"Coder deployment is entitled to external provisioner daemons",
)
return ctrl.Result{}, nil
}
func (r *CoderProvisionerReconciler) ensureProvisionerKeySecret(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
secretName string,
secretKey string,
keyMaterial string,
) (*corev1.Secret, error) {
secret := &corev1.Secret{ObjectMeta: metav1.ObjectMeta{Name: secretName, Namespace: provisioner.Namespace}}
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, secret, func() error {
labels := provisionerLabels(provisioner.Name)
secret.Labels = maps.Clone(labels)
secret.Type = corev1.SecretTypeOpaque
if secret.Data == nil {
secret.Data = make(map[string][]byte)
}
if keyMaterial != "" {
secret.Data[secretKey] = []byte(keyMaterial)
}
if len(secret.Data[secretKey]) == 0 {
return fmt.Errorf("provisioner key secret %q key %q is empty", secretName, secretKey)
}
if err := controllerutil.SetControllerReference(provisioner, secret, r.Scheme); err != nil {
return fmt.Errorf("set controller reference: %w", err)
}
return nil
})
if err != nil {
return nil, fmt.Errorf("reconcile provisioner key secret %q: %w", secretName, err)
}
return secret, nil
}
func (r *CoderProvisionerReconciler) reconcileServiceAccount(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
serviceAccountName string,
) (*corev1.ServiceAccount, error) {
serviceAccount := &corev1.ServiceAccount{ObjectMeta: metav1.ObjectMeta{Name: serviceAccountName, Namespace: provisioner.Namespace}}
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, serviceAccount, func() error {
labels := provisionerLabels(provisioner.Name)
serviceAccount.Labels = maps.Clone(labels)
if err := controllerutil.SetControllerReference(provisioner, serviceAccount, r.Scheme); err != nil {
return fmt.Errorf("set controller reference: %w", err)
}
return nil
})
if err != nil {
return nil, fmt.Errorf("reconcile serviceaccount %q: %w", serviceAccountName, err)
}
return serviceAccount, nil
}
func (r *CoderProvisionerReconciler) reconcileRole(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
roleName string,
) (*rbacv1.Role, error) {
role := &rbacv1.Role{ObjectMeta: metav1.ObjectMeta{Name: roleName, Namespace: provisioner.Namespace}}
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, role, func() error {
labels := provisionerLabels(provisioner.Name)
role.Labels = maps.Clone(labels)
role.Rules = []rbacv1.PolicyRule{{
APIGroups: []string{""},
Resources: []string{"pods", "persistentvolumeclaims"},
Verbs: []string{"get", "list", "watch", "create", "update", "patch", "delete"},
}}
if err := controllerutil.SetControllerReference(provisioner, role, r.Scheme); err != nil {
return fmt.Errorf("set controller reference: %w", err)
}
return nil
})
if err != nil {
return nil, fmt.Errorf("reconcile role %q: %w", roleName, err)
}
return role, nil
}
func (r *CoderProvisionerReconciler) reconcileRoleBinding(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
roleBindingName string,
roleName string,
serviceAccountName string,
) (*rbacv1.RoleBinding, error) {
roleBinding := &rbacv1.RoleBinding{ObjectMeta: metav1.ObjectMeta{Name: roleBindingName, Namespace: provisioner.Namespace}}
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, roleBinding, func() error {
labels := provisionerLabels(provisioner.Name)
roleBinding.Labels = maps.Clone(labels)
roleBinding.RoleRef = rbacv1.RoleRef{
APIGroup: rbacv1.GroupName,
Kind: "Role",
Name: roleName,
}
roleBinding.Subjects = []rbacv1.Subject{{
Kind: rbacv1.ServiceAccountKind,
Name: serviceAccountName,
Namespace: provisioner.Namespace,
}}
if err := controllerutil.SetControllerReference(provisioner, roleBinding, r.Scheme); err != nil {
return fmt.Errorf("set controller reference: %w", err)
}
return nil
})
if err != nil {
return nil, fmt.Errorf("reconcile rolebinding %q: %w", roleBindingName, err)
}
return roleBinding, nil
}
func (r *CoderProvisionerReconciler) reconcileDeployment(
ctx context.Context,
provisioner *coderv1alpha1.CoderProvisioner,
image string,
coderURL string,
secretRef *coderv1alpha1.SecretKeySelector,
serviceAccountName string,
secretChecksum string,
) (*appsv1.Deployment, error) {
deploymentName := provisionerResourceName(provisioner.Name)
deployment := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Name: deploymentName, Namespace: provisioner.Namespace}}
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, deployment, func() error {
labels := provisionerLabels(provisioner.Name)
deployment.Labels = maps.Clone(labels)
if err := controllerutil.SetControllerReference(provisioner, deployment, r.Scheme); err != nil {
return fmt.Errorf("set controller reference: %w", err)
}
replicas := defaultProvisionerReplicas
if provisioner.Spec.Replicas != nil {
replicas = *provisioner.Spec.Replicas
}
terminationGracePeriodSeconds := defaultProvisionerTerminationGracePeriodSeconds
if provisioner.Spec.TerminationGracePeriodSeconds != nil {
terminationGracePeriodSeconds = *provisioner.Spec.TerminationGracePeriodSeconds
}
args := []string{"provisioner", "start"}
args = append(args, provisioner.Spec.ExtraArgs...)