200 Commits

Author SHA1 Message Date
zhu.boxiang
8faa968ed5 DOC: fix the uri for share group types
1. Use group-specs instead of group_specs for share group type.
2. Use access instead of share_type_access for share group types.

Change-Id: Ie5ac1b927ca4a01269f1c255cee52bdf2ebf7c69
2022-04-21 17:28:10 +08:00
Maurice Escher
aa9f03d542 Add missing updated_at field in share-instance show.
Share_replicas (which are internally share_instances with replica_state
not null) have "updated_at" in its view/API call. However same field is
missing in share-instance show command.

Closes-Bug: #1965122

Change-Id: Ia69f3615d82e0044e3e9f81556dc8355637ef146
2022-04-06 12:38:39 +00:00
Zuul
b6b1f41664 Merge "[api-ref] Add request examples for share replica APIs" 2022-03-10 14:10:29 +00:00
haixin
d51eb05c05 Update micversion to API2.69, Manila share support Recycle Bin
Add support share Recycle Bin, the end user can soft delete
share to Recycle Bin, and can restore the share within 7 days,
otherwise the share will be deleted automatically.

DocImpact
APIImpact
Partially-Implements: blueprint manila-share-support-recycle-bin

Change-Id: Ic838eec5fea890be6513514053329b1d2d86b3ba
2022-02-19 02:02:06 +08:00
Kiran Pawar
9da023eeb5 Add support of scheduler_hints in share replica create
The OnlyHostFilter added for share creation can be extended to use in
share replica creation using scheduler-hints.

e.g. manila share-replica-create share_id \
	--scheduler-hints "only_host=host@backend#pool"

