From f4e2a7c176eb4d793c4b943afaa1707bf237e6e2 Mon Sep 17 00:00:00 2001
From: akash1810 <akash1810@users.noreply.github.com>
Date: Mon, 16 Sep 2024 10:28:34 +0100
Subject: [PATCH] docs(experimental-ec2-pattern): Add changeset

---
 .changeset/happy-badgers-compare.md | 43 +++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 .changeset/happy-badgers-compare.md

diff --git a/.changeset/happy-badgers-compare.md b/.changeset/happy-badgers-compare.md
new file mode 100644
index 0000000000..4596a10a93
--- /dev/null
+++ b/.changeset/happy-badgers-compare.md
@@ -0,0 +1,43 @@
+---
+"@guardian/cdk": minor
+---
+
+feat(experimental-ec2-pattern): Pattern to deploy ASG updates w/CFN
+
+Included in this update is a new experimental pattern `GuEc2AppExperimental`, which can be used in place of a `GuEc2App`:
+
+```ts
+import { GuEc2AppExperimental } from "@guardian/cdk/lib/experimental/patterns/ec2-app";
+```
+
+This pattern will add an [`AutoScalingRollingUpdate` policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate)
+to the autoscaling group.
+This allows application updates to be performed like a standard CloudFormation update,
+and using the custom logic provided by Riff-Raff's `autoscaling` deployment type is unnecessary.
+
+This experimental pattern has few requirements.
+
+## Add the build number to the application artifact
+This change requires versioned artifacts.
+
+The easiest way to achieve this is by adding the build number to the filename of the artifact:
+
+```ts
+import { UserData } from "aws-cdk-lib/aws-ec2";
+// Use a GitHub Actions provided environment variable
+const buildNumber = process.env.GITHUB_RUN_NUMBER ?? "DEV";
+
+const userData = UserData.forLinux();
+userData.addCommands(`aws s3 cp s3://dist-bucket/path/to/artifact-${buildNumber}.deb /tmp/artifact.deb`);
+userData.addCommands(`dpkg -i /tmp/artifact.dep`);
+```
+
+## `riff-raff.yaml`
+The `riff-raff.yaml` file should remove the `deploy` action of the `autoscaling` deployment type.
+Though including it shouldn't break anything, it would result in a longer deployment time as instance will be rotated by both CloudFormation and Riff-Raff's custom logic.
+
+The `uploadArtifacts` step of the `autoscaling` deployment type should still be included, with the `cloud-formation` deployment type depending on it.
+This step uploads the versioned artifact to S3.
+
+> [!TIP]
+> An [auto-generated `riff-raff.yaml` file](https://github.com/guardian/cdk/blob/main/src/riff-raff-yaml-file/README.md) meets this requirement.