105 Commits

Author SHA1 Message Date
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
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
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
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
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
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
Goutham Pacha Ravi
b39bc70093 [api-ref] Correct share metadata API ref
- Clarify the difference between PUT and POST
  on the /shares/<ID>/metadata URL
- Add ref for API to retrieve a single metadata
  item
- Add more notes regarding API behavior

Partial-Bug: #1760644
Change-Id: Ic976e0436584b86938c96db571022e96b4592d1f
2019-07-26 15:13:41 -07:00
shaoxj
2736d4adcc The parameters of 'list shares' are optional
Only 'project_id' in the path is required,
other parameters are not required

Partial-Bug: #1760644
Change-Id: I8f5735f8b828f33c95139e5a963f56b5b6e9105a
2019-04-04 19:03:38 +00:00
Goutham Pacha Ravi
4ffca949c2 [api-ref] Delete unused parameters
TrivialFix
Related-Bug: #1760644
Change-Id: I0eb4282b9162ba8ab83abb925828d5b1cfb333b2
2019-04-04 16:00:08 +00:00
Goutham Pacha Ravi
5bf0337396 [api-ref] De-duplicate name and description parameters
Many resources in manila have user-defined
names and descriptions. All of them have the
same restrictions that apply, so represent them
as the fewest parameters needed.

Having common parameters is easier to maintain in
the documentation.

Change-Id: Ib175e8d78e4240bf40d87a47af2459ac520fb24a
Partial-Bug: #1760644
2019-04-04 16:00:02 +00:00
Goutham Pacha Ravi
f185ff0f44 [api-ref] De-duplicate date and time parameters
Many APIs present information when the resource
in question was 'created_at' and 'updated_at'.

Having common parameters is easier to maintain in
the documentation since the description is the same
across the board.

Change-Id: Ia5d4ac399fe0d7983c61f5c5e0245d0987e97d6a
Partial-Bug: #1760644
2019-04-04 15:59:32 +00:00
Thomas Bechtold
d7140ffe09 [api-ref] Replace "tenant" terminology with "project"
Nowadays "project" and "project_id" are used instead of "tenant" in
the OpenStack world. See [1] and [2].

- Replace "tenant_id" in the API paths to "project_id"
- For most manila resources, the "project_id" in an API response body
  refers to the project that owns the resource. So, create a unified
  parameter and share that across the APIs.
- Fix path variable names, and their order
- Fix usage of "UUID" to refer to project and user IDs
- Fix query parameters

[1] https://docs.openstack.org/operations-guide/ops-projects-users.html
[2] https://developer.openstack.org/api-ref/identity/v3/index.html#projects

Partial-Bug: #1760644
Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com>
Change-Id: I64e4ef8ad258d07c7d80d11a4d015c4b82156722
2019-04-04 08:58:01 -07:00
Zuul
fb4a1b81f4 Merge "[doc][api-ref] snapshot user_id and project_id fields" 2019-04-04 15:45:49 +00:00
Zuul
04d4bbd6a6 Merge "[doc][api-ref] Fix annotation and missing parameters" 2019-03-28 01:18:59 +00:00
Goutham Pacha Ravi
41d243c394 [doc][api-ref] Fix annotation and missing parameters
- Call out the maximum API version in Stein (2.49)
- Add parameter 'cast_rules_to_readonly' to share instance API ref
- Remove parameters 'export_location' and 'export_locations' from
  share instance API ref.
- Add "min_version" and "max_version" annotations on parameters
  where missing.
- Add "versionadded" annotation to APIs
- Add "DEPRECATED" annotation to deprecated APIs along with
  a warning message.

Identical changes to the manage/unmanage APIs are handled
in https://review.openstack.org/#/c/647973/

Partial-Bug: #1760644
Change-Id: I5342cc26d1cbeea8ca3d55868e0f69d525333421
2019-03-27 20:09:29 +00:00
silvacarloss
3fe22863db Add api-ref for manage/unmanage with DHSS=True
This patch updates the manila api-ref adding content to the
manage/unmanage of share servers with DHSS=True feature.

Partial-Bug: #1818758
Change-Id: Ia63762df5cfb2c4b47cf59186ceb571b4c79c31b
2019-03-27 11:45:38 -07: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
zhongjun2
22656d097c Add api ref for access rule metadata feature
Partially-implements: bp metadata-for-access-rule
Change-Id: Icbac8ec427e23f6a781a7d3e682fe4852fa16179
2019-02-14 17:15:31 -08:00
Goutham Pacha Ravi
53918308c8 Separate APIs for share & replica export locations
Users of replicated shares expect to see primary
export locations when viewing information regarding
the share. Because we collate exports of all replicas
within the export locations APIs, it becomes hard for
users to discern which exports belong to the primary
share. For secondary replicas, users would also need
additional information (availability zone, state of the
replication) to work with.

