LSO, an API for remotely running Ansible playbooks.
Project description
Lightweight Service Orchestrator
LSO: an API that allows for remotely executing Ansible playbooks.
Code documentation
Code documentation can be found at https://workfloworchestrator.org/lso
Quick start
This is a quick setup guide for running on your local machine.
As a Docker container
To run LSO as a Docker container, build an image using the Dockerfile.example
as an example. Be sure to update
requirements.txt
and ansible-galaxy-requirements.yaml
accordingly, depending on your specific Ansible collection and
-role needs.
Use the Docker image to then spin up an environment. An example Docker compose file is presented below:
version: "3.5"
services:
lso:
image: my-lso:latest
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"
- "~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro"
- "~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro"
This will expose the API on port 8000. The container requires some more files to be mounted:
- 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
As an alternative, below are a set of instructions for installing and running LSO directly on a machine.
One of these should be what you're looking for:
- Install the latest release
python3 -m venv my-venv-directory
. my-venv-directory/bin/activate
pip install orchestrator-lso
- Install the source code
git clone https://github.com/workfloworchestrator/lso.git && cd lso
python3 -m venv my-venv-directory
. my-venv-directory/bin/activate
pip install flit
flit install --deps production
# Or, for the full development environment
flit install --deps develop
Running the app
- Create a settings file, see
config.json.example
for an example. - If necessary, set the environment variable
ANSIBLE_HOME
to a custom path. - Run the app like this (
app.py
starts the server on port 44444):
SETTINGS_FILENAME=/absolute/path/to/config.json python -m lso.app
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for orchestrator_lso-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 459918c16f1a1d5889870d29445720f06a4159eb856af9f910e3793d73c02bcf |
|
MD5 | 1a4701f722af18b714380e3378633b11 |
|
BLAKE2b-256 | cd0d7185238b141bcbb55ce751afcf230a1e3e5d97cadff21b8b1b230c7fc11e |