Skip to content
Snippets Groups Projects
Commit 9e4d7807 authored by Jörg Sachse's avatar Jörg Sachse
Browse files

doc: describe invocation and document details of Vault/variable use

parent 2a6e8940
No related branches found
No related tags found
No related merge requests found
...@@ -16,7 +16,7 @@ To deploy this role to a managed host, the following software must be installed ...@@ -16,7 +16,7 @@ To deploy this role to a managed host, the following software must be installed
## Quick start ## Quick start
``` ```
ansible-playbook site.yml -i <INVENTORY_FILE> --limit <HOSTNAME> ansible-playbook site.yml [-i <INVENTORY_FILE>] [--limit <HOSTNAME>] [-u <USERNAME] [-b]
``` ```
## General Ansible usage ## General Ansible usage
...@@ -63,12 +63,16 @@ For more help with ansible-playbook, use the `--help` flag. ...@@ -63,12 +63,16 @@ For more help with ansible-playbook, use the `--help` flag.
## Testing the role ## Testing the role
Tests have been implemented using the Molecule framework. The details on using the test suite are described below `molecule/`. Tests have been prepared/implemented using the Molecule framework. The details on using the test suite are described below `molecule/`.
## Variables ## Variables
Many variables have been "hidden" in encrypted Ansible Vaults. For security reasons, these Vaults are maintained in a separate private internal repository of SLUB's Git. However, in order to better understand the data within the vaults, you can find `\*.vault.example` files below the `vars/` directory. Many variables have been "hidden" in encrypted Ansible Vaults. For security reasons, these Vaults are maintained in a separate private internal repository of SLUB's Git. However, in order to better understand the data within the vaults, you can find `\*.vault.example` files below the `vars/` directory.
If you work outside of SLUBArchive and have no access to the vault repository, make sure to put the necessary vaults in the expected paths at `../ansible_vaults/<ROLENAME>/`.
You also might want to update the values of the variables in `vars/main.yml` to match your requirements.
## git configuration ## git configuration
Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations. Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment