ref: Replace components with extracted common pkg (#248)

`github.com/weaveworks-liquidmetal/controller-pkg` contains things used
by both CAPMVM and the new microvm-operator.

Aside from this switch there are no code changes at all.

Author: Callisto13

api/v1alpha1/defaults.go

@@ -1,10 +1,11 @@
 package v1alpha1
 
 import (
+	"github.com/weaveworks-liquidmetal/controller-pkg/types/microvm"
 	"github.com/yitsushi/macpot"
 )
 
-func SetDefaults_NetworkInterface(obj *NetworkInterface) { //nolint: revive,stylecheck // idk it was here
+func SetDefaults_NetworkInterface(obj *microvm.NetworkInterface) { //nolint: revive,stylecheck // idk it was here
 	if obj.GuestMAC == "" {
 		mac, _ := macpot.New(macpot.AsLocal(), macpot.AsUnicast())
 

api/v1alpha1/microvmcluster_types.go

@@ -4,6 +4,8 @@
 package v1alpha1
 
 import (
+	flclient "github.com/weaveworks-liquidmetal/controller-pkg/client"
+	"github.com/weaveworks-liquidmetal/controller-pkg/types/microvm"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 )
@@ -21,13 +23,13 @@ type MicrovmClusterSpec struct {
 	// If specified these keys will be applied to all machine created unless you
 	// specify different keys at the machine level.
 	// +optional
-	SSHPublicKeys []SSHPublicKey `json:"sshPublicKeys,omitempty"`
+	SSHPublicKeys []microvm.SSHPublicKey `json:"sshPublicKeys,omitempty"`
 	// Placement specifies how machines for the cluster should be placed onto hosts (i.e. where the microvms are created).
 	// +kubebuilder:validation:Required
 	Placement Placement `json:"placement"`
 	// MicrovmProxy is the proxy server details to use when calling the microvm service. This is an
 	// alteranative to using the http proxy environment variables and applied purely to the grpc service.
-	MicrovmProxy *Proxy `json:"microvmProxy,omitempty"`
+	MicrovmProxy *flclient.Proxy `json:"microvmProxy,omitempty"`
 
 	// mTLS Configuration:
 	//

api/v1alpha1/microvmmachine_types.go

@@ -4,6 +4,7 @@
 package v1alpha1
 
 import (
+	microvm "github.com/weaveworks-liquidmetal/controller-pkg/types/microvm"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/errors"
@@ -17,14 +18,14 @@ const (
 
 // MicrovmMachineSpec defines the desired state of MicrovmMachine.
 type MicrovmMachineSpec struct {
-	MicrovmSpec `json:",inline"`
+	microvm.VMSpec `json:",inline"`
 
 	// SSHPublicKeys is list of SSH public keys that will be used with stated users
 	// on this machine.
 	// If specified they will take precedence over any SSH keys specified at
 	// the cluster level.
 	// +optional
-	SSHPublicKeys []SSHPublicKey `json:"sshPublicKeys,omitempty"`
+	SSHPublicKeys []microvm.SSHPublicKey `json:"sshPublicKeys,omitempty"`
 
 	// ProviderID is the unique identifier as specified by the cloud provider.
 	ProviderID *string `json:"providerID,omitempty"`
@@ -38,7 +39,7 @@ type MicrovmMachineStatus struct {
 	Ready bool `json:"ready"`
 
 	// VMState indicates the state of the microvm.
-	VMState *VMState `json:"vmState,omitempty"`
+	VMState *microvm.VMState `json:"vmState,omitempty"`
 
 	// Addresses contains the microvm associated addresses.
 	Addresses []clusterv1.MachineAddress `json:"addresses,omitempty"`

api/v1alpha1/types.go

@@ -7,45 +7,6 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 )
 
-// MicrovmSpec represents the specification for a microvm.
-type MicrovmSpec struct {
-	// VCPU specifies how many vcpu's the microvm will be allocated.
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Minimum:=1
-	VCPU int64 `json:"vcpu"`
-
-	// MemoryMb is the amount of memory in megabytes that the microvm will be allocated.
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Minimum:=1024
-	MemoryMb int64 `json:"memoryMb"`
-
-	// RootVolume specifies the volume to use for the root of the microvm.
-	// +kubebuilder:validation:Required
-	RootVolume Volume `json:"rootVolume"`
-
-	// AdditionalVolumes specifies additional non-root volumes to attach to the microvm.
-	// +optional
-	AdditionalVolumes []Volume `json:"volumes,omitempty"`
-
-	// Kernel specifies the kernel and its arguments to use.
-	// +kubebuilder:validation:Required
-	Kernel ContainerFileSource `json:"kernel"`
-
-	// KernelCmdLine are the additional args to use for the kernel cmdline.
-	// Each MicroVM provider has its own recommended list, they will be used
-	// automatically. This field is for additional values.
-	KernelCmdLine map[string]string `json:"kernelCmdline,omitempty"`
-
-	// Initrd is an optional initial ramdisk to use.
-	// +optional
-	Initrd *ContainerFileSource `json:"initrd,omitempty"`
-
-	// NetworkInterfaces specifies the network interfaces attached to the microvm.
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MinItems:=1
-	NetworkInterfaces []NetworkInterface `json:"networkInterfaces"`
-}
-
 // MicrovmMachineTemplateResource describes the data needed to create a MicrovmMachine from a template.
 type MicrovmMachineTemplateResource struct {
 	// Standard object's metadata.
@@ -57,73 +18,6 @@ type MicrovmMachineTemplateResource struct {
 	Spec MicrovmMachineSpec `json:"spec"`
 }
 
-// ContainerFileSource represents a file coming from a container.
-type ContainerFileSource struct {
-	// Image is the container image to use.
-	// +kubebuilder:validation:Required
-	Image string `json:"image"`
-	// Filename is the name of the file in the container to use.
-	// +optional
-	Filename string `json:"filename,omitempty"`
-}
-
-// Volume represents a volume to be attached to a microvm.
-type Volume struct {
-	// ID is a unique identifier for this volume.
-	// +kubebuilder:validation:Required
-	ID string `json:"id"`
-	// Image is the container image to use for the volume.
-	// +kubebuilder:validation:Required
-	Image string `json:"image"`
-	// ReadOnly specifies that the volume is to be mounted readonly.
-	// +kubebuilder:default:=false
-	// +optional
-	ReadOnly bool `json:"readOnly,omitempty"`
-}
-
-// IfaceType is a type representing the network interface types.
-type IfaceType string
-
-const (
-	// IfaceTypeTap is a TAP network interface.
-	IfaceTypeTap = "tap"
-	// IfaceTypeMacvtap is a MACVTAP network interface.
-	IfaceTypeMacvtap = "macvtap"
-)
-
-// NetworkInterface represents a network interface for the microvm.
-type NetworkInterface struct {
-	// GuestDeviceName is the name of the network interface to create in the microvm.
-	// +kubebuilder:validation:Required
-	GuestDeviceName string `json:"guestDeviceName"`
-	// GuestMAC allows the specifying of a specific MAC address to use for the interface. If
-	// not supplied a autogenerated MAC address will be used.
-	// +optional
-	GuestMAC string `json:"guestMac,omitempty"`
-	// Type is the type of host network interface type to create to use by the guest.
-	// +kubebuilder:validation:Enum=macvtap;tap
-	Type IfaceType `json:"type"`
-	// Address is an optional IP address to assign to this interface. If not supplied then DHCP will be used.
-	// +optional
-	Address string `json:"address,omitempty"`
-}
-
-// VMState is a type that represents the state of a microvm.
-type VMState string
-
-var (
-	// VMStatePending indicates the microvm hasn't been started.
-	VMStatePending = VMState("pending")
-	// VMStateRunning indicates the microvm is running.
-	VMStateRunning = VMState("running")
-	// VMStateFailed indicates the microvm has failed.
-	VMStateFailed = VMState("failed")
-	// VMStateDeleted indicates the microvm has been deleted.
-	VMStateDeleted = VMState("deleted")
-	// VMStateUnknown indicates the microvm is in an state that is unknown/supported by CAPMVM.
-	VMStateUnknown = VMState("unknown")
-)
-
 // Placement represents configuration relating to the placement of the microvms. The number of placement
 // options will grow and so we need to ensure in the validation webhook that only 1 placement types
 // is configured.
@@ -167,7 +61,8 @@ type MicrovmHost struct {
 	// Name is an optional name for the host.
 	// +optional
 	Name string `json:"name,omitempty"`
-	// Endpoint is the API endpoint for the microvm service (i.e. flintlock).
+	// Endpoint is the API endpoint for the microvm service (i.e. flintlock)
+	// including the port.
 	// +kubebuilder:validation:Required
 	Endpoint string `json:"endpoint"`
 	// ControlPlaneAllowed marks this host as suitable for running control plane nodes in
@@ -176,12 +71,6 @@ type MicrovmHost struct {
 	ControlPlaneAllowed bool `json:"controlplaneAllowed"`
 }
 
-// Proxy represents a proxy server.
-type Proxy struct {
-	// Endpoint is the address of the proxy.
-	Endpoint string `json:"endpoint"`
-}
-
 // TLSConfig represents config for connecting to TLS enabled hosts.
 type TLSConfig struct {
 	Cert   []byte `json:"cert"`