feat: allow node annotations to be set by the provisioner

kubernetes-sigs · Nov 25, 2022 · 6150a5c · 6150a5c
1 parent 308c133
commit 6150a5c
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 4 deletions.
diff --git a/pkg/apis/crds/karpenter.sh_provisioners.yaml b/pkg/apis/crds/karpenter.sh_provisioners.yaml
@@ -41,6 +41,11 @@ spec:
               Node properties are determined from a combination of provisioner and
               pod scheduling constraints.
             properties:
+              annotations:
+                additionalProperties:
+                  type: string
+                description: Annotations are applied to every node.
+                type: object
               consolidation:
                 description: Consolidation are the consolidation parameters
                 properties:

diff --git a/pkg/apis/provisioning/v1alpha5/provisioner.go b/pkg/apis/provisioning/v1alpha5/provisioner.go
@@ -28,6 +28,9 @@ import (
 // is capable of managing a diverse set of nodes. Node properties are determined
 // from a combination of provisioner and pod scheduling constraints.
 type ProvisionerSpec struct {
+	// Annotations are applied to every node.
+	//+optional
+	Annotations map[string]string `json:"annotations,omitempty"`
 	// Labels are layered with Requirements and applied to every node.
 	//+optional
 	Labels map[string]string `json:"labels,omitempty"`

diff --git a/pkg/apis/provisioning/v1alpha5/zz_generated.deepcopy.go b/pkg/apis/provisioning/v1alpha5/zz_generated.deepcopy.go
diff --git a/pkg/controllers/provisioning/suite_test.go b/pkg/controllers/provisioning/suite_test.go
@@ -497,6 +497,18 @@ var _ = Describe("Provisioning", func() {
 			Expect(*allocatable.Memory()).To(Equal(resource.MustParse("4Gi")))
 		})
 	})
+	Context("Annotations", func() {
+		It("should annotate nodes", func() {
+			provisioner := test.Provisioner(test.ProvisionerOptions{
+				Annotations: map[string]string{v1alpha5.DoNotConsolidateNodeAnnotationKey: "true"},
+			})
+			ExpectApplied(ctx, env.Client, provisioner)
+			for _, pod := range ExpectProvisioned(ctx, env.Client, recorder, pendingPodController, prov, test.UnschedulablePod()) {
+				node := ExpectScheduled(ctx, env.Client, pod)
+				Expect(node.Annotations).To(HaveKeyWithValue(v1alpha5.DoNotConsolidateNodeAnnotationKey, "true"))
+			}
+		})
+	})
 	Context("Labels", func() {
 		It("should label nodes", func() {
 			provisioner := test.Provisioner(test.ProvisionerOptions{

diff --git a/pkg/controllers/state/zz_generated.deepcopy.go b/pkg/controllers/state/zz_generated.deepcopy.go
diff --git a/pkg/scheduling/nodetemplate.go b/pkg/scheduling/nodetemplate.go
@@ -30,6 +30,7 @@ type NodeTemplate struct {
 	ProvisionerName      string
 	Provider             *v1alpha5.Provider
 	ProviderRef          *v1alpha5.ProviderRef
+	Annotations          map[string]string
 	Labels               map[string]string
 	Taints               Taints
 	StartupTaints        Taints
@@ -47,6 +48,7 @@ func NewNodeTemplate(provisioner *v1alpha5.Provisioner) *NodeTemplate {
 		Provider:             provisioner.Spec.Provider,
 		ProviderRef:          provisioner.Spec.ProviderRef,
 		KubeletConfiguration: provisioner.Spec.KubeletConfiguration,
+		Annotations:          provisioner.Spec.Annotations,
 		Labels:               labels,
 		Taints:               provisioner.Spec.Taints,
 		StartupTaints:        provisioner.Spec.StartupTaints,
@@ -57,8 +59,9 @@ func NewNodeTemplate(provisioner *v1alpha5.Provisioner) *NodeTemplate {
 func (n *NodeTemplate) ToNode() *v1.Node {
 	return &v1.Node{
 		ObjectMeta: metav1.ObjectMeta{
-			Labels:     lo.Assign(n.Labels, n.Requirements.Labels()),
-			Finalizers: []string{v1alpha5.TerminationFinalizer},
+			Labels:      lo.Assign(n.Labels, n.Requirements.Labels()),
+			Annotations: n.Annotations,
+			Finalizers:  []string{v1alpha5.TerminationFinalizer},
 		},
 		Spec: v1.NodeSpec{
 			Taints: append(n.Taints, n.StartupTaints...),

diff --git a/pkg/test/provisioner.go b/pkg/test/provisioner.go
@@ -36,6 +36,7 @@ type ProvisionerOptions struct {
 	Provider               interface{}
 	ProviderRef            *v1alpha5.ProviderRef
 	Kubelet                *v1alpha5.KubeletConfiguration
+	Annotations            map[string]string
 	Labels                 map[string]string
 	Taints                 []v1.Taint
 	StartupTaints          []v1.Taint
@@ -73,6 +74,7 @@ func Provisioner(overrides ...ProvisionerOptions) *v1alpha5.Provisioner {
 			ProviderRef:            options.ProviderRef,
 			Taints:                 options.Taints,
 			StartupTaints:          options.StartupTaints,
+			Annotations:            options.Annotations,
 			Labels:                 lo.Assign(options.Labels, map[string]string{DiscoveryLabel: "unspecified"}), // For node cleanup discovery
 			Limits:                 &v1alpha5.Limits{Resources: options.Limits},
 			TTLSecondsAfterEmpty:   options.TTLSecondsAfterEmpty,