Skip to main content

Manage Playbook Dependencies

Last updated on

Many Ansible playbooks require dependencies beyond what the default Harness Ansible image provides. Python packages like tabulate, netaddr, and jmespath are common needs, but you may also need system tools (sshpass, rsync, jq), Ansible collections, or custom roles. You can provide these dependencies in two ways: install them at runtime using a requirements.txt file, or pre-build a custom Docker image with everything pre-installed.

Choose runtime installation for quick prototyping and frequently changing Python packages. Choose pre-built images for production workloads requiring faster execution, strict reproducibility, or non-Python dependencies like system packages and Ansible collections.

Before you begin​

Before you begin, make sure the following are in place:

  • Harness IaCM pipeline configured: You need an existing pipeline with the IACMAnsiblePlugin step. Go to Get started with Ansible to configure your first Ansible pipeline.
  • Playbook repository with Git connector: Your playbooks must be stored in a Git repository with a configured Harness connector. Go to Connect to a code repository to set up a Git connector.
  • Understanding of Python package names: You should know which Python packages your playbooks require. Go to PyPI to search for Python packages.
  • Container registry access (for pre-built images only): If building custom images, you need push access to a container registry. Go to Connect to an artifact registry to configure a Harness connector.
  • Docker installed locally (for pre-built images only): If you want to test your custom image locally before using it in Harness, install Docker. Go to Get Docker to install Docker Desktop or Docker Engine.

Troubleshooting​

ModuleNotFoundError: No module named 'package_name' in Harness IaCM Ansible pipeline

Verify the package is installed. For runtime installation, check that ANSIBLE_REQUIREMENTS variable points to the correct file. For custom images, run: docker run --rm your-image:tag python3.11 -c 'import package_name; print(package_name.version)'

pip install fails with permission denied when building custom Ansible image

Make sure you switch to USER harness before running pip install, and use the --user flag: RUN pip install --user package-name

Custom Ansible image not being pulled in Harness IaCM pipeline

Verify your connectorRef in the pipeline YAML matches a configured Docker connector with access to your registry, and confirm the image name and tag are correct.

Ansible playbook works locally but fails in Harness IaCM with missing Python package

For runtime installation, confirm the ANSIBLE_REQUIREMENTS variable is set. For custom images, confirm the pipeline step references your custom image in the image field. Check the pipeline logs to see which image was actually pulled.

ANSIBLE_REQUIREMENTS variable set but packages not installing in Harness IaCM pipeline

Verify the requirements.txt file exists at the path specified in the variable, relative to the repository root. Check the Debug file system section in the pipeline logs to confirm the file was cloned to the expected path.

Next steps​

You now understand how to provide dependencies to Ansible playbooks in Harness IaCM. You can install packages at runtime using requirements.txt for flexibility, or pre-install them in a custom image for faster execution.