summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorLingxian Kong <anlin.kong@gmail.com>2020-10-07 18:50:53 +1300
committerLingxian Kong <anlin.kong@gmail.com>2020-10-09 11:43:48 +1300
commit1d24b65052bbfb8f7dff5744c7bb44a58a2336c6 (patch)
treeaaa0fe3f8feb9b6640ca11aa69bf122ce0505ad9 /api-ref
parent680c7b8361521c494ae93d13b5d33c43a27d35ad (diff)
downloadtrove-1d24b65052bbfb8f7dff5744c7bb44a58a2336c6.tar.gz
Image tags support in datastore version
Change-Id: I0e51d08515c121e3a7b0e82b6e4c4161bb4fbc4a
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/datastore-versions.inc12
-rwxr-xr-xapi-ref/source/parameters.yaml53
2 files changed, 65 insertions, 0 deletions
diff --git a/api-ref/source/datastore-versions.inc b/api-ref/source/datastore-versions.inc
index 7318006e..c431b1b2 100644
--- a/api-ref/source/datastore-versions.inc
+++ b/api-ref/source/datastore-versions.inc
@@ -286,6 +286,13 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
+ - name: datastore_version_name
+ - datastore_name: datastore_name_required
+ - datastore_manager: datastore_type1
+ - image: image_id
+ - image_tags: image_tags
+ - active: active
+ - default: default
Request Example
---------------
@@ -363,6 +370,11 @@ Request
- project_id: project_id
- datastore_version_id: datastore_version_id
+ - datastore_manager: datastore_type
+ - image: image_id
+ - image_tags: image_tags
+ - active: active_optional
+ - default: default
Request Example
---------------
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 40fd98d9..101f15d2 100755
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -99,6 +99,18 @@ access_is_public:
in: body
required: false
type: boolean
+active:
+ description: |
+ Whether the database version is enabled.
+ in: body
+ required: true
+ type: boolean
+active_optional:
+ description: |
+ Whether the database version is enabled.
+ in: body
+ required: false
+ type: boolean
availability_zone:
description: |
The availability zone of the instance.
@@ -302,6 +314,12 @@ datastore2:
in: body
required: true
type: object
+datastore_name_required:
+ description: |
+ The name of a datastore.
+ in: body
+ required: true
+ type: string
datastore_type:
description: |
The type of a datastore.
@@ -339,6 +357,14 @@ datastore_version_name:
in: body
required: true
type: string
+default:
+ description: |
+ When true this datastore version is created as the default in the
+ datastore. If not specified, for creating, default is false, for updating,
+ it's ignored.
+ in: body
+ required: false
+ type: boolean
description:
description: |
New description of the configuration group.
@@ -392,6 +418,33 @@ flavorRef:
in: body
required: true
type: string
+image_id:
+ description: |
+ The ID of an image.
+
+ Either ``image`` or ``image_tags`` needs to be specified when creating
+ datastore version.
+ in: body
+ required: false
+ type: string
+image_tags:
+ description: |
+ List of image tags.
+
+ Either ``image`` or ``image_tags`` needs to be specified when creating
+ datastore version.
+
+ If the image ID is not provided, the image can be retrieved by the image
+ tags. The tags are used for filtering as a whole rather than separately.
+ Using image tags is more flexible than ID especially when a new guest image
+ is uploaded to Glance, Trove can pick up the latest image automatically for
+ creating instances.
+
+ When updating, only specifying ``image_tags`` could remove ``image``
+ from the datastore version.
+ in: body
+ required: false
+ type: array
instance:
description: |
An ``instance`` object.