data.coop/ansible
8
3
Fork 7
Code Issues 49 Pull requests 9 Projects 1 Releases Wiki Activity

Add README.md #127

Merged
benjaoming merged 13 commits from readme into main 2022-11-29 13:58:39 +00:00
Conversation 2 Commits 13 Files changed 1 +35 -16
1 changed files with 35 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 6cd0eadade - Show all commits

51
README.md
View file

@ -19,11 +19,18 @@ only can also be specified. By default, the script deploys everything.
Here is a summary of the options that can be used with the script: Here is a summary of the options that can be used with the script:
```console ```sh
$ ./deploy.sh # deploy everything # deploy everything
samsapti marked this conversation as resolved Outdated
valberg commented 2022-11-28 18:24:46 +00:00
Outdated
Review
Copy link

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?
👍 1
samsapti commented 2022-11-28 18:31:49 +00:00
Outdated
Review
Copy link

Done 👍

Done 👍
$ ./deploy.sh base # deploy the ubuntu_base role only ./deploy.sh
$ ./deploy.sh services # deploy the docker role only
$ ./deploy.sh services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker service only # deploy the ubuntu_base role only
./deploy.sh base
# deploy the docker role only
./deploy.sh services
# deploy SINGLE_SERVICE Docker service only
./deploy.sh services SINGLE_SERVICE
``` ```
`SINGLE_SERVICE` should match one of the service names in the `services` `SINGLE_SERVICE` should match one of the service names in the `services`
@ -46,12 +53,21 @@ this to work properly.
Here is a summary of the commands that are available with the `vagrant` Here is a summary of the commands that are available with the `vagrant`
command-line tool: command-line tool:
```console ```sh
$ vagrant up # Create and provision the VM # Create and provision the VM
$ vagrant provision # Re-provision the VM vagrant up
$ vagrant ssh # SSH into the VM
$ vagrant halt # Power down the VM # Re-provision the VM
$ vagrant destroy # Power down and delete the VM vagrant provision
# SSH into the VM
vagrant ssh
# Power down the VM
vagrant halt
# Power down and delete the VM
vagrant destroy
``` ```
The `vagrant` command-line tool does not support supplying extra The `vagrant` command-line tool does not support supplying extra
@ -59,9 +75,12 @@ 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 Ansible playbook to Vagrant, the `deploy.sh` script can be used with
the `--vagrant` flag. Here are some examples: the `--vagrant` flag. Here are some examples:
```console ```sh
$ ./deploy.sh --vagrant base # deploy the ubuntu_base role only in the Vagrant VM # 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 ./deploy.sh --vagrant base
# deploy SINGLE_SERVICE Docker service only in the Vagrant VM
./deploy.sh --vagrant services SINGLE_SERVICE
``` ```
Note that the `--vagrant` flag should be the first argument when using Note that the `--vagrant` flag should be the first argument when using
@ -75,8 +94,8 @@ every commit, so please use that. To initialize pre-commit, you need to
have Python and GNU make installed. Then, just run the following shell have Python and GNU make installed. Then, just run the following shell
command: command:
```console ```sh
$ make init make init
``` ```
## Nice tools ## Nice tools