@dotcom-tool-kit/containerised-app NPM

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).

This bootstrap plugin is also preconfigured to run the Node task on the command run:local.

Installation & Usage

With Tool Kit already set up, install this plugin as a dev dependency:

npm install --save-dev @dotcom-tool-kit/containerised-app

And add it to your repo's .toolkitrc.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:

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:

Plugin-wide options

`@dotcom-tool-kit/containerised-app`

Property	Description	Type	Default
`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\//`)
`hakoReviewEnvironments`	the set of Hako environments to deploy to in the deploy:review command	`Array<string>`	`["ft-com-test-eu"]`
`hakoStagingEnvironments`	the set of Hako environments to deploy to in the deploy:staging command	`Array<string>`	`["ft-com-test-eu"]`
`hakoProductionEnvironments`	the set of Hako environments to deploy to in the deploy:production command	`Array<string>`	`["ft-com-prod-eu"]`