---
id: os-brick
version: "7.1.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# os-brick — OpenStack Cinder brick library for managing local volume attaches

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

## What it is and what it does

os-brick is the OpenStack Cinder brick library, a specialized tool for managing local storage volume attachments on a host system. It provides discovery of volumes being attached via various transport protocols and handles their removal. The package is part of the OpenStack ecosystem and integrates with Cinder, the block storage service.

The library depends on a suite of Oslo libraries (oslo.concurrency, oslo.config, oslo.context, oslo.log, oslo.i18n, oslo.privsep, oslo.serialization, oslo.service, oslo.utils) for configuration, logging, and service infrastructure, plus requests, tenacity, and psutil for HTTP communication, retry logic, and system utilities. It requires Python 3.11 or later and is actively maintained for current Python versions.

Use it for:

- Discovering storage volumes attached to an OpenStack compute or storage node for inventory and monitoring.
- Programmatically attaching and detaching block devices in Cinder-managed environments.
- Integrating custom storage backends with OpenStack by leveraging the brick attachment API.
- Managing multi-protocol storage connections in infrastructure automation.

## Worth the install?

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

Manages discovery and removal of storage volumes attached to a host, supporting multiple transport protocols for OpenStack Cinder integration.

Yes, if you are building or extending OpenStack Cinder deployments or custom storage integrations that require local volume attachment management. Not applicable for standalone use outside OpenStack environments. The package is actively maintained, has no known vulnerabilities, and carries a permissive license suitable for enterprise use.

## Install

pip install os-brick
uv add os-brick
poetry add os-brick

## Installing os-brick

Before you install: Low install friction with a pure Python wheel distribution. Active maintenance status with a recent release 87 days ago. Depends on 13 runtime libraries including Oslo components, requests, tenacity, and psutil.

License in practice: Apache-2.0 (permissive) allows use in most contexts including commercial deployments, with standard attribution requirements.

Quickstart:

pip install os-brick

from os_brick import connector
# Use connector to discover and manage volumes

Requires Python 3.11 or later; designed for OpenStack environments with Cinder integration.

Verify before relying:

- Which specific transport protocols are supported for volume discovery and attachment.
- Whether this package is intended for direct use or primarily as a Cinder dependency.
- Performance characteristics or scalability limits for large numbers of attached volumes.

## Package facts

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

## Tags

volume attachment management, storage device discovery, openstack cinder integration, local volume management, block device attachment, openstack, storage-management, infrastructure

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