Files
openstacksdk/doc/source/user/guides/shared_file_system.rst
tutkuna 1ca0f0c3f3 Add share instances to shared file systems
Change-Id: I7e1f8bd4218858a8e483a402b3906706840a47a5
Co-Authored-By: Reynaldo Bontje <rey.bontje80@gmail.com>
2023-03-28 00:51:05 +00:00

60 lines
1.6 KiB
ReStructuredText

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 :doc:`connect` user
guide. This will provide you with the ``conn`` variable used in the examples
below.
.. contents:: Table of Contents
:local:
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.
.. literalinclude:: ../examples/shared_file_system/availability_zones.py
:pyobject: list_availability_zones
Share Instances
---------------
Administrators can list, show information for, explicitly set the state of,
and force-delete share instances.
.. literalinclude:: ../examples/shared_file_system/share_instances.py
:pyobject: share_instances
Get Share Instance
------------------
Shows details for a single share instance.
.. literalinclude:: ../examples/shared_file_system/share_instances.py
:pyobject: get_share_instance
Reset Share Instance Status
---------------------------
Explicitly updates the state of a share instance.
.. literalinclude:: ../examples/shared_file_system/share_instances.py
:pyobject: reset_share_instance_status
Delete Share Instance
---------------------
Force-deletes a share instance.
.. literalinclude:: ../examples/shared_file_system/share_instances.py
:pyobject: delete_share_instance