Skip to content

Commit

Permalink
Expose volume & snapshot use_quota field
Browse files Browse the repository at this point in the history 
This patch adds a new REST API microversion to expose the new use_quota
DB field present in volumes and snapshots.

The field will be reported when listing and showing resources and can be
used when filtering as well.

The field is exposed in the REST API as `consumes_quota` to prevent
confusion for users and admins, since exposing it as `use_quota` may
give them the wrong impression that they can set it up for their own
purposes.

For users we say what is happening with the quota for that resource -it
consumes or doesn't consume quota-, whereas internally we express
instruction to the core code -whether to use quota or not-, hence the
difference in the naming.

APIImpact
DocImpact
Implements: blueprint temp-resources
Change-Id: I655a47fc75ddc11caf1defe984d9a66a9ad5a2e7
  • Loading branch information
@Akrog
Akrog committed Aug 26, 2021
1 parent 94dfad9 commit ec44fc8
Show file tree
Hide file tree
Showing 43 changed files with 733 additions and 60 deletions.
21 changes: 21 additions & 0 deletions api-ref/source/v3/parameters.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,18 @@ detail:
in: query
required: false
type: boolean
filter_consumes_quota:
description: |
Filters results by ``consumes_quota`` field. Resources that don't use
quotas are usually temporary internal resources created to perform an
operation. Default is to not filter by it. Filtering by this option may
not be always possible in a cloud, see
:ref:`List Resource Filters <resource-filters>` to determine whether this
filter is available in your cloud.
in: query
required: false
type: boolean
min_version: 3.65
filter_created_at:
description: |
Filters reuslts by a time that resources are created at with time
Expand Down Expand Up @@ -841,6 +853,15 @@ consumer:
in: body
required: false
type: string
consumes_quota:
description: |
Whether this resource consumes quota or not. Resources that not counted
for quota usage are usually temporary internal resources created to perform
an operation.
in: body
required: false
type: boolean
min_version: 3.65
container:
description: |
The container name or null.
Expand Down
2 changes: 2 additions & 0 deletions api-ref/source/v3/resource-filters.inc
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. -*- rst -*-
.. _resource-filters:

Resource Filters (resource_filters)
===================================

