Merge pull request #5167 from mboersma/community-gallery-ref-images

Use community gallery for default VM images

Dockerfile

@@ -18,7 +18,7 @@
 ARG ARCH
 
 # Build the manager binary
-FROM golang:1.22 as builder
+FROM golang:1.22 AS builder
 WORKDIR /workspace
 
 # Run this with docker build --build_arg $(go env GOPROXY) to override the goproxy

Makefile

@@ -114,7 +114,7 @@ GINKGO_VER := $(shell go list -m -f '{{.Version}}' github.com/onsi/ginkgo/v2)
 GINKGO_BIN := ginkgo
 GINKGO := $(TOOLS_BIN_DIR)/$(GINKGO_BIN)-$(GINKGO_VER)
 
-KUBECTL_VER := v1.28.4
+KUBECTL_VER := v1.29.10
 KUBECTL_BIN := kubectl
 KUBECTL := $(TOOLS_BIN_DIR)/$(KUBECTL_BIN)-$(KUBECTL_VER)
 

Tiltfile

@@ -129,7 +129,7 @@ def validate_auth():
 
 tilt_helper_dockerfile_header = """
 # Tilt image
-FROM golang:1.22 as tilt-helper
+FROM golang:1.22 AS tilt-helper
 # Support live reloading with Tilt
 RUN wget --output-document /restart.sh --quiet https://raw.githubusercontent.com/windmilleng/rerun-process-wrapper/master/restart.sh  && \
     wget --output-document /start.sh --quiet https://raw.githubusercontent.com/windmilleng/rerun-process-wrapper/master/start.sh && \
@@ -138,7 +138,7 @@ RUN wget --output-document /restart.sh --quiet https://raw.githubusercontent.com
 """
 
 tilt_dockerfile_header = """
-FROM gcr.io/distroless/base:debug as tilt
+FROM gcr.io/distroless/base:debug AS tilt
 WORKDIR /tilt
 RUN ["/busybox/chmod", "0777", "."]
 COPY --from=tilt-helper /process.txt .

api/v1beta1/azuremachine_types.go

@@ -44,8 +44,8 @@ type AzureMachineSpec struct {
 	FailureDomain *string `json:"failureDomain,omitempty"`
 
 	// Image is used to provide details of an image to use during VM creation.
-	// If image details are omitted the image will default the Azure Marketplace "capi" offer,
-	// which is based on Ubuntu.
+	// If image details are omitted, the default is to use an Azure Compute Gallery Image
+	// from CAPZ's community gallery.
 	// +kubebuilder:validation:nullable
 	// +optional
 	Image *Image `json:"image,omitempty"`

azure/converters/vmss.go

@@ -183,7 +183,7 @@ func GetOrchestrationMode(modeType infrav1.OrchestrationModeType) armcompute.Orc
 	return armcompute.OrchestrationModeUniform
 }
 
-// IDImageRefToImage converts an ID to a infrav1.Image with ComputerGallery set or ID, depending on the structure of the ID.
+// IDImageRefToImage converts an ID to a infrav1.Image with ComputeGallery set or ID, depending on the structure of the ID.
 func IDImageRefToImage(id string) infrav1.Image {
 	// compute gallery image
 	if ok, params := getParams(RegExpStrComputeGalleryID, id); ok {

azure/defaults.go

@@ -48,14 +48,12 @@ const (
 )
 
 const (
-	// DefaultImageOfferID is the default Azure Marketplace offer ID.
-	DefaultImageOfferID = "capi"
-	// DefaultWindowsImageOfferID is the default Azure Marketplace offer ID for Windows.
-	DefaultWindowsImageOfferID = "capi-windows"
-	// DefaultImagePublisherID is the default Azure Marketplace publisher ID.
-	DefaultImagePublisherID = "cncf-upstream"
-	// LatestVersion is the image version latest.
-	LatestVersion = "latest"
+	// DefaultPublicGalleryName is the default Azure compute gallery.
+	DefaultPublicGalleryName = "ClusterAPI-f72ceb4f-5159-4c26-a0fe-2ea738f0d019"
+	// DefaultLinuxGalleryImageName is the default Linux community gallery image definition.
+	DefaultLinuxGalleryImageName = "capi-ubun2-2404"
+	// DefaultWindowsGalleryImageName is the default Windows community gallery image definition.
+	DefaultWindowsGalleryImageName = "capi-win-2019-containerd"
 )
 
 const (

azure/scope/machine.go

@@ -727,7 +727,7 @@ func (m *MachineScope) GetVMImage(ctx context.Context) (*infrav1.Image, error) {
 	}
 
 	log.Info("No image specified for machine, using default Linux Image", "machine", m.AzureMachine.GetName())
-	return svc.GetDefaultUbuntuImage(ctx, m.Location(), ptr.Deref(m.Machine.Spec.Version, ""))
+	return svc.GetDefaultLinuxImage(ctx, m.Location(), ptr.Deref(m.Machine.Spec.Version, ""))
 }
 
 // SetSubnetName defaults the AzureMachine subnet name to the name of one the subnets with the machine role when there is only one of them.

azure/scope/machine_test.go

@@ -43,7 +43,6 @@ import (
 	"sigs.k8s.io/cluster-api-provider-azure/azure/services/resourceskus"
 	"sigs.k8s.io/cluster-api-provider-azure/azure/services/roleassignments"
 	"sigs.k8s.io/cluster-api-provider-azure/azure/services/virtualmachineimages"
-	"sigs.k8s.io/cluster-api-provider-azure/azure/services/virtualmachineimages/mock_virtualmachineimages"
 	"sigs.k8s.io/cluster-api-provider-azure/azure/services/vmextensions"
 )
 
@@ -1538,7 +1537,7 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 	clusterMock.EXPECT().SubscriptionID().AnyTimes()
 	clusterMock.EXPECT().CloudEnvironment().AnyTimes()
 	clusterMock.EXPECT().Token().Return(&azidentity.DefaultAzureCredential{}).AnyTimes()
-	svc := virtualmachineimages.Service{Client: mock_virtualmachineimages.NewMockClient(mockCtrl)}
+	svc := virtualmachineimages.Service{}
 
 	tests := []struct {
 		name         string
@@ -1547,7 +1546,7 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 		expectedErr  string
 	}{
 		{
-			name: "returns AzureMachine image is found if present in the AzureMachine spec",
+			name: "returns AzureMachine image if present in the AzureMachine spec",
 			machineScope: MachineScope{
 				AzureMachine: &infrav1.AzureMachine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -1566,7 +1565,7 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 			expectedErr: "",
 		},
 		{
-			name: "if no image is specified and os specified is windows with version below 1.22, returns windows dockershim image",
+			name: "if no image is specified and os specified is windows, returns windows containerd image",
 			machineScope: MachineScope{
 				Machine: &clusterv1.Machine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -1589,42 +1588,13 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 				ClusterScoper: clusterMock,
 			},
 			want: func() *infrav1.Image {
-				image, _ := svc.GetDefaultWindowsImage(context.TODO(), "", "1.20.1", "dockershim", "")
+				image, _ := svc.GetDefaultWindowsImage(context.TODO(), "", "1.20.1", "containerd", "")
 				return image
 			}(),
 			expectedErr: "",
 		},
 		{
-			name: "if no image is specified and os specified is windows with version is 1.22+ with no annotation, returns windows containerd image",
-			machineScope: MachineScope{
-				Machine: &clusterv1.Machine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-					},
-					Spec: clusterv1.MachineSpec{
-						Version: ptr.To("1.22.1"),
-					},
-				},
-				AzureMachine: &infrav1.AzureMachine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-					},
-					Spec: infrav1.AzureMachineSpec{
-						OSDisk: infrav1.OSDisk{
-							OSType: azure.WindowsOS,
-						},
-					},
-				},
-				ClusterScoper: clusterMock,
-			},
-			want: func() *infrav1.Image {
-				image, _ := svc.GetDefaultWindowsImage(context.TODO(), "", "1.22.1", "containerd", "")
-				return image
-			}(),
-			expectedErr: "",
-		},
-		{
-			name: "if no image is specified and os specified is windows with version is 1.22+ with annotation dockershim, returns windows dockershim image",
+			name: "if no image is specified and os specified is windows with annotation dockershim, returns error",
 			machineScope: MachineScope{
 				Machine: &clusterv1.Machine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -1653,71 +1623,10 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 				image, _ := svc.GetDefaultWindowsImage(context.TODO(), "", "1.22.1", "dockershim", "")
 				return image
 			}(),
-			expectedErr: "",
-		},
-		{
-			name: "if no image is specified and os specified is windows with version is less and 1.22 with annotation dockershim, returns windows dockershim image",
-			machineScope: MachineScope{
-				Machine: &clusterv1.Machine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-					},
-					Spec: clusterv1.MachineSpec{
-						Version: ptr.To("1.21.1"),
-					},
-				},
-				AzureMachine: &infrav1.AzureMachine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-						Annotations: map[string]string{
-							"runtime": "dockershim",
-						},
-					},
-					Spec: infrav1.AzureMachineSpec{
-						OSDisk: infrav1.OSDisk{
-							OSType: azure.WindowsOS,
-						},
-					},
-				},
-				ClusterScoper: clusterMock,
-			},
-			want: func() *infrav1.Image {
-				image, _ := svc.GetDefaultWindowsImage(context.TODO(), "", "1.21.1", "dockershim", "")
-				return image
-			}(),
-			expectedErr: "",
-		},
-		{
-			name: "if no image is specified and os specified is windows with version is less and 1.22 with annotation containerd, returns error",
-			machineScope: MachineScope{
-				Machine: &clusterv1.Machine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-					},
-					Spec: clusterv1.MachineSpec{
-						Version: ptr.To("1.21.1"),
-					},
-				},
-				AzureMachine: &infrav1.AzureMachine{
-					ObjectMeta: metav1.ObjectMeta{
-						Name: "machine-name",
-						Annotations: map[string]string{
-							"runtime": "containerd",
-						},
-					},
-					Spec: infrav1.AzureMachineSpec{
-						OSDisk: infrav1.OSDisk{
-							OSType: azure.WindowsOS,
-						},
-					},
-				},
-				ClusterScoper: clusterMock,
-			},
-			want:        nil,
-			expectedErr: "containerd image only supported in 1.22+",
+			expectedErr: "unsupported runtime dockershim",
 		},
 		{
-			name: "if no image is specified and os specified is windows with windowsServerVersion annotation set to 2019, retrurns 2019 image",
+			name: "if no image is specified and os specified is windows with windowsServerVersion annotation set to 2019, returns error",
 			machineScope: MachineScope{
 				Machine: &clusterv1.Machine{
 					ObjectMeta: metav1.ObjectMeta{
@@ -1799,7 +1708,7 @@ func TestMachineScope_GetVMImage(t *testing.T) {
 				ClusterScoper: clusterMock,
 			},
 			want: func() *infrav1.Image {
-				image, _ := svc.GetDefaultUbuntuImage(context.TODO(), "", "1.20.1")
+				image, _ := svc.GetDefaultLinuxImage(context.TODO(), "", "1.20.1")
 				return image
 			}(),
 			expectedErr: "",

azure/scope/machinepool.go

@@ -800,7 +800,7 @@ func (m *MachinePoolScope) GetVMImage(ctx context.Context) (*infrav1.Image, erro
 		log.V(4).Info("No image specified for machine, using default Windows Image", "machine", m.MachinePool.GetName(), "runtime", runtime, "windowsServerVersion", windowsServerVersion)
 		defaultImage, err = svc.GetDefaultWindowsImage(ctx, m.Location(), ptr.Deref(m.MachinePool.Spec.Template.Spec.Version, ""), runtime, windowsServerVersion)
 	} else {
-		defaultImage, err = svc.GetDefaultUbuntuImage(ctx, m.Location(), ptr.Deref(m.MachinePool.Spec.Template.Spec.Version, ""))
+		defaultImage, err = svc.GetDefaultLinuxImage(ctx, m.Location(), ptr.Deref(m.MachinePool.Spec.Template.Spec.Version, ""))
 	}
 
 	if err != nil {

azure/scope/machinepool_test.go

@@ -425,14 +425,10 @@ func TestMachinePoolScope_GetVMImage(t *testing.T) {
 			Verify: func(g *WithT, amp *infrav1exp.AzureMachinePool, vmImage *infrav1.Image, err error) {
 				g.Expect(err).NotTo(HaveOccurred())
 				image := &infrav1.Image{
-					Marketplace: &infrav1.AzureMarketplaceImage{
-						ImagePlan: infrav1.ImagePlan{
-							Publisher: "cncf-upstream",
-							Offer:     "capi",
-							SKU:       "k8s-1dot19dot11-ubuntu-1804",
-						},
-						Version:         "latest",
-						ThirdPartyImage: false,
+					ComputeGallery: &infrav1.AzureComputeGalleryImage{
+						Gallery: "ClusterAPI-f72ceb4f-5159-4c26-a0fe-2ea738f0d019",
+						Name:    "capi-ubun2-2404",
+						Version: "1.19.11",
 					},
 				}
 				g.Expect(vmImage).To(Equal(image))