Skip to content
Snippets Groups Projects
Verified Commit ceb2c923 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

update docs

parent 7bb4520a
No related branches found
No related tags found
1 merge request!19playbooks run from temporary file, remove obsolete test
GOAT Lightweight Service Orchestrator
=====================================
Lightweight service orchestrator
================================
Documentation for LSO: a Lightweight Service Orchestrator
Documentation for LSO (Lightweight Service Orchestrator).
.. toctree::
:maxdepth: 1
......
......@@ -35,6 +35,7 @@ Running the app
-------------------
* Create a settings file, see `config.json.example` for an example.
* If necessary, set the environment vairable `ANSIBLE_HOME` to a custom path.
* Run the app like this (`app.py` starts the server on port 44444):
.. code-block:: bash
......
......@@ -34,7 +34,7 @@ def create_app():
app.include_router(default.router, prefix='/api')
app.include_router(device.router, prefix='/api/device')
# test that config params are available and can be loaded
# test that config params are loaded and available
config.load()
logging.info('FastAPI app initialized')
......
......@@ -117,8 +117,8 @@ def run_playbook(
:param dict extra_vars: Any extra vars needed for the playbook to run.
:param str inventory: The inventory that the playbook is executed against.
:param str callback: Callback URL where the playbook should send a status
update when execution is completed. This is used for WFO to continue
with the next step in a workflow.
update when execution is completed. This is used for
workflow-orchestrator to continue with the next step in a workflow.
:return: Result of playbook launch, this could either be successful or
unsuccessful.
:rtype: :class:`PlaybookLaunchResponse`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment