Add README.md #127
21
README.md
21
README.md
|
@ -13,17 +13,17 @@ The script has options to deploy only one of the roles, which are namely
|
||||||
services themselves using Docker containers. Select services only can
|
services themselves using Docker containers. Select services only can
|
||||||
samsapti marked this conversation as resolved
Outdated
|
|||||||
also be specified. By default, the script deploys everything.
|
also be specified. By default, the script deploys everything.
|
||||||
|
|
||||||
Here is a summary of the options that can be used:
|
Here is a summary of the options that can be used with the script:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ ./deploy.sh # deploy everything
|
$ ./deploy.sh # deploy everything
|
||||||
$ ./deploy.sh base # deploy the ubuntu_base role only
|
$ ./deploy.sh base # deploy the ubuntu_base role only
|
||||||
$ ./deploy.sh services # deploy the docker role only
|
$ ./deploy.sh services # deploy the docker role only
|
||||||
$ ./deploy.sh services SERVICE # deploy SERVICE only
|
$ ./deploy.sh services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only
|
||||||
```
|
```
|
||||||
samsapti marked this conversation as resolved
Outdated
valberg
commented
Just for better rendering: can we put comments on the preceding line and have a newline between each comman e? Just for better rendering: can we put comments on the preceding line and have a newline between each comman e?
samsapti
commented
Done 👍 Done 👍
|
|||||||
|
|
||||||
`SERVICE` should match one of the filenames in
|
`SINGLE_SERVICE` should match one of the filenames in
|
||||||
`roles/docker/tasks/services/`, but without the `.yml` extension
|
`roles/docker/tasks/services/`, but without the `.yml` extension.
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
|
@ -49,3 +49,16 @@ $ vagrant halt # Power down the VM
|
||||||
$ vagrant destroy # Power down and delete the VM
|
$ vagrant destroy # Power down and delete the VM
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The `vagrant` command-line tool does not support supplying extra
|
||||||
|
variables to Ansible on runtime, so to be able to deploy only parts of
|
||||||
|
the Ansible playbook to Vagrant, the `deploy.sh` script can be used with
|
||||||
|
the `--vagrant` flag. Here are some examples:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ ./deploy.sh --vagrant base # deploy the ubuntu_base role only in the Vagrant VM
|
||||||
|
$ ./deploy.sh --vagrant services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only in the Vagrant VM
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the `--vagrant` flag should be the first argument when using
|
||||||
|
the script.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue
This is really good! Suggesting this:
I agree, your suggestion looks a bit cleaner 👍