From 4611d890f7ef3db0ba946c89fa72b22fa74eee0a Mon Sep 17 00:00:00 2001 From: Sam Al-Sapti Date: Sat, 26 Nov 2022 16:32:06 +0100 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bafd8c3a..114d1a1d 100644 --- a/README.md +++ b/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 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 -$ ./deploy.sh # deploy everything -$ ./deploy.sh base # deploy the ubuntu_base role only -$ ./deploy.sh services # deploy the docker role only -$ ./deploy.sh services SERVICE # deploy SERVICE only +$ ./deploy.sh # deploy everything +$ ./deploy.sh base # deploy the ubuntu_base role only +$ ./deploy.sh services # deploy the docker role only +$ ./deploy.sh services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only ``` -`SERVICE` should match one of the filenames in -`roles/docker/tasks/services/`, but without the `.yml` extension +`SINGLE_SERVICE` should match one of the filenames in +`roles/docker/tasks/services/`, but without the `.yml` extension. ## Testing @@ -49,3 +49,16 @@ $ vagrant halt # Power down 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. +