|
| 1 | +# RESTACKER.YML |
| 2 | +This is the configuration file for Restacker CLI. |
| 3 | +See the sample [here](../source/restacker-sample.yml). |
| 4 | + |
| 5 | +## STRUCTURE |
| 6 | +In order for Restacker to work as expected, the following key:value pairs are required: |
| 7 | +- `:default:`: specifies the default location/plane for all Restacker operations. This is intended to save you from having to specify the required `-l <location>` everytime. |
| 8 | + - `:label:`: the name of the default location. |
| 9 | +- `:ctrl: &ctrl_default`: default configuration for the Control Account |
| 10 | + - `:label:`: name of the account |
| 11 | + - `:role-name:` |
| 12 | + - `:role-prefix:` |
| 13 | + - `:bucket:`: S3 Bucket configuration to read/consume files from. |
| 14 | + - `:name:`: Bucket name |
| 15 | + - `:prefix:`: **optional** bucket prefix/path |
| 16 | + - `:ami_key:`: **optional** name of object on S3 that contains list of approved AMIs |
| 17 | +- `:Account_Name:`: name of target account |
| 18 | + - `:region:`: default region to deploy instances in (e.g. `us-west-2`) |
| 19 | + - `:ctrl:`: control account for this account |
| 20 | + - `<<: *ctrl_default`: if the control account is the default account specified in `&ctrl_default`, then just insert default configurations here |
| 21 | + - `:target:`: the target account configuration |
| 22 | + - `:label:`: name of target account |
| 23 | + - `:account_number:`: target account number |
| 24 | + - `:role_name:`: target role name |
| 25 | + - `:role_prefix:`: target role prefix |
| 26 | + |
| 27 | +## Example Restacker Configuration: |
| 28 | +``` |
| 29 | +:default: |
| 30 | + :label: myapp1 |
| 31 | +
|
| 32 | +:ctrl: &ctrl_default |
| 33 | + :label: ctrlAcct |
| 34 | + :account_number: '123456789012' |
| 35 | + :role_name: ctrl-ctrl-DeployAdmin |
| 36 | + :role_prefix: "/dso/ctrl/ctrl/" |
| 37 | + :bucket: |
| 38 | + :name: kaos-installers |
| 39 | + :prefix: cloudformation |
| 40 | + :ami_key: latest_amis |
| 41 | +
|
| 42 | +:ctrlAcct: |
| 43 | + :region: us-west-2 |
| 44 | + :ctrl: |
| 45 | + <<: *ctrl_default |
| 46 | + :target: |
| 47 | + <<: *ctrl_default |
| 48 | +
|
| 49 | +:myapp1: |
| 50 | + :region: us-west-2 |
| 51 | + :ctrl: |
| 52 | + <<: *ctrl_default |
| 53 | + :role_name: ctrl-myapp1-DeployAdmin |
| 54 | + :target: |
| 55 | + :label: myapp1 |
| 56 | + :account_number: '098765432123' |
| 57 | + :role_name: myapp1-dso-DeployAdmin |
| 58 | + :role_prefix: "/dso/human/" |
| 59 | +
|
| 60 | +:myapp2: |
| 61 | + :region: us-west-2 |
| 62 | + :ctrl: |
| 63 | + <<: *ctrl_default |
| 64 | + :role_name: ctrl-myapp2-DeployAdmin |
| 65 | + :target: |
| 66 | + :label: myapp2 |
| 67 | + :account_number: '123098456765' |
| 68 | + :role_name: myapp2-dso-DeployAdmin |
| 69 | + :role_prefix: "/dso/human/" |
| 70 | +
|
| 71 | +``` |
0 commit comments