Expand Down
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/snapshots/snapshot-create-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
"updated_at": null,
"volume_id": "d291b81c-6e40-4525-8231-90aa1588121e"
}
}
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/snapshots/snapshot-show-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
"updated_at": null,
"volume_id": "b72c48f1-64b7-4cd8-9745-b12e0be82d37"
}
}
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/snapshots/snapshot-update-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
"updated_at": null,
"volume_id": "070c942d-9909-42e9-a467-7a781f150c58"
}
}
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/snapshots/snapshots-list-detailed-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
"volume_id": "7acd675e-4e06-4653-af9f-2ecd546342d6"
}
]
}
}
18 changes: 18 additions & 0 deletions api-ref/source/v3/samples/snapshots/v3.65/snapshot-create-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"snapshot": {
"created_at": "2019-03-11T16:24:34.469003",
"description": "Daily backup",
"id": "b36476e5-d18b-47f9-ac69-4818cb43ee21",
"metadata": {
"key": "v3"
},
"name": "snap-001",
"size": 10,
"status": "creating",
"updated_at": null,
"volume_id": "d291b81c-6e40-4525-8231-90aa1588121e",
"group_snapshot_id": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"consumes_quota": true
}
}
20 changes: 20 additions & 0 deletions api-ref/source/v3/samples/snapshots/v3.65/snapshot-show-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"snapshot": {
"created_at": "2019-03-12T04:42:00.809352",
"description": "Daily backup",
"id": "4a584cae-e4ce-429b-9154-d4c9eb8fda4c",
"metadata": {
"key": "v3"
},
"name": "snap-001",
"os-extended-snapshot-attributes:progress": "0%",
"os-extended-snapshot-attributes:project_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3",
"size": 10,
"status": "creating",
"updated_at": null,
"volume_id": "b72c48f1-64b7-4cd8-9745-b12e0be82d37",
"group_snapshot_id": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"consumes_quota": true
}
}
18 changes: 18 additions & 0 deletions api-ref/source/v3/samples/snapshots/v3.65/snapshot-update-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"snapshot": {
"created_at": "2019-03-12T04:53:53.426591",
"description": "This is yet, another snapshot.",
"id": "43666194-8e72-451a-b7bb-54fef763b2b8",
"metadata": {
"key": "v3"
},
"name": "snap-002",
"size": 10,
"status": "creating",
"updated_at": null,
"volume_id": "070c942d-9909-42e9-a467-7a781f150c58",
"group_snapshot_id": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"consumes_quota": true
}
}
22 changes: 22 additions & 0 deletions api-ref/source/v3/samples/snapshots/v3.65/snapshots-list-detailed-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"snapshots": [
{
"created_at": "2019-03-11T16:24:36.464445",
"description": "Daily backup",
"id": "d0083dc5-8795-4c1a-bc9c-74f70006c205",
"metadata": {
"key": "v3"
},
"name": "snap-001",
"os-extended-snapshot-attributes:progress": "0%",
"os-extended-snapshot-attributes:project_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3",
"size": 10,
"status": "creating",
"updated_at": null,
"volume_id": "7acd675e-4e06-4653-af9f-2ecd546342d6",
"group_snapshot_id": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"consumes_quota": true
}
]
}
4 changes: 2 additions & 2 deletions api-ref/source/v3/samples/versions/version-show-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
],
"min_version": "3.0",
"status": "CURRENT",
"updated": "2021-05-30T00:00:00Z",
"version": "3.64"
"updated": "2021-08-25T00:00:00Z",
"version": "3.65"
}
]
}
4 changes: 2 additions & 2 deletions api-ref/source/v3/samples/versions/versions-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
],
"min_version": "3.0",
"status": "CURRENT",
"updated": "2021-05-30T00:00:00Z",
"version": "3.64"
"updated": "2021-08-25T00:00:00Z",
"version": "3.65"
}
]
}
41 changes: 41 additions & 0 deletions api-ref/source/v3/samples/volumes/v3.65/volume-create-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"volume": {
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2018-11-28T06:21:12.715987",
"description": null,
"encrypted": false,
"id": "2b955850-f177-45f7-9f49-ecb2c256d161",
"links": [
{
"href": "http://127.0.0.1:33951/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/2b955850-f177-45f7-9f49-ecb2c256d161",
"rel": "self"
},
{
"href": "http://127.0.0.1:33951/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/2b955850-f177-45f7-9f49-ecb2c256d161",
"rel": "bookmark"
}
],
"metadata": {},
"migration_status": null,
"multiattach": false,
"name": null,
"replication_status": null,
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"updated_at": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__",
"group_id": null,
"provider_id": null,
"service_uuid": null,
"shared_targets": true,
"cluster_name": null,
"volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d",
"consumes_quota": true
}
}
45 changes: 45 additions & 0 deletions api-ref/source/v3/samples/volumes/v3.65/volume-show-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"volume": {
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2018-11-29T06:50:07.770785",
"description": null,
"encrypted": false,
"id": "f7223234-1afc-4d19-bfa3-d19deb6235ef",
"links": [
{
"href": "http://127.0.0.1:45839/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/f7223234-1afc-4d19-bfa3-d19deb6235ef",
"rel": "self"
},
{
"href": "http://127.0.0.1:45839/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/f7223234-1afc-4d19-bfa3-d19deb6235ef",
"rel": "bookmark"
}
],
"metadata": {},
"migration_status": null,
"multiattach": false,
"name": null,
"os-vol-host-attr:host": null,
"os-vol-mig-status-attr:migstat": null,
"os-vol-mig-status-attr:name_id": null,
"os-vol-tenant-attr:tenant_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3",
"replication_status": null,
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"updated_at": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__",
"provider_id": null,
"group_id": null,
"service_uuid": null,
"shared_targets": true,
"cluster_name": null,
"volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d",
"consumes_quota": true
}
}
43 changes: 43 additions & 0 deletions api-ref/source/v3/samples/volumes/v3.65/volume-update-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"volume": {
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2018-11-29T06:59:23.679903",
"description": "This is yet, another volume.",
"encrypted": false,
"id": "8b2459d1-0059-4e14-a89f-dfa73a452af6",
"links": [
{
"href": "http://127.0.0.1:41467/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/8b2459d1-0059-4e14-a89f-dfa73a452af6",
"rel": "self"
},
{
"href": "http://127.0.0.1:41467/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/8b2459d1-0059-4e14-a89f-dfa73a452af6",
"rel": "bookmark"
}
],
"metadata": {
"name": "metadata0"
},
"migration_status": null,
"multiattach": false,
"name": "vol-003",
"replication_status": null,
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"updated_at": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__",
"group_id": null,
"provider_id": null,
"service_uuid": null,
"shared_targets": true,
"cluster_name": null,
"volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d",
"consumes_quota": true
}
}
47 changes: 47 additions & 0 deletions api-ref/source/v3/samples/volumes/v3.65/volumes-list-detailed-response.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"volumes": [
{
"attachments": [],
"availability_zone": "nova",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2018-11-28T06:25:15.288987",
"description": null,
"encrypted": false,
"id": "cb49b381-9012-40cb-b8ee-80c19a4801b5",
"links": [
{
"href": "http://127.0.0.1:43543/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/cb49b381-9012-40cb-b8ee-80c19a4801b5",
"rel": "self"
},
{
"href": "http://127.0.0.1:43543/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/cb49b381-9012-40cb-b8ee-80c19a4801b5",
"rel": "bookmark"
}
],
"metadata": {},
"migration_status": null,
"multiattach": false,
"name": null,
"os-vol-host-attr:host": null,
"os-vol-mig-status-attr:migstat": null,
"os-vol-mig-status-attr:name_id": null,
"os-vol-tenant-attr:tenant_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3",
"replication_status": null,
"size": 10,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"updated_at": null,
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__",
"volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d",
"provider_id": null,
"group_id": null,
"service_uuid": null,
"shared_targets": true,
"cluster_name": null,
"consumes_quota": true
}
]
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/volumes/volume-create-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__"
}
}
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/volumes/volume-show-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__"
}
}
}
2 changes: 1 addition & 1 deletion api-ref/source/v3/samples/volumes/volume-update-response.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@
"user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e",
"volume_type": "__DEFAULT__"
}
}
}
Loading

0 comments on commit ec44fc8

Please sign in to comment.