Installing ansible-navigator with execution environment support¶

Linux
macOS
Windows with WSL2

Recommendation

The recommended approach to install ansible-navigator is using the ansible-dev-tools package. Ansible Development Tools (ADT) aims to streamline the setup and usage of several tools needed in order to create Ansible content. ADT 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

Linux¶

Requirements¶

Either podman or Docker for Linux
Internet access (during initial installation)

Install the desired container engine for execution environment support¶

Follow the podman installation instructions for the appropriate distribution.
Follow the Docker for Linux installation instructions for the appropriate distribution.

Install ansible-navigator¶

Install the python package manager using the system package installer (e.g.):
```
sudo dnf install python3-pip
```

Install ansible-navigator:

python3 -m pip install ansible-navigator --user

Add the installation path to the user shell initialization file (e.g.):
```
echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.profile
```
Refresh the PATH (e.g.):
```
source ~/.profile
```
Launch ansible-navigator:
```
ansible-navigator
```
ansible-navigator triggers a one-time download of the demo execution-environment image.

macOS¶

Requirements (macos)¶

Docker Desktop for Mac or Podman on macOS
macOS command line developer tools
Internet access (during initial installation)

Install the desired container engine for execution environment support (macos)¶

Docker Desktop for Mac installation instructions
Podman on MacOS installation instructions

Install ansible-navigator (macos)¶

Install the command line developer tools and proceed with the installation if prompted.
```
xcode-select --install
```
Install ansible-navigator:
```
pip3 install ansible-navigator --user
```

Add the installation path to the PATH, using the installed Python version:

echo 'export PATH=$HOME/Library/Python/3.10/bin:$PATH' >> ~/.zprofile

Refresh the PATH:
```
source ~/.zprofile
```
Launch ansible-navigator:
```
ansible-navigator
```
ansible-navigator triggers a one-time download of the demo execution-environment image.

Windows with WSL2¶

Requirements (windows)¶

Windows Subsystem for Linux 2
Either podman or Docker Desktop for Windows
Internet access (during initial installation)

Setup Windows Subsystem for Linux 2 with Ubuntu¶

Install Windows Subsystem for Linux 2.
Install the Ubuntu 20.04 LTS Linux distribution from the Microsoft store.
Open PowerShell and set the default WSL 2 distribution:
```
wsl --set-default ubuntu
```
Launch the Ubuntu] virtual machine from the Windows menu and complete the initial set-up.
From the Ubuntu terminal, create the /dev/mqueue directory:
```
sudo mkdir /dev/mqueue
```

Install the desired container engine for execution environment support (windows)¶

Installation instructions for podman on Ubuntu 20.04 LTS.

!!! notice

  The podman package is available in the official repositories for Ubuntu 20.10 and newer.
  Since interim releases of Ubuntu are not available on the Microsoft Store for WSL the
  [Kubic project] package can be used.

Update the ubuntu package index:
```
sudo apt update
```
Install system dependencies for podman:
```
apt-get install curl wget gnupg2
```
Source the Ubuntu release:
```
source /etc/os-release
```

Add the podman repository:

sudo sh -c "echo 'deb http://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/xUbuntu_${VERSION_ID}/ /' > /etc/apt/sources.list.d/devel:kubic:libcontainers:stable.list"

Download the GPG key:

wget -nv https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/xUbuntu_${VERSION_ID}/Release.key -O- | sudo apt-key add -

Update using the new repository:
```
sudo apt-get update
```
Install podman:
```
sudo apt-get install podman
```
Follow the Docker Desktop for Windows installation instructions (if podman was not installed above)
Be sure to complete the Manage Docker as a non-root user steps.

Install ansible-navigator (windows)¶

From the Ubuntu terminal:

Ensure the /dev/mqueue directory exists:
```
sudo mkdir /dev/mqueue
```
Install the python package manager:
```
sudo apt install python3-pip
```

Install ansible-navigator:

python3 -m pip install ansible-navigator --user

Add the installation path to the user shell initialization file:
```
echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.profile
```
Refresh the PATH:
```
source ~/.profile
```
Launch ansible-navigator:
```
ansible-navigator
```
ansible-navigator triggers a one-time download of the demo execution-environment image.