README.md in simple_deploy-0.2.3 vs README.md in simple_deploy-0.2.4
- old
+ new
@@ -12,10 +12,12 @@
Create a file **~/.simple_deploy.yml** and include within it:
```
deploy:
gateway: ADMIN_IP_TO_YOUR_VPC
+ user: SSH_USER_TO_GATEWAY_AND_INSTANCES
+ key: PRIVATE_SSH_KEYFILE_FOR_USER
artifacts:
- name: live_community_chef_repo
bucket_prefix: intu-lc
variable: CHEF_REPO_URL
cloud_formation_url: ChefRepoURL
@@ -34,10 +36,17 @@
access_key: XXX
secret_key: yyy
region: us-west-1
```
+Configuration File
+------------------
+
+The configuration file supports additional optional deployment parameters. Artifacts can have an **endpoint** specified to be passed in (by default they pass in the s3 url).
+
+Deploy can have a ssh **user** and **key** set. These will be used to connect to both the gateway and tunnel through to instances.
+
Commands
--------
You can issues the following commands:
@@ -53,8 +62,12 @@
simple_deploy attributes -n STACK_NAME -e ENVIRONMENT
simple_deploy events -n STACK_NAME -e ENVIRONMENT
simple_deploy resources -n STACK_NAME -e ENVIRONMENT
simple_deploy outputs -n STACK_NAME -e ENVIRONMENT
simple_deploy template -n STACK_NAME -e ENVIRONMENT
+
+Attribute pairs are = seperated key value pairs. Multiple can be specified. For example:
+
+simple_deploy create -t ~/my-template.json -e my-env -n test-stack -a arg1=val1 arg2=vol2
```
For more information, run simple_deploy -h.