OnlyHostFilter (https://review.opendev.org/c/openstack/manila/+/813293)

Depends-on: I603434cac246e2c0946672d3f0fe469ed5423fa4
Closes-Bug: #1950313
Change-Id: I2e6d8709fc02df16622bdc910127fa489835db38
2022-02-15 03:21:20 +00:00
Zuul
a340217965 Merge "[DOC] Incorrect response code for share network creation" 2022-02-08 01:43:21 +00:00
archanaserver
96823254c1 [DOC] Incorrect response code for share network creation
The response code of share network creation operation is
mentioned 202 while it should be 200.

Closes-Bug: #1958072

Change-Id: I27c24c71a7c388033fbdf206c2d3e8004839d98a
2022-01-31 08:52:31 +00:00
Zuul
d1509256da Merge "OnlyHostFilter allows user to specify host during share create." 2022-01-14 04:38:59 +00:00
Fabio Oliveira
603e484fb6 api-ref: Add share instances by share endpoint
The endpoint for /shares/{share_id}/instances was missing for the
share section.
This patch adds the section and update the existing one on
v2/shate_instances.

Closes-Bug: 1952673
Change-Id: Ie8412379c20528575d2e67485ce955bcf8c13eee
2022-01-11 14:57:05 -03:00
Kiran Pawar
746fb7e2df OnlyHostFilter allows user to specify host during share create.
e.g. manila create NFS 1 --name Share1 --share-network net1 \
--scheduler_hint="only_host=host1@generic1#GENERIC1"

Since there is no way to create share server in manila, we can use a
workaround of creating first share on specific host
(e.g. host@backend#pool). This will then create the share server
automatically on that host and admin can use idle host when other
hosts are overloaded.

New microversion 2.67 introduced.

DocImpact

Closes-Bug: #1946462
Change-Id: I603434cac246e2c0946672d3f0fe469ed5423fa4
2022-01-10 10:06:27 +00:00
Zuul
37c41e57cf Merge "Support group specs search for share group type API" 2021-12-21 23:26:46 +00:00
Victoria Martinez de la Cruz
3a1e23801f Support group specs search for share group type API
Add support for group_specs filter search in share group type list API.

Implements: blueprint support-group-spec-search-share-group-type-api
Change-Id: I10caed1d524614a74a75e8f856b0579ab11dc4b5
2021-12-09 17:26:11 +00:00
Zuul
c09a5f08c4 Merge "Add api-ref for security service update" 2021-12-08 15:21:06 +00:00
silvacarloss
40da25f286 Add api-ref for security service update
Updates the API reference to fit into the changes merged in the
add/update security service in share networks feature.

Change-Id: Id7dd45dc23c41c1ade28b042f87b216142b8a062
2021-12-06 19:07:13 -03:00
tutkuna
d4c0f4a907 [api-ref] Fix datatype of cast_rules_to_readonly
Fixing cast_rules_to_readonly type from string to boolean
for share instances and share replicas.

The API-REF had the wrong type for these fields.

Closes-Bug: #1948717

Change-Id: Ie8defe1fcb03bced9887ba1b41d5b062ba477924
2021-12-02 00:39:34 +00:00
haixin
fb1aaa93ff [doc] update doc about query user message
Change-Id: I22d35ac31f024712a2bdd6df307682de04301c22
2021-11-10 11:37:42 +08:00
Goutham Pacha Ravi
1e6967c95b [api-ref] Add request examples for share replica APIs
Samples illustrate how to send POST requests to the
/v2/share-replicas/{replica_id}/action to initiate
share replica promotion and resync actions.

Change-Id: I6c4890909406668322e387466620d591f161a93a
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-11-02 12:23:11 -07:00
Zuul
dd8f1aeee8 Merge "Fix api-ref for access rules" 2021-09-28 17:46:32 +00:00
Chuan Miao
7e7ec7337c Add Share Affinity/Anti-Affinity Scheduler Filters
This patch implements hard affinity and anti-affinity filter for
manila scheduler. Users can specify affinity/anti-affinity share
ids to the field "share.scheduler_hints.same_host" or
"share.scheduler_hints.different_host" in the request payload
when creating a manila share. The scheduler_hints are stored as
share metadata. The filter properties are populated from this
metadata during share migration and so filters will be applied
for share migration as well.

Both fields can be a single share UUID or multiple uuids
separated by comma. For example,

`{
    "share": {
        "scheduler_hints": {
            "same_host": "share_uuid_1,share_uuid_2",
            "different_host": "share_uuid_3"
        }
    }
}`

Implements: bp/affinity-antiaffinity-filter

Change-Id: Ic42d8a0c1d22e77ae64e0ca014607b28fd336467
Co-authored-by: Maurice Escher <maurice.escher@sap.com>
2021-09-03 08:58:46 +02:00
Goutham Pacha Ravi
18741fe632 Fix api-ref for access rules
The key for access rule metadata in the API
request or response is just "metadata".

The "access_key" in /share-access-rules
endpoint responses doesn't need to specify
a min-version since its present in all API
versions that the endpoint itself is supported
with.

TrivialFix

Change-Id: I66ac3804f22d70ad673eb7185e5e7eb08843c811
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-08-31 21:10:56 +00:00
haixin
cdbc428b69 Extend share will go through scheduler
Add an force parameter to the API layer that lets the user choose
whether to go through the scheduler or not, which is boolean.and
default is False,set True means extend share directly, set False
means extend share will go through scheduler.
Add an new min_version 2.64 to extend share api. force parameter
only support min_version >= 2.64.

Closes-Bug:#1855391
Change-Id: I6da36a687a37c78a7fb7d3f252318d03d4a05133
2021-08-27 05:35:45 +00:00
Zuul
3457fc62f9 Merge "Update api-ref documentation" 2021-07-28 22:25:39 +00:00
ashrod98
bf2c40e3ff Update api-ref documentation
Adds message id, expires_at, created_at parameters to user messages in
response body.

Updates share_types response body to account for extra_specs object including
snapshot_support, create_from_snapshot_support, mount_snapshot_support,
revert_to_snapshot_support, replication_type, and
driver_handles_share_servers.

Change-Id: I408dcf5fdbf2f12eb1dc0ce80232d4e710cef765
2021-07-28 14:21:20 +00:00
kpdev
df3382d960 Add documentation for per share gigabytes quotas
Update documentation to fit into the new manila quota key:
- `per_share_gigabytes`

Closes-Bug: #1918959
Change-Id: If0bbac2d153348f26f5b60cba3eb492926aa53c5
2021-05-24 09:18:31 +02:00
Fabio Oliveira
95d60c0d48 Fix API reference of share snapshot creation
Changes HTTP response status code from 200 to 202.

Closes-Bug: #1928055
Change-Id: Iae7787cc4f8d8306649a24e619024a9ca9bb20f7
2021-05-19 15:34:25 -03:00
Zuul
ad4315eb36 Merge "Add api reference for share server migration" 2021-04-07 11:33:44 +00:00
Zuul
50401393c7 Merge "[api-ref] Fix incorrect parameters" 2021-03-23 01:34:21 +00:00
Goutham Pacha Ravi
2eab5de885 [api-ref] Fix incorrect parameters
Some of the response parameters for the
/shares APIs were either incorrect or
out of date. These inconsistencies
were discovered by Ashley Rodriguez
when working on the openstacksdk
integration for these APIs.

Change-Id: I475a7e4df2ee6924699b97c196f1958d4885c01d
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-02-12 18:17:24 -08:00
Goutham Pacha Ravi
de29398128 [doc] remove project_id from api endpoints
As of API version 2.60, a project_id is no
longer needed in the API URLs.

Fix the docs to indicate that.

Also fix up a few quota parameters that use
project_id in a different place in the API path.

Change-Id: I24b32c8521805a7d67d512d36d644c0f07c532ea
Implements: bp remove-project-id-from-urls
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-02-09 21:59:07 -08:00
Maurice Escher
aa62a8090e
add additional driver data to migration get progress view
new field `details` is introduced with microversion 2.59

Change-Id: I91d455c585ff546cc65e57e8560f126a280eac8d
Closes-Bug: #1902854
2021-01-25 09:50:35 +01:00
silvacarloss
256c18d6c2 Add api reference for share server migration
Add documentation to the share server migration APIs introduced
during Victoria release.

Partial-bug: #1897903

Change-Id: I13d13c38a3869929bbfdf8083529a597d7982a16
2021-01-06 09:04:23 -03:00
silvacarloss
136a89937c Update share replicas export location API ref
Moves the share replica export location API reference out of the
experimental features documentation.

Change-Id: I16cbad169d0c4f89428f17a317840750966d240f
2020-11-06 09:05:36 -03:00
Zuul
86fdfee94a Merge "Documentation for Share Migration Ocata Improvements." 2020-09-23 14:59:13 +00:00
vrushti
295adb71bf Documentation for Share Migration Ocata Improvements.
Implemented several improvements to share migration in documentation
according to https://review.opendev.org/#/c/406305/

Summary of changes:

 - Add driver-assisted mandatory parameters.
 - Removed previous API documentation because support for them isn't
   there anymore after the backwards incompatible changes were
   made via https://review.opendev.org/#/c/406305/.
 - Add force-host-assisted migration.

Change-Id: I6d446b4037a3a9991e375f0a8bfb1f6edce09c1f
Closes-Bug: #1658230
2020-09-22 19:24:16 -03:00
Zuul
6a05a2d922 Merge "Update api-ref for share groups graduation" 2020-09-22 20:16:34 +00:00
silvacarloss
05d696c48b Update share replicas api-ref
Moves the share replicas API session out of the experimental
features documentation session.

Change-Id: I19031e0c3db3b0f678b3055d21161e7c5bb52ea7
2020-09-21 16:14:24 +00:00
silvacarloss
a5112a3f10 Update api-ref for share groups graduation
Moves the share group APIs documentation out of the experimental
session.

Closes-Bug: #1659025
Change-Id: Ib1970c34b6068fa7ef4f09027817c647091d6668
2020-09-21 15:43: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
Zuul
5d2294268a Merge "Update Share types api-ref" 2020-08-21 22:58:24 +00:00
Zuul
a6f86e53c5 Merge "Add api-ref for share network subnets" 2020-08-20 22:43:47 +00:00
silvacarloss
c650b63d33 Updates the API reference for some share operations
Added missing `user_id` field to the response of share create,
show and manage operations.

Change-Id: I1e7244185d44bff2df85b09c4566836a26c84376
Closes-Bug: #1821837
2020-08-13 12:53:50 +00:00
Goutham Pacha Ravi
271214a051 Update Share types api-ref
Was missing a query parameter (is_public)
and some information on an existing query
parameter (extra-specs)

Change-Id: Ib70e08c963cf1f583ab6d5fbae6a69aa3593980a
Closes-Bug: #1816486
2020-08-06 17:06:21 -07:00
silvacarloss
de62a36e3f Add api-ref for share network subnets
This patch updates the API reference to fit into the changes that
were done in order to implement share networks with multiple
subnets.

Change-Id: I667a26cbf9ea93509718b71dadc8fb304fbca855
Partial-Bug: #1843953
2020-08-06 21:58:37 +00:00
Maurice Escher
1660385588
[api-ref] fix typo
Change-Id: Ifd5ada2b467994b9b8efca5016a7c746ab704719
2020-07-03 17:30:02 +02:00
Goutham Pacha Ravi
34978c6285 [api-ref] Fix HTTP method on the manage API
Should be a POST and not a GET

Change-Id: Id35e80ed9ea8d7bb224805f9c5026d8199ef2b0d
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-06-22 17:52:15 -07:00
Zuul
e5f8763e8a Merge "Add documentation for share replica quotas" 2020-06-09 14:13:02 +00:00
silvacarloss
7bc4886a03 Add documentation for share replica quotas
Update documentation to fit into the new manila quota keys:
- `share_replicas`
- `replica_gigabytes`

Closes-Bug: #1881921
Change-Id: I91fa2222743da06557ceb52fcbae0f8928d0752c
2020-06-03 14:28:58 +00:00
Andreas Jaeger
9296424e44 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I6635fbab5d4cf60be6bc317061cdac2118cebc25
2020-05-21 13:01:11 +02:00
Douglas Viroel
6c47b193b0 Create share from snapshot in another pool or backend
This patch enables the creation of a share from snapshot
specifying another pool or backend. In the scheduler, a
new filter and weigher were implemented in order to consider
this operation if the backend supports it. Also, a new
field called 'progress' was added in the share and share
instance. The 'progress' field indicates the status
of the operation create share from snapshot (in percentage).
Finally, a new periodic task was added in order to constantly
check the share status.

Partially-implements: bp create-share-from-snapshot-in-another-pool-or-backend

DOCImpact
Change-Id: Iab13a0961eb4a387a502246e5d4b79bc9046e04b
Co-authored-by: carloss <ces.eduardo98@gmail.com>
Co-authored-by: dviroel <viroel@gmail.com>
2020-04-09 11:15:22 -03:00
haixin
01e89ae26b Add update share-type API to Share Types
Currently, only the name and description and public access of share-type
is set when the share-type is created, and not allowed to be edited
after the share-type is created. We can only set extra spec for share-type.
But not name or description or public access for share-type.

Co-Authored-By: Brin Zhang <zhangbailin@inspur.com>
APIImpact

Implements: blueprint update-share-type-name-or-description
Change-Id: I4c7bdd601d48b40c01639b5089d4bff259a7b3af
2019-09-10 14:43:07 -07:00