[deprecation] Add v1beta1 CRDs for LinodeMachine and LinodeCluster

PROJECT

@@ -129,4 +129,30 @@ resources:
   kind: FirewallRule
   path: github.com/linode/cluster-api-provider-linode/api/v1alpha2
   version: v1alpha2
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: cluster.x-k8s.io
+  group: infrastructure
+  kind: LinodeCluster
+  path: github.com/linode/cluster-api-provider-linode/api/v1beta1
+  version: v1beta1
+  webhooks:
+    conversion: true
+    spoke:
+    - v1alpha2
+    webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: cluster.x-k8s.io
+  group: infrastructure
+  kind: LinodeMachine
+  path: github.com/linode/cluster-api-provider-linode/api/v1beta1
+  version: v1beta1
+  webhooks:
+    conversion: true
+    spoke:
+    - v1alpha2
+    webhookVersion: v1
 version: "3"

api/v1alpha2/linodemachine_types.go

@@ -56,6 +56,7 @@ type LinodeMachineSpec struct {
 	Type string `json:"type,omitempty"`
 
 	// group is the Linode group to create the instance in.
+	// Deprecated: group is a deprecated property denoting a group label for the Linode.
 	// +optional
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
 	Group string `json:"group,omitempty"`

api/v1beta1/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2023 Akamai Technologies, Inc.
+
+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 v1beta1 contains API Schema definitions for the infrastructure v1beta1 API group
+// +kubebuilder:object:generate=true
+// +groupName=infrastructure.cluster.x-k8s.io
+package v1beta1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1beta1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

api/v1beta1/linodecluster_conversion.go

@@ -0,0 +1,22 @@
+/*
+Copyright 2023 Akamai Technologies, Inc.
+
+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 v1beta1
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+
+// Hub marks this type as a conversion hub.
+func (*LinodeCluster) Hub() {}

api/v1beta1/linodecluster_types.go

@@ -0,0 +1,294 @@
+/*
+Copyright 2023 Akamai Technologies, Inc.
+
+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 v1beta1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
+)
+
+const (
+	// ClusterFinalizer allows ReconcileLinodeCluster to clean up Linode resources associated
+	// with LinodeCluster before removing it from the apiserver.
+	ClusterFinalizer = "linodecluster.infrastructure.cluster.x-k8s.io"
+	ConditionPaused  = "Paused"
+)
+
+// LinodeClusterSpec defines the desired state of LinodeCluster
+type LinodeClusterSpec struct {
+	// region the LinodeCluster lives in.
+	// +kubebuilder:validation:MinLength=1
+	// +required
+	Region string `json:"region,omitempty"`
+
+	// controlPlaneEndpoint represents the endpoint used to communicate with the LinodeCluster control plane
+	// If ControlPlaneEndpoint is unset then the Nodebalancer ip will be used.
+	// +optional
+	ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint"`
+
+	// network encapsulates all things related to Linode network.
+	// +optional
+	Network NetworkSpec `json:"network"`
+
+	// vpcRef is a reference to a VPC object. This makes the Linodes use the specified VPC.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	VPCRef *corev1.ObjectReference `json:"vpcRef,omitempty"`
+
+	// vpcID is the ID of an existing VPC in Linode.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	VPCID *int `json:"vpcID,omitempty"`
+
+	// nodeBalancerFirewallRef is a reference to a NodeBalancer Firewall object. This makes the linode use the specified NodeBalancer Firewall.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	NodeBalancerFirewallRef *corev1.ObjectReference `json:"nodeBalancerFirewallRef,omitempty"`
+
+	// objectStore defines a supporting Object Storage bucket for cluster operations. This is currently used for
+	// bootstrapping (e.g. Cloud-init).
+	// +optional
+	ObjectStore *ObjectStore `json:"objectStore,omitempty"`
+
+	// credentialsRef is a reference to a Secret that contains the credentials to use for provisioning this cluster. If not
+	//  supplied, then the credentials of the controller will be used.
+	// +optional
+	CredentialsRef *corev1.SecretReference `json:"credentialsRef,omitempty"`
+}
+
+// LinodeClusterStatus defines the observed state of LinodeCluster
+type LinodeClusterStatus struct {
+	// conditions define the current service state of the LinodeCluster.
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	// +patchStrategy=merge
+	// +patchMergeKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
+
+	// ready denotes that the cluster (infrastructure) is ready.
+	// +optional
+	Ready bool `json:"ready"`
+
+	// failureReason will be set in the event that there is a terminal problem
+	// reconciling the LinodeCluster and will contain a succinct value suitable
+	// for machine interpretation.
+	// +optional
+	FailureReason *string `json:"failureReason,omitempty"`
+
+	// failureMessage will be set in the event that there is a terminal problem
+	// reconciling the LinodeCluster and will contain a more verbose string suitable
+	// for logging and human consumption.
+	// +optional
+	FailureMessage *string `json:"failureMessage,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:path=linodeclusters,scope=Namespaced,categories=cluster-api,shortName=lc
+// +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this LinodeCluster belongs"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Cluster infrastructure is ready for Linode instances"
+// +kubebuilder:printcolumn:name="Endpoint",type="string",JSONPath=".spec.ControlPlaneEndpoint",description="API Endpoint",priority=1
+// +kubebuilder:unservedversion
+
+// LinodeCluster is the Schema for the linodeclusters API
+type LinodeCluster struct {
+	metav1.TypeMeta `json:",inline"`
+
+	// metadata is the standard object's metadata.
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// spec is the desired state of the LinodeCluster.
+	// +required
+	Spec LinodeClusterSpec `json:"spec,omitzero,omitempty"`
+
+	// status is the observed state of the LinodeCluster.
+	// +optional
+	Status LinodeClusterStatus `json:"status,omitempty"`
+}
+
+func (lc *LinodeCluster) SetCondition(cond metav1.Condition) {
+	if cond.LastTransitionTime.IsZero() {
+		cond.LastTransitionTime = metav1.Now()
+	}
+	for i := range lc.Status.Conditions {
+		if lc.Status.Conditions[i].Type == cond.Type {
+			lc.Status.Conditions[i] = cond
+			return
+		}
+	}
+	lc.Status.Conditions = append(lc.Status.Conditions, cond)
+}
+
+func (lc *LinodeCluster) GetCondition(condType string) *metav1.Condition {
+	for i := range lc.Status.Conditions {
+		if lc.Status.Conditions[i].Type == condType {
+			return &lc.Status.Conditions[i]
+		}
+	}
+
+	return nil
+}
+
+func (lc *LinodeCluster) IsPaused() bool {
+	for i := range lc.Status.Conditions {
+		if lc.Status.Conditions[i].Type == ConditionPaused {
+			return lc.Status.Conditions[i].Status == metav1.ConditionTrue
+		}
+	}
+	return false
+}
+
+// NetworkSpec encapsulates Linode networking resources.
+type NetworkSpec struct {
+	// loadBalancerType is the type of load balancer to use, defaults to NodeBalancer if not otherwise set.
+	// +kubebuilder:validation:Enum=NodeBalancer;dns;external
+	// +kubebuilder:default=NodeBalancer
+	// +optional
+	LoadBalancerType string `json:"loadBalancerType,omitempty"`
+
+	// DNSConfig contains configuration for DNS-based load balancing. Ignored if LoadBalancerType is not set to "dns".
+	// +optional
+	DNSConfig *DNSConfig `json:"dnsConfig,omitempty"`
+
+	// NodeBalancerConfig contains configuration for NodeBalancer-based load balancing. Ignored if LoadBalancerType is not set to "NodeBalancer".
+	// +optional
+	NodeBalancerConfig *NodeBalancerConfig `json:"nodeBalancerConfig,omitempty"`
+
+	// apiserverLoadBalancerPort used by the api server. It must be valid ports range (1-65535).
+	// If omitted, default value is 6443.
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	// +optional
+	ApiserverLoadBalancerPort int `json:"apiserverLoadBalancerPort,omitempty"`
+
+	// subnetName is the name/label of the VPC subnet to be used by the cluster
+	// +optional
+	SubnetName string `json:"subnetName,omitempty"`
+
+	// useVlan provisions a cluster that uses VLANs instead of VPCs. IPAM is managed internally.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	UseVlan bool `json:"useVlan,omitempty"`
+}
+
+type DNSConfig struct {
+	// Provider is the provider who manages the domain.
+	// +kubebuilder:validation:Enum=linode;akamai
+	// +kubebuilder:default=linode
+	// +optional
+	Provider string `json:"dnsProvider,omitempty"`
+
+	// dnsRootDomain is the root domain used to create a DNS entry for the control-plane endpoint.
+	// +optional
+	DNSRootDomain string `json:"dnsRootDomain,omitempty"`
+
+	// dnsUniqueIdentifier is the unique identifier for the DNS. This let clusters with the same name have unique
+	// DNS record
+	// If not set, CAPL will create a unique identifier for you
+	// +optional
+	DNSUniqueIdentifier string `json:"dnsUniqueIdentifier,omitempty"`
+
+	// dnsTTLsec is the TTL for the domain record
+	// +kubebuilder:default=30
+	// +optional
+	DNSTTLSec int `json:"dnsTTLsec,omitempty"`
+
+	// dnsSubDomainOverride is used to override CAPL's construction of the controlplane endpoint
+	// If set, this will override the DNS subdomain from <clustername>-<uniqueid>.<rootdomain> to <overridevalue>.<rootdomain>
+	// +optional
+	DNSSubDomainOverride string `json:"dnsSubDomainOverride,omitempty"`
+}
+
+type NodeBalancerConfig struct {
+	// nodeBalancerID is the id of NodeBalancer.
+	// +optional
+	NodeBalancerID *int `json:"nodeBalancerID,omitempty"`
+
+	// nodeBalancerFirewallID is the id of NodeBalancer Firewall.
+	// +optional
+	NodeBalancerFirewallID *int `json:"nodeBalancerFirewallID,omitempty"`
+
+	// apiserverNodeBalancerConfigID is the config ID of api server NodeBalancer config.
+	// +optional
+	ApiserverNodeBalancerConfigID *int `json:"apiserverNodeBalancerConfigID,omitempty"`
+
+	// nodeBalancerBackendIPv4Range is the subnet range we want to provide for creating nodebalancer in VPC.
+	// example: 10.10.10.0/30
+	// +optional
+	NodeBalancerBackendIPv4Range string `json:"nodeBalancerBackendIPv4Range,omitempty"`
+
+	// additionalPorts contains list of ports to be configured with NodeBalancer.
+	// +optional
+	// +listType=map
+	// +listMapKey=port
+	AdditionalPorts []LinodeNBPortConfig `json:"additionalPorts,omitempty"`
+
+	// enableVPCBackends toggles VPC-scoped NodeBalancer and VPC backend IP usage.
+	// If set to false (default), the NodeBalancer will not be created in a VPC and
+	// backends will use Linode private IPs. If true, the NodeBalancer will be
+	// created in the configured VPC (when VPCRef or VPCID is set) and backends
+	// will use VPC IPs.
+	// +kubebuilder:default=false
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	EnableVPCBackends bool `json:"enableVPCBackends,omitempty"`
+}
+
+type LinodeNBPortConfig struct {
+	// port configured on the NodeBalancer. It must be valid port range (1-65535).
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	// +required
+	Port int `json:"port,omitempty"`
+
+	// nodeBalancerConfigID is the config ID of port's NodeBalancer config.
+	// +optional
+	NodeBalancerConfigID *int `json:"nodeBalancerConfigID,omitempty"`
+}
+
+// ObjectStore defines a supporting Object Storage bucket for cluster operations. This is currently used for
+// bootstrapping (e.g. Cloud-init).
+type ObjectStore struct {
+	// presignedURLDuration defines the duration for which presigned URLs are valid.
+	//
+	// This is used to generate presigned URLs for S3 Bucket objects, which are used by
+	// control-plane and worker nodes to fetch bootstrap data.
+	// +optional
+	PresignedURLDuration *metav1.Duration `json:"presignedURLDuration,omitempty"`
+
+	// credentialsRef is a reference to a Secret that contains the credentials to use for accessing the Cluster Object Store.
+	// +optional
+	CredentialsRef corev1.SecretReference `json:"credentialsRef,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// LinodeClusterList contains a list of LinodeCluster
+type LinodeClusterList struct {
+	metav1.TypeMeta `json:",inline"`
+	// metadata is the standard object's metadata.
+	metav1.ListMeta `json:"metadata,omitempty"`
+	// items is a list of LinodeCluster.
+	Items []LinodeCluster `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&LinodeCluster{}, &LinodeClusterList{})
+}