Initial scaffolding for operator

Domain is cluster.x-k8s.io

Create API scaffolding for CoreProvider

kubebuilder create api --group operator --version v1alpha4 --kind CoreProvider

Create API scaffolding for BootstrapProvider

kubebuilder create api --group operator --version v1alpha4 --kind BootstrapProvider
Created Resources, not controllers

Create API scaffolding for ControlPlaneProvider

kubebuilder create api --group operator --version v1alpha4 --kind ControlPlaneProvider
Created Resources, not controllers

Create API scaffolding for InfrastructureProvider

kubebuilder create api --group operator --version v1alpha4 --kind InfrastructureProvider
Created Resources, not controllers

Add placeholders for ProviderSpec and ProviderStatus

Fix some module imports. Will be cleaned up in future PRs.

Fix boilerplate on files

Move operator to exp folder

exp/operator/.gitignore

@@ -0,0 +1,24 @@
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Kubernetes Generated files - skip generated files, except for vendored files
+
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+*.swp
+*.swo
+*~

exp/operator/Dockerfile

@@ -0,0 +1,43 @@
+# syntax=docker/dockerfile:1.1-experimental
+
+# Copyright 2021 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.
+
+# Build the manager binary
+FROM golang:1.13 as builder
+
+WORKDIR /workspace
+# Copy the Go Modules manifests
+COPY go.mod go.mod
+COPY go.sum go.sum
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+RUN go mod download
+
+# Copy the go source
+COPY main.go main.go
+COPY api/ api/
+COPY controllers/ controllers/
+
+# Build
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager main.go
+
+# Use distroless as minimal base image to package the manager binary
+# Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER nonroot:nonroot
+
+ENTRYPOINT ["/manager"]

exp/operator/Makefile

@@ -0,0 +1,93 @@
+# Copyright 2021 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.
+
+# Image URL to use all building/pushing image targets
+IMG ?= controller:latest
+# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
+CRD_OPTIONS ?= "crd:trivialVersions=true"
+
+# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
+all: manager
+
+# Run tests
+test: generate fmt vet manifests
+	go test ./... -coverprofile cover.out
+
+# Build manager binary
+manager: generate fmt vet
+	go build -o bin/manager main.go
+
+# Run against the configured Kubernetes cluster in ~/.kube/config
+run: generate fmt vet manifests
+	go run ./main.go
+
+# Install CRDs into a cluster
+install: manifests
+	kustomize build config/crd | kubectl apply -f -
+
+# Uninstall CRDs from a cluster
+uninstall: manifests
+	kustomize build config/crd | kubectl delete -f -
+
+# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
+deploy: manifests
+	cd config/manager && kustomize edit set image controller=${IMG}
+	kustomize build config/default | kubectl apply -f -
+
+# Generate manifests e.g. CRD, RBAC etc.
+manifests: controller-gen
+	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+
+# Run go fmt against code
+fmt:
+	go fmt ./...
+
+# Run go vet against code
+vet:
+	go vet ./...
+
+# Generate code
+generate: controller-gen
+	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
+
+# Build the docker image
+docker-build: test
+	docker build . -t ${IMG}
+
+# Push the docker image
+docker-push:
+	docker push ${IMG}
+
+# find or download controller-gen
+# download controller-gen if necessary
+controller-gen:
+ifeq (, $(shell which controller-gen))
+	@{ \
+	set -e ;\
+	CONTROLLER_GEN_TMP_DIR=$$(mktemp -d) ;\
+	cd $$CONTROLLER_GEN_TMP_DIR ;\
+	go mod init tmp ;\
+	go get sigs.k8s.io/controller-tools/cmd/[email protected] ;\
+	rm -rf $$CONTROLLER_GEN_TMP_DIR ;\
+	}
+CONTROLLER_GEN=$(GOBIN)/controller-gen
+else
+CONTROLLER_GEN=$(shell which controller-gen)
+endif

exp/operator/PROJECT

@@ -0,0 +1,16 @@
+domain: cluster.x-k8s.io
+repo: sigs.k8s.io/cluster-api
+resources:
+- group: operator
+  kind: CoreProvider
+  version: v1alpha4
+- group: operator
+  kind: BootstrapProvider
+  version: v1alpha4
+- group: operator
+  kind: ControlPlaneProvider
+  version: v1alpha4
+- group: operator
+  kind: InfrastructureProvider
+  version: v1alpha4
+version: "2"

exp/operator/api/v1alpha4/bootstrapprovider_types.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2021 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 v1alpha4
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// BootstrapProviderSpec defines the desired state of BootstrapProvider
+type BootstrapProviderSpec struct {
+	ProviderSpec `json:",inline"`
+}
+
+// BootstrapProviderStatus defines the observed state of BootstrapProvider
+type BootstrapProviderStatus struct {
+	ProviderStatus `json:",inline"`
+}
+
+// +kubebuilder:object:root=true
+
+// BootstrapProvider is the Schema for the bootstrapproviders API
+type BootstrapProvider struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   BootstrapProviderSpec   `json:"spec,omitempty"`
+	Status BootstrapProviderStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// BootstrapProviderList contains a list of BootstrapProvider
+type BootstrapProviderList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []BootstrapProvider `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&BootstrapProvider{}, &BootstrapProviderList{})
+}

exp/operator/api/v1alpha4/controlplaneprovider_types.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2021 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 v1alpha4
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// ControlPlaneProviderSpec defines the desired state of ControlPlaneProvider
+type ControlPlaneProviderSpec struct {
+	ProviderSpec `json:",inline"`
+}
+
+// ControlPlaneProviderStatus defines the observed state of ControlPlaneProvider
+type ControlPlaneProviderStatus struct {
+	ProviderStatus `json:",inline"`
+}
+
+// +kubebuilder:object:root=true
+
+// ControlPlaneProvider is the Schema for the controlplaneproviders API
+type ControlPlaneProvider struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   ControlPlaneProviderSpec   `json:"spec,omitempty"`
+	Status ControlPlaneProviderStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// ControlPlaneProviderList contains a list of ControlPlaneProvider
+type ControlPlaneProviderList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []ControlPlaneProvider `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&ControlPlaneProvider{}, &ControlPlaneProviderList{})
+}

exp/operator/api/v1alpha4/coreprovider_types.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2021 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 v1alpha4
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// CoreProviderSpec defines the desired state of CoreProvider
+type CoreProviderSpec struct {
+	ProviderSpec `json:",inline"`
+}
+
+// CoreProviderStatus defines the observed state of CoreProvider
+type CoreProviderStatus struct {
+	ProviderStatus `json:",inline"`
+}
+
+// +kubebuilder:object:root=true
+
+// CoreProvider is the Schema for the coreproviders API
+type CoreProvider struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   CoreProviderSpec   `json:"spec,omitempty"`
+	Status CoreProviderStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// CoreProviderList contains a list of CoreProvider
+type CoreProviderList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []CoreProvider `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&CoreProvider{}, &CoreProviderList{})
+}

exp/operator/api/v1alpha4/groupversion_info.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2021 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 v1alpha4 contains API Schema definitions for the operator v1alpha4 API group
+// +kubebuilder:object:generate=true
+// +groupName=operator.cluster.x-k8s.io
+package v1alpha4
+
+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: "operator.cluster.x-k8s.io", Version: "v1alpha4"}
+
+	// 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
+)