OpenAddresses Deploy Tools for Cloudformation
\n\n## Brief\n\n- Store and manage AWS credentials locally for one or more AWS accounts\n- Create, Update, & Delete CF based stacks from the terminal\n\n## Install\n\nRun the following\n\n```sh\nnpm install -g @openaddresses/deploy\n```\n\nThis will make the `deploy` command available globally\n\n### Auth Setup\n\nBefore you can make changes to any of the underlying infrastructure you must first authenticate the deploy cli\n\nTo do so run:\n\n```sh\ndeploy init\n```\n\nand follow the prompts for your credentials.\n\nNote the `profile name` prompted for should ideally match the profile name as set in your AWS credentials\nfile located at `~/.aws/credentials` If the profile name is found in your AWS credentials file, the\ncredentials from the file will be linked. If it does not exist, you will be prompted for a set of credentials\n\nOnce finished run\n\n```sh\ndeploy\n```\n\nto see a full list of options\n\nNote: The credentials file can be found in the `~/.deployrc.json` file\n\n# Global Config `~/.deployrc.json`\n\n## Required Tags\n\nIf an account uses tags for billing, the following can be used in the `~/.deployrc.json` file to ensure that\ntags are attached to all stacks deployed to that profile\n\n| Key | Notes |\n| ----------------- | ----- |\n| `region` | Default AWS Account Region |\n\n## Optional Tags\n\n| Key | Notes |\n| ----------------- | ----- |\n| `tags` | Cloudformation Tags to apply to stack |\n| `github` | Github API token for updating deployment status |\n| `role` | IAM Service Role ARN CloudFormation assumes for create/update/delete |\n\n### Service Role\n\nBy default CloudFormation performs stack operations using the credentials of the\ncaller. Setting `role` passes a Service Role that CloudFormation assumes instead,\nallowing users without IAM permissions to deploy stacks that manage IAM resources.\nThe caller must be allowed `iam:PassRole` on the given role.\n\nThe value is a Handlebars template with the following variables available:\n`{{accountId}}`, `{{partition}}`, `{{region}}`, `{{stack}}`, `{{project}}`\n\nPrecedence is `--role