Merge pull request #17 from weaveworks/multi-bootstrap-bump-api

Bump the apiVersion to avoid issues with the multi-bootstrap changes.

When we changed to support multiple bootstrappers, this can cause issues for existing clusters.

Author: bigkevmcd

api/v1alpha2/clusterbootstrapconfig_types.go

@@ -0,0 +1,124 @@
+/*
+Copyright 2021.
+
+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 v1alpha2
+
+import (
+	"time"
+
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const defaultWaitDuration = time.Second * 60
+
+const (
+	BootstrappedAnnotation     = "capi.weave.works/bootstrapped"
+	BootstrapConfigsAnnotation = "capi.weave.works/bootstrap-configs"
+)
+
+// JobTemplate describes a job to create
+type JobTemplate struct {
+	// DNS1032 compatible name used as a prefix when generating the Job from the
+	// Spec.
+	GenerateName string `json:"generateName"`
+	// Specifies the number of retries before marking this job failed.
+	// Defaults to 6
+	//+kubebuilder:validation:Optional
+	//+kubebuilder:default:=6
+	BackoffLimit *int32 `json:"backoffLimit,optional"`
+
+	// ttlSecondsAfterFinished limits the lifetime of a Job that has finished
+	// execution (either Complete or Failed). If this field is set,
+	// ttlSecondsAfterFinished after the Job finishes, it is eligible to be
+	// automatically deleted. When the Job is being deleted, its lifecycle
+	// guarantees (e.g. finalizers) will be honored. If this field is unset,
+	// the Job won't be automatically deleted. If this field is set to zero,
+	// the Job becomes eligible to be deleted immediately after it finishes.
+	//+optional
+	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
+
+	// A batch/v1 Job is created with the Spec as the PodSpec.
+	Spec corev1.PodSpec `json:"spec"`
+}
+
+// ClusterBootstrapConfigSpec defines the desired state of ClusterBootstrapConfig
+type ClusterBootstrapConfigSpec struct {
+	ClusterSelector metav1.LabelSelector `json:"clusterSelector"`
+	Template        JobTemplate          `json:"jobTemplate"`
+
+	// Trigger the bootstrapping when the linked cluster has a True
+	// "ClusterProvisioned" condition.
+	//
+	// A new job will not be triggered when the cluster is finally "Ready"
+	// because it will already have the annotation that indicates the cluster
+	// has been bootstrapped.
+	//
+	// Defaults to false.
+	//+kubebuilder:default:false
+	//+optional
+	RequireClusterProvisioned bool `json:"requireClusterProvisioned"`
+
+	// Wait for the remote cluster to be "ready" before creating the jobs.
+	// Defaults to false.
+	//+kubebuilder:default:false
+	//+optional
+	RequireClusterReady bool `json:"requireClusterReady"`
+	// When checking for readiness, this is the time to wait before
+	// checking again.
+	//+kubebuilder:default:60s
+	//+optional
+	ClusterReadinessBackoff *metav1.Duration `json:"clusterReadinessBackoff,omitempty"`
+}
+
+// ClusterBootstrapConfigStatus defines the observed state of ClusterBootstrapConfig
+type ClusterBootstrapConfigStatus struct {
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+//+kubebuilder:storageversion
+
+// ClusterBootstrapConfig is the Schema for the clusterbootstrapconfigs API
+type ClusterBootstrapConfig struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   ClusterBootstrapConfigSpec   `json:"spec,omitempty"`
+	Status ClusterBootstrapConfigStatus `json:"status,omitempty"`
+}
+
+// ClusterReadinessRequeue returns the configured ClusterReadinessBackoff or a default
+// value if not configured.
+func (c ClusterBootstrapConfig) ClusterReadinessRequeue() time.Duration {
+	if v := c.Spec.ClusterReadinessBackoff; v != nil {
+		return v.Duration
+	}
+	return defaultWaitDuration
+}
+
+//+kubebuilder:object:root=true
+
+// ClusterBootstrapConfigList contains a list of ClusterBootstrapConfig
+type ClusterBootstrapConfigList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []ClusterBootstrapConfig `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&ClusterBootstrapConfig{}, &ClusterBootstrapConfigList{})
+}

api/v1alpha2/clusterbootstrapconfig_types_test.go

@@ -0,0 +1,38 @@
+/*
+Copyright 2022.
+
+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 v1alpha2
+
+import (
+	"testing"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func TestControl(t *testing.T) {
+	cfg := ClusterBootstrapConfig{}
+
+	if v := cfg.ClusterReadinessRequeue(); v != defaultWaitDuration {
+		t.Fatalf("ClusterReadinessRequeue() got %v, want %v", v, defaultWaitDuration)
+	}
+
+	want := time.Second * 20
+	cfg.Spec.ClusterReadinessBackoff = &metav1.Duration{Duration: want}
+	if v := cfg.ClusterReadinessRequeue(); v != want {
+		t.Fatalf("ClusterReadinessRequeue() got %v, want %v", v, want)
+	}
+}

api/v1alpha2/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2021.
+
+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 v1alpha2 contains API Schema definitions for the capi v1alpha2 API group
+// +kubebuilder:object:generate=true
+// +groupName=capi.weave.works
+package v1alpha2
+
+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: "capi.weave.works", Version: "v1alpha2"}
+
+	// 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
+)