yum Operations

The yum module manages packages and repositories on RHEL/CentOS systems using the yum package manager.

Yum package names are case-sensitive.

Functions

packages

Install, remove, or update yum packages.

from pyinfra.operations import yum

yum.packages(
    name="Install web server",
    packages=["nginx", "certbot"],
    update=True,
)

str | list[str]

List of packages to ensure.

bool

default:true

Whether the packages should be installed.

bool

default:false

Whether to upgrade packages without a specified version.

bool

default:false

Run yum update before installing packages.

bool

default:false

Run yum clean all before installing packages.

bool

default:false

Add the —nobest option to install.

str

Additional arguments to the yum install command.

str

Additional arguments to the yum uninstall command.

Package versions can be pinned as: <pkg>=<version>

Examples

from pyinfra.operations import yum

# Update package list and install packages
yum.packages(
    name="Install Vim and Vim enhanced",
    packages=["vim-enhanced", "vim"],
    update=True,
)

from pyinfra.operations import yum

# Install the latest versions of packages (always check)
yum.packages(
    name="Install latest Vim",
    packages=["vim"],
    latest=True,
)

from pyinfra.operations import yum

# Clean cache before installing
yum.packages(
    name="Install packages with fresh cache",
    packages=["httpd", "mod_ssl"],
    clean=True,
)

update

Update all yum packages.

from pyinfra.operations import yum

yum.update(
    name="Update all packages",
)

This operation is not idempotent - it will always execute.

repo

Add, remove, or update yum repositories.

from pyinfra.operations import yum

yum.repo(
    name="Add Docker repository",
    src="DockerCE",
    baseurl="https://download.docker.com/linux/centos/7/$basearch/stable",
)

str

required

URL or name for the .repo file.

bool

default:true

Whether the .repo file should be present.

str

The baseurl of the repo (if src is not a URL).

str

Optional verbose description.

bool

default:true

Whether this repo is enabled.

bool

default:true

Whether to set gpgcheck=1.

str

The URL to the GPG key for this repo.

baseurl, description, gpgcheck, and gpgkey are only valid when src is a filename (not a URL). Use a URL to download and install remote repository files.

Examples

from pyinfra.operations import yum

# Download a repository file
yum.repo(
    name="Install Docker-CE repo via URL",
    src="https://download.docker.com/linux/centos/docker-ce.repo",
)

from pyinfra.operations import yum

# Create the repository file from baseurl/etc
yum.repo(
    name="Add the Docker repo",
    src="DockerCE",
    baseurl="https://download.docker.com/linux/centos/7/$basearch/stable",
)

rpm

Install or remove .rpm package files.

from pyinfra import host
from pyinfra.operations import yum
from pyinfra.facts.server import LinuxDistribution

major_version = host.get_fact(LinuxDistribution)["major"]
yum.rpm(
    name="Install EPEL rpm to enable EPEL repo",
    src=f"https://dl.fedoraproject.org/pub/epel/epel-release-latest-{major_version}.noarch.rpm",
)

str

required

Filename or URL of the .rpm package.

bool

default:true

Whether the package should exist on the system.

URL sources with present=False: If the .rpm file isn’t downloaded, pyinfra can’t remove any existing package as the file won’t exist until mid-deploy.

key

Add yum GPG keys with rpm.

from pyinfra import host
from pyinfra.operations import yum
from pyinfra.facts.server import LinuxDistribution

linux_id = host.get_fact(LinuxDistribution)["release_meta"].get("ID")
yum.key(
    name="Add the Docker CentOS gpg key",
    src=f"https://download.docker.com/linux/{linux_id}/gpg",
)

str

required

Filename or URL of the GPG key.

This operation is not idempotent - it always returns one command without state checking.

Common Use Cases

Install EPEL Repository

from pyinfra import host
from pyinfra.operations import yum
from pyinfra.facts.server import LinuxDistribution

# Get the major version
major_version = host.get_fact(LinuxDistribution)["major"]

# Install EPEL release package
yum.rpm(
    name="Install EPEL repository",
    src=f"https://dl.fedoraproject.org/pub/epel/epel-release-latest-{major_version}.noarch.rpm",
)

# Install packages from EPEL
yum.packages(
    name="Install packages from EPEL",
    packages=["htop", "ncdu"],
)

Install Docker on CentOS

from pyinfra import host
from pyinfra.operations import yum
from pyinfra.facts.server import LinuxDistribution

linux_id = host.get_fact(LinuxDistribution)["release_meta"].get("ID")

# Add Docker GPG key
yum.key(
    name="Add Docker GPG key",
    src=f"https://download.docker.com/linux/{linux_id}/gpg",
)

# Add Docker repository
yum.repo(
    name="Add Docker repository",
    src="https://download.docker.com/linux/centos/docker-ce.repo",
)

# Install Docker
yum.packages(
    name="Install Docker",
    packages=["docker-ce", "docker-ce-cli", "containerd.io"],
)

Development Environment

from pyinfra.operations import yum

# Install development tools
yum.packages(
    name="Install Development Tools group",
    packages=["@Development Tools"],
)

# Install additional tools
yum.packages(
    name="Install development utilities",
    packages=[
        "git",
        "vim",
        "tmux",
        "wget",
        "curl",
    ],
    update=True,
)

Overview

Package Managers

Language Packages

Service Management

System Operations

Containers

Databases

Version Control

Security

Functions

packages

Examples

update

repo

Examples

rpm

key

Common Use Cases

Install EPEL Repository

Install Docker on CentOS

Development Environment

​Functions

​packages

​Examples

​update

​repo

​Examples

​rpm

​key

​Common Use Cases

​Install EPEL Repository

​Install Docker on CentOS

​Development Environment

Functions

packages

Examples

update

repo

Examples

rpm

key

Common Use Cases

Install EPEL Repository

Install Docker on CentOS

Development Environment