Module extstorage

Take an External Storage action.

Take an External Storage action concerning or affecting a specific Volume inside the External Storage.

Parameters:

• action (string) - which action to perform. One of: create / remove / grow / attach / detach / snapshot
• unique_id (tuple (driver, vol_name)) - a tuple containing the type of ExtStorage (driver) and the Volume name
• ext_params (dict) - ExtStorage parameters
• size (integer) - the size of the Volume in mebibytes
• grow (integer) - the new size in mebibytes (after grow)
• metadata (string) - metadata info of the Volume, for use by the provider
• name (string) - name of the Volume (objects.Disk.name)
• snap_size (integer) - the size of the snapshot
• snap_name (string) - the name of the snapshot
• exclusive (boolean) - Whether the Volume will be opened exclusively or not
• uuid (string) - uuid of the Volume (objects.Disk.uuid)

Returns: None or a block device path (during attach)

Check prereqs for an ExtStorage file.

Check if file exists, if it is a regular file and in case it is one of extstorage scripts if it is executable.

Parameters:

• base_dir (string) - Base directory containing ExtStorage installations.
• filename (string) - The basename of the ExtStorage file.
• required (bool) - Whether the file is required or not.

Returns: String

The file path if the file is found and is valid, None if the file is not found and not required.

Raises:

• BlockDeviceError - In case prereqs are not met (found and not valid/executable, not found and required)

Calculate the environment for an External Storage script.

Parameters:

• unique_id (tuple (driver, vol_name)) - ExtStorage pool and name of the Volume
• ext_params (dict) - the EXT parameters
• size (integer) - size of the Volume (in mebibytes)
• grow (integer) - new size of Volume after grow (in mebibytes)
• metadata (string) - metadata info of the Volume
• name (string) - name of the Volume (objects.Disk.name)
• uuid (string) - uuid of the Volume (objects.Disk.uuid)
• snap_size (integer) - the size of the snapshot
• snap_name (string) - the name of the snapshot
• exclusive (boolean) - Whether the Volume will be opened exclusively or not

Returns: dict

dict of environment variables

Compute the ExtStorage log filename for a given Volume and operation.

Parameters:

• kind (string) - the operation type (e.g. create, remove etc.)
• es_name (string) - the ExtStorage name
• volume (string) - the name of the Volume inside the External Storage