Skip to content

Commit

Permalink
updated documentation about the cluster creation
Browse files Browse the repository at this point in the history
  • Loading branch information
ndegory committed Aug 4, 2017
1 parent a89cf41 commit 73c150d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [Usage](#usage)
* [Target an AMP cluster](#target-an-amp-cluster)
* [Creating a local AMP cluster](#creating-a-local-amp-cluster)
* [Creating an AMP cluster on AWS](#creating-an-amp-cluster-on-aws)
* [Signing up and logging in](#signing-up-and-logging-in)
* [UI and Dashboard](#ui-and-dashboard)
* [UI](#ui)
Expand Down Expand Up @@ -186,6 +187,10 @@ $ amp cluster create

For more examples of cluster commands and deployment in different environments, see the [cluster documentation](cluster.md).

#### Creating an AMP cluster on AWS

See the [cluster documentation](cluster.md#creating-a-cluster-on-aws).

### Signing up and logging in

In order to be able to use AMP, you will need to signup for a user account, verify the account
Expand Down
10 changes: 7 additions & 3 deletions docs/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ This is the default mode.

* To create a cluster locally:
```
$ amp cluster create
$ amp cluster create --local-fast
...
Cluster status: healthy
2017/08/04 01:17:59 ampctl (version: 0.14.0-dev, build: 08772ef3)
...
{"SwarmID":"sdo9fm7ner6htnu56ww2plo0k","NodeID":"zxij8nozr9xay175jl78xdafu"}
```
This will deploy the `AMP` stack on your local docker engine.
Using the `--tag` option will allow you deploy a cluster with a specific image tag.
Expand All @@ -66,4 +68,6 @@ If the secret is already created, it will be used as is without any modification

#### Creating a cluster on AWS

Not available on 0.12, coming on next release.
To target AWS, you should use the --provider aws option.

More details on the AWS creation on the [AMP wiki](https://github.com/appcelerator/amp/wiki/AMP-deployment-on-AWS)

0 comments on commit 73c150d

Please sign in to comment.