---
id: oslo-upgradecheck
version: "2.8.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# oslo.upgradecheck — Common code for writing OpenStack upgrade checks

License: permissive · Maintenance: active · Downloads: 314.0K/mo

## What it is and what it does

oslo.upgradecheck is a library that provides common infrastructure for writing upgrade checks in OpenStack projects. It supplies a base class and utilities that let OpenStack services define and run validation checks before performing version upgrades, helping operators verify system readiness and catch configuration or compatibility issues early.

The package is part of the oslo project—a collection of shared libraries across OpenStack—and is designed to be integrated into individual OpenStack projects rather than used as a standalone tool. It includes both the core framework module and an example of how to wire it into a project's command-line interface. It depends on oslo.config, oslo.i18n, oslo.utils, oslo.policy for configuration and utility support, and PrettyTable for formatting check results.

Use it for:

- OpenStack project developers integrating pre-upgrade validation into their services
- Operators running upgrade checks to verify system state before applying version updates
- Automated deployment pipelines that need to validate upgrade readiness before proceeding
- Multi-component OpenStack environments checking compatibility across interdependent services

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides a framework for writing and running upgrade checks in OpenStack projects, allowing operators to validate system readiness before performing version upgrades.

Yes, if you are developing or operating an OpenStack project. The package is actively maintained, has no known vulnerabilities, and provides a standardized framework that reduces duplication of upgrade-check logic across the OpenStack ecosystem. Not relevant for non-OpenStack use cases.

## Install

pip install oslo-upgradecheck
uv add oslo-upgradecheck
poetry add oslo-upgradecheck

## Installing oslo.upgradecheck

Before you install: Low install friction with a wheel distribution. Active maintenance status with a recent release (35 days old). Depends on five oslo.* libraries and PrettyTable, all standard OpenStack ecosystem packages.

License in practice: Apache-2.0 permissive license allows use, modification, and distribution with minimal restrictions, suitable for both proprietary and open-source projects.

Quickstart:

pip install oslo.upgradecheck

from oslo_upgradecheck import upgradecheck

# Define a check class inheriting from upgradecheck.UpgradeCommands
class MyUpgradeChecks(upgradecheck.UpgradeCommands):
    def _check_something(self):
        return upgradecheck.Result(upgradecheck.Code.SUCCESS)

Requires Python 3.11 or later; intended for use within OpenStack projects that integrate the framework.

Verify before relying:

- Whether this package is intended for end-user operators or for OpenStack project developers writing upgrade checks
- Specific OpenStack versions or projects that currently use this framework
- Performance characteristics or scalability limits for large-scale deployments

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 314.0K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

openstack upgrade checks, pre-upgrade validation, upgrade readiness framework, openstack version migration, upgrade compatibility checks, system upgrade validation, openstack upgrade tooling, openstack, upgrade-validation, oslo-library

[View on SkillFed](https://skillfed.io/packages/oslo-upgradecheck) · [View on PyPI](https://pypi.org/project/oslo-upgradecheck/)