sys_reqs

Platform Notes

The playbooks have been tested and verified on the following systems:

Platform	Notes
Ubuntu 22.04, 24.04	Netplan version >= 0.105
RHEL 9 and derivatives	NetworkManager required

Requirements

• Ansible version >= 2.14 and < 2.16 (currently required if you want to run Ceph provisioning)
• SSH access to the inventory servers, either directly or through a bastion host
• The user that will perform the installation needs to sudo to root

Installing the Requirements

There are essentially two installation methods:

• Method 1: Install in a Python virtual environment, using hatch
• Method 2: Pre-install Ansible system-wide

Below is a brief description of each method. For details on installation and running the playbooks, see Using the Playbooks.

Tip

For full details on installing Ansible on your system, please refer to the Ansible documentation.

For both methods: Clone the one-deploy git repo

To clone the one-deploy repo, run:

git clone https://github.com/OpenNebula/one-deploy.git

This will clone to directory one-deploy.

Then, proceed to install the requirements using your preferred method below:

Method 1: Install in a Python virtual environment using hatch

To install hatch, run the below commands for your operating system:

pipx install hatch
pipx ensurepath
source ~/.bashrc

Go to the one-deploy root directory and install the requirements:

cd ./one-deploy/ && make requirements

This installs the virtual environment with all requirements. To list the new virtual environment, run:

hatch env show

Spawn a shell in the virtual environment (default):

hatch shell

After switching to the virtual environment (default), your terminal prompt should begin with the string (one-deploy), as shown below:

~/one-deploy$ hatch shell
~/one-deploy$ source "/home/user/.local/share/hatch/env/virtual/one-deploy/zyWWq5iB/one-deploy/bin/activate"
(one-deploy) ~/one-deploy$

Note

When using make, ansible-playbook is executed in dedicated hatch vitual envs automatically (entering hatch shell is not required).

Method 2: Pre-install Ansible system-wide

To install Ansible, run the below commands for your operating system:

Ubuntu 22.04	Ubuntu 24.04
apt install python3-pip	apt install pipx
pip3 install 'ansible-core<2.16'	pipx install 'ansible-core<2.16'

Build the one-deploy requirements:

cd /path/to/one-deploy/
make requirements

Tip

If you want to ensure hatch is not used even if it’s available on the system, for building the requirements run make requirements HATCH_BIN=.