Add KubeadmControlPlane types

Author: detiber

api/v1alpha3/kubeadm_control_plane_types.go

@@ -0,0 +1,163 @@
+/*
+Copyright 2019 The Kubernetes Authors.
+
+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 v1alpha3
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	cabpkv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha2"
+)
+
+// KubeadmControlPlaneSpec defines the desired state of KubeadmControlPlane.
+type KubeadmControlPlaneSpec struct {
+	// Number of desired machines. Defaults to 1. When stacked etcd is used only
+	// odd numbers are permitted, as per [etcd best practice](https://etcd.io/docs/v3.3.12/faq/#why-an-odd-number-of-cluster-members).
+	// This is a pointer to distinguish between explicit zero and not specified.
+	// +optional
+	Replicas *int32 `json:"replicas,omitempty"`
+
+	// Version defines the desired Kubernetes version.
+	Version string `json:"version"`
+
+	// InfrastructureTemplate is a required reference to a custom resource
+	// offered by an infrastructure provider.
+	InfrastructureTemplate corev1.ObjectReference `json:"infrastructureTemplate"`
+
+	// KubeadmConfigSpec is a KubeadmConfigSpec
+	// to use for initializing and joining machines to the control plane.
+	KubeadmConfigSpec cabpkv1.KubeadmConfigSpec `json:"kubeadmConfigSpec"`
+}
+
+// KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane.
+type KubeadmControlPlaneStatus struct {
+	// Selector is the label selector in string format to avoid introspection
+	// by clients, and is used to provide the CRD-based integration for the
+	// scale subresource and additional integrations for things like kubectl
+	// describe.. The string will be in the same format as the query-param syntax.
+	// More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors
+	// +optional
+	Selector string `json:"selector,omitempty"`
+
+	// Total number of non-terminated machines targeted by this control plane
+	// (their labels match the selector).
+	// +optional
+	Replicas int32 `json:"replicas,omitempty"`
+
+	// Total number of non-terminated machines targeted by this control plane
+	// that have the desired template spec.
+	// +optional
+	UpdatedReplicas int32 `json:"updatedReplicas,omitempty"`
+
+	// Total number of fully running and ready control plane machines.
+	// +optional
+	ReadyReplicas int32 `json:"readyReplicas,omitempty"`
+
+	// Total number of unavailable machines targeted by this control plane.
+	// This is the total number of machines that are still required for
+	// the deployment to have 100% available capacity. They may either
+	// be machines that are running but not yet ready or machines
+	// that still have not been created.
+	// +optional
+	UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"`
+
+	// Initialized denotes whether or not the control plane has the
+	// uploaded kubeadm-config configmap.
+	// +optional
+	Initialized bool `json:"initialized,omitempty"`
+
+	// Ready denotes that the KubeadmControlPlane API Server is ready to
+	// receive requests.
+	// +optional
+	Ready bool `json:"ready,omitempty"`
+
+	// ErrorReason indicates that there is a problem reconciling the
+	// state, and will be set to a token value suitable for
+	// programmatic interpretation.
+	// +optional
+	ErrorReason KubeadmControlPlaneStatusError `json:"errorReason,omitempty"`
+
+	// ErrorMessage indicates that there is a problem reconciling the
+	// state, and will be set to a descriptive error message.
+	// +optional
+	ErrorMessage *string `json:"errorMessage,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:path=kubeadmcontrolplanes,shortName=kcp,scope=Namespaced,categories=cluster-api
+// +kubebuilder:storageversion
+// +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
+
+// KubeadmControlPlane is the Schema for the KubeadmControlPlane API.
+type KubeadmControlPlane struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   KubeadmControlPlaneSpec   `json:"spec,omitempty"`
+	Status KubeadmControlPlaneStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// KubeadmControlPlaneList contains a list of KubeadmControlPlane.
+type KubeadmControlPlaneList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []KubeadmControlPlane `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&KubeadmControlPlane{}, &KubeadmControlPlaneList{})
+}
+
+type KubeadmControlPlaneStatusError string
+
+// A more descriptive kind of error that represents an error condition that
+// should be set in the KubeadmControlPlane.Status. The "Reason" field is meant for short,
+// enum-style constants meant to be interpreted by control planes. The "Message"
+// field is meant to be read by humans.
+type KubeadmControlPlaneError struct {
+	Reason  KubeadmControlPlaneStatusError
+	Message string
+}
+
+func (e *KubeadmControlPlaneError) Error() string {
+	return e.Message
+}
+
+const (
+	// InvalidConfigurationKubeadmControlPlaneError indicates that the kubeadm control plane
+	// configuration is invalid.
+	InvalidConfigurationKubeadmControlPlaneError KubeadmControlPlaneStatusError = "InvalidConfiguration"
+
+	// UnsupportedChangeKubeadmControlPlaneError indicates that the kubeadm control plane
+	// spec has been updated in an unsupported way. That cannot be
+	// reconciled.
+	UnsupportedChangeKubeadmControlPlaneError KubeadmControlPlaneStatusError = "UnsupportedChange"
+
+	// CreateKubeadmControlPlaneError indicates that an error was encountered
+	// when trying to create the kubeadm control plane.
+	CreateKubeadmControlPlaneError KubeadmControlPlaneStatusError = "CreateError"
+
+	// UpdateKubeadmControlPlaneError indicates that an error was encountered
+	// when trying to update the kubeadm control plane.
+	UpdateKubeadmControlPlaneError KubeadmControlPlaneStatusError = "UpdateError"
+
+	// DeleteKubeadmControlPlaneError indicates that an error was encountered
+	// when trying to delete the kubeadm control plane.
+	DeleteKubeadmControlPlaneError KubeadmControlPlaneStatusError = "DeleteError"
+)