df5f987c1e
Introduce Shares class with basic methods including list, create, delete, get and update to shared file system storage service. [1] https://tree.taiga.io/project/ashrod98-openstacksdk-manila-support/us/11?kanban-status=2360120 Change-Id: Ia7d7c88eb55307296336e2f04a00e92bdca6f8ae
149 lines
6.5 KiB
Python
149 lines
6.5 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||
# not use this file except in compliance with the License. You may obtain
|
||
# a copy of the License at
|
||
#
|
||
# http://www.apache.org/licenses/LICENSE-2.0
|
||
#
|
||
# Unless required by applicable law or agreed to in writing, software
|
||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||
# License for the specific language governing permissions and limitations
|
||
# under the License.
|
||
|
||
from openstack import proxy
|
||
from openstack import resource
|
||
from openstack.shared_file_system.v2 import (
|
||
availability_zone as _availability_zone)
|
||
from openstack.shared_file_system.v2 import share as _share
|
||
|
||
|
||
class Proxy(proxy.Proxy):
|
||
|
||
def availability_zones(self):
|
||
"""Retrieve shared file system availability zones
|
||
|
||
:returns: A generator of availability zone resources
|
||
:rtype: :class:`~openstack.shared_file_system.v2.
|
||
\availability_zone.AvailabilityZone`
|
||
"""
|
||
return self._list(_availability_zone.AvailabilityZone)
|
||
|
||
def shares(self, details=True, **query):
|
||
"""Lists all shares with details
|
||
|
||
:param kwargs query: Optional query parameters to be sent to limit
|
||
the shares being returned. Available parameters include:
|
||
|
||
* status: Filters by a share status
|
||
* share_server_id: The UUID of the share server.
|
||
* metadata: One or more metadata key and value pairs as a url
|
||
encoded dictionary of strings.
|
||
* extra_specs: The extra specifications as a set of one or more
|
||
key-value pairs.
|
||
* share_type_id: The UUID of a share type to query resources by.
|
||
* name: The user defined name of the resource to filter resources
|
||
by.
|
||
* snapshot_id: The UUID of the share’s base snapshot to filter
|
||
the request based on.
|
||
* host: The host name of the resource to query with.
|
||
* share_network_id: The UUID of the share network to filter
|
||
resources by.
|
||
* project_id: The ID of the project that owns the resource.
|
||
* is_public: A boolean query parameter that, when set to true,
|
||
allows retrieving public resources that belong to
|
||
all projects.
|
||
* share_group_id: The UUID of a share group to filter resource.
|
||
* export_location_id: The export location UUID that can be used
|
||
to filter shares or share instances.
|
||
* export_location_path: The export location path that can be used
|
||
to filter shares or share instances.
|
||
* name~: The name pattern that can be used to filter shares, share
|
||
snapshots, share networks or share groups.
|
||
* description~: The description pattern that can be used to filter
|
||
shares, share snapshots, share networks or share groups.
|
||
* with_count: Whether to show count in API response or not,
|
||
default is False.
|
||
* limit: The maximum number of shares to return.
|
||
* offset: The offset to define start point of share or share group
|
||
listing.
|
||
* sort_key: The key to sort a list of shares.
|
||
* sort_dir: The direction to sort a list of shares. A valid value
|
||
is asc, or desc.
|
||
|
||
:returns: Details of shares resources
|
||
:rtype: :class:`~openstack.shared_file_system.v2.
|
||
share.Share`
|
||
"""
|
||
base_path = '/shares/detail' if details else None
|
||
return self._list(_share.Share, base_path=base_path, **query)
|
||
|
||
def get_share(self, share_id):
|
||
"""Lists details of a single share
|
||
|
||
:param share: The ID of the share to get
|
||
:returns: Details of the identified share
|
||
:rtype: :class:`~openstack.shared_file_system.v2.
|
||
share.Share`
|
||
"""
|
||
return self._get(_share.Share, share_id)
|
||
|
||
def delete_share(self, share, ignore_missing=True):
|
||
"""Deletes a single share
|
||
|
||
:param share: The ID of the share to delete
|
||
:returns: Result of the ``delete``
|
||
:rtype: ``None``
|
||
"""
|
||
self._delete(_share.Share, share,
|
||
ignore_missing=ignore_missing)
|
||
|
||
def update_share(self, share_id, **attrs):
|
||
"""Updates details of a single share.
|
||
|
||
:param share: The ID of the share to update
|
||
:pram dict attrs: The attributes to update on the share
|
||
:returns: the updated share
|
||
:rtype: :class:`~openstack.shared_file_system.v2.
|
||
share.Share`
|
||
"""
|
||
return self._update(_share.Share, share_id, **attrs)
|
||
|
||
def create_share(self, **attrs):
|
||
"""Creates a share from attributes
|
||
|
||
:returns: Details of the new share
|
||
:param dict attrs: Attributes which will be used to create
|
||
a :class:`~openstack.shared_file_system.v2.
|
||
shares.Shares`,comprised of the properties
|
||
on the Shares class. 'size' and 'share'
|
||
are required to create a share.
|
||
:rtype: :class:`~openstack.shared_file_system.v2.
|
||
share.Share`
|
||
"""
|
||
return self._create(_share.Share, **attrs)
|
||
|
||
def wait_for_status(self, res, status='active', failures=None,
|
||
interval=2, wait=120):
|
||
"""Wait for a resource to be in a particular status.
|
||
:param res: The resource to wait on to reach the specified status.
|
||
The resource must have a ``status`` attribute.
|
||
:type resource: A :class:`~openstack.resource.Resource` object.
|
||
:param status: Desired status.
|
||
:param failures: Statuses that would be interpreted as failures.
|
||
:type failures: :py:class:`list`
|
||
:param interval: Number of seconds to wait before to consecutive
|
||
checks. Default to 2.
|
||
:param wait: Maximum number of seconds to wait before the change.
|
||
Default to 120.
|
||
:returns: The resource is returned on success.
|
||
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
|
||
to the desired status failed to occur in specified seconds.
|
||
:raises: :class:`~openstack.exceptions.ResourceFailure` if the resource
|
||
has transited to one of the failure statuses.
|
||
:raises: :class:`~AttributeError` if the resource does not have a
|
||
``status`` attribute.
|
||
"""
|
||
failures = [] if failures is None else failures
|
||
return resource.wait_for_status(
|
||
self, res, status, failures, interval, wait)
|