feat: Add ClusterAddonSet and ClusterAddon API types (#26)

As discussed, and influenced by CAPI resources such as `MachineSet`,
this PR adds initial API kinds for `ClusterAddonSet` and `ClusterAddon`.

Author: jimmidyson

api/v1alpha1/clusteraddon_types.go

@@ -4,26 +4,24 @@
 package v1alpha1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // ClusterAddonSpec defines the desired state of ClusterAddon.
 type ClusterAddonSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-
-	// Foo is an example field of ClusterAddon. Edit clusteraddon_types.go to remove/update
-	Foo string `json:"foo,omitempty"`
+	// ImplementationRef is a required reference to a custom resource
+	// offered by an cluster addon provider.
+	ImplementationRef corev1.TypedLocalObjectReference `json:"implementationRef"`
+
+	// Version defines the desired addon version.
+	// This field is meant to be optionally used by addon providers.
+	// +optional
+	Version *string `json:"version,omitempty"`
 }
 
 // ClusterAddonStatus defines the observed state of ClusterAddon.
-type ClusterAddonStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-}
+type ClusterAddonStatus struct{}
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status

api/v1alpha1/clusteraddonset_types.go

@@ -0,0 +1,58 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// ClusterAddonSetSpec defines the desired state of ClusterAddonSet.
+type ClusterAddonSetSpec struct {
+	// ClusterSelector selects Clusters in the same namespace with a label that matches the specified label selector.
+	ClusterSelector metav1.LabelSelector `json:"clusterSelector"`
+
+	Template ClusterAddonSetTemplateSpec `json:"template,omitempty"`
+}
+
+// ClusterAddonSetTemplateSpec describes the data needed to create a ClusterAddon from a template.
+type ClusterAddonSetTemplateSpec struct {
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
+	ObjectMeta `json:"metadata,omitempty"`
+
+	// Specification of the desired state of the cluster addon.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+	// +optional
+	Spec ClusterAddonSpec `json:"spec,omitempty"`
+}
+
+// ClusterAddonSetStatus defines the observed state of ClusterAddon.
+type ClusterAddonSetStatus struct{}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// ClusterAddonSet is the Schema for the clusteraddons API.
+type ClusterAddonSet struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   ClusterAddonSetSpec   `json:"spec,omitempty"`
+	Status ClusterAddonSetStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// ClusterAddonSetList contains a list of ClusterAddon.
+type ClusterAddonSetList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []ClusterAddonSet `json:"items"`
+}
+
+//nolint:gochecknoinits // Idiomatic way to register k8s API kinds.
+func init() {
+	SchemeBuilder.Register(&ClusterAddonSet{}, &ClusterAddonSetList{})
+}

api/v1alpha1/common_types.go

@@ -0,0 +1,25 @@
+// Copyright 2023 D2iQ, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1
+
+// ObjectMeta is metadata that all persisted resources must have, which includes all objects
+// users must create. This is a copy of customizable fields from metav1.ObjectMeta.
+//
+// For more details on why this is included instead of using metav1.ObjectMeta directly, see
+// https://github.com/kubernetes-sigs/cluster-api/blob/v1.3.3/api/v1beta1/common_types.go#L175-L195.
+type ObjectMeta struct {
+	// Map of string keys and values that can be used to organize and categorize
+	// (scope and select) objects. May match selectors of replication controllers
+	// and services.
+	// More info: http://kubernetes.io/docs/user-guide/labels
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Annotations is an unstructured key value map stored with a resource that may be
+	// set by external tools to store and retrieve arbitrary metadata. They are not
+	// queryable and should be preserved when modifying objects.
+	// More info: http://kubernetes.io/docs/user-guide/annotations
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -35,10 +35,33 @@ spec:
           spec:
             description: ClusterAddonSpec defines the desired state of ClusterAddon.
             properties:
-              foo:
-                description: Foo is an example field of ClusterAddon. Edit clusteraddon_types.go
-                  to remove/update
+              implementationRef:
+                description: ImplementationRef is a required reference to a custom
+                  resource offered by an cluster addon provider.
+                properties:
+                  apiGroup:
+                    description: APIGroup is the group for the resource being referenced.
+                      If APIGroup is not specified, the specified Kind must be in
+                      the core API group. For any other third-party types, APIGroup
+                      is required.
+                    type: string
+                  kind:
+                    description: Kind is the type of resource being referenced
+                    type: string
+                  name:
+                    description: Name is the name of resource being referenced
+                    type: string
+                required:
+                - kind
+                - name
+                type: object
+                x-kubernetes-map-type: atomic
+              version:
+                description: Version defines the desired addon version. This field
+                  is meant to be optionally used by addon providers.
                 type: string
+            required:
+            - implementationRef
             type: object
           status:
             description: ClusterAddonStatus defines the observed state of ClusterAddon.