Introduce micro-version 2.47 from which the export locations
API (GET /v2/{tenant_id}/shares/{share_id}/export_locations)
no longer provides export locations of non-active share
replicas. A new API has been introduced to provide export
location details for share replicas, both active and non-active.
(GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations)

The new API provides the replica's state and availability zone
in addition to the export location information.

APIImpact
Implements: bp export-locations-az
Change-Id: I0a1d9dd00b4c13ac01988e30ca2b7d7ce4a747d1
2019-01-07 01:51:16 -08:00
Maurice Schreiber
a84423a1be
[api-ref] Added share servers show and corrected path to details
Change-Id: Idc0fbd9f786b50dd4899258337aa5bcb61c4ab0a
Closes-Bug: #1795604
2018-11-20 11:34:27 +01:00
Zuul
65076ffba8 Merge "Api-ref: Add min_version in the API parameters" 2018-08-04 02:03:25 +00:00
Zuul
3abfbef591 Merge "Retrieve is_default value to fix empty display in CLI" 2018-07-24 19:31:55 +00:00
Zuul
f8360539c0 Merge "Api-ref: change fix `extra-spec-key` key in path" 2018-07-24 18:39:56 +00:00
lijunbo
fb7ac9b8bf Api-ref: Add min_version in the API parameters
TrivialFix:

Change-Id: Idc29bb1744e4760f72be706c03eb6451465d5d59
Closes-bug: #1614955
2018-07-24 23:15:46 +08:00
lijunbo
cf677f2603 Retrieve is_default value to fix empty display in CLI
This bug is from path[1], when we use manila client to create
a share type or share group type, the is_default value is always
empty, so add the is_default value when we create each share type
or share group type.

Closes-bug: #1743941
[1] Ib264d8422fe57701f990cbbf7ea5d1e90b8b0008

Change-Id: Ia8bcb632591fc0b5438847b22ec59c2039ecf5f1
2018-07-24 12:00:58 +08:00
junboli
7b8e6af033 Api-ref: Add missing parameter in the version api
Add missing updated parameter in the version api.
besides, change media-types parameter in body and
required.

Change-Id: Ib0123f16a969ecc98f5dccd2a03eab621e02d8c8
2018-07-17 15:36:41 +00:00
junboli
d3d7e4c69a Api-ref: change fix `extra-spec-key` key in path
TrivialFix:
In the API Unset an extra spec:
/v2/{tenant_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
the key extra-spec-key should be in path, but it is in body, this
is to fix this.

Change-Id: Ia6f01a6bca369ca4b922a45e8e6ece4f583528c7
2018-07-16 14:10:10 +08:00
Zuul
32f7688bce Merge "API: Add `all_tenants` parameter" 2018-06-21 13:34:28 +00:00
shaoxj
cdf1470879 API: Add `all_tenants` parameter
When administrarots query snapshots, share networks, or security
services, they may set ``all_tenants`` to true to get records for all
OpenStack projects.

Change-Id: Ia208dec102295f1021ce5c4da88397e7946c8dba
2018-06-20 07:00:39 +00:00
zhiguo.li
7ebbf8dd75 [Doc] Add 'gateway' and 'mtu' in share network api-ref
The attributes "gateway" and "mtu" are already added in Shared File
Systems API since version 2.18 and 2.20. This patch provides description
about them in response parameters, and adds them to response examples.

Change-Id: I55e3a04453a9edd20b5ca4e1627ae8c3ae5601cc
2018-06-09 22:21:43 +00:00
Maurice Schreiber
1bd9a1e8f4 Add ou to security service
Allows to configure in which organizational unit the share ends up

APIImpact

Change-Id: I70fd4e0ea7898e85dff59a927b3cb086d5e408ac
Needed-By: I77d87c8e6f98054f2f02bc4202c14314ff321964
Partial-Bug: #1696669
2018-04-24 15:04:40 -07:00
junboli
d80596b508 Support filter search for share type API
Add support for extra_specs filter search in type list API.

Change-Id: I43fbef2a32489f2064586a3674eb34329f3503c4
Implements: blueprint support-filter-search-for-share-type
2018-03-25 18:19:38 +08:00
junboli
cc4afb9aad Add docs for quota_class_set API
We have implemented quota-classes-show and quota-classes-update
api, but no api-ref is documented. This patch is to add api-ref
in the docs.

Change-Id: I275ee4fe048607a49368c4f985c055ab3a3bbfb6
Closes-bug: #1751683
2018-02-27 10:10:40 +08:00
junboli
4073c5b3e4 DocImpact: Add MapR-FS native driver
Change-Id: I5dfeb0e9e914d658ab7f76d7695402ab2b1bd829
Closes-Bug: #1657002
2018-01-16 04:38:17 +00:00