diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 7938e791d0..fd74c7d8a0 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -318,6 +318,13 @@ service_zone_query: in: query required: false type: string +share_group_id_query: + description: | + The UUID of a share group to filter resource. + in: query + required: false + type: string + min_version: 2.31 share_network_id_5: description: | The UUID of the share network. @@ -2398,6 +2405,20 @@ share_force_delete: in: body required: true type: string +share_group_id: + description: | + The UUID of the share group. + in: body + required: True + type: string + min_version: 2.31 +share_group_id_request: + description: | + The UUID of the share group. + in: body + required: False + type: string + min_version: 2.31 share_id_2: description: | The UUID of the share from which the share diff --git a/api-ref/source/samples/pools-list-detailed-response.json b/api-ref/source/samples/pools-list-detailed-response.json index 28de53a862..4387db9ac2 100644 --- a/api-ref/source/samples/pools-list-detailed-response.json +++ b/api-ref/source/samples/pools-list-detailed-response.json @@ -11,6 +11,9 @@ "total_capacity_gb": "unknown", "driver_handles_share_servers": true, "server_pools_mapping": {}, + "share_group_stats": { + "consistent_snapshot_support": null + }, "pools": null, "vendor_name": "Open Source", "reserved_percentage": 0, diff --git a/api-ref/source/samples/share-create-request.json b/api-ref/source/samples/share-create-request.json index 62e6af8bb6..09b9835c29 100644 --- a/api-ref/source/samples/share-create-request.json +++ b/api-ref/source/samples/share-create-request.json @@ -4,6 +4,7 @@ "share_type": null, "share_proto": "nfs", "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", + "share_group_id": null, "name": "share_London", "snapshot_id": null, "is_public": true, diff --git a/api-ref/source/samples/share-create-response.json b/api-ref/source/samples/share-create-response.json index 53c16af78e..423a5d12c1 100644 --- a/api-ref/source/samples/share-create-response.json +++ b/api-ref/source/samples/share-create-response.json @@ -20,6 +20,7 @@ } ], "share_network_id": null, + "share_group_id": null, "export_locations": [], "share_proto": "NFS", "host": null, diff --git a/api-ref/source/samples/share-manage-response.json b/api-ref/source/samples/share-manage-response.json index a1797b5c37..a3fbbdb850 100644 --- a/api-ref/source/samples/share-manage-response.json +++ b/api-ref/source/samples/share-manage-response.json @@ -14,6 +14,7 @@ "share_network_id": null, "export_locations": [], "share_server_id": null, + "share_group_id": null, "snapshot_id": null, "id": "00137b40-ca06-4ae8-83a3-2c5989eebcce", "size": null, diff --git a/api-ref/source/samples/share-show-response.json b/api-ref/source/samples/share-show-response.json index f499e1cad1..a8d0969f8c 100644 --- a/api-ref/source/samples/share-show-response.json +++ b/api-ref/source/samples/share-show-response.json @@ -14,6 +14,7 @@ "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", "export_locations": [], "share_server_id": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef", + "share_group_id": null, "snapshot_id": null, "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", "size": 1, diff --git a/api-ref/source/samples/share-update-response.json b/api-ref/source/samples/share-update-response.json index 6e45fe0053..1cec3b7017 100644 --- a/api-ref/source/samples/share-update-response.json +++ b/api-ref/source/samples/share-update-response.json @@ -14,6 +14,7 @@ "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", "export_locations": [], "share_server_id": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef", + "share_group_id": null, "snapshot_id": null, "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", "size": 1, diff --git a/api-ref/source/samples/shares-list-detailed-response.json b/api-ref/source/samples/shares-list-detailed-response.json index 8e8151b19d..217c1df8ee 100644 --- a/api-ref/source/samples/shares-list-detailed-response.json +++ b/api-ref/source/samples/shares-list-detailed-response.json @@ -15,6 +15,7 @@ "share_network_id": "f9b2e754-ac01-4466-86e1-5c569424754e", "export_locations": [], "share_server_id": "87d8943a-f5da-47a4-b2f2-ddfa6794aa82", + "share_group_id": null, "snapshot_id": null, "id": "f45cc5b2-d1bb-4a3e-ba5b-5c4125613adc", "size": 1, diff --git a/api-ref/source/shares.inc b/api-ref/source/shares.inc index 5137fd163a..579d6cf7a1 100644 --- a/api-ref/source/shares.inc +++ b/api-ref/source/shares.inc @@ -114,6 +114,7 @@ Request - share_network_id: share_network_id - project_id: project_id_6 - is_public: is_public + - share_group_id: share_group_id_query - export_location_id: export_location_id_query - export_location_path: export_location_path_query - name~: name_inexact_query @@ -168,6 +169,7 @@ Request - share_network_id: share_network_id - project_id: project_id_6 - is_public: is_public + - share_group_id: share_group_id_query - export_location_id: export_location_id_query - export_location_path: export_location_path_query - name~: name_inexact_query @@ -196,6 +198,7 @@ Response parameters - host: host_1 - access_rules_status: access_rules_status - is_public: is_public + - share_group_id: share_group_id - task_state: task_state - snapshot_support: snapshot_support - name: name_5 @@ -255,6 +258,7 @@ Response parameters - host: host_9 - access_rules_status: access_rules_status - is_public: is_public + - share_group_id: share_group_id - task_state: task_state - snapshot_support: snapshot_support - name: name_5 @@ -298,6 +302,7 @@ Request - volume_type: volume_type - snapshot_id: snapshot_id_request - is_public: is_public + - share_group_id: share_group_id_request - metadata: metadata - share_network_id: share_network_id_2 - availability_zone: availability_zone @@ -330,6 +335,7 @@ Response parameters - volume_type: volume_type - snapshot_id: snapshot_id_share_response - is_public: is_public + - share_group_id: share_group_id - metadata: metadata - share_network_id: share_network_id - availability_zone: availability_zone_1 @@ -407,6 +413,7 @@ Response parameters - description: description_5 - host: host_9 - is_public: is_public + - share_group_id: share_group_id - snapshot_support: snapshot_support - name: name_5 - created_at: created_at_4 @@ -483,6 +490,7 @@ Response parameters - host: host_9 - access_rules_status: access_rules_status - is_public: is_public + - share_group_id: share_group_id - task_state: task_state - snapshot_support: snapshot_support - name: name_5 diff --git a/doc/source/admin/shared-file-systems-crud-share.rst b/doc/source/admin/shared-file-systems-crud-share.rst index 407cd5cd40..bb854d5366 100644 --- a/doc/source/admin/shared-file-systems-crud-share.rst +++ b/doc/source/admin/shared-file-systems-crud-share.rst @@ -141,6 +141,7 @@ protocol, and size 1 GB: | availability_zone | None | | share_network_id | None | | share_server_id | None | + | share_group_id | None | | host | | | access_rules_status | active | | snapshot_id | None | @@ -184,6 +185,7 @@ New share ``Share2`` should have a status ``available``: | | id = 44933f59-e0e3-4483-bb88-72ba7c486f41 | | | share_instance_id = a5fb1ab7-0bbd-465b-ac14-05706294b6e9 | | share_server_id | None | + | share_group_id | None | | host | manila@paris#epsilon | | access_rules_status | active | | snapshot_id | None | @@ -288,6 +290,7 @@ share type, NFS shared file system protocol, and size 1 GB: | availability_zone | None | | share_network_id | c895fe26-92be-4152-9e6c-f2ad230efb13 | | share_server_id | None | + | share_group_id | None | | host | | | access_rules_status | active | | snapshot_id | None | @@ -347,6 +350,7 @@ status share should have status ``available``: | | id = 602d0f5c-921b-4e45-bfdb-5eec8a89165a | | | share_instance_id = fe874928-39a2-441b-8d24-29e6f0fde965 | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | manila@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -399,6 +403,7 @@ the share if you need: | | id = 602d0f5c-921b-4e45-bfdb-5eec8a89165a | | | share_instance_id = fe874928-39a2-441b-8d24-29e6f0fde965 | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | manila@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -531,6 +536,7 @@ include ``available``, ``error``, ``creating``, ``deleting``, | | id = 602d0f5c-921b-4e45-bfdb-5eec8a89165a | | | share_instance_id = fe874928-39a2-441b-8d24-29e6f0fde965 | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | manila@london#LONDON | | access_rules_status | active | | snapshot_id | None | diff --git a/doc/source/admin/shared-file-systems-manage-and-unmanage-share.rst b/doc/source/admin/shared-file-systems-manage-and-unmanage-share.rst index 4fdf2172b7..e0bb6450c8 100644 --- a/doc/source/admin/shared-file-systems-manage-and-unmanage-share.rst +++ b/doc/source/admin/shared-file-systems-manage-and-unmanage-share.rst @@ -97,6 +97,7 @@ To manage share, run: | availability_zone | None | | share_network_id | None | | share_server_id | None | + | share_group_id | None | | host | manila@paris#shares | | access_rules_status | active | | snapshot_id | None | @@ -140,6 +141,7 @@ Check that the share is available: | | id = 1dd4f0a3-778d-486a-a851-b522f6e7cf5f | | | share_instance_id = 4c8e3887-4f9a-4775-bab4-e5840a09c34e | | share_server_id | None | + | share_group_id | None | | host | manila@paris#shares | | access_rules_status | active | | snapshot_id | None | diff --git a/doc/source/admin/shared-file-systems-share-replication.rst b/doc/source/admin/shared-file-systems-share-replication.rst index 919ae6d4eb..e0db157c64 100644 --- a/doc/source/admin/shared-file-systems-share-replication.rst +++ b/doc/source/admin/shared-file-systems-share-replication.rst @@ -192,6 +192,7 @@ protocol, size and the availability zone. | availability_zone | availability_zone_1 | | share_network_id | None | | share_server_id | None | + | share_group_id | None | | host | | | access_rules_status | active | | snapshot_id | None | @@ -238,6 +239,7 @@ Specify the share ID or name as a parameter. | | id = 6f843ecd-a7ea-4939-86de-e1e01d9e8672 | | | share_instance_id = 38efc042-50c2-4825-a6d8-cba2a8277b28 | | share_server_id | None | + | share_group_id | None | | host | openstack4@zfsonlinux_1#alpha | | access_rules_status | active | | snapshot_id | None | diff --git a/doc/source/admin/shared-file-systems-share-resize.rst b/doc/source/admin/shared-file-systems-share-resize.rst index d4bdd0c426..90794731b4 100644 --- a/doc/source/admin/shared-file-systems-share-resize.rst +++ b/doc/source/admin/shared-file-systems-share-resize.rst @@ -44,6 +44,7 @@ To extend the share and check the result, run: | | id = 1f0e263f-370d-47d3-95f6-1be64088b9da | | | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 | | share_server_id | None | + | share_group_id | None | | host | manila@paris#shares | | access_rules_status | active | | snapshot_id | None | @@ -90,6 +91,7 @@ check the result, run: | | id = 1f0e263f-370d-47d3-95f6-1be64088b9da | | | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 | | share_server_id | None | + | share_group_id | None | | host | manila@paris#shares | | access_rules_status | active | | snapshot_id | None | diff --git a/doc/source/admin/shared-file-systems-snapshots.rst b/doc/source/admin/shared-file-systems-snapshots.rst index 6aa9bad15a..4587c3a4a5 100644 --- a/doc/source/admin/shared-file-systems-snapshots.rst +++ b/doc/source/admin/shared-file-systems-snapshots.rst @@ -80,6 +80,7 @@ it is available: | share_network_id | None | | export_locations | [] | | share_server_id | None | + | share_group_id | None | | host | None | | snapshot_id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd | | is_public | False | @@ -107,6 +108,7 @@ it is available: | share_network_id | 5c3cbabb-f4da-465f-bc7f-fadbe047b85a | | export_locations | 10.254.0.3:/shares/share-1dc2a471-3d47-...| | share_server_id | 41b7829d-7f6b-4c96-aea5-d106c2959961 | + | share_group_id | None | | host | manila@generic1#GENERIC1 | | snapshot_id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd | | is_public | False | diff --git a/doc/source/install/common/dhss-false-mode-using-shared-file-systems.rst b/doc/source/install/common/dhss-false-mode-using-shared-file-systems.rst index 7eda6fa86d..5be0466393 100644 --- a/doc/source/install/common/dhss-false-mode-using-shared-file-systems.rst +++ b/doc/source/install/common/dhss-false-mode-using-shared-file-systems.rst @@ -67,6 +67,7 @@ Create a share | description | None | | availability_zone | None | | share_network_id | None | + | share_group_id | None | | host | | | access_rules_status | active | | snapshot_id | None | @@ -110,6 +111,7 @@ Create a share | description | None | | availability_zone | nova | | share_network_id | None | + | share_group_id | None | | export_locations | | | | path = 10.0.0.41:/var/lib/manila/mnt/share-8e13a98f-c310-41df-ac90-fc8bce4910b8 | | | id = 3c8d0ada-cadf-48dd-85b8-d4e8c3b1e204 | diff --git a/doc/source/install/common/dhss-true-mode-using-shared-file-systems.rst b/doc/source/install/common/dhss-true-mode-using-shared-file-systems.rst index 8b2866bed9..94b238c6b3 100644 --- a/doc/source/install/common/dhss-true-mode-using-shared-file-systems.rst +++ b/doc/source/install/common/dhss-true-mode-using-shared-file-systems.rst @@ -161,6 +161,7 @@ Create a share | description | None | | availability_zone | None | | share_network_id | 58b2f0e6-5509-4830-af9c-97f525a31b14 | + | share_group_id | None | | host | None | | snapshot_id | None | | is_public | False | @@ -202,6 +203,7 @@ Create a share | description | None | | availability_zone | nova | | share_network_id | 58b2f0e6-5509-4830-af9c-97f525a31b14 | + | share_group_id | None | | export_locations | | | | path = 10.254.0.6:/shares/share-0bfd69a1-27f0-4ef5-af17-7cd50bce6550 | | | id = e525cbca-b3cc-4adf-a1cb-b1bf48fa2422 | diff --git a/doc/source/user/create-and-manage-shares.rst b/doc/source/user/create-and-manage-shares.rst index 46d9e4505b..68dfc27568 100644 --- a/doc/source/user/create-and-manage-shares.rst +++ b/doc/source/user/create-and-manage-shares.rst @@ -69,6 +69,7 @@ Create a share | availability_zone | None | | share_network_id | c895fe26-92be-4152-9e6c-f2ad230efb13 | | share_server_id | None | + | share_group_id | None | | host | | | access_rules_status | active | | snapshot_id | None | @@ -112,6 +113,7 @@ Create a share | | id = 6921e862-88bc-49a5-a2df-efeed9acd583 | | | share_instance_id = e1c2d35e-fe67-4028-ad7a-45f668732b1d | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -294,6 +296,7 @@ Create share from snapshot | availability_zone | nova | | share_network_id | c895fe26-92be-4152-9e6c-f2ad230efb13 | | share_server_id | None | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | e744ca47-0931-4e81-9d9f-2ead7d7c1640 | @@ -349,6 +352,7 @@ Create share from snapshot | | id = 26f55e4c-6edc-4e55-8c55-c62b7db1aa9f | | | share_instance_id = 4c00cb49-51d9-478e-abc1-d1853efaf6d3 | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | e744ca47-0931-4e81-9d9f-2ead7d7c1640 | @@ -457,6 +461,7 @@ Extend share | | id = 6921e862-88bc-49a5-a2df-efeed9acd583 | | | share_instance_id = e1c2d35e-fe67-4028-ad7a-45f668732b1d | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -500,6 +505,7 @@ Extend share | | id = 6921e862-88bc-49a5-a2df-efeed9acd583 | | | share_instance_id = e1c2d35e-fe67-4028-ad7a-45f668732b1d | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -552,6 +558,7 @@ Shrink share | | id = 6921e862-88bc-49a5-a2df-efeed9acd583 | | | share_instance_id = e1c2d35e-fe67-4028-ad7a-45f668732b1d | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | None | @@ -595,6 +602,7 @@ Shrink share | | id = 6921e862-88bc-49a5-a2df-efeed9acd583 | | | share_instance_id = e1c2d35e-fe67-4028-ad7a-45f668732b1d | | share_server_id | 2e9d2d02-883f-47b5-bb98-e053b8d1e683 | + | share_group_id | None | | host | nosb-devstack@london#LONDON | | access_rules_status | active | | snapshot_id | None |