swh.objstorage.backends.winery.pools.rbd module#

class swh.objstorage.backends.winery.pools.rbd.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 = '')[source]#

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[source]#

Create a Pool from a set of arbitrary keyword arguments

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

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][source]#

Run rbd with the given arguments

image_exists(image: str)[source]#

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

image_list()[source]#

List all known images, mapped or not

image_path(image: str) → str[source]#

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

image_create(image: str)[source]#

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

image_map(image: str, options: str)[source]#

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)[source]#

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

image_open(image: str) → ImageReader[source]#
delete_object(shard_name: str, obj_id: bytes) → None[source]#
open_writer(shard_name: str, nb_objects: int, create_image: bool) → ImageWriter[source]#

Instantiate the correct ImageWriter object for the given shard

This is used at time of packing a batch of objects in a shard file.

image_import(image: str) → None[source]#

Import an existing image file in the current pool