Skip to content

Commit 2a516d0

Browse files
committed
Add documentation
1 parent ef50327 commit 2a516d0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,27 @@ Available [tags](https://docs.ansible.com/ansible/latest/user_guide/playbooks_ta
147147

148148
- - -
149149

150+
### Engine and Federated API applications
151+
152+
Available playbooks to deploy both the Open Terms Archive Engine and Federated API applications on a single server.
153+
154+
| Playbook name | Description | Command example |
155+
| --- | --- | --- |
156+
| `engine_and_federated_api.infrastructure` | Set up and configure the infrastructure required by the Open Terms Archive engine and federated API applications | `ansible-playbook opentermsarchive.deployment.engine_and_federated_api.infrastructure` |
157+
| `engine_and_federated_api.application` | Deploy the Open Terms Archive engine and federated API applications | `ansible-playbook opentermsarchive.deployment.engine_and_federated_api.application` |
158+
| `engine_and_federated_api.all` | Set up infrastructure and deploy the Open Terms Archive engine and federated API applications | `ansible-playbook opentermsarchive.deployment.engine_and_federated_api.all` |
159+
160+
#### Configuration
161+
162+
Available variables are listed below, along with default values:
163+
164+
| Variable | Description | Default value | Required |
165+
| --- | --- | --- | --- |
166+
| `ota_reverse_proxy_engine_path` | Path where the API of the engine will be available | `/collection-api` | - |
167+
| `ota_reverse_proxy_federated_api_path` | Path where the federated API will be available | `/federation-api` | - |
168+
169+
- - -
170+
150171
## Encrypt sensitive configuration entries
151172

152173
Certain configuration entries contain sensitive information that should be encrypted to ensure security. Ansible provides a convenient way to encrypt such strings using its built-in [vault feature](https://docs.ansible.com/ansible/2.9/user_guide/vault.html):

0 commit comments

Comments
 (0)