Add ORC with image controller

This commits creates a new home for ORC, initially incubated in CAPO.
The initial implementation of ORC has an image controller.

The image controller is integrated with OpenStackServer and from there
into both OpenStackMachine and the bastion.

The E2E tests are updated to use the new image controller. Images are
now loaded dynamically by the test suite.

Author: mdbooth

.golangci.yml

@@ -59,6 +59,7 @@ linters-settings:
     sections:
     - standard
     - default
+    - prefix(github.com/k-orc/openstack-resource-controller)
     - prefix(sigs.k8s.io/cluster-api-provider-openstack)
   gocritic:
     enabled-tags:
@@ -130,6 +131,9 @@ linters-settings:
         alias: controlplanev1alpha4
       - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1
         alias: controlplanev1
+      # ORC
+      - pkg: github.com/k-orc/openstack-resource-controller/api/v1alpha1
+        alias: orcv1alpha1
 
   nolintlint:
     # https://github.com/golangci/golangci-lint/issues/3228

Dockerfile

@@ -21,8 +21,11 @@ ARG goproxy=https://proxy.golang.org
 ENV GOPROXY=$goproxy
 
 # Copy the Go Modules manifests
+RUN mkdir orc
 COPY go.mod go.mod
 COPY go.sum go.sum
+COPY orc/go.mod orc/go.mod
+COPY orc/go.sum orc/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

Makefile

@@ -150,6 +150,7 @@ TEST_PATHS ?= ./...
 test: $(ARTIFACTS) $(GOTESTSUM) kubebuilder_assets
 	KUBEBUILDER_ASSETS="$(KUBEBUILDER_ASSETS)" $(GOTESTSUM) --junitfile $(ARTIFACTS)/junit.test.xml --junitfile-hide-empty-pkg --jsonfile $(ARTIFACTS)/test-output.log -- \
 			   -v $(TEST_PATHS) $(TEST_ARGS)
+	$(MAKE) -C $(REPO_ROOT)/orc test
 
 E2E_TEMPLATES_DIR=test/e2e/data/infrastructure-openstack
 E2E_KUSTOMIZE_DIR=test/e2e/data/kustomize
@@ -250,10 +251,12 @@ $(GO_APIDIFF): # Build go-apidiff.
 .PHONY: lint
 lint: $(GOLANGCI_LINT) ## Lint codebase
 	$(GOLANGCI_LINT) run -v --fast=false
+	$(MAKE) -C $(REPO_ROOT)/orc lint
 
 .PHONY: lint-update
 lint-update: $(GOLANGCI_LINT) ## Lint codebase
 	$(GOLANGCI_LINT) run -v --fast=false --fix
+	$(MAKE) -C $(REPO_ROOT)/orc lint-fix
 
 lint-fast: $(GOLANGCI_LINT) ## Run only faster linters to detect possible issues
 	$(GOLANGCI_LINT) run -v --fast=true
@@ -264,11 +267,13 @@ lint-fast: $(GOLANGCI_LINT) ## Run only faster linters to detect possible issues
 
 .PHONY: modules
 modules: ## Runs go mod to ensure proper vendoring.
+	$(MAKE) -C $(REPO_ROOT)/orc modules
 	go mod tidy
 	cd $(TOOLS_DIR); go mod tidy
+	cd $(REPO_ROOT)/hack/codegen; go mod tidy
 
 .PHONY: generate
-generate: templates generate-controller-gen generate-codegen generate-conversion-gen generate-go generate-manifests generate-api-docs ## Generate all generated code
+generate: templates generate-orc generate-controller-gen generate-codegen generate-conversion-gen generate-go generate-manifests generate-api-docs ## Generate all generated code
 
 .PHONY: generate-go
 generate-go: $(MOCKGEN)
@@ -280,9 +285,14 @@ generate-controller-gen: $(CONTROLLER_GEN)
 		paths=./api/... \
 		object:headerFile=./hack/boilerplate/boilerplate.generatego.txt
 
+.PHONY: generate-codegen
 generate-codegen: generate-controller-gen
 	./hack/update-codegen.sh
 
+.PHONY: generate-orc
+generate-orc:
+	$(MAKE) -C $(REPO_ROOT)/orc generate
+
 .PHONY: generate-conversion-gen
 capo_module := sigs.k8s.io/cluster-api-provider-openstack
 generate-conversion-gen: $(CONVERSION_GEN)
@@ -308,6 +318,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
 	$(CONTROLLER_GEN) \
 		paths=./ \
 		paths=./controllers/... \
+		paths=./internal/controllers/... \
 		output:rbac:dir=$(RBAC_ROOT) \
 		rbac:roleName=manager-role
 

PROJECT

@@ -30,14 +30,14 @@ resources:
   kind: OpenStackClusterTemplate
   version: v1alpha7
 - group: infrastructure
-  version: v1beta1
   kind: OpenStackCluster
-- group: infrastructure
   version: v1beta1
-  kind: OpenStackMachine
 - group: infrastructure
+  kind: OpenStackMachine
   version: v1beta1
+- group: infrastructure
   kind: OpenStackMachineTemplate
+  version: v1beta1
 - group: infrastructure
   kind: OpenStackClusterTemplate
   version: v1beta1
@@ -47,4 +47,5 @@ resources:
 - group: infrastructure
   kind: OpenStackServer
   version: v1alpha1
+- group: infrastructure
 version: "2"

api/v1beta1/conditions_consts.go

@@ -42,6 +42,8 @@ const (
 	InstanceDeleteFailedReason = "InstanceDeleteFailed"
 	// OpenstackErrorReason used when there is an error communicating with OpenStack.
 	OpenStackErrorReason = "OpenStackError"
+	// DependencyFailedReason indicates that a dependent object failed.
+	DependencyFailedReason = "DependencyFailed"
 )
 
 const (

api/v1beta1/types.go

@@ -28,7 +28,13 @@ type OpenStackMachineTemplateResource struct {
 	Spec OpenStackMachineSpec `json:"spec"`
 }
 
-// ImageParam describes a glance image. It can be specified by ID or filter.
+type ResourceReference struct {
+	// Name is the name of the referenced resource
+	Name string `json:"name"`
+}
+
+// ImageParam describes a glance image. It can be specified by ID, filter, or a
+// reference to an ORC Image.
 // +kubebuilder:validation:MaxProperties:=1
 // +kubebuilder:validation:MinProperties:=1
 type ImageParam struct {
@@ -42,6 +48,11 @@ type ImageParam struct {
 	// be raised.
 	// +optional
 	Filter *ImageFilter `json:"filter,omitempty"`
+
+	// ImageRef is a reference to an ORC Image in the same namespace as the
+	// referring object.
+	// +optional
+	ImageRef *ResourceReference `json:"imageRef,omitempty"`
 }
 
 // ImageFilter describes a query for an image.