Commit Graph

43 Commits

Author SHA1 Message Date
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
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
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
Zuul
50336e2ed4 Merge "Correct json format in api-ref" 2019-08-14 00:21:48 +00:00
zhangqing
fe43d281f9 Correct json format in api-ref
Update symbols in api-ref/samples with correct json format.

Change-Id: If4ea56324e6187e0eaab70503afc5ad7944c9024
2019-08-13 17:05:33 +08: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
Goutham Pacha Ravi
f1042ed49b [api-ref] Update JSON samples for scheduler-stats API
The pools API responses have evolved quite a bit, and
the current state must be reflected in our docs.

Change-Id: I43fb5617911abdab45cce4352dc3377b5b10badf
2019-05-06 17:31:45 -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
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
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
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
ee11996bf9 Api-ref: add show details for share type
Add missing show details for a specified share type
in api ref.

Change-Id: Iffa5cdcb86d9d9d34950fd7e7365b1608f8716bf
2017-12-31 16:12:06 +08:00
Zuul
99fed712e5 Merge "Add count info in /shares and /shares/detail API doc" 2017-12-14 19:14:50 +00:00
zhongjun
506aa1cf9c Add count info in /shares and /shares/detail API doc
Added support for display count info
in share list and detail APIs Doc.

Depends-On: I12c41a46140b04f26565d8934e0326480477c612
Partially-Implements bp add-amount-info-in-list-api
Change-Id: I25c41a46190b04f26565d8934e0326480477c613
2017-12-11 01:04:57 +00:00
zhongjun
470e76d6b3 Add 'description' in share type API Doc
Add attr 'description' in list/create share
type API Doc.

Depends-On: I39705acbfca812b66d74fbd2fee228a7a85bc2d8
Change-Id: I49705acbfca812b66d74fbd2fee228a7a85bc2d7
Partial-Bug: #1724183
2017-11-23 11:13:57 +08:00
junboli
d88ab3cfa2 [Api-ref] update parameters for share types api
1. update share types params
2. correct sample json datas

Closes-bug: #1733753
Change-Id: I804b657cf7b189c25f09864e79a74f76a99252bb
2017-11-22 16:01:09 +00:00
Zuul
3f85754e0a Merge "[Doc] Fix parameters in share network api-ref" 2017-11-13 00:29:21 +00:00
zhongjun
cd77c128b0 Add API document for share group [3/3]
This patch adds a new API document for share group snapshot.

Partial-Bug: 1724716
Change-Id: I832d264eb220027aad32937dc64a6ca428ee55a4
2017-11-02 16:38:16 +00:00
zhongjun
3da1c7d4fb Add API document for share group [2/3]
This patch adds a new API document for share group

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca128ee55a3
2017-11-02 16:35:11 +00:00
zhongjun
9f2f05ffc4 Add API document for share group [1/3]
This patch adds a new API document for share group type.

Partial-Bug: 1724716
Change-Id: I852d264eb120027aad32997dc64a6ca428ee55a4
2017-10-31 10:06:34 +00:00
zhongjun
3dba4d4715 [Doc] Fix parameters in share network api-ref
* Change description parameter 'required' attr value
  from true to false.
* Add neutron_net_id and neutron_subnet_id in share
  network update API request parameter.

Closes-bug: #1727145
Change-Id: Iedde7a2a674a60e760b47d5eb2973f42d79223d1
2017-10-25 03:45:49 +00: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
zhongjun
c60f1fca88 [doc] Add API document for snapshot instances
This patch adds a new API document for snapshot instances.

Change-Id: Ia0cc534e0bfb2ca5e495e575e27e9911c746690b
2017-09-12 05:15:10 +00:00
zhongjun
514c1a05a1 Add API document for share replica
This patch adds a new API document for share replica.

Change-Id: Ia0cc534e0bfb2ca4e485e575e27e9911c746691b
2017-09-07 01:05:08 +00:00
zhongjun
52ea955a89 Add API document for share group quotas
"Quota" APIs now will return two new following keys [1]:

- 'share_groups'
- 'share_group_snapshots'

[1] https://review.openstack.org/#/c/473464/

DocImpact
Partially Implements BluePrint add-share-groups-quota
Change-Id: I497a8e886236cb22fa50abdf2a4a938bb04c655d
2017-08-10 12:07:07 +00:00
Alex Meade
dd630c3929 User Messages
For quite some time, OpenStack services have wanted to be able to send
messages to API end users (by user I do not mean the operator, but the
user that is interacting with the client).

