swh.objstorage.backends.winery.pools module

class swh.objstorage.backends.winery.pools.Pool(*args, **kwargs)

Bases: Protocol

pool_name: str

image_exists(image: str) → bool

Check whether the named image exists (it does not have to be mapped)

image_mapped(image: str) → Literal['ro', 'rw'] | None

Check whether the image is already mapped, read-only or read-write

image_list() → List[str]

List all known images, mapped or not

image_path(image: str) → str

Return a path to the image, that can be opened with open().

image_create(image: str) → None

Create a new image named image and allocate the right amount of space.

image_map(image: str, options: str) → None

Map an image for use. Options can be “ro” to map the image read-only, or “rw” to map the image read-write.

image_unmap(image: str) → None

Unmap the image. Once this is done, the image is unavailable for use.

image_remap_ro(image: str)

class swh.objstorage.backends.winery.pools.RBDPool(shard_max_size: int, rbd_use_sudo: bool = True, rbd_pool_name: str = 'shards', rbd_data_pool_name: str | None = None, rbd_image_features_unsupported: Tuple[str, ...] = (), rbd_map_options: str = '')

Bases: Pool

Manage a Ceph RBD pool for Winery shards.

Parameters:

• shard_max_size – max size of shard contents

• rbd_use_sudo – whether to use sudo for rbd commands

• rbd_pool_name – name of the pool used for RBD images (metadata)

• rbd_data_pool_name – name of the pool used for RBD images (data)

• rbd_image_features_unsupported – features not supported by the kernel mounting the rbd images

• rbd_map_options – options to pass to rbd device map, e.g. ms_mode=prefer-secure to connect to a ceph cluster with encryption enabled

POOL_CONFIG: Tuple[str, ...] = ('shard_max_size', 'rbd_use_sudo', 'rbd_pool_name', 'rbd_data_pool_name', 'rbd_image_features_unsupported', 'rbd_map_options')

classmethod from_kwargs(**kwargs) → RBDPool

Create a Pool from a set of arbitrary keyword arguments

run(*cmd: str) → Iterable[str]

Run the given command, and return its output as lines.

Return: the standard output of the run command

Raises: CalledProcessError if the command doesn’t exit with exit code 0.

rbd(*arguments: str) → Iterable[str]

Run rbd with the given arguments

image_exists(image: str)

Check whether the named image exists (it does not have to be mapped)

image_list()

List all known images, mapped or not

image_path(image: str) → str

Return a path to the image, that can be opened with open().

image_create(image: str)

Create a new image named image and allocate the right amount of space.

image_map(image: str, options: str)

Map an image for use. Options can be “ro” to map the image read-only, or “rw” to map the image read-write.

image_unmap(image: str)

Unmap the image. Once this is done, the image is unavailable for use.

class swh.objstorage.backends.winery.pools.FileBackedPool(base_directory: Path, pool_name: str, shard_max_size: int)

Bases: Pool

File-backed pool for Winery shards mimicking a Ceph RBD pool.

Unmapped images are represented by setting the file permission to 0o000.

image_exists(image: str) → bool

Check whether the named image exists (it does not have to be mapped)

image_list() → List[str]

List all known images, mapped or not

image_path(image: str) → str

Return a path to the image, that can be opened with open().

image_create(image: str) → None

Create a new image named image and allocate the right amount of space.

image_map(image: str, options: str) → None

Map an image for use. Options can be “ro” to map the image read-only, or “rw” to map the image read-write.

image_unmap(image: str) → None

Unmap the image. Once this is done, the image is unavailable for use.

image_unmap_all() → None

swh.objstorage.backends.winery.pools.pool_from_settings(shards_settings: Shards, shards_pool_settings: ShardsPool) → Pool

Return a Pool from the settings