diff options
| author | He Jie Xu <hejie.xu@intel.com> | 2015-12-08 10:25:14 +0800 |
|---|---|---|
| committer | He Jie Xu <hejie.xu@intel.com> | 2015-12-08 14:17:36 +0800 |
| commit | 50aa74f91d5c58dbbb95c4f1ab1faf239203f05d (patch) | |
| tree | 615cb00f39999fbb2783290578ff4625f0f9212d /api-guide/source/microversions.rst | |
| parent | 3f8c69b2ef3eef886e36c0b7f397b83a36a7beb8 (diff) | |
| download | nova-50aa74f91d5c58dbbb95c4f1ab1faf239203f05d.tar.gz | |
docs: add microversions description in the concept doc
This patch adds generic description for microversions. We will write
more use-cases in later patches.
blueprint complete-todo-in-api-concept-doc
Change-Id: I600ad4186a38eaffbec38bb15b2de0146c076abf
Diffstat (limited to 'api-guide/source/microversions.rst')
| -rw-r--r-- | api-guide/source/microversions.rst | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/api-guide/source/microversions.rst b/api-guide/source/microversions.rst index 8b31cb7574..baedcdd066 100644 --- a/api-guide/source/microversions.rst +++ b/api-guide/source/microversions.rst @@ -11,11 +11,26 @@ License for the specific language governing permissions and limitations under the License. -============== +============= Microversions -============== +============= -API v2.1 users micro versions, instead of extensions, to allow for the API -to slowly evolve over time, without breaking any existing users. +API v2.1 supports Microversions. User uses Microversions to discover the +supported API version in the cloud. If cloud is upgraded to support newer +versions, it will still support all older versions to maintain the backward +compatibility for users using older versions. Also user can discover new +features easily with Microversions, then user can take all the advantages of +current cloud. -TODO - add more information. +There are multiple cases which you can resolve with Microversions: + +Legacy v2 API user with new cloud +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The minimum version of Microversions is `2.1`, this is a version compatible +with legacy v2 API. The legacy v2 API user don't need to worry about that his +old client is broken with new cloud deployment. Cloud operator don't need to +worry that upgrading cloud to newer versions will break any user with old +client. + +TODO: add more use-cases for Microversions |