Merge branch 'main' into fix/provisioned-poller-config-types-and-docs

Author: badmintoncryer

packages/aws-cdk-lib/aws-batch/README.md

@@ -164,6 +164,21 @@ new batch.ManagedEc2EcsComputeEnvironment(this, 'myEc2ComputeEnv', {
 });
 ```
 
+If your image needs GPU resources, specify `ECS_AL2023_NVIDIA`:
+
+```ts
+declare const vpc: ec2.IVpc;
+
+new batch.ManagedEc2EcsComputeEnvironment(this, 'myGpuComputeEnv', {
+  vpc,
+  images: [
+    {
+      imageType: batch.EcsMachineImageType.ECS_AL2023_NVIDIA,
+    },
+  ],
+});
+```
+
 #### Allocation Strategies
 
 | Allocation Strategy           | Optimized for              | Downsides                     |

packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts

@@ -7,11 +7,12 @@ import type * as eks from '../../aws-eks';
 import * as iam from '../../aws-iam';
 import type { IRole } from '../../aws-iam';
 import type { Duration, ITaggable } from '../../core';
-import { ArnFormat, Lazy, Resource, Stack, TagManager, TagType, Token, ValidationError } from '../../core';
+import { ArnFormat, FeatureFlags, Lazy, Resource, Stack, TagManager, TagType, Token, ValidationError } from '../../core';
 import { memoizedGetter } from '../../core/lib/helpers-internal';
 import { addConstructMetadata, MethodMetadata } from '../../core/lib/metadata-resource';
 import { lit } from '../../core/lib/private/literal-string';
 import { propertyInjectable } from '../../core/lib/prop-injectable';
+import * as cxapi from '../../cx-api';
 
 /**
  * Represents a Managed ComputeEnvironment. Batch will provision EC2 Instances to
@@ -255,7 +256,8 @@ export interface IManagedEc2EcsComputeEnvironment extends IManagedComputeEnviron
    * Leave this `undefined` to allow Batch to choose the latest AMIs it supports for each instance that it launches.
    *
    * @default
-   * - ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances
+   * - ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.
    */
   readonly images?: EcsMachineImage[];
 
@@ -384,7 +386,8 @@ export interface EcsMachineImage extends MachineImage {
   /**
    * Tells Batch which instance type to launch this image on
    *
-   * @default - 'ECS_AL2' for non-gpu instances, 'ECS_AL2_NVIDIA' for gpu instances
+   * @default - 'ECS_AL2' for non-gpu instances, 'ECS_AL2_NVIDIA' for gpu instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, 'ECS_AL2023' will be used instead of 'ECS_AL2'.
    */
   readonly imageType?: EcsMachineImageType;
 }
@@ -396,7 +399,8 @@ export interface EksMachineImage extends MachineImage{
   /**
    * Tells Batch which instance type to launch this image on
    *
-   * @default - 'EKS_AL2' for non-gpu instances, 'EKS_AL2_NVIDIA' for gpu instances
+   * @default - 'EKS_AL2' for non-gpu instances, 'EKS_AL2_NVIDIA' for gpu instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, 'EKS_AL2023' will be used instead of 'EKS_AL2'.
    */
   readonly imageType?: EksMachineImageType;
 }
@@ -420,6 +424,11 @@ export enum EcsMachineImageType {
    * Tells Batch that this machine image runs on GPU instances
    */
   ECS_AL2_NVIDIA = 'ECS_AL2_NVIDIA',
+
+  /**
+   * Tells Batch that this machine image runs on GPU AL2023 instances
+   */
+  ECS_AL2023_NVIDIA = 'ECS_AL2023_NVIDIA',
 }
 
 /**
@@ -435,6 +444,16 @@ export enum EksMachineImageType {
    * Tells Batch that this machine image runs on GPU instances
    */
   EKS_AL2_NVIDIA = 'EKS_AL2_NVIDIA',
+
+  /**
+   * Tells Batch that this machine image runs on non-GPU AL2023 instances
+   */
+  EKS_AL2023 = 'EKS_AL2023',
+
+  /**
+   * Tells Batch that this machine image runs on GPU AL2023 instances
+   */
+  EKS_AL2023_NVIDIA = 'EKS_AL2023_NVIDIA',
 }
 
 /**
@@ -551,12 +570,15 @@ export interface ManagedEc2EcsComputeEnvironmentProps extends ManagedEc2ComputeE
   /**
    * Configure which AMIs this Compute Environment can launch.
    * If you specify this property with only `image` specified, then the
-   * `imageType` will default to `ECS_AL2`. *If your image needs GPU resources,
-   * specify `ECS_AL2_NVIDIA`; otherwise, the instances will not be able to properly
-   * join the ComputeEnvironment*.
+   * `imageType` will default to `ECS_AL2` (or `ECS_AL2023` if the
+   * `@aws-cdk/aws-batch:defaultToAL2023` feature flag is set).
+   * *If your image needs GPU resources,
+   * specify `ECS_AL2_NVIDIA` or `ECS_AL2023_NVIDIA`; otherwise, the instances
+   * will not be able to properly join the ComputeEnvironment*.
    *
    * @default
-   * - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances
+   * - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.
    */
   readonly images?: EcsMachineImage[];
 
@@ -782,11 +804,26 @@ export class ManagedEc2EcsComputeEnvironment extends ManagedEc2ComputeEnvironmen
         : undefined
     );
 
-    if (this.images?.find(image => image.imageType === EcsMachineImageType.ECS_AL2023) &&
-      (this.instanceClasses.includes(ec2.InstanceClass.A1) ||
-       this.instanceTypes.find(instanceType => instanceType.sameInstanceClassAs(ec2.InstanceType.of(ec2.InstanceClass.A1, ec2.InstanceSize.LARGE))))
-    ) {
-      throw new ValidationError(lit`AmazonLinuxSupportInstances`, 'Amazon Linux 2023 does not support A1 instances.', this);
+    const hasA1Instances = this.instanceClasses.includes(ec2.InstanceClass.A1) ||
+      this.instanceTypes.some(instanceType => instanceType.sameInstanceClassAs(ec2.InstanceType.of(ec2.InstanceClass.A1, ec2.InstanceSize.LARGE)));
+
+    const willUseAL2023 = (!this.images || this.images.length === 0)
+      ? FeatureFlags.of(this).isEnabled(cxapi.BATCH_DEFAULT_AL2023)
+      : this.images.some(image => {
+        const resolved = image.imageType ?? (
+          FeatureFlags.of(this).isEnabled(cxapi.BATCH_DEFAULT_AL2023)
+            ? EcsMachineImageType.ECS_AL2023
+            : EcsMachineImageType.ECS_AL2
+        );
+        return [EcsMachineImageType.ECS_AL2023, EcsMachineImageType.ECS_AL2023_NVIDIA].includes(resolved);
+      });
+
+    if (willUseAL2023 && hasA1Instances) {
+      throw new ValidationError(
+        lit`AmazonLinuxSupportInstances`,
+        'Amazon Linux 2023 does not support A1 instances. To use A1 instances, explicitly set imageType to ECS_AL2 or disable the @aws-cdk/aws-batch:defaultToAL2023 feature flag.',
+        this,
+      );
     }
 
     const { instanceRole, instanceProfile } = createInstanceRoleAndProfile(this, props.instanceRole);
@@ -821,7 +858,11 @@ export class ManagedEc2EcsComputeEnvironment extends ManagedEc2ComputeEnvironmen
         ec2Configuration: this.images?.map((image) => {
           return {
             imageIdOverride: image.image?.getImage(this).imageId,
-            imageType: image.imageType ?? EcsMachineImageType.ECS_AL2,
+            imageType: image.imageType ?? (
+              FeatureFlags.of(this).isEnabled(cxapi.BATCH_DEFAULT_AL2023)
+                ? EcsMachineImageType.ECS_AL2023
+                : EcsMachineImageType.ECS_AL2
+            ),
           };
         }),
         placementGroup: props.placementGroup?.placementGroupRef.groupName,
@@ -868,7 +909,8 @@ interface IManagedEc2EksComputeEnvironment extends IManagedEc2ComputeEnvironment
    * Configure which AMIs this Compute Environment can launch.
    *
    * @default
-   * EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances,
+   * EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, EKS_AL2023 will be used instead of EKS_AL2.
    */
   readonly images?: EksMachineImage[];
 
@@ -985,9 +1027,10 @@ export interface ManagedEc2EksComputeEnvironmentProps extends ManagedEc2ComputeE
    *
    * @default
    * If `imageKubernetesVersion` is specified,
-   * - EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances,
+   * - EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances.
    * Otherwise,
-   * - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances,
+   * - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances.
+   * If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, EKS_AL2023 / ECS_AL2023 will be used instead.
    */
   readonly images?: EksMachineImage[];
 
@@ -1144,11 +1187,23 @@ export class ManagedEc2EksComputeEnvironment extends ManagedEc2ComputeEnvironmen
         bidPercentage: this.spotBidPercentage,
         launchTemplate: this.launchTemplate ? {
           launchTemplateId: this.launchTemplate?.launchTemplateId,
+          userdataType: this.images?.some(image => {
+            const resolved = image.imageType ?? (
+              FeatureFlags.of(this).isEnabled(cxapi.BATCH_DEFAULT_AL2023)
+                ? EksMachineImageType.EKS_AL2023
+                : EksMachineImageType.EKS_AL2
+            );
+            return [EksMachineImageType.EKS_AL2023, EksMachineImageType.EKS_AL2023_NVIDIA].includes(resolved);
+          }) ? 'EKS_NODEADM' : undefined,
         } : undefined,
         ec2Configuration: this.images?.map((image) => {
           return {
             imageIdOverride: image.image?.getImage(this).imageId,
-            imageType: image.imageType ?? EksMachineImageType.EKS_AL2,
+            imageType: image.imageType ?? (
+              FeatureFlags.of(this).isEnabled(cxapi.BATCH_DEFAULT_AL2023)
+                ? EksMachineImageType.EKS_AL2023
+                : EksMachineImageType.EKS_AL2
+            ),
           };
         }),
         placementGroup: props.placementGroup?.placementGroupRef.groupName,