Skip to content

Installation

This document assumes the developer has a basic understanding of Python packaging, and how to install and manage Python on the system executing Molecule.

Requirements

Depending on the driver chosen, you may need to install additional OS packages.

  • Python >= 3.10 with ansible-core >= 2.12
$ sudo dnf install -y gcc python3-pip python3-devel openssl-devel python3-libselinux
$ sudo apt update
$ sudo apt install -y python3-pip libssl-dev

Pip

pip is the only supported installation method.

Recommendation

The recommended approach to install ansible-navigator is using the ansible-dev-tools package. Ansible Development Tools aims to streamline the setup and usage of several tools needed in order to create Ansible content. It combines critical Ansible development packages into a unified Python package.

# This also installs ansible-core if it is not already installed
pip3 install ansible-dev-tools
$ python3 -m pip install molecule ansible-core

Keep in mind that on selinux supporting systems, if you install into a virtual environment, you may face issue 34340 even if selinux is not enabled or is configured to be permissive.

It is your responsibility to ensure that soft dependencies of Ansible are available on your controller or host machines.

Warning

It is highly recommended that you install molecule in a virtual environment. This will provide a modern copy of setuptools which is mandatory in order for molecule to be installed successfully and function correctly. If you cannot use a virtual environment then you can attempt a package upgrade with the following:

$ python3 -m pip install --upgrade --user setuptools

Requirements

Depending on the driver chosen, you may need to install additional Python packages. See the driver's documentation in that case.

Install

Install Molecule:

$ python3 -m pip install --user molecule

Molecule does not include ansible-lint (nor does the lint extra), but is easily installed separately:

$ python3 -m pip install --user molecule ansible-lint

Molecule uses the \"delegated\" driver by default. Other drivers can be installed separately from PyPI, most of them being included in molecule-plugins package. If you would like to use podman as the molecule driver, the installation command would look like this:

$ python3 -m pip install --user "molecule-plugins[podman]"

Warning

If you upgrade molecule from previous versions, make sure to remove previously installed drivers like for instance molecule-podman or molecule-vagrant since those are now available in the molecule-plugins package.

Installing molecule package also installed its main script molecule, usually in PATH. Users should know that molecule can also be called as a python module, using python3 -m molecule .... This alternative method has some benefits:

  • allows to explicitly control which Python interpreter is used by molecule
  • allows molecule installation at the user level without even needing to have the script in PATH.

Container

Molecule is built into a container image by the Ansible Creator Execution Environment project, creator-ee.

Any questions or bugs related to the use of Molecule from within a container should be addressed by the Ansible Creator Execution Environment project.

Source

Due to the rapid pace of development on this tool, you might want to install and update a bleeding-edge version of Molecule from Git. Follow the instructions below to do the initial install and subsequent updates.

The package distribution that you'll get installed will be autogenerated and will contain commit hash information, making it easier to refer to.

Requirements

$ sudo dnf install -y libffi-devel git
$ sudo apt install -y libffi-dev git
Install
$ python3 -m pip install -U git+https://github.com/ansible-community/molecule