From 052b7f46ba41d8bf436ce42675e9a91776d602f7 Mon Sep 17 00:00:00 2001 From: sslypushenko Date: Thu, 17 Sep 2015 19:26:22 +0300 Subject: [PATCH] Add sections describing experimental API Added sections describing experimental part of of the Shared File Systems [1] API v1 and v2. [1] https://wiki.openstack.org/wiki/Manila Change-Id: I6f485f45cd90d4150114b953897497117ea87387 Partial-Bug: #1498053 --- api-ref/src/docbkx/api-ref-share-v2.xml | 1 + api-ref/src/docbkx/ch_share-v1.xml | 8 +- .../src/docbkx/ch_share-v2-experimental.xml | 103 ++++ api-ref/src/docbkx/ch_share-v2.xml | 4 +- .../wadls/share-api/src/v2/experimental.ent | 528 ++++++++++++++++++ .../src/v2/os-share-v2-experimental.wadl | 392 +++++++++++++ 6 files changed, 1030 insertions(+), 6 deletions(-) create mode 100644 api-ref/src/docbkx/ch_share-v2-experimental.xml create mode 100644 api-ref/src/wadls/share-api/src/v2/experimental.ent create mode 100644 api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl diff --git a/api-ref/src/docbkx/api-ref-share-v2.xml b/api-ref/src/docbkx/api-ref-share-v2.xml index 2b1165d39..5d224a45b 100644 --- a/api-ref/src/docbkx/api-ref-share-v2.xml +++ b/api-ref/src/docbkx/api-ref-share-v2.xml @@ -20,4 +20,5 @@ + diff --git a/api-ref/src/docbkx/ch_share-v1.xml b/api-ref/src/docbkx/ch_share-v1.xml index c60cc44cd..90b209e50 100644 --- a/api-ref/src/docbkx/ch_share-v1.xml +++ b/api-ref/src/docbkx/ch_share-v1.xml @@ -17,11 +17,11 @@ The Shared File Systems API v1 is functionally identical to the Shared File - Systems API v2.0. Subsequent API v2 micro-versions, such as v2.1, - differ from API v1.0. + xlink:type="simple" xlink:href="api-ref-share-v2.html">Shared File Systems + API v2.0. Subsequent API v2 micro-versions, such as v2.1, differ + from API v1.0. - Starting with the API v2.0, the API uses Compute-style micro-versions. + Starting with API v2.0, the API uses Compute-style micro-versions. diff --git a/api-ref/src/docbkx/ch_share-v2-experimental.xml b/api-ref/src/docbkx/ch_share-v2-experimental.xml new file mode 100644 index 000000000..f08c74554 --- /dev/null +++ b/api-ref/src/docbkx/ch_share-v2-experimental.xml @@ -0,0 +1,103 @@ + + + %common_project; + ]> + + Shared File Systems API v2 (EXPERIMENTAL) + + Contributors can change or remove the experimental part of the Shared + File Systems API without maintaining backward compatibility. + +
+ Consistency groups (since API v2.4) + + Consistency groups enable you to create snapshots at the exact + same point in time from multiple file system shares. For example, + a database might place its tables, logs, and configuration on + separate shares. To restore this database from a previous point + in time, it makes sense to restore the logs, tables, and + configuration together from the exact same point in time. + + + As an administrator, you can also reset the state of a consistency + group and force-delete a specified consistency group in any state. + Use the policy.json file to grant permissions for + these actions to other roles. + + + + + + + + + + + + + + + + + + + +
+
+ Consistency group snapshots (since API v2.4) + + You can create snapshots of consistency groups. To create a + snapshot, you specify the ID of the consistency group that you + want to snapshot. After you create a consistency group snapshot, + you can create a consistency group from it. + + + A consistency group snapshot can have member shares. To add a + member share, include the consistency_group_id + parameter in the create share request. This ID must match the ID + of the consistency group from which the consistency group snapshot + was created. Then, when you use consistency group snapshots to + restore data, you can easily determine which shares belong to a + specified consistency group. + + + As an administrator, you can also reset the state of a consistency + group snapshot and force-delete a specified consistency group + snapshot in any state. Use the policy.json file to + grant permissions for these actions to other roles. + + + + + + + + + + + + + + + + + + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/ch_share-v2.xml b/api-ref/src/docbkx/ch_share-v2.xml index 7c86989cf..585f86858 100644 --- a/api-ref/src/docbkx/ch_share-v2.xml +++ b/api-ref/src/docbkx/ch_share-v2.xml @@ -59,8 +59,8 @@ Limits Limits are the resource limitations that are allowed for each - tenant (project). An administrator can configure limits in - the manila.conf file. + tenant (project). An administrator can configure limits in the + manila.conf file. Users can query their rate and absolute limits. The absolute diff --git a/api-ref/src/wadls/share-api/src/v2/experimental.ent b/api-ref/src/wadls/share-api/src/v2/experimental.ent new file mode 100644 index 000000000..9f078db71 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/experimental.ent @@ -0,0 +1,528 @@ + + + + A list of one or more share type IDs. + + + + + + + The consistency group name. + + + + + + + The consistency group description. + + + + + + + The ID of a share network. + + + Note that when using a share type with the + driver_handles_share_servers extra spec as + False, you should not provide a + share_network_id. + + + + + + + The ID of the consistency group snapshot from which to create the + consistency group. + + +'> + + + + The consistency group ID. + + + + + + + The consistency group status. A valid value is + creating, available, error, + deleting, or error_deleting. + + + + + + + The consistency group name. + + + + + + + The consistency group description. + + + + + + + The consistency group snapshot ID. A valid value is null or + the ID of the consistency group snapshot, if the consistency group was + created from a snapshot. + + + + + + + The date and time stamp when the consistency group was created. + + + + + + + The ID of a share network. + + + + + + + The consistency group host name. + + + + + + + The ID of the project in which the consistency group was created. + + + + + + + A list of share type IDs. + + +'> + + + + The consistency group ID. + + + + + + + The consistency group name. + + +'> + + + + The consistency group name. + + + + + + + The consistency group description. + + +'> + + + + The consistency group status. A valid value is creating, + error, available, deleting, or + error_deleting. + + +'> + + + + To force-delete a consistency group, set this value to null. + + +'> + + + + The ID of the consistency group from which to create a snapshot. + + + + + + + The consistency group snapshot name. + + + + + + + The consistency group snapshot description. + + +'> + + + + The consistency group snapshot ID. + + + + + + + The consistency group snapshot status, which is + available, creating, error, + deleting, or error_deleting. + + + + + + + The ID of the project in which the consistency group snapshot was created. + + + + + + + The ID of the consistency group from which the snapshot was created. + + + + + + + The consistency group snapshot name. + + + + + + + The consistency group snapshot description. + + + + + + + The date and time stamp when the consistency group snapshot was created. + + +'> + + + + The consistency group snapshot ID. + + + + + + + The consistency group snapshot name. + + +'> + + + + The consistency group snapshot member ID. + + + + + + + The ID of the share that is a consistency group snapshot member. + + + + + + + The share type ID of the member. + + + + + + + The date and time stamp when the member was created. + + + + + + + The consistency group snapshot ID. + + + + + + + The file system protocol of the member, which is NFS, + CIFS, GlusterFS, or HDFS. + + + + + + + The ID of the project in which the consistency group snapshot member was + created. + + + + + + + The member size, in GBs. + + +'> + + + + The consistency group snapshot name. + + + + + + + The consistency group snapshot description. + + +'> + + + + The consistency group snapshot status. A valid value is + creating, error, available, + deleting, or error_deleting. + + +'> + + + + To force-delete a consistency group snapshot, set this value to + null. + + +'> \ No newline at end of file diff --git a/api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl b/api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl new file mode 100644 index 000000000..757c95710 --- /dev/null +++ b/api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl @@ -0,0 +1,392 @@ + + + + %common; + + %experimental; + + %common_project; +]> + + + + + + A valid Shared File Systems API micro-version. + For example, + "X-Openstack-Manila-Api-Version: 2.6". + If you omit this header, the default micro-version is 2.0. + + + + + + + + + + + + + Indicates that this is an experimental Shared File + Systems API request. Set to true. + For example, + "X-OpenStack-Manila-API-Experimental: true". + + + + + + The tenant ID in a multi-tenancy cloud. + + + + + + + + + + + + The unique identifier of the consistency group. + + + + + + + + + + + + + + + + + + + + + The unique identifier of the consistency group snapshot. + + + + + + + + + + + + + + + + + + + + + Creates a consistency group. + + + + + + + &createConsistencyGroupRequestParameters; + + + + + + + + &createConsistencyGroupResponseParameters; + + + + + + Lists all consistency groups. + + + + + + + &getConsistencyGroupsResponseParameters; + + + + + + Lists all consistency groups with details. + + + + + + + &createConsistencyGroupResponseParameters; + + + + + + Shows information about a specified consistency group. + + + + + + + &createConsistencyGroupResponseParameters; + + + + + + Updates a specified consistency group. + You can update only these attributes: + + + + name, which changes the consistency group name. + + + + + description, which changes the consistency group description. + + + + + + + + + + &updateConsistencyGroupRequestParameters; + + + + + + + + &createConsistencyGroupResponseParameters; + + + + + + Deletes a specified consistency group. + + + + + + Administrator only. Explicitly updates the state of a specified consistency group. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &resetConsistencyGroupStateRequestParameter; + + + + + + + Administrator only. Force-deletes a specified consistency group. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &force-deleteConsistencyGroupRequestParameter; + + + + + + + Creates a consistency group snapshot. + + You can create a consistency group snapshot for a consistency group + in available state only. + + + + + + + + &createConsistencyGroupSnapshotRequestParameters; + + + + + + + + &createConsistencyGroupSnapshotResponseParameters; + + + + + + Lists all consistency group snapshots. + + + + + + + &getConsistencyGroupSnapshotsResponseParameters; + + + + + + Lists all consistency group snapshots with details. + + + + + + + &createConsistencyGroupSnapshotResponseParameters; + + + + + + Shows information about a specified consistency group snapshot. + + + + + + + &createConsistencyGroupSnapshotResponseParameters; + + + + + + Shows information about a specified consistency group snapshot member. + + + + + + + &getConsistencyGroupSnapshotMembersResponseParameters; + + + + + + Updates a specified consistency group snapshot. + You can update only these attributes: + + + + name, which changes the consistency group snapshot name. + + + + + description, which changes the consistency group snapshot description. + + + + + + + + + + &updateConsistencyGroupSnapshotRequestParameters; + + + + + + + + &createConsistencyGroupSnapshotResponseParameters; + + + + + + Deletes a specified consistency group snapshot. + + + + + + Administrator only. Explicitly updates the state of a specified consistency group snapshot. + Administrators can use the policy.json file to permit other roles to complete this action. + + + + + + + &resetConsistencyGroupSnapshotStateRequestParameter; + + + + + + + Administrator only. Force-deletes a specified consistency group snapshot. + Use the policy.json file to grant permissions for this action to other roles. + + + + + + + &force-deleteConsistencyGroupSnapshotRequestParameter; + + + + +