Installation

Docker Run

You can run hoppr with the hoppr/hopctl docker image.

$ docker run hoppr/hopctl version
Hoppr Framework Version: {{ hoppr.version }}
Python Version: 3.10.4

Install Hoppr CLI

Req #1 - Python

Python 3.10 or higher is required to run Hoppr. Instructions to download Python are available here.

For Rocky Linux users, Python may need to be built from source.

Hoppr is available on pypi.org. You can install Hoppr simply by running the following commands:

# Instantiate virtual environment
python3 -m venv .venv

# Source virtual environment
source .venv/bin/activate

# Install hoppr
python3 -m pip install hoppr

You can verify that Hoppr is installed by executing hopctl version:

$ hopctl version
Hoppr Framework Version: {{ hoppr.version }}
Python Version: 3.10.4

Plugin Dependencies

Hoppr plugins often utilize underlying system applications. This means that some plugins will only run on certain Operating Systems. For example, the DNF and YUM collectors generally require a RHEL-based platform. Some examples:

• collect_dnf_plugin requires dnf
• collect_docker_plugin requires skopeo (install instructions)
• collect_git_plugin requires git (install instructions)
• collect_helm_plugin requires helm (install instructions)
• collect_maven_plugin requires mvn (install instructions)
• collect_pypi_plugin requires pip (install instructions)
• collect_yum_plugin requires yumdownloader

Install skopeo

# Ubuntu
apt-get install --yes skopeo

# Rocky
dnf install --assumeyes skopeo

# Alpine
apk add --no-cache skopeo

Install git

# Ubuntu
apt-get install --yes git

# Rocky
dnf install git-all

# Alpine
apk add --no-cache git

Install helm

# Rocky
dnf install --assumeyes helm

# Alpine/Ubuntu
curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

Install maven

# Ubuntu
apt-get install --yes maven

# Rocky
dnf install --assumeyes maven

# Alpine
apk add --no-cache maven

Install pip

# Ubuntu
apt-get install python3-pip

# Rocky
dnf install python3-pip

# Alpine
apk add py3-pip

# Without package manager
python3 -m ensurepip