@dotcom-tool-kit/containerised-app 0.1.0

package/.toolkitrc.yml

@@ -0,0 +1,38 @@
+plugins:
+  - '@dotcom-tool-kit/aws'
+  - '@dotcom-tool-kit/cloudsmith'
+  - '@dotcom-tool-kit/docker'
+  - '@dotcom-tool-kit/doppler'
+  - '@dotcom-tool-kit/hako'
+  - '@dotcom-tool-kit/node'
+
+commands:
+  'run:local':
+    - Node
+  'deploy:review': [] # Coming soon, see https://financialtimes.atlassian.net/browse/CPREL-1280
+  'deploy:staging':
+    - DockerAuthCloudsmith
+    - DockerBuild
+    - DockerPush
+    - AwsAssumeRole:
+        roleArn: !toolkit/option '@dotcom-tool-kit/containerised-app.awsRoleArnStaging'
+    - HakoDeploy:
+        environments:
+          - ft-com-test-eu
+  'deploy:production':
+    - DockerAuthCloudsmith
+    - AwsAssumeRole:
+        roleArn: !toolkit/option '@dotcom-tool-kit/containerised-app.awsRoleArnProduction'
+    # HACK: the `environments` property under `HakoDeploy` gets fully overridden by the `environments`
+    # property under the !toolkit/if-defined if multiregion is true. We'll refactor this later when
+    # we decide what new YAML tags we need
+    - HakoDeploy:
+        environments:
+          - ft-com-prod-eu
+        !toolkit/if-defined '@dotcom-tool-kit/containerised-app.multiregion':
+          environments:
+            - ft-com-prod-eu
+            - ft-com-prod-us
+
+optionsSchema: ./schema
+version: 2

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@dotcom-tool-kit/containerised-app",
+  "version": "0.1.0",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
+  "license": "ISC",
+  "description": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/financial-times/dotcom-tool-kit.git",
+    "directory": "plugins/containerised-app"
+  },
+  "bugs": "https://github.com/financial-times/dotcom-tool-kit/issues",
+  "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/containerised-app",
+  "files": [
+    ".toolkitrc.yml",
+    "index.js"
+  ],
+  "engines": {
+    "node": "18.x || 20.x || 22.x"
+  },
+  "peerDependencies": {
+    "dotcom-tool-kit": "4.x"
+  },
+  "dependencies": {
+    "@dotcom-tool-kit/aws": "^0.1.2",
+    "@dotcom-tool-kit/cloudsmith": "^1.0.1",
+    "@dotcom-tool-kit/docker": "^0.3.2",
+    "@dotcom-tool-kit/doppler": "^2.1.7",
+    "@dotcom-tool-kit/hako": "^0.1.3",
+    "@dotcom-tool-kit/node": "^4.2.9",
+    "zod": "^3.24.1"
+  }
+}

package/readme.md

@@ -0,0 +1,59 @@
+# dotcom-tool-kit/containerised-app
+
+A bootstrap plugin that provides the minimum required Tool Kit plugins for a containerised application that's deployed to Amazon Elastic Container Service (ECS).
+
+  - [`@dotcom-tool-kit/aws`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/aws)
+  - [`@dotcom-tool-kit/cloudsmith`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/cloudsmith)
+  - [`@dotcom-tool-kit/docker`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/docker)
+  - [`@dotcom-tool-kit/doppler`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/doppler)
+  - [`@dotcom-tool-kit/hako`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/hako)
+  - [`@dotcom-tool-kit/node`](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/node)
+
+This bootstrap plugin is also preconfigured to run the `Node` task on the command `run:local`.
+
+## Installation & Usage
+
+With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/containerised-app
+```
+
+And add it to your repo's `.toolkitrc.yml`:
+
+```yml
+plugins:
+  - '@dotcom-tool-kit/containerised-app'
+```
+
+As well as the plugin options outlined below, you'll need to specify plugin options for the `cloudsmith` and `docker` plugins. The bare minimum is:
+
+```yml
+options:
+  plugins:
+    '@dotcom-tool-kit/cloudsmith':
+      serviceAccount: <SERVICE_ACCOUNT_WITH_WRITE_ACCESS>
+    '@dotcom-tool-kit/docker':
+      images:
+        web:
+          name: <YOUR_APP_NAME>
+```
+
+See the relevant documentation for further options:
+
+  - [`@dotcom-tool-kit/cloudsmith` plugin options](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/cloudsmith#plugin-wide-options)
+  - [`@dotcom-tool-kit/docker` plugin options](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/docker#plugin-wide-options)
+
+<!-- begin autogenerated docs -->
+## Plugin-wide options
+
+### `@dotcom-tool-kit/containerised-app`
+
+| Property                        | Description                                                   | Type                                             |
+| :------------------------------ | :------------------------------------------------------------ | :----------------------------------------------- |
+| **`awsRoleArnStaging`** (\*)    | the ARN of an IAM role to assume when deploying to staging    | `string` (_regex: `/^arn:aws:iam::\d+:role\//`_) |
+| **`awsRoleArnProduction`** (\*) | the ARN of an IAM role to assume when deploying to production | `string` (_regex: `/^arn:aws:iam::\d+:role\//`_) |
+| `multiregion`                   | Whether the app is deployed across both EU and US regions     | `true`                                           |
+
+_(\*) Required._
+<!-- end autogenerated docs -->