CORS-3608: aws: deprecate platform.aws.amiID field

This field was introduced [1] before the Installer had support for
custom AMIs in machine pools [2]. Now that it does, the same
functionality is achieved via the defaultMachinePlatform field
`platform.aws.defaultMachinePlatform.amiID`

[1] fdf94e3
[2] bc47222

Author: r4f4

data/data/install.openshift.io_installconfigs.yaml

@@ -2155,9 +2155,9 @@ spec:
                 description: AWS is the configuration used when installing on AWS.
                 properties:
                   amiID:
-                    description: AMIID is the AMI that should be used to boot machines
-                      for the cluster. If set, the AMI should belong to the same region
-                      as the cluster.
+                    description: The field is deprecated. AMIID is the AMI that should
+                      be used to boot machines for the cluster. If set, the AMI should
+                      belong to the same region as the cluster.
                     type: string
                   bestEffortDeleteIgnition:
                     description: BestEffortDeleteIgnition is an optional field that

docs/user/aws/customization.md

@@ -5,7 +5,7 @@ Beyond the [platform-agnostic `install-config.yaml` properties](../customization
 ## Cluster-scoped properties
 
 * `amiID` (optional string): The AMI that should be used to boot machines for the cluster.
-    If set, the AMI should belong to the same region as the cluster.
+    If set, the AMI should belong to the same region as the cluster. This field is now deprecated and `defaultMachinePlatform` should be used instead.
 * `region` (required string): The AWS region where the cluster will be created.
 * `subnets` (optional array of strings): Existing subnets (by ID) where cluster resources will be created.
     Leave unset to have the installer create subnets in a new VPC on your behalf.

pkg/asset/rhcos/image.go

@@ -84,9 +84,6 @@ func osImage(ctx context.Context, config *types.InstallConfig) (string, error) {
 	}
 	switch config.Platform.Name() {
 	case aws.Name:
-		if len(config.Platform.AWS.AMIID) > 0 {
-			return config.Platform.AWS.AMIID, nil
-		}
 		region := config.Platform.AWS.Region
 		if !rhcos.AMIRegions(config.ControlPlane.Architecture).Has(region) {
 			const globalResourceRegion = "us-east-1"

pkg/explain/printer_test.go

@@ -148,7 +148,7 @@ func Test_PrintFields(t *testing.T) {
 		path: []string{"platform", "aws"},
 		desc: `FIELDS:
     amiID <string>
-      AMIID is the AMI that should be used to boot machines for the cluster. If set, the AMI should belong to the same region as the cluster.
+      The field is deprecated. AMIID is the AMI that should be used to boot machines for the cluster. If set, the AMI should belong to the same region as the cluster.
 
     bestEffortDeleteIgnition <boolean>
       BestEffortDeleteIgnition is an optional field that can be used to ignore errors from S3 deletion of ignition objects during cluster bootstrap. The default behavior is to fail the installation if ignition objects cannot be deleted. Enable this functionality when there are known reasons disallowing their deletion.

pkg/types/aws/platform.go

@@ -16,8 +16,9 @@ const (
 // Platform stores all the global configuration that all machinesets
 // use.
 type Platform struct {
-	// AMIID is the AMI that should be used to boot machines for the cluster.
-	// If set, the AMI should belong to the same region as the cluster.
+	// The field is deprecated. AMIID is the AMI that should be used to boot
+	// machines for the cluster. If set, the AMI should belong to the same
+	// region as the cluster.
 	//
 	// +optional
 	AMIID string `json:"amiID,omitempty"`

pkg/types/conversion/installconfig.go

@@ -289,5 +289,14 @@ func convertAWS(config *types.InstallConfig) error {
 	if !config.AWS.BestEffortDeleteIgnition {
 		config.AWS.BestEffortDeleteIgnition = config.AWS.PreserveBootstrapIgnition
 	}
+	if ami := config.AWS.AMIID; len(ami) > 0 {
+		if config.AWS.DefaultMachinePlatform == nil {
+			config.AWS.DefaultMachinePlatform = &aws.MachinePool{}
+		}
+		// DefaultMachinePlatform.AMIID takes precedence in the machine manifest code anyway
+		if len(config.AWS.DefaultMachinePlatform.AMIID) == 0 {
+			config.AWS.DefaultMachinePlatform.AMIID = ami
+		}
+	}
 	return nil
 }

pkg/types/conversion/installconfig_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/openshift/installer/pkg/ipnet"
 	"github.com/openshift/installer/pkg/types"
+	"github.com/openshift/installer/pkg/types/aws"
 	"github.com/openshift/installer/pkg/types/baremetal"
 	"github.com/openshift/installer/pkg/types/nutanix"
 	"github.com/openshift/installer/pkg/types/openstack"
@@ -706,6 +707,32 @@ func TestConvertInstallConfig(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "aws deprecated platform amiID",
+			config: &types.InstallConfig{
+				TypeMeta: metav1.TypeMeta{
+					APIVersion: types.InstallConfigVersion,
+				},
+				Platform: types.Platform{
+					AWS: &aws.Platform{
+						AMIID: "deprec-id",
+					},
+				},
+			},
+			expected: &types.InstallConfig{
+				TypeMeta: metav1.TypeMeta{
+					APIVersion: types.InstallConfigVersion,
+				},
+				Platform: types.Platform{
+					AWS: &aws.Platform{
+						AMIID: "deprec-id",
+						DefaultMachinePlatform: &aws.MachinePool{
+							AMIID: "deprec-id",
+						},
+					},
+				},
+			},
+		},
 	}
 
 	for _, tc := range cases {