Commit Graph

15 Commits

Author SHA1 Message Date
ashrod98 5b3c29548f [DOC] Add snapshot metadata to user guide
Add code block for share snapshot create, list,
set and unset to user guide.

Closes-Bug: 2058941
Change-Id: Ibed2063a92a9f338553f1db879c45545fcdbf2ee
2024-03-25 15:52:15 +00:00
silvacarloss 0f82690ddd Allow restricting access rules fields and deletion
Access rules rules allow API will now take three additional
parameters:

- lock_visibility: when True, only services, administrators and
  the same user will be able to see the content of ``access_to`` and
  access_key.

- lock_deletion: when True, the access rule will be locked for
  deletion. Only services, administrators or the user that placed
  the lock will be able to drop the access rule.

- lock_reason: a reason for the lock. This parameter should only
  be provided in the presence of at least one of the former
  parameters.

In order to delete an access rule that is currently locked, the
requester will need to specify ``unrestrict=True`` in the request.

In case a service placed the restrictions, only the own service or
the system administrator will be able to release it.

This change also implements filters to the access list API. It is
now possible to filter access rules based on `access_to`,
`access_type`, `access_level` and `access_key`.

DocImpact

Change-Id: Iea422c9d6bc99a81cd88c5f4b7055d6a1cf97fdc
2023-08-24 14:53:06 -03:00
Goutham Pacha Ravi f641577d8a Resource Locks: Support for share deletion lock
Add CRUD APIs for resource locks with support
for preventing deletion of shares (applies to
soft-deletions and unmanage operations as well).

Change-Id: I146bc09e4e8a39797e22458ff6860346e11e592e
Implements: bp/allow-locking-shares-against-deletion
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2023-08-18 10:47:25 -07:00
Zuul c976f041dd Merge "[DOC] Add doc for Scheduler Hints" 2023-06-10 17:52:40 +00:00
Nahim Alves de Souza 21356fee2d [DOC] Add doc for Scheduler Hints
Closes-bug: #2008029
Change-Id: Icfdba020267bc1270f7d581b635730f20d99135e
2023-06-09 11:15:44 +00:00
MelloCaique e9f4bf7474 [DOC] Add doc for Share Transfer
Change-Id: Id60a0e009320a1e7b7ae7a84faf76c8bc3a50828
2023-06-02 14:07:44 +00:00
debeltrami c4617f4fff [DOC] Add admin and user documentation for share revert to snapshot
This patch adds the admin and user documentation for share revert to
the latest available snapshot.

Change-Id: Id35b99fdb47bb9de38f42034818fb4a29370bf36
Closes-Bug: #1657322
2020-09-24 15:40:14 +00:00
Douglas Viroel 56a6b39aa0 Improve IPv6 documentation for access rules
This patch improves the access rules API documentation
to include IPv6 information that was missing.
It includes a note on user guide and changes an access list
example to IPv6.

Change-Id: I5a9ff4e3c8a70cb0b14caa39f5f17740b17b719a
Closes-Bug: #1705045
Signed-off-by: Douglas Viroel <viroel@gmail.com>
2020-09-10 10:19:50 -03:00
Goutham Pacha Ravi bce5429d1a Update "Create and manage shares" doc
This is the basic user guide for manila:

- Update examples and outputs
- Add limits and metadata examples
- Add descriptions about common concepts
  including share type extra specifications
- Add contents for easy navigation

Change-Id: Idf374866a63e0da2c4af3157ac5f471af6173d5e
Closes-Bug: #1652375
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-09-08 23:58:01 +00:00
Douglas Viroel e2e764d976 Update access rules documentation for user guide
Updates user guide documentation to provide metadata info
to an access rules. Also add two new operations for access
rule metadata: 'access-metadata set' and 'access-metadata unset'

Change-Id: Ib6008c9dd4284b8c3434ffce61fb74f1db6c3d35
Closes-Bug: #1782859
2020-08-20 19:55:32 -03:00
Goutham Pacha Ravi f8ddadba8d [doc][api-ref] snapshot user_id and project_id fields
Patch addresses a documentation gap.

Change-Id: Ia07218201322fa222474e39e3b44d9dcd68c60aa
Closes-Bug: #1594372
2019-03-22 17:59:02 +00:00
Tom Barron 78dda3ab8e Purge doc of references to nova net
since support for nova network was removed back in Ocata [1] [2].

Also fix a self-referential link.

[1] 0f33dcf62b

[2] I8b9a559fbea61979f01737ed1dc272276c4f1269

TrivialFix

Change-Id: I7f7fdcbf72c2ed38a9141977a0b48dc3fec2f46e
2017-10-31 04:51:19 -04:00
zhongjun 0d4a317adb [Doc] Add share group in doc
Separate add share group description in other API or CLI echo in
this patch from add share group itself description in other patches:
Added share group iteslf in api-ref [1]
Added share api admin doc [2]
Added share group in driver requirements [3]

[1] I852d264eb120027aad32997dc64a6ca428ee55a4
[2] Ia0cc534e0bfb2ca5e495e575237e9911c746691b
[3] Iedde5a9a774a60e760b47d5eb2973f42d79227d4

Change-Id: Iedde5a9a774a60e760b47d5eb2973f42d79127d3
2017-09-28 14:49:29 +00:00
zhongjun 804b81226c [Doc] Delete consistency group in doc
Since consistency group APIs were removed in 2.31 API version.
Now we delete consistency group description in docs.

Change-Id: I6499ae6c98d9489a257bb20febd6c1ddb9e17b12
2017-09-18 11:29:57 +08:00
Tom Barron 47e3adbbf7 doc migration: user-guide
In accord with the OpenStack documentation migration spec [1],
this patch pulls over material from the centralized User Guide
so that it will not be lost.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partial-Bug: #1706181
Needed-By: Ib0fca0c16e14c05307bfc31ae50c65271b7402f1
Depends-On: Ibe3588c3f4560c037cf109058fc357234e70a846
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: I04237021943bb7501acb9cfb7252be2cbf07ac4b
2017-08-24 17:55:59 +00:00