Skip to content
Snippets Groups Projects
Verified Commit 0ad65591 authored by Carolina Fernandez's avatar Carolina Fernandez
Browse files

feature/doc-update: add more details in README

parent 435a65a9
Branches
Tags
1 merge request!2feature/doc-update: add more details in README
Pipeline #85489 passed
Ansible Inventory Generator # Ansible Inventory Generator
Overview
This project aims to automate the generation of Ansible inventory files by pulling data from the WFO API. ## Overview
Features Tool for the automated generation of Ansible inventory files by pulling data extracted from the WFO API.
Generate Ansible inventory from WFO API. ## Features
Save processed data to appropriate inventory file(s).
Ensure no alteration to existing inventory files in case of process failure.
Once installed, you can use the `ansible_inventory_generator` command to generate the Ansible inventory from the API: * Generate Ansible inventory from WFO API.
* Save processed data to appropriate inventory file(s).
* Ensure no alteration to existing inventory files in case of process failure.
## Installation
Install from PIP.
```bash ```bash
pip install \ pip install \
--pre \ --pre \
--extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple \ --extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple \
ansible-inventory-generator ansible-inventory-generator
```
## Deployment
Fill in environment variables and run the command to generate the Ansible inventory from the API.
```bash
# Rewritting environment variables
## URL of the WFO API (change IP only)
export api_url=http://127.0.0.1:8080/api/v1/subscriptions/routers export api_url=http://127.0.0.1:8080/api/v1/subscriptions/routers
## Full paths where this tool will save variables and inventory files
export host_vars_dir=/path/to/base/hostvars/dir export host_vars_dir=/path/to/base/hostvars/dir
export vars_file_name=wfo_vars.yaml
export hosts_file_dir=/path/to/base/hosts/dir export hosts_file_dir=/path/to/base/hosts/dir
## Full path where this tool will save the WFO variables
export vars_file_name=wfo_vars.yaml
# Execution of the command to generate the Ansible inventory files
ansible_inventory_generator
```
Ansible inventory files will be available under the path stated under `hosts_file_dir`.
## Troubleshooting
### 403 error
ansible_inventory_generator This tol cannot reach the WFO API because it is authenticated.
\ No newline at end of file Correct it by redeploying WFO by first running `export OAUTH2_ACTIVE=false` and then re-running WFO.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment