(aws-ecs): support RuntimePlatform Property at TaskDefinition class for create windows OperatingSystem

[neilkuan]

Description

support RuntimePlatform Property at TaskDefinition class for create windows OperatingSystem.

Use Case

Windows support for AWS Fargate on Amazon ECS on 28 OCT 2021 .
https://aws.amazon.com/tw/blogs/containers/running-windows-containers-with-amazon-ecs-on-aws-fargate/

Proposed Solution

support RuntimePlatform Property at TaskDefinition class.

Other information

No response

Acknowledge

• I may be able to implement this feature request
• This feature might incur a breaking change

[peterwoodworth]

Thanks for submitting this feature request @neilkuan,

The underlying taskDefinition doesn't get created with this property.

aws-cdk/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts

Lines 420 to 448 in 9c094ae

	const taskDef = new CfnTaskDefinition(this, 'Resource', {
	containerDefinitions: Lazy.any({ produce: () => this.renderContainers() }, { omitEmptyArray: true }),
	volumes: Lazy.any({ produce: () => this.renderVolumes() }, { omitEmptyArray: true }),
	executionRoleArn: Lazy.string({ produce: () => this.executionRole && this.executionRole.roleArn }),
	family: this.family,
	taskRoleArn: this.taskRole.roleArn,
	requiresCompatibilities: [
	...(isEc2Compatible(props.compatibility) ? ['EC2'] : []),
	...(isFargateCompatible(props.compatibility) ? ['FARGATE'] : []),
	...(isExternalCompatible(props.compatibility) ? ['EXTERNAL'] : []),
	],
	networkMode: this.renderNetworkMode(this.networkMode),
	placementConstraints: Lazy.any({
	produce: () =>
	!isFargateCompatible(this.compatibility) ? this.placementConstraints : undefined,
	}, { omitEmptyArray: true }),
	proxyConfiguration: props.proxyConfiguration ? props.proxyConfiguration.bind(this.stack, this) : undefined,
	cpu: props.cpu,
	memory: props.memoryMiB,
	ipcMode: props.ipcMode,
	pidMode: props.pidMode,
	inferenceAccelerators: Lazy.any({
	produce: () =>
	!isFargateCompatible(this.compatibility) ? this.renderInferenceAccelerators() : undefined,
	}, { omitEmptyArray: true }),
	ephemeralStorage: this.ephemeralStorageGiB ? {
	sizeInGiB: this.ephemeralStorageGiB,
	} : undefined,
	});

CloudFormation docs on RuntimePlatform

To work around this before we officially support it, you should be able to use an escape hatch to apply this property as needed.

Contributions are welcome as well 😃

[neilkuan]

yes, I already did that :).

const vpc = ec2.Vpc.fromLookup(this, 'VPC', { isDefault: true });
    const cluster = new ecs.Cluster(this, 'Cluster', {
      vpc,
      enableFargateCapacityProviders: true,
    });
    const taskdef = new ecs.TaskDefinition(this, 'TaskDef', { compatibility: ecs.Compatibility.FARGATE, memoryMiB: '2048', cpu: '1024' });
    taskdef.addContainer('Container', {
      logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),
      portMappings: [{ containerPort: 80 }],
      image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),
    });
    (taskdef.node.defaultChild as ecs.CfnTaskDefinition).addPropertyOverride('RuntimePlatform', {
      OperatingSystemFamily: 'WINDOWS_SERVER_2019_CORE',
    });
    const fargateWindowsService = new ecs.FargateService(this, 'Service', {
      taskDefinition: taskdef,
      cluster,
      assignPublicIp: true,
    });
    ecs.WindowsOptimizedVersion.SERVER_2019;
    fargateWindowsService.connections.allowFrom(ec2.Peer.ipv4(`${process.env.MYIP}/32`), ec2.Port.tcp(80));

[pahud]

Looks like v46 spec has the RuntimePlatform property. Let's wait until the #17223 being merged.

[alisade]

also for graviton
https://aws.amazon.com/blogs/aws/announcing-aws-graviton2-support-for-aws-fargate-get-up-to-40-better-price-performance-for-your-serverless-containers/

[suresh26k]

For python, we can do the same

   task_definition = ecs.TaskDefinition(
        .....
    )

    # Import resource as cfn resource
    cfn_task_definition = task_definition.node.find_child("Resource")
    # Override cfn resource property
    cfn_task_definition.add_override(
        "Properties.RuntimePlatform.OperatingSystemFamily", "WINDOWS_SERVER_2019_CORE")

[suresh26k]

Thanks for submitting this feature request @neilkuan,

The underlying taskDefinition doesn't get created with this property.

aws-cdk/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts

Lines 420 to 448 in 9c094ae

	const taskDef = new CfnTaskDefinition(this, 'Resource', {
	containerDefinitions: Lazy.any({ produce: () => this.renderContainers() }, { omitEmptyArray: true }),
	volumes: Lazy.any({ produce: () => this.renderVolumes() }, { omitEmptyArray: true }),
	executionRoleArn: Lazy.string({ produce: () => this.executionRole && this.executionRole.roleArn }),
	family: this.family,
	taskRoleArn: this.taskRole.roleArn,
	requiresCompatibilities: [
	...(isEc2Compatible(props.compatibility) ? ['EC2'] : []),
	...(isFargateCompatible(props.compatibility) ? ['FARGATE'] : []),
	...(isExternalCompatible(props.compatibility) ? ['EXTERNAL'] : []),
	],
	networkMode: this.renderNetworkMode(this.networkMode),
	placementConstraints: Lazy.any({
	produce: () =>
	!isFargateCompatible(this.compatibility) ? this.placementConstraints : undefined,
	}, { omitEmptyArray: true }),
	proxyConfiguration: props.proxyConfiguration ? props.proxyConfiguration.bind(this.stack, this) : undefined,
	cpu: props.cpu,
	memory: props.memoryMiB,
	ipcMode: props.ipcMode,
	pidMode: props.pidMode,
	inferenceAccelerators: Lazy.any({
	produce: () =>
	!isFargateCompatible(this.compatibility) ? this.renderInferenceAccelerators() : undefined,
	}, { omitEmptyArray: true }),
	ephemeralStorage: this.ephemeralStorageGiB ? {
	sizeInGiB: this.ephemeralStorageGiB,
	} : undefined,
	});

CloudFormation docs on RuntimePlatform

To work around this before we officially support it, you should be able to use an escape hatch to apply this property as needed.

Contributions are welcome as well 😃

@peterwoodworth

Could you please share any docs to help me start contributing.

[peterwoodworth]

Thanks for your interest @suresh26k, please check out CONTRIBUTING.md. Let me know if you have any further questions 🙂

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.