Move APIs and cloud provider types into standalone Go module in ./sdk (#1900)

* it compiles

* fix/harmonize/lint imports across the project

* move configvarresolver into SDK

* add license to SDK to make wwhrd work

* update boilerplate check

* move skip-eviction annotation into the sdk

* move anexia errors into SDK

* move baremetal plugin types to sdk

* move bootstrap types into SDK

* move testhelper into SDK, improve linting

* use the same API registering method as for machines

* better filenames

Author: xrstf

.golangci.yml

@@ -44,11 +44,48 @@ linters-settings:
           - { pkg: io/ioutil, desc: https://go.dev/doc/go1.16#ioutil }
           - { pkg: github.com/ghodss/yaml, desc: use sigs.k8s.io/yaml instead }
 
+  revive:
+    rules:
+      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
+      - name: duplicated-imports
+        severity: warning
+
   govet:
     enable:
       - nilness # find tautologies / impossible conditions
 
+  importas:
+    no-unaliased: true
+    alias:
+      # Machine Controller
+      - pkg: k8c.io/machine-controller/sdk/apis/(\w+)/(v[\w\d]+)
+        alias: $1$2
+      # Kubernetes
+      - pkg: k8s.io/api/(\w+)/(v[\w\d]+)
+        alias: $1$2
+      - pkg: k8s.io/apimachinery/pkg/apis/meta/v1
+        alias: metav1
+      - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
+        alias: apiextensionsv1
+      - pkg: k8s.io/apimachinery/pkg/api/errors
+        alias: apierrors
+      - pkg: k8s.io/apimachinery/pkg/util/errors
+        alias: kerrors
+      # Controller Runtime
+      - pkg: sigs.k8s.io/controller-runtime/pkg/client
+        alias: ctrlruntimeclient
+      # Other Kube APIs
+      - pkg: go.anx.io/go-anxcloud/pkg/apis/(\w+)/(v[\w\d]+)
+        alias: anx$1$2
+      - pkg: github.com/tinkerbell/tink/api/(v[\w\d]+)
+        alias: tink$1
+      - pkg: kubevirt.io/api/(\w+)/(v[\w\d]+)
+        alias: kubevirt$1$2
+      - pkg: kubevirt.io/containerized-data-importer-api/pkg/apis/(\w+)/(v[\w\d]+)
+        alias: cdi$1$2
+
 issues:
+  max-same-issues: 0
   exclude:
     - func Convert_MachinesV1alpha1Machine_To_ClusterV1alpha1Machine should be ConvertMachinesV1alpha1MachineToClusterV1alpha1Machine
     - func Convert_MachineDeployment_ProviderConfig_To_ProviderSpec should be ConvertMachineDeploymentProviderConfigToProviderSpec
@@ -59,4 +96,4 @@ issues:
     - 'cyclomatic complexity [0-9]+ of func `\(\*provider\)\.getConfig` is high'
     - "SA1019: s.server.IPv6 is deprecated"
   exclude-dirs:
-    - pkg/machines
+    - apis/machines

Makefile

@@ -52,12 +52,12 @@ build-machine-controller: machine-controller
 
 .PHONY: clean
 clean:
-	rm -f machine-controller \
-		webhook
+	rm -f machine-controller webhook
 
 .PHONY: lint
 lint:
 	golangci-lint run -v
+	make -C sdk lint
 
 yamllint:
 	yamllint -c .yamllint.conf .
@@ -91,15 +91,18 @@ test-unit-docker:
 .PHONY: test-unit
 test-unit:
 	go test -v ./...
+	cd sdk && go test -v ./...
 
 .PHONY: build-tests
 build-tests:
 	go test -run nope ./...
+	cd sdk && go test -run nope ./...
 	go test -tags e2e -run nope ./...
 
 .PHONY: check-dependencies
 check-dependencies:
 	go mod verify
+	cd sdk && go mod verify
 
 .PHONY: download-gocache
 download-gocache:

cmd/machine-controller/main.go

@@ -30,8 +30,6 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"go.uber.org/zap"
 
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
-	"k8c.io/machine-controller/pkg/apis/cluster/v1alpha1/migrations"
 	cloudprovidertypes "k8c.io/machine-controller/pkg/cloudprovider/types"
 	"k8c.io/machine-controller/pkg/cloudprovider/util"
 	clusterinfo "k8c.io/machine-controller/pkg/clusterinfo"
@@ -41,8 +39,10 @@ import (
 	"k8c.io/machine-controller/pkg/controller/nodecsrapprover"
 	"k8c.io/machine-controller/pkg/health"
 	machinecontrollerlog "k8c.io/machine-controller/pkg/log"
-	machinesv1alpha1 "k8c.io/machine-controller/pkg/machines/v1alpha1"
+	"k8c.io/machine-controller/pkg/migrations"
 	"k8c.io/machine-controller/pkg/node"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
+	machinesv1alpha1 "k8c.io/machine-controller/sdk/apis/machines/v1alpha1"
 
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/types"

go.mod

@@ -4,6 +4,8 @@ go 1.22.3
 
 toolchain go1.23.1
 
+replace k8c.io/machine-controller/sdk => ./sdk
+
 require (
 	cloud.google.com/go/logging v1.11.0
 	cloud.google.com/go/monitoring v1.21.1
@@ -49,6 +51,7 @@ require (
 	gomodules.xyz/jsonpatch/v2 v2.4.0
 	google.golang.org/api v0.197.0
 	gopkg.in/yaml.v3 v3.0.1
+	k8c.io/machine-controller/sdk v0.0.0-00010101000000-000000000000
 	k8s.io/api v0.31.1
 	k8s.io/apiextensions-apiserver v0.31.1
 	k8s.io/apimachinery v0.31.1
@@ -60,7 +63,6 @@ require (
 	kubevirt.io/api v1.3.1
 	kubevirt.io/containerized-data-importer-api v1.60.3
 	sigs.k8s.io/controller-runtime v0.19.0
-	sigs.k8s.io/yaml v1.4.0
 )
 
 require (
@@ -185,4 +187,5 @@ require (
 	kubevirt.io/controller-lifecycle-operator-sdk/api v0.2.4 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
 )

hack/verify-boilerplate.sh

@@ -20,5 +20,4 @@ cd $(dirname $0)/..
 
 boilerplate \
   -boilerplates hack/boilerplate \
-  -exclude pkg/machines/v1alpha1 \
-  -exclude pkg/signals
+  -exclude sdk/apis/machines/v1alpha1

pkg/admission/machinedeployments.go

@@ -21,7 +21,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
 
 	admissionv1 "k8s.io/api/admission/v1"
 	apiequality "k8s.io/apimachinery/pkg/api/equality"

pkg/admission/machinedeployments_test.go

@@ -19,7 +19,7 @@ package admission
 import (
 	"testing"
 
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )

pkg/admission/machinedeployments_validation.go

@@ -20,9 +20,9 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"k8c.io/machine-controller/pkg/apis/cluster/common"
-	"k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
-	providerconfigtypes "k8c.io/machine-controller/pkg/providerconfig/types"
+	"k8c.io/machine-controller/sdk/apis/cluster/common"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
+	providerconfigtypes "k8c.io/machine-controller/sdk/providerconfig"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	metav1validation "k8s.io/apimachinery/pkg/apis/meta/v1/validation"
@@ -32,13 +32,13 @@ import (
 	"k8s.io/apimachinery/pkg/util/validation/field"
 )
 
-func validateMachineDeployment(md v1alpha1.MachineDeployment) field.ErrorList {
+func validateMachineDeployment(md clusterv1alpha1.MachineDeployment) field.ErrorList {
 	allErrs := field.ErrorList{}
 	allErrs = append(allErrs, validateMachineDeploymentSpec(&md.Spec, field.NewPath("spec"))...)
 	return allErrs
 }
 
-func validateMachineDeploymentSpec(spec *v1alpha1.MachineDeploymentSpec, fldPath *field.Path) field.ErrorList {
+func validateMachineDeploymentSpec(spec *clusterv1alpha1.MachineDeploymentSpec, fldPath *field.Path) field.ErrorList {
 	allErrs := field.ErrorList{}
 	allErrs = append(allErrs, metav1validation.ValidateLabelSelector(&spec.Selector, metav1validation.LabelSelectorValidationOptions{}, fldPath.Child("selector"))...)
 	if len(spec.Selector.MatchLabels)+len(spec.Selector.MatchExpressions) == 0 {
@@ -60,7 +60,7 @@ func validateMachineDeploymentSpec(spec *v1alpha1.MachineDeploymentSpec, fldPath
 	return allErrs
 }
 
-func validateMachineDeploymentStrategy(strategy *v1alpha1.MachineDeploymentStrategy, fldPath *field.Path) field.ErrorList {
+func validateMachineDeploymentStrategy(strategy *clusterv1alpha1.MachineDeploymentStrategy, fldPath *field.Path) field.ErrorList {
 	allErrs := field.ErrorList{}
 	switch strategy.Type {
 	case common.RollingUpdateMachineDeploymentStrategyType:
@@ -73,7 +73,7 @@ func validateMachineDeploymentStrategy(strategy *v1alpha1.MachineDeploymentStrat
 	return allErrs
 }
 
-func validateMachineRollingUpdateDeployment(rollingUpdate *v1alpha1.MachineRollingUpdateDeployment, fldPath *field.Path) field.ErrorList {
+func validateMachineRollingUpdateDeployment(rollingUpdate *clusterv1alpha1.MachineRollingUpdateDeployment, fldPath *field.Path) field.ErrorList {
 	allErrs := field.ErrorList{}
 	var maxUnavailable int
 	var maxSurge int
@@ -110,11 +110,11 @@ func getIntOrPercent(s *intstr.IntOrString, roundUp bool) (int, error) {
 	return intstr.GetValueFromIntOrPercent(s, 100, roundUp)
 }
 
-func machineDeploymentDefaultingFunction(md *v1alpha1.MachineDeployment) {
-	v1alpha1.PopulateDefaultsMachineDeployment(md)
+func machineDeploymentDefaultingFunction(md *clusterv1alpha1.MachineDeployment) {
+	clusterv1alpha1.PopulateDefaultsMachineDeployment(md)
 }
 
-func mutationsForMachineDeployment(md *v1alpha1.MachineDeployment) error {
+func mutationsForMachineDeployment(md *clusterv1alpha1.MachineDeployment) error {
 	providerConfig, err := providerconfigtypes.GetConfig(md.Spec.Template.Spec.ProviderSpec)
 	if err != nil {
 		return fmt.Errorf("failed to read MachineDeployment.Spec.Template.Spec.ProviderSpec: %w", err)

pkg/admission/machines.go

@@ -24,11 +24,11 @@ import (
 	"github.com/Masterminds/semver/v3"
 	"golang.org/x/crypto/ssh"
 
-	"k8c.io/machine-controller/pkg/apis/cluster/common"
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
 	"k8c.io/machine-controller/pkg/cloudprovider"
-	"k8c.io/machine-controller/pkg/providerconfig"
-	providerconfigtypes "k8c.io/machine-controller/pkg/providerconfig/types"
+	"k8c.io/machine-controller/sdk/apis/cluster/common"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
+	"k8c.io/machine-controller/sdk/providerconfig"
+	"k8c.io/machine-controller/sdk/userdata"
 
 	admissionv1 "k8s.io/api/admission/v1"
 	apiequality "k8s.io/apimachinery/pkg/api/equality"
@@ -101,7 +101,7 @@ func (ad *admissionData) mutateMachines(ctx context.Context, ar admissionv1.Admi
 		common.SetKubeletFlags(&machine, map[common.KubeletFlags]string{
 			common.ExternalCloudProviderKubeletFlag: fmt.Sprintf("%t", ad.nodeSettings.ExternalCloudProvider),
 		})
-		providerConfig, err := providerconfigtypes.GetConfig(machine.Spec.ProviderSpec)
+		providerConfig, err := providerconfig.GetConfig(machine.Spec.ProviderSpec)
 		if err != nil {
 			return nil, err
 		}
@@ -116,7 +116,7 @@ func (ad *admissionData) mutateMachines(ctx context.Context, ar admissionv1.Admi
 }
 
 func (ad *admissionData) defaultAndValidateMachineSpec(ctx context.Context, spec *clusterv1alpha1.MachineSpec) error {
-	providerConfig, err := providerconfigtypes.GetConfig(spec.ProviderSpec)
+	providerConfig, err := providerconfig.GetConfig(spec.ProviderSpec)
 	if err != nil {
 		return fmt.Errorf("failed to read machine.spec.providerSpec: %w", err)
 	}
@@ -164,7 +164,7 @@ func (ad *admissionData) defaultAndValidateMachineSpec(ctx context.Context, spec
 		return fmt.Errorf("Invalid public keys specified: %w", err)
 	}
 
-	defaultedOperatingSystemSpec, err := providerconfig.DefaultOperatingSystemSpec(
+	defaultedOperatingSystemSpec, err := userdata.DefaultOperatingSystemSpec(
 		providerConfig.OperatingSystem,
 		providerConfig.OperatingSystemSpec,
 	)

pkg/admission/util.go

@@ -20,7 +20,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	providerconfigtypes "k8c.io/machine-controller/pkg/providerconfig/types"
+	providerconfigtypes "k8c.io/machine-controller/sdk/providerconfig"
 )
 
 const cloudProviderPacket = "packet"

pkg/cloudprovider/cache/cloudprovidercache.go

@@ -24,7 +24,7 @@ import (
 
 	gocache "github.com/patrickmn/go-cache"
 
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
 )
 
 type CloudproviderCache struct {

pkg/cloudprovider/cache/cloudprovidercache_test.go

@@ -20,7 +20,7 @@ import (
 	"errors"
 	"testing"
 
-	clusterv1alpha1 "k8c.io/machine-controller/pkg/apis/cluster/v1alpha1"
+	clusterv1alpha1 "k8c.io/machine-controller/sdk/apis/cluster/v1alpha1"
 
 	corev1 "k8s.io/api/core/v1"
 	runtime "k8s.io/apimachinery/pkg/runtime"

pkg/cloudprovider/errors/errors.go

@@ -20,7 +20,7 @@ import (
 	"errors"
 	"fmt"
 
-	"k8c.io/machine-controller/pkg/apis/cluster/common"
+	"k8c.io/machine-controller/sdk/apis/cluster/common"
 )
 
 var (

pkg/cloudprovider/instance/instance.go

@@ -16,7 +16,7 @@ limitations under the License.
 
 package instance
 
-import v1 "k8s.io/api/core/v1"
+import corev1 "k8s.io/api/core/v1"
 
 // Instance represents a instance on the cloud provider.
 type Instance interface {
@@ -27,7 +27,7 @@ type Instance interface {
 	// ProviderID returns the expected providerID for the instance
 	ProviderID() string
 	// Addresses returns a list of addresses associated with the instance.
-	Addresses() map[string]v1.NodeAddressType
+	Addresses() map[string]corev1.NodeAddressType
 	// Status returns the instance status.
 	Status() Status
 }