Module gluster::volume [] [src]

Structs

Brick

A Gluster Brick consists of a Peer and a path to the mount point

Volume

A volume is a logical collection of bricks. Most of the gluster management operations happen on the volume.

Enums

Transport

An enum to select the transport method Gluster should use for the Volume

VolumeTranslator
VolumeType

These are all the different Volume types that are possible in Gluster Note: Tier is not represented here because I'm waiting for it to become more stable For more information about these types see: Gluster Volume

Functions

get_quota_usage

Returns a u64 representing the bytes used on the volume. Note: This uses my brand new RPC library. Some bugs may exist so use caution. This does not shell out and therefore should be significantly faster. It also suffers far less hang conditions than the CLI version.

ok_to_remove

Based on the replicas or erasure bits that are still available in the volume this will return True or False as to whether you can remove a Brick. This should be called before volume_remove_brick()

quota_list

Return a list of quotas on the volume if any

volume_add_brick

This adds a new brick to the volume

volume_add_quota

Adds a size quota to the volume and path.

volume_create_arbiter

The arbiter volume is special subset of replica volumes that is aimed at preventing split-brains and providing the same consistency guarantees as a normal replica 3 volume without consuming 3x space.

volume_create_distributed

This creates a new distributed volume

volume_create_erasure

This creates a new erasure coded volume

volume_create_replicated

This creates a new replicated volume

volume_create_striped

This creates a new striped volume

volume_create_striped_replicated

This creates a new striped and replicated volume

volume_delete

This deletes a stopped volume

volume_disable_bitrot

Disable bitrot detection and remediation on the volume

volume_disable_quotas

Disable quotas on the volume

volume_enable_bitrot

Enable bitrot detection and remediation on the volume

volume_enable_quotas

Enable quotas on the volume

volume_info

Returns a Volume with all available information on the volume

volume_list

Lists all available volume names.

volume_quotas_enabled

Check if quotas are already enabled on a volume

volume_rebalance

This function doesn't do anything yet. It is a place holder because volume_rebalance is a long running command and I haven't decided how to poll for completion yet

volume_remove_brick

This will remove a brick from the volume

volume_remove_quota

Removes a size quota to the volume and path.

volume_set_bitrot_option

Set a bitrot option on the volume

volume_set_options

Set an option on the volume

volume_start

Once a volume is created it needs to be started. This starts the volume

volume_status

Query the status of the volume given.

volume_stop

This stops a running volume