fix: Set container memory limit to the same as the task to ensure the…

… .NET GC knows the correct amount of available heap space.
aws · Mar 8, 2023 · 8520316 · 8520316
1 parent a592ab8
commit 8520316
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/src/AWS.Deploy.Recipes/CdkTemplates/AspNetAppEcsFargate/Generated/Recipe.cs b/src/AWS.Deploy.Recipes/CdkTemplates/AspNetAppEcsFargate/Generated/Recipe.cs
@@ -151,7 +151,8 @@ private void ConfigureECSClusterAndService(IRecipeProps<Configuration> recipeCon
             {
                 Image = ContainerImage.FromEcrRepository(EcrRepository, recipeConfiguration.ECRImageTag),
                 Logging = AppLogging,
-                Environment = settings.ECSEnvironmentVariables
+                Environment = settings.ECSEnvironmentVariables,
+                MemoryLimitMiB = settings.TaskMemory
             }));
 
             AppContainerDefinition.AddPortMappings(new PortMapping

diff --git a/src/AWS.Deploy.Recipes/CdkTemplates/ConsoleAppECSFargateScheduleTask/Generated/Recipe.cs b/src/AWS.Deploy.Recipes/CdkTemplates/ConsoleAppECSFargateScheduleTask/Generated/Recipe.cs
@@ -126,7 +126,8 @@ private void ConfigureTaskDefinition(IRecipeProps<Configuration> props)
             {
                 Image = ContainerImage.FromEcrRepository(ecrRepository, props.ECRImageTag),
                 Logging = AppLogging,
-                Environment = settings.ECSEnvironmentVariables
+                Environment = settings.ECSEnvironmentVariables,
+                MemoryLimitMiB = settings.TaskMemory
             };
 
             AppTaskDefinition.AddContainer(nameof(AppContainerDefinition), InvokeCustomizeCDKPropsEvent(nameof(AppContainerDefinition), this, AppContainerDefinition));

diff --git a/src/AWS.Deploy.Recipes/CdkTemplates/ConsoleAppECSFargateService/Generated/Recipe.cs b/src/AWS.Deploy.Recipes/CdkTemplates/ConsoleAppECSFargateService/Generated/Recipe.cs
@@ -133,7 +133,8 @@ private void ConfigureTaskDefinition(IRecipeProps<Configuration> props)
             {
                 Image = ContainerImage.FromEcrRepository(ecrRepository, props.ECRImageTag),
                 Logging = AppLogging,
-                Environment = settings.ECSEnvironmentVariables
+                Environment = settings.ECSEnvironmentVariables,
+                MemoryLimitMiB = settings.TaskMemory
             };
 
             AppTaskDefinition.AddContainer(nameof(AppContainerDefinition), InvokeCustomizeCDKPropsEvent(nameof(AppContainerDefinition), this, AppContainerDefinition));

diff --git a/test/AWS.Deploy.CLI.IntegrationTests/AWS.Deploy.CLI.IntegrationTests.csproj b/test/AWS.Deploy.CLI.IntegrationTests/AWS.Deploy.CLI.IntegrationTests.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
@@ -8,6 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="AWSSDK.CloudWatchLogs" Version="3.7.101.7" />
+    <PackageReference Include="AWSSDK.ECS" Version="3.7.100.14" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
     <PackageReference Include="xunit" Version="2.4.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />

diff --git a/test/AWS.Deploy.CLI.IntegrationTests/ServerModeTests.cs b/test/AWS.Deploy.CLI.IntegrationTests/ServerModeTests.cs
@@ -12,6 +12,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Amazon.CloudFormation;
+using Amazon.ECS;
 using Amazon.Runtime;
 using AWS.Deploy.CLI.Commands;
 using AWS.Deploy.CLI.Common.UnitTests.IO;
@@ -245,6 +246,13 @@ public async Task WebFargateDeploymentNoConfigChanges()
 
                 Assert.True(logOutput.Length > 0);
 
+                // Check to make sure the task memory setting was copied to the container defintion memory limit;
+                var taskDefinitionId = await _cloudFormationHelper.GetResourceId(_stackName, "RecipeAppTaskDefinitionAC7F53DB");
+                using var ecsClient = new AmazonECSClient(Amazon.RegionEndpoint.GetBySystemName(_awsRegion));
+                var taskDefinition = (await ecsClient.DescribeTaskDefinitionAsync(new Amazon.ECS.Model.DescribeTaskDefinitionRequest { TaskDefinition = taskDefinitionId })).TaskDefinition;
+                var containerDefinition = taskDefinition.ContainerDefinitions[0];
+                Assert.Equal(int.Parse(taskDefinition.Memory), containerDefinition.Memory);
+
                 // Make sure section header is return to output log
                 Assert.Contains("Creating deployment image", logOutput.ToString());