Skip to content

Commit c90b9cf

Browse files
author
Peter Benjamin
committed
Update README verbiage
1 parent 3f5b303 commit c90b9cf

1 file changed

Lines changed: 34 additions & 15 deletions

File tree

README.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Restacker
22

3-
Restacker is the DevSecOps deployment swiss army knife. You can use it do deploy, update, migrate, and/or remove stacks.
4-
Although not feature complete yet, you can begin using it to deploy or re-stack your existing apps.
3+
Restacker is the DevSecOps deployment swiss army knife. You can use it safely & securely deploy, update, migrate, and/or remove AWS stacks.
4+
Although not feature complete yet, you can begin using it to deploy or re-stack your existing AWS accounts/instances.
55

66
## Install it:
7-
7+
- Grab the binary from [GitHub Releases](https://github.com/devsecops/restacker/releases)
8+
- Or build from source:
89
```
910
git clone https://github.com/devsecops/restacker.git
1011
cd restacker/source
@@ -61,9 +62,9 @@ Notes:
6162
- Deployed stack name will be in the form of NAME-DATE using today's date
6263
```
6364

64-
## Configuration
65-
66-
To configure another target account, just add a section to ~/.restacker/restacker.yml listing the master & target account properties.
65+
## Configure it
66+
- `restacker configure -l <location>`
67+
- Or copy the `restacker-sample.yml` to `~/.restacker/restacker.yml` & update the configurations
6768
The below configuration is an example of MyApp1 and MyApp2 as target accounts and CTRL as master.
6869

6970
```
@@ -72,29 +73,47 @@ $ cat ~/.restacker/restacker.yml
7273
:default:
7374
:label: myapp1
7475
75-
:master: &master_default
76-
:label: ctrl
76+
:ctrl: &ctrl_default
77+
:label: ctrlAcct
7778
:account_number: '123456789012'
7879
:role_name: ctrl-ctrl-DeployAdmin
79-
:role_prefix: "/dso/ctrl/master/"
80+
:role_prefix: "/dso/ctrl/ctrl/"
81+
:bucket:
82+
:name: kaos-installers
83+
:prefix: cloudformation
84+
:ami_key: latest_amis
8085
81-
:ctrl:
86+
:ctrlAcct:
8287
:region: us-west-2
83-
:master:
84-
<<: *master_default
88+
:ctrl:
89+
<<: *ctrl_default
8590
:target:
86-
<<: *master_default
91+
<<: *ctrl_default
8792
8893
:myapp1:
8994
:region: us-west-2
90-
:master:
91-
<<: *master_default
95+
:ctrl:
96+
<<: *ctrl_default
9297
:role_name: ctrl-myapp1-DeployAdmin
9398
:target:
9499
:label: myapp1
95100
:account_number: '098765432123'
96101
:role_name: myapp1-dso-DeployAdmin
97102
:role_prefix: "/dso/human/"
98103
104+
:myapp2:
105+
:region: us-west-2
106+
:ctrl:
107+
<<: *ctrl_default
108+
:role_name: ctrl-myapp2-DeployAdmin
109+
:target:
110+
:label: myapp2
111+
:account_number: '123098456765'
112+
:role_name: myapp2-dso-DeployAdmin
113+
:role_prefix: "/dso/human/"
114+
99115
...
100116
```
117+
118+
## More Info
119+
Checkout the [docs](./docs/) for detailed information.

0 commit comments

Comments
 (0)