Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1765 from detiber/kubeadmControlPlaneTypes
✨ Add KubeadmControlPlane types / validation webhooks
- Loading branch information
Showing
18 changed files
with
1,589 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
/* | ||
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" | ||
"sigs.k8s.io/cluster-api/errors" | ||
) | ||
|
||
// 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. | ||
// +kubebuilder:validation:MinLength:=1 | ||
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"` | ||
|
||
// FailureReason indicates that there is a terminal problem reconciling the | ||
// state, and will be set to a token value suitable for | ||
// programmatic interpretation. | ||
// +optional | ||
Failurereason errors.KubeadmControlPlaneStatusError `json:"failureReason,omitempty"` | ||
|
||
// ErrorMessage indicates that there is a terminal problem reconciling the | ||
// state, and will be set to a descriptive error message. | ||
// +optional | ||
FailureMessage *string `json:"failureMessage,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{}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/* | ||
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 ( | ||
"sigs.k8s.io/controller-runtime/pkg/webhook" | ||
) | ||
|
||
// +kubebuilder:webhook:verbs=create;update,path=/mutate-cluster-x-k8s-io-v1alpha3-kubeadmcontrolplane,mutating=true,failurePolicy=fail,groups=cluster.x-k8s.io,resources=kubeadmcontrolplane,versions=v1alpha3,name=default.kubeadmcontrolplane.cluster.x-k8s.io | ||
|
||
var _ webhook.Defaulter = &KubeadmControlPlane{} | ||
|
||
// Default implements webhook.Defaulter so a webhook will be registered for the type | ||
func (r *KubeadmControlPlane) Default() { | ||
if r.Spec.Replicas == nil { | ||
replicas := int32(1) | ||
r.Spec.Replicas = &replicas | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/* | ||
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 ( | ||
"reflect" | ||
|
||
"k8s.io/apimachinery/pkg/runtime" | ||
"k8s.io/apimachinery/pkg/util/validation/field" | ||
ctrl "sigs.k8s.io/controller-runtime" | ||
"sigs.k8s.io/controller-runtime/pkg/webhook" | ||
) | ||
|
||
func (r *KubeadmControlPlane) SetupWebhookWithManager(mgr ctrl.Manager) error { | ||
return ctrl.NewWebhookManagedBy(mgr). | ||
For(r). | ||
Complete() | ||
} | ||
|
||
// +kubebuilder:webhook:verbs=create;update,path=/validate-cluster-x-k8s-io-v1alpha3-kubeadmcontrolplane,mutating=false,failurePolicy=fail,groups=cluster.x-k8s.io,resources=kubeadmcontrolplane,versions=v1alpha3,name=validation.kubeadmcontrolplane.cluster.x-k8s.io | ||
|
||
var _ webhook.Validator = &KubeadmControlPlane{} | ||
|
||
// ValidateCreate implements webhook.Validator so a webhook will be registered for the type | ||
func (r *KubeadmControlPlane) ValidateCreate() error { | ||
if r.Spec.Replicas == nil { | ||
return field.Required(field.NewPath("spec", "replicas"), "is required") | ||
} | ||
|
||
if *r.Spec.Replicas <= 0 { | ||
return field.Forbidden(field.NewPath("spec", "replicas"), "cannot be less than or equal to 0") | ||
} | ||
|
||
if r.Spec.KubeadmConfigSpec.InitConfiguration != nil { | ||
if r.Spec.KubeadmConfigSpec.InitConfiguration.Etcd.External == nil { | ||
if *r.Spec.Replicas%2 == 0 { | ||
return field.Forbidden(field.NewPath("spec", "replicas"), "cannot be an even number when using managed etcd") | ||
} | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type | ||
func (r *KubeadmControlPlane) ValidateUpdate(old runtime.Object) error { | ||
oldKubeadmControlPlane := old.(*KubeadmControlPlane) | ||
if !reflect.DeepEqual(r.Spec.KubeadmConfigSpec, oldKubeadmControlPlane.Spec.KubeadmConfigSpec) { | ||
return field.Forbidden(field.NewPath("spec", "kubeadmConfigSpec"), "cannot be modified") | ||
} | ||
|
||
return nil | ||
} | ||
|
||
// ValidateDelete implements webhook.Validator so a webhook will be registered for the type | ||
func (r *KubeadmControlPlane) ValidateDelete() error { | ||
return nil | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.