openstacksdk/doc/source/user/guides/shared_file_system.rst
Anvi Joshi 7b5356f32d Support manage/unmanage shares with manila
Change-Id: I95b72434a8a44f737f5ee9a44b6ecbf8f4162a7a
2023-08-09 03:33:53 +00:00

4.9 KiB

Using OpenStack Shared File Systems

Before working with the Shared File System service, you'll need to create a connection to your OpenStack cloud by following the connect user guide. This will provide you with the conn variable used in the examples below.

Table of Contents

List Availability Zones

A Shared File System service availability zone is a failure domain for your shared file systems. You may create a shared file system (referred to simply as shares) in a given availability zone, and create replicas of the share in other availability zones.

../examples/shared_file_system/availability_zones.py

Share Instances

Administrators can list, show information for, explicitly set the state of, and force-delete share instances.

../examples/shared_file_system/share_instances.py

Get Share Instance

Shows details for a single share instance.

../examples/shared_file_system/share_instances.py

Reset Share Instance Status

Explicitly updates the state of a share instance.

../examples/shared_file_system/share_instances.py

Delete Share Instance

Force-deletes a share instance.

../examples/shared_file_system/share_instances.py

Resize Share

Shared File System shares can be resized (extended or shrunk) to a given size. For details on resizing shares, refer to the Manila docs.

../examples/shared_file_system/shares.py

../examples/shared_file_system/shares.py

List Share Group Snapshots

A share group snapshot is a point-in-time, read-only copy of the data that is contained in a share group. You can list all share group snapshots

../examples/shared_file_system/share_group_snapshots.py

Get Share Group Snapshot

Show share group snapshot details

../examples/shared_file_system/share_group_snapshots.py

List Share Group Snapshot Members

Lists all share group snapshots members.

../examples/shared_file_system/share_group_snapshots.py

Create Share Group Snapshot

Creates a snapshot from a share group.

../examples/shared_file_system/share_group_snapshots.py

Reset Share Group Snapshot

Reset share group snapshot state.

../examples/shared_file_system/share_group_snapshots.py

Update Share Group Snapshot

Updates a share group snapshot.

../examples/shared_file_system/share_group_snapshots.py

Delete Share Group Snapshot

Deletes a share group snapshot.

../examples/shared_file_system/share_group_snapshots.py

List Share Metadata

Lists all metadata for a given share.

../examples/shared_file_system/share_metadata.py

Get Share Metadata Item

Retrieves a specific metadata item from a shares metadata by its key.

../examples/shared_file_system/share_metadata.py

Create Share Metadata

Creates share metadata.

../examples/shared_file_system/share_metadata.py

Update Share Metadata

Updates metadata of a given share.

../examples/shared_file_system/share_metadata.py

Delete Share Metadata

Deletes a specific metadata item from a shares metadata by its key. Can specify multiple keys to be deleted.

../examples/shared_file_system/share_metadata.py

Manage Share

Manage a share with Manila.

../examples/shared_file_system/shares.py

Unmanage Share

Unmanage a share from Manila.

../examples/shared_file_system/shares.py