💎 Refactor VM service spec

Author: Cecile Robert-Michon

cloud/converters/vmss.go

@@ -17,7 +17,7 @@ limitations under the License.
 package converters
 
 import (
-	"github.com/Azure/azure-sdk-for-go/profiles/latest/compute/mgmt/compute"
+	"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2020-06-01/compute"
 	"github.com/Azure/go-autorest/autorest/to"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"

cloud/converters/vmss_test.go

@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/Azure/azure-sdk-for-go/profiles/latest/compute/mgmt/compute"
+	"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2020-06-01/compute"
 	"github.com/Azure/go-autorest/autorest/to"
 	"github.com/onsi/gomega"
 

cloud/defaults.go

@@ -18,7 +18,6 @@ package azure
 
 import (
 	"fmt"
-
 	"github.com/blang/semver"
 	"github.com/pkg/errors"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"
@@ -41,27 +40,6 @@ const (
 	LatestVersion = "latest"
 )
 
-// SupportedAvailabilityZoneLocations is a slice of the locations where Availability Zones are supported.
-// This is used to validate whether a virtual machine should leverage an Availability Zone.
-// Based on the Availability Zones listed in https://docs.microsoft.com/en-us/azure/availability-zones/az-overview
-var SupportedAvailabilityZoneLocations = []string{
-	// Americas
-	"centralus",
-	"eastus",
-	"eastus2",
-	"westus2",
-
-	// Europe
-	"francecentral",
-	"northeurope",
-	"uksouth",
-	"westeurope",
-
-	// Asia Pacific
-	"japaneast",
-	"southeastasia",
-}
-
 // GenerateInternalLBName generates a internal load balancer name, based on the cluster name.
 func GenerateInternalLBName(clusterName string) string {
 	return fmt.Sprintf("%s-%s", clusterName, "internal-lb")

cloud/scope/machine.go

@@ -19,14 +19,13 @@ package scope
 import (
 	"context"
 	"encoding/base64"
-	"k8s.io/apimachinery/pkg/util/uuid"
-
+	"github.com/Azure/go-autorest/autorest/to"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/uuid"
 	"k8s.io/klog/klogr"
-	"k8s.io/utils/pointer"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha3"
 	azure "sigs.k8s.io/cluster-api-provider-azure/cloud"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1alpha3"
@@ -87,6 +86,25 @@ type MachineScope struct {
 	AzureMachine *infrav1.AzureMachine
 }
 
+// VMSpecs returns the VM specs.
+func (m *MachineScope) VMSpecs() []azure.VMSpec {
+	return []azure.VMSpec{
+		{
+			Name:                   m.Name(),
+			Role:                   m.Role(),
+			NICNames:               m.NICNames(),
+			SSHKeyData:             m.AzureMachine.Spec.SSHPublicKey,
+			Size:                   m.AzureMachine.Spec.VMSize,
+			OSDisk:                 m.AzureMachine.Spec.OSDisk,
+			DataDisks:              m.AzureMachine.Spec.DataDisks,
+			Zone:                   m.AvailabilityZone(),
+			Identity:               m.AzureMachine.Spec.Identity,
+			UserAssignedIdentities: m.AzureMachine.Spec.UserAssignedIdentities,
+			SpotVMOptions:          m.AzureMachine.Spec.SpotVMOptions,
+		},
+	}
+}
+
 // PublicIPSpec returns the public IP specs.
 func (m *MachineScope) PublicIPSpecs() []azure.PublicIPSpec {
 	var spec []azure.PublicIPSpec
@@ -147,6 +165,14 @@ func (m *MachineScope) NICSpecs() []azure.NICSpec {
 	return specs
 }
 
+func (m *MachineScope) NICNames() []string {
+	nicNames := make([]string, len(m.NICSpecs()))
+	for i, nic := range m.NICSpecs() {
+		nicNames[i] = nic.Name
+	}
+	return nicNames
+}
+
 // DiskSpecs returns the disk specs.
 func (m *MachineScope) DiskSpecs() []azure.DiskSpec {
 	spec := azure.DiskSpec{
@@ -180,13 +206,14 @@ func (m *MachineScope) Subnet() *infrav1.SubnetSpec {
 // AvailabilityZone returns the AzureMachine Availability Zone.
 // Priority for selecting the AZ is
 //   1) Machine.Spec.FailureDomain
-//   2) AzureMachine.Spec.FailureDomain
+//   2) AzureMachine.Spec.FailureDomain (This is to support deprecated AZ)
 //   3) AzureMachine.Spec.AvailabilityZone.ID (This is DEPRECATED)
 //   4) No AZ
 func (m *MachineScope) AvailabilityZone() string {
 	if m.Machine.Spec.FailureDomain != nil {
 		return *m.Machine.Spec.FailureDomain
 	}
+	// DEPRECATED: to support old clients
 	if m.AzureMachine.Spec.FailureDomain != nil {
 		return *m.AzureMachine.Spec.FailureDomain
 	}
@@ -221,12 +248,12 @@ func (m *MachineScope) Role() string {
 }
 
 // GetVMID returns the AzureMachine instance id by parsing Spec.ProviderID.
-func (m *MachineScope) GetVMID() *string {
+func (m *MachineScope) GetVMID() string {
 	parsed, err := noderefutil.NewProviderID(m.GetProviderID())
 	if err != nil {
-		return nil
+		return ""
 	}
-	return pointer.StringPtr(parsed.ID())
+	return parsed.ID()
 }
 
 // GetProviderID returns the AzureMachine providerID from the spec.
@@ -239,12 +266,15 @@ func (m *MachineScope) GetProviderID() string {
 
 // SetProviderID sets the AzureMachine providerID in spec.
 func (m *MachineScope) SetProviderID(v string) {
-	m.AzureMachine.Spec.ProviderID = pointer.StringPtr(v)
+	m.AzureMachine.Spec.ProviderID = to.StringPtr(v)
 }
 
 // GetVMState returns the AzureMachine VM state.
-func (m *MachineScope) GetVMState() *infrav1.VMState {
-	return m.AzureMachine.Status.VMState
+func (m *MachineScope) GetVMState() infrav1.VMState {
+	if m.AzureMachine.Status.VMState != nil {
+		return *m.AzureMachine.Status.VMState
+	}
+	return ""
 }
 
 // SetVMState sets the AzureMachine VM state.
@@ -264,7 +294,7 @@ func (m *MachineScope) SetNotReady() {
 
 // SetFailureMessage sets the AzureMachine status failure message.
 func (m *MachineScope) SetFailureMessage(v error) {
-	m.AzureMachine.Status.FailureMessage = pointer.StringPtr(v.Error())
+	m.AzureMachine.Status.FailureMessage = to.StringPtr(v.Error())
 }
 
 // SetFailureReason sets the AzureMachine status failure reason.
@@ -299,11 +329,12 @@ func (m *MachineScope) Close(ctx context.Context) error {
 // the value from AzureMachine takes precedence.
 func (m *MachineScope) AdditionalTags() infrav1.Tags {
 	tags := make(infrav1.Tags)
-
 	// Start with the cluster-wide tags...
 	tags.Merge(m.ClusterDescriber.AdditionalTags())
 	// ... and merge in the Machine's
 	tags.Merge(m.AzureMachine.Spec.AdditionalTags)
+	// Set the cloud provider tag
+	tags[infrav1.ClusterAzureCloudProviderTagKey(m.ClusterName())] = string(infrav1.ResourceLifecycleOwned)
 
 	return tags
 }
@@ -325,3 +356,13 @@ func (m *MachineScope) GetBootstrapData(ctx context.Context) (string, error) {
 	}
 	return base64.StdEncoding.EncodeToString(value), nil
 }
+
+// Pick image from the machine configuration, or use a default one.
+func (m *MachineScope) GetVMImage() (*infrav1.Image, error) {
+	// Use custom Marketplace image, Image ID or a Shared Image Gallery image if provided
+	if m.AzureMachine.Spec.Image != nil {
+		return m.AzureMachine.Spec.Image, nil
+	}
+	m.Info("No image specified for machine, using default", "machine", m.AzureMachine.GetName())
+	return azure.GetDefaultUbuntuImage(to.String(m.Machine.Spec.Version))
+}

cloud/scope/machinepool.go

@@ -19,6 +19,7 @@ package scope
 import (
 	"context"
 	"encoding/base64"
+	"github.com/Azure/go-autorest/autorest/to"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
@@ -177,3 +178,13 @@ func (m *MachinePoolScope) GetBootstrapData(ctx context.Context) (string, error)
 	}
 	return base64.StdEncoding.EncodeToString(value), nil
 }
+
+// Pick image from the machine configuration, or use a default one.
+func (m *MachinePoolScope) GetVMImage() (*infrav1.Image, error) {
+	// Use custom Marketplace image, Image ID or a Shared Image Gallery image if provided
+	if m.AzureMachinePool.Spec.Template.Image != nil {
+		return m.AzureMachinePool.Spec.Template.Image, nil
+	}
+	m.Info("No image specified for machine, using default", "machine", m.MachinePool.GetName())
+	return azure.GetDefaultUbuntuImage(to.String(m.MachinePool.Spec.Template.Spec.Version))
+}

cloud/services/networkinterfaces/networkinterfaces_test.go

@@ -37,8 +37,8 @@ import (
 	"sigs.k8s.io/cluster-api-provider-azure/cloud/services/resourceskus"
 	"sigs.k8s.io/cluster-api-provider-azure/cloud/services/subnets/mock_subnets"
 
-	"github.com/Azure/azure-sdk-for-go/profiles/latest/compute/mgmt/compute"
-	network "github.com/Azure/azure-sdk-for-go/services/network/mgmt/2019-06-01/network"
+	"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2020-06-01/compute"
+	"github.com/Azure/azure-sdk-for-go/services/network/mgmt/2019-06-01/network"
 	"k8s.io/klog/klogr"
 	"k8s.io/utils/pointer"
 )