From 1530c14fcad4caf73af00a4b2698f9d1de74ae78 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Tue, 2 Jan 2024 12:10:08 +0100
Subject: [PATCH] update documentation
---
README.md | 4 ----
docs/source/quickstart.rst | 3 +++
2 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ff9daff..357f8ec 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,3 @@ Build documentation using `build-docs.sh`, and check out the quickstart page.
### Docker deployment
Run the following from the root, then refer to the above documentation for usage.
-```bash
-./docker/docker-start.sh
-```
-
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index 3c88e48..f9ae6b7 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -18,6 +18,7 @@ An example Docker compose file is presented below:
image: goat-lso:$LSO_VERSION_TAG
environment:
SETTINGS_FILENAME: /app/config.json
+ ANSIBLE_ROLES_PATH: /app/lso/ansible_roles
volumes:
- "/home/user/config.json:/app/config.json:ro"
- "/home/user/ansible_inventory:/opt/ansible_inventory:ro"
@@ -30,6 +31,8 @@ This will expose the API on port 8080. The container requires some more files to
* A ``config.json`` that references to the location where the Ansible playbooks are stored **inside the container**.
* An Ansible inventory for all host and group variables that are used in the playbooks
* A public/private key pair for SSH authentication on external machines that are targeted by Ansible playbooks.
+* Any Ansible-specific configuration (such as ``collections_path``, ``roles_path``, etc.) should be set using
+ environment variables. ``ANSIBLE_ROLES_PATH`` is given as an example in the Docker compose snippet above.
Install the module
------------------
--
GitLab