From 6d4802afda0644ccf68e66f2c222585c482168c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Sachse?= <Joerg.Sachse@slub-dresden.de> Date: Mon, 21 Dec 2020 12:19:40 +0100 Subject: [PATCH] doc: add information specific to this role (was only rather generic default documentation) --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 825955c..238e5c1 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ To deploy this role to a managed host, the following software must be installed * Python3 * SSHd +In order to create a bootable ISO image, you have to provide a RHEL ISO image in the role's root directory and set the correct version in `vars/main.yml`. + ## Quick start ``` @@ -61,14 +63,6 @@ You can then run only certain tagged tasks by using the `--tags` option: For more help with ansible-playbook, use the `--help` flag. -## Testing the role - -Tests have been implemented using the Molecule framework. The details on using the test suite are described below `molecule/`. - -## 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. - ## git configuration Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations. -- GitLab