This patch implements basic user messages with the following APIs.
GET /messages
GET /messages/<message_id>
DELETE /messages/<message_id>

Implements the basic /messages resource and tempest tests
The patch is aligned with related cinder patch where possible:
I8a635a07ed6ff93ccb71df8c404c927d1ecef005

DocImpact
APIImpact

Needed-By: I5ffb840a271c518f62ee1accfd8e20a97f45594d
Needed-By: I9ce096eebda3249687268e361b7141dea4032b57
Needed-By: Ic7d25a144905a39c56ababe8bd666b01bc0d0aef

Partially-implements: blueprint user-messages
Co-Authored-By: Jan Provaznik <jprovazn@redhat.com>
Change-Id: Ia0cc524e0bfb2ca5e495e575e17e9911c746690b
2017-07-13 13:05:57 +02:00
Goutham Pacha Ravi
6ba74918d5 Mark 'v1' API deprecated in the versions response
We announced the deprecation of the v1 API on
the mailing list during the mitaka release. While we
continue to support it in code and run CI tests on it,
we should allow the consumers of the versions API to
acknowledge this change.

This patch does not remove the API. It only marks the
version as "DEPRECATED".

[1] http://lists.openstack.org/pipermail/openstack-dev/2016-June/096517.html

Change-Id: If80bddb68a5b92b604ef582fe07eef72c47d6f2f
2017-01-27 14:12:39 +00:00
Clinton Knight
d4a379d083 Implement share revert to snapshot
This commit adds the ability for Manila to revert a
share to the latest available snapshot.

The feature is implemented in the LVM driver, for
testing purposes.

APIImpact
DocImpact
Co-Authored-By: Ben Swartzlander <ben@swartzlander.org>
Co-Authored-By: Andrew Kerr <andrew.kerr@netapp.com>
Implements: blueprint manila-share-revert-to-snapshot
Change-Id: Id497e13070e0003db2db951526a52de6c2182cca
2017-01-17 15:06:01 -05:00
Tom Barron
b213a25c44 Remove NovaNetworkPlugin
Nova network was deprecated in Newton and is no longer supported for
regular deployments in Ocata [1].

Complete the removal of nova network support from manila begun in [2]
by removing support for ''nova_net_id`` in the share networks API,
by removing the corresponding column from the share networks DB model,
and by removing the nova network plugins themselves.  Unit tests for
share network api views were refactored to remove redundancy while
extending coverage to the new microversion introduced with this patch
and maintaining full coverage of earlier microversions.

APIImpact
DocImpact
UpgradeImpact

Partially-implements: bp remove-nova-net-plugin

[1] http://docs.openstack.org/releasenotes/nova/unreleased.html
[2] I846b760fa7c01f7f86768399a2bfad9ced7e57cd

Change-Id: I8b9a559fbea61979f01737ed1dc272276c4f1269
2017-01-13 08:11:16 -05:00
zhongjun
7275aafc9e Add the ability to check the tenant quota in detail
Now the quota-set API only returned single attribute
'limit', this change intends to add a new API
'quota-sets/{project_id}/detail' to retrieve more info
with attributes 'in_use', 'limit', 'reserved'.

APIImpact
Implements: blueprint admin-check-tenant-quota-usage
Depends-On: Ie0eb7d32b7b032ffdb7f7dd47f68841211e7d7a6
Change-Id: I499b099a3ba7704a2108cd15f80ff507e24b7cd0
2016-12-28 10:32:24 +08:00
Ramana Raja
0d4f2ee4e0 add access_key to share_access_map
For backends with internal authentication system,
e.g. Ceph, that return ``access_key`` (credential) for
client identities that are granted share access:

* Retrieve ``access_key`` as return value of driver's
  update_access()

* Store ``access_key`` in ShareAccessMapping model

* Expose it in access_list API

APIImpact

DocImpact

Partially implements bp auth-access-keys

Co-Authored-By: John Spray <jspray@redhat.com>

Change-Id: I486064f117cf3001dba7735ca92a7d89aee3ce5b
2016-08-22 20:41:19 +05:30
Daniel Gonzalez
3e86e3deac Migrate API reference into tree
The API Documentation team has requires [1] that
projects maintain their api-reference in-tree and
build it to the developer.openstack.org website.

This version of the API reference uses os-api-ref
and compiles API documentation close to that of
the OpenStack compute service (nova).

Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com>

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

Implements: bp move-manila-api-reference-in-tree
Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-07-25 15:55:00 +00:00