voraus IPC Tools Ansible

CI black isort

voraus IPC related Ansible roles and tools. This collection helps to set up a real-time system with all prerequisites to deploy the voraus.core.

[!NOTE] This collection and its roles are tested against Debian 13 (trixie), and might need modifications for other systems.


Prerequisites

  • An IPC running debian

  • SSH root access to this IPC

Quickstart

  1. Create a Python virtual environment and install ansible and the collection

python3 -m venv venv
source venv/bin/activate
pip install ansible

# Install the collection
ansible-galaxy collection install voraus.ipc_tools

  1. Copy the example inventory to a inventory.yml file and change it according to your needs. In this example, we assume that the IPC is reachable via the IP address 192.168.1.1.

  2. Run the example playbook shipped with the collection.

ansible-playbook voraus.ipc_tools.example -i inventory.yml

Documentation

Please refer to the official documentation.


Getting Started

Requirements

Create a python3 virtual environment and install the dependencies:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip tox && pip install .

Roles

The collection currently contains the following roles, please refer to their individual documentation for more details:

Development

In order to modify and test the roles locally, install the development dependencies as well:

source venv/bin/activate
pip install --upgrade ".[dev]"

License Compliance Information