From ac34e393faff326c96b39de114b59634ce0ee4f1 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sat, 27 Apr 2013 10:08:43 -0500 Subject: [PATCH] Updated title of Compute Dev Guide to add extensions bug: #1156827 Change-Id: I8d1bc5cd81346a617c69424e0cee8858b4d80b37 author: Diane Fleming --- .../src/os-compute-devguide.xml | 398 +++++++----------- .../src/samples/choices.xml | 45 +- .../src/samples/ext-servers.xml | 102 +++-- .../src/samples/extension.xml | 26 +- .../src/samples/extensions.xml | 52 +-- .../src/samples/images-page1.xml | 19 +- .../src/samples/server-post-req-short.json | 10 +- .../src/samples/server-post-req.json | 10 +- .../src/samples/version.xml | 30 +- .../src/samples/versions.xml | 22 +- .../src/section_concepts.xml | 80 ++++ 11 files changed, 387 insertions(+), 407 deletions(-) create mode 100644 openstack-compute-api-2/src/section_concepts.xml diff --git a/openstack-compute-api-2/src/os-compute-devguide.xml b/openstack-compute-api-2/src/os-compute-devguide.xml index 203a1a9..930619d 100644 --- a/openstack-compute-api-2/src/os-compute-devguide.xml +++ b/openstack-compute-api-2/src/os-compute-devguide.xml @@ -34,8 +34,10 @@ xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="os-cs-devguide"> - OpenStack Compute Developer Guide - OpenStack Compute Dev Guide + OpenStack Compute and Extensions Developer Guide + + OpenStack Compute and Extensions Dev + Guide @@ -43,7 +45,7 @@ - OpenStack LLC + OpenStack Foundation @@ -55,8 +57,8 @@ OpenStack Foundation API v2 - OpenStack Compute - 2012-05-30 + OpenStack Compute and Extensions + Copyright details are filled in by the @@ -70,6 +72,19 @@ (API). + + + 2013-04-27 + + + + Changed title of this book to + reflect that it contains Compute + extensions. + + + + 2013-04-17 @@ -77,8 +92,9 @@ Added to document the server admin actions extension. + linkend="ext-os-admin-actions"/> to + document the server admin actions + extension. @@ -171,26 +187,26 @@ - Added limit + Added limit and marker parameters to list operations. - The rebuild action behaves just - like create: an imageRef is used and a + The rebuild action behaves just like + create: an imageRef is used and a password may be specified. - Added tenant and user_id attributes + Added tenant and user_id attributes to server and image. - Added vcpus attribute to flavors. + Added vcpus attribute to flavors. - We now use a flavorRef in the - resize action. + We now use a flavorRef in the resize + action. @@ -200,78 +216,78 @@ - Added missing response examples for + Added missing response examples for server update. - Ensure consistent HTTP status codes + Ensure consistent HTTP status codes for all resources. - Clarifications on setting and + Clarifications on setting and changing a server password. - Minor updates to metadata section + Minor updates to metadata section for clarity. - Discuss alternate links. + Discuss alternate links. - Removed version number from compute + Removed version number from compute media types — use a media type parameter instead. - Bought back the flavorRef and + Bought back the flavorRef and imageRef server attributes these are now only used when creating a server. - Made the create image operation a + Made the create image operation a server action. - Added minDisk and minRam filters to + Added minDisk and minRam filters to flavor lists. - Added minDisk and minRam attributes + Added minDisk and minRam attributes to images. - Asynchronous faults may now contain + Asynchronous faults may now contain a timestamp. - Changes-since request returns an + Changes-since request returns an empty list rather than a 304. - Added DELETED image status. + Added DELETED image status. - Fix content length in Fix content length in . - Fixed bad request error code in + Fixed bad request error code in . - Compact image, server, and flavor + Compact image, server, and flavor lists should contain IDs, names, and links (Any kind of link may be included — not just self links). - Changed metadata URI from .../meta + Changed metadata URI from .../meta to .../metadata for consistency. @@ -283,7 +299,7 @@ - Renamed Primary IP to Access IP. + Renamed Primary IP to Access IP. @@ -294,73 +310,72 @@ - Many minor updates based on + Many minor updates based on community feedback. - Removed sections on Content + Removed sections on Content Compression, Persistent Connections, and Caching — these are operator specific. Added section on HTTP. - A Location header is returned when + A Location header is returned when creating servers/images. - Added filters to collection of + Added filters to collection of Image, Servers, and Flavors. - Added asynchronous faults. + Added asynchronous faults. - Updates to links and references. + Updates to links and references. Remove serverRef, imageRef, and flavorRef and instead embed one entity in another to provide links. - Added primary IP addresses. + Added primary IP addresses. - Added forbidden fault. + Added forbidden fault. - We now use a single bookmark link + We now use a single bookmark link per entity regardless of mimetype. - Collections are now sorted by - create time. + Collections are now sorted by create + time. - Previous links are no longer + Previous links are no longer required. - Added the ability to create or + Added the ability to create or update multiple metadata items simultaneously. - Minor cleanups to server and image + Minor cleanups to server and image state machine. - Update to JSON collection format. + Update to JSON collection format. - Replace integer IDs with UUIDs. + Replace integer IDs with UUIDs. - Removed affinityID, this will - likely come in as an extension. - + Removed affinityID, this will likely + come in as an extension. @@ -370,7 +385,7 @@ - Some minor cleanups in preparation + Some minor cleanups in preparation for OpenStack Summit discussion. @@ -382,32 +397,32 @@ - Many minor updates based on + Many minor updates based on community feedback. - Updates to resource linking and + Updates to resource linking and references. - Better description of paginated + Better description of paginated collections. - Metadata supported in servers and + Metadata supported in servers and images. - Dropped support for shared IP + Dropped support for shared IP groups. - IPs organized by network id, vs + IPs organized by network id, vs simply having public and private IPs. - Generalized affinity id. + Generalized affinity id. @@ -417,7 +432,7 @@ - Initial release. + Initial release. @@ -426,8 +441,8 @@ - - Overview + + Preface OpenStack Compute is a compute service that provides server capacity in the cloud. Compute Servers come in different flavors of memory, cores, disk space, and CPU, @@ -477,69 +492,11 @@ xlink:href="http://docs.openstack.org"> http://docs.openstack.org. - - - - Concepts - To use the OpenStack Compute API effectively, you - should understand several key concepts: -
- Server - A server is a virtual machine instance in the - compute system. Flavor and image are requisite - elements when creating a server. -
-
- Flavor - A flavor is an available hardware configuration for - a server. Each flavor has a unique combination of disk - space, memory capacity and priority for CPU time. - -
-
- Image - An image is a collection of files used to create or - rebuild a server. Operators provide a number of - pre-built OS images by default. You may also create - custom images from cloud servers you have launched. - These custom images are useful for backup purposes or - for producing “gold” server images if you plan to - deploy a particular server configuration frequently. - -
-
- Reboot - The reboot function allows for either a soft or - hard reboot of a server. With a soft reboot, the - operating system is signaled to restart, which allows - for a graceful shutdown of all processes. A hard - reboot is the equivalent of power cycling the server. - The virtualization platform should ensure that the - reboot action has completed successfully even in cases - in which the underlying domain/vm is paused or - halted/stopped. -
-
- Rebuild - The rebuild function removes all data on the server - and replaces it with the specified image. Server ID - and IP addresses remain the same. -
-
- Resize - The resize function converts an existing server to - a different flavor, in essence, scaling the server up - or down. The original server is saved for a period of - time to allow rollback if there is a problem. All - resizes should be tested and explicitly confirmed, at - which time the original server is removed. All resizes - are automatically confirmed after 24 hours if they are - not confirmed or reverted. -
- + + General API Information - The OpenStack Compute API is defined as a ReSTful HTTP + The OpenStack Compute API is defined as a ReSTful HTTP service. The API takes advantage of all aspects of the HTTP protocol (methods, URIs, media types, response codes, etc.) and providers are free to use existing features of @@ -551,12 +508,13 @@ &GET; requests using ETags, or they may send a redirect in response to a &GET; request. Clients should be written to account for these differences. - Providers may return information identifying requests - in HTTP response headers, for example, to facilitate + Providers can return information identifying requests in + HTTP response headers, for example, to facilitate communication between the provider and client users. +
Authentication - Each HTTP request against the OpenStack Compute + Each HTTP request against the OpenStack Compute system requires the inclusion of specific authentication credentials. A single deployment may support multiple authentication schemes (OAuth, Basic @@ -565,27 +523,25 @@ system. Please contact your provider to determine the best way to authenticate against this API. - Some authentication schemes may require that - the API operate using SSL over HTTP (HTTPS). - + Some authentication schemes may require that the + API operate using SSL over HTTP (HTTPS).
Request/Response Types - The OpenStack Compute API supports both the JSON - and XML data serialization formats. The request format - is specified using the Content-Type - header and is required for operations that have a - request body. The response format can be specified in - requests using either the Accept header - or adding an .xml or .json extension to the request - URI. Note that it is possible for a response to be - serialized using a format different from the request - (see example below). If no response format is - specified, JSON is the default. If conflicting formats - are specified using both an Accept header - and a query extension, the query extension takes - precedence. + The OpenStack Compute API supports both the JSON and + XML data serialization formats. The request format is + specified using the Content-Type header + and is required for operations that have a request + body. The response format can be specified in requests + using either the Accept header or adding + an .xml or .json extension to the request URI. Note + that it is possible for a response to be serialized + using a format different from the request (see example + below). If no response format is specified, JSON is + the default. If conflicting formats are specified + using both an Accept header and a query + extension, the query extension takes precedence. @@ -635,7 +591,7 @@ Content-Type: application/xml; charset=UTF-8 - Notice, in the above example, that the content type + Notice, in the above example, that the content type is set to application/json but it asks for an application/xml response with the Accept header. An alternative method of achieving the same @@ -656,7 +612,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
Links and References - Often resources need to refer to other resources. + Often resources need to refer to other resources. For example, when creating a server, you must specify the image from which to build the server. You can specify the image by providing an ID or a URL to a @@ -729,7 +685,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
Paginated Collections - To reduce load on the service, list operations will + To reduce load on the service, list operations will return a maximum number of items at a time. The maximum number of items returned is determined by the compute provider. To navigate the collection, the @@ -748,10 +704,10 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb (413) fault may be thrown. A marker with an invalid ID will return a badRequest (400) fault. - For convenience, collections are required to - contain atom "next" links. They may optionally also - contain "previous" links. The last page in the list - will not contain a "next" link. The following examples + For convenience, collections are required to contain + atom "next" links. They may optionally also contain + "previous" links. The last page in the list will not + contain a "next" link. The following examples illustrate three pages in a collection of images. The first page was retrieved via a &GET; to http://servers.api.openstack.org/v2/1234/images?limit=1. @@ -764,9 +720,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Images Collection, First Page: XML - - - + Images Collection, First Page: JSON @@ -775,9 +729,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Images Collection, Second Page: XML - - - + Images Collection, Second Page: JSON @@ -794,7 +746,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Images Collection, Last Page: JSON - In JSON, members in a paginated collection are + In JSON, members in a paginated collection are stored in a JSON array named after the collection. A JSON object may also be used to hold members in cases where using an associative array is more practical. @@ -828,7 +780,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Efficient Polling with the <parameter>Changes-Since</parameter> Parameter - The ReST API allows you to poll for the status of + The ReST API allows you to poll for the status of certain operations by performing a &GET; on various elements. Rather than re-downloading and re-parsing the full status at each polling interval, your ReST @@ -853,7 +805,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb https://api.servers.openstack.org/v2/224532/servers?changes-since=2011-01-24T17:08Z would list all servers that have changed since Mon, 24 Jan 2011 17:08:00 UTC. - To allow clients to keep track of changes, the + To allow clients to keep track of changes, the changes-since filter displays items that have been recently deleted. Both images and servers contain a DELETED status that @@ -866,7 +818,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
Limits - Accounts may be pre-configured with a set of + Accounts may be pre-configured with a set of thresholds (or limits) to manage capacity and prevent abuse of the system. The system recognizes two kinds of limits: rate limits and @@ -882,14 +834,14 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb too low.
Rate Limits - Rate limits are specified in terms of both a + Rate limits are specified in terms of both a human-readable wild-card URI and a machine-processable regular expression. The human-readable limit is intended for displaying in graphical user interfaces. The machine-processable form is intended to be used directly by client applications. - The regular expression boundary matcher "^" for + The regular expression boundary matcher "^" for the rate limit takes effect after the root URI path. For example, the regular expression ^/servers would match the bolded portion of the @@ -939,8 +891,8 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
JSON and XML Response Formats
- Rate limits are applied in order relative to - the verb, going from least to most specific. For + Rate limits are applied in order relative to the + verb, going from least to most specific. For example, although the threshold for &POST; to */servers is 50 per day, one cannot &POST; to */servers more than 10 times within a single @@ -956,7 +908,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
Absolute Limits - Absolute limits are specified as name/value + Absolute limits are specified as name/value pairs. The name of the absolute limit uniquely identifies the limit within a deployment. Please consult your provider for an exhaustive list of @@ -1013,7 +965,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
Determining Limits Programmatically - Applications can programmatically determine + Applications can programmatically determine current account limits using the /limits URI as follows: @@ -1093,22 +1045,20 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb - The MIME type versioning approach allows for - the creating of permanent links, because the - version scheme is not specified in the URI path: + The MIME type versioning approach allows for the + creating of permanent links, because the version + scheme is not specified in the URI path: https://api.servers.openstack.org/224532/servers/123. - If a request is made without a version specified in + If a request is made without a version specified in the URI or via HTTP headers, then a multiple-choices response (300) will follow providing links and MIME types to available versions. Multiple Choices Response: XML - - - + @@ -1116,7 +1066,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb - New features and functionality that do not break + New features and functionality that do not break API-compatibility will be introduced in the current version of the API as extensions (see below) and the URI and MIME types will remain unchanged. Features or @@ -1128,7 +1078,7 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Providers should work with developers and partners to ensure there is adequate time to migrate to the new version before deprecated versions are discontinued. - Your application can programmatically determine + Your application can programmatically determine available API versions by performing a &GET; on the root URL (i.e. with the version and everything to the right of it truncated) returned from the @@ -1159,25 +1109,21 @@ Host: servers.api.openstack.org body. Versions List Response: XML - - - + Versions List Response: Atom - - - + Versions List Response: JSON - You can also obtain additional information about a + You can also obtain additional information about a specific version by performing a &GET; on the base - version URL (e.g. + version URL (such as, https://servers.api.openstack.org/v2/). Version request URLs should always end with a trailing slash (/). If the slash is omitted, the server may respond @@ -1213,23 +1159,19 @@ Host: servers.api.openstack.org/v2/ body Version Details Response: XML - - - + Version Details Response: Atom - - - + Version Details Response: JSON - The detailed version response contains pointers to + The detailed version response contains pointers to both a human-readable and a machine-processable description of the API service. The machine-processable description is written in the Web @@ -1244,7 +1186,7 @@ Host: servers.api.openstack.org/v2/
Extensions - The OpenStack Compute API is extensible. Extensions + The OpenStack Compute API is extensible. Extensions serve two purposes: They allow the introduction of new features in the API without requiring a version change and they allow the introduction of vendor specific @@ -1284,18 +1226,16 @@ Host: servers.api.openstack.org/v2/ (400), badMethod (405), overLimit (413) - This operation does not require a request body. - Each extension is identified by two unique - identifiers, a namespace and an + This operation does not require a request body. Each + extension is identified by two unique identifiers, a + namespace and an alias. Additionally an extension contains documentation links in various formats. Extensions Response: XML - - - + @@ -1303,9 +1243,9 @@ Host: servers.api.openstack.org/v2/ - Extensions may also be queried individually by - their unique alias. This provides the simplest method - of checking if an extension is available as an + Extensions may also be queried individually by their + unique alias. This provides the simplest method of + checking if an extension is available as an unavailable extension will issue an itemNotFound (404) response. @@ -1343,15 +1283,13 @@ Host: servers.api.openstack.org/v2/ Extension Response: xml - - - + Extension Response: JSON - Extensions may define new data types, parameters, + Extensions may define new data types, parameters, actions, headers, states, and resources. In XML, additional elements and attributes may be defined. These elements must be defined in the extension's @@ -1373,7 +1311,7 @@ Host: servers.api.openstack.org/v2/ followed by a colon. For example, an image may be in the RS-PIE:PrepareShare state. - Applications should be prepared to ignore + Applications should be prepared to ignore response data that contains extension elements. An extended state should always be treated as an UNKNOWN state if the application @@ -1383,9 +1321,7 @@ Host: servers.api.openstack.org/v2/ Extended Server Response: XML - - - + Extended Server Response: JSON @@ -1393,9 +1329,7 @@ Host: servers.api.openstack.org/v2/ Extended Action: XML - - - + Extended Action: JSON @@ -1407,11 +1341,11 @@ Host: servers.api.openstack.org/v2/ Faults
Synchronous Faults - When an error occurs at request time, the - system will return an HTTP error response code - denoting the type of error. The system will also - return additional information about the fault in - the body of the response. + When an error occurs at request time, the system + will return an HTTP error response code denoting + the type of error. The system will also return + additional information about the fault in the body + of the response. Fault Response: XML @@ -1420,7 +1354,7 @@ Host: servers.api.openstack.org/v2/ Fault Response: JSON - The error code is returned in the body of the + The error code is returned in the body of the response for convenience. The message section returns a human-readable message that is appropriate for display to the end user. The @@ -1429,7 +1363,7 @@ Host: servers.api.openstack.org/v2/ trace—to assist in tracking down an error. The detail section may or may not be appropriate for display to an end user. - The root element of the fault (e.g. + The root element of the fault (e.g. computeFault) may change depending on the type of error. The following is a list of possible elements along with their associated error codes. @@ -1525,14 +1459,14 @@ Host: servers.api.openstack.org/v2/ JSON - From an XML schema perspective, all API faults + From an XML schema perspective, all API faults are extensions of the base fault type ComputeAPIFault. When working with a system that binds XML to actual classes (such as JAXB), one should be capable of using ComputeAPIFault as a “catch-all” if there's no interest in distinguishing between individual fault types. - The OverLimit fault is generated when a rate + The OverLimit fault is generated when a rate limit threshold is exceeded. For convenience, the fault adds a retryAfter attribute that contains the content of the @@ -1549,7 +1483,7 @@ Host: servers.api.openstack.org/v2/
Asynchronous Faults - An error may occur in the background while a + An error may occur in the background while a server or image is being built or while a server is executing an action. In these cases, the server or image is placed in an ERROR state @@ -2197,18 +2131,14 @@ Host: servers.api.openstack.org/v2/ Creating a Server with a Access IP: XML - - - + Creating a Server with a Access IP: JSON - - - + - Note that both IPv4 and IPv6 addresses may + Note that both IPv4 and IPv6 addresses may be used as access addresses and both addresses may be assigned simultaneously as illustrated below. Access addresses may be updated after a @@ -2217,17 +2147,13 @@ Host: servers.api.openstack.org/v2/ Creating a Server with Multiple Access IPs: XML - - - + Creating a Server with Multiple Access IPs: JSON - - - +
@@ -2396,7 +2322,7 @@ Host: servers.api.openstack.org/v2/ - Access addresses may simultaneously be updated + Access addresses may simultaneously be updated as illustrated below. Server Update Access Address Request: @@ -3856,7 +3782,7 @@ Host: servers.api.openstack.org/v2/ <?hard-pagebreak?> <section xml:id="MetadataSection"> <title>Metadata - The following operations allow access to metadata + The following operations allow access to metadata after a server or image has been created.
List Metadata diff --git a/openstack-compute-api-2/src/samples/choices.xml b/openstack-compute-api-2/src/samples/choices.xml index 8ce868c..f2d68ea 100644 --- a/openstack-compute-api-2/src/samples/choices.xml +++ b/openstack-compute-api-2/src/samples/choices.xml @@ -1,28 +1,29 @@ + + + + + + - - - - - - - - + - + - - - - - - + + + + + + diff --git a/openstack-compute-api-2/src/samples/ext-servers.xml b/openstack-compute-api-2/src/samples/ext-servers.xml index d91fc52..d549134 100644 --- a/openstack-compute-api-2/src/samples/ext-servers.xml +++ b/openstack-compute-api-2/src/samples/ext-servers.xml @@ -1,58 +1,52 @@ - - - - - - - - - - - Web Head 1 - 2.1 - - - - - - - - - - - - - - - - - + + + + + + + + + + + Web Head 1 + 2.1 + + + + + + + + + + + + + + + + + - - - + + + diff --git a/openstack-compute-api-2/src/samples/extension.xml b/openstack-compute-api-2/src/samples/extension.xml index c6e4023..35e3bd0 100644 --- a/openstack-compute-api-2/src/samples/extension.xml +++ b/openstack-compute-api-2/src/samples/extension.xml @@ -1,24 +1,14 @@ - - - - - Adds the capability to share an image with other users. - - - + Adds the capability to share an image with other + users. + - - + diff --git a/openstack-compute-api-2/src/samples/extensions.xml b/openstack-compute-api-2/src/samples/extensions.xml index 09784bb..2087915 100644 --- a/openstack-compute-api-2/src/samples/extensions.xml +++ b/openstack-compute-api-2/src/samples/extensions.xml @@ -1,43 +1,27 @@ - - - + - - - Adds the capability to share an - image with other users. - - + alias="RAX-PIE" updated="2011-01-22T13:25:27-06:00"> + Adds the capability to share an image with other + users. + - + type="application/vnd.sun.wadl+xml" + href="http://docs.rackspacecloud.com/servers/api/ext/cs-pie.wadl" + /> - - - - Allows mounting cloud block - storage volumes. - - + alias="RAX-CBS" updated="2011-01-12T11:22:33-06:00"> + Allows mounting cloud block storage volumes. + - + type="application/vnd.sun.wadl+xml" + href="http://docs.rackspacecloud.com/servers/api/ext/cs-cbs.wadl" + /> diff --git a/openstack-compute-api-2/src/samples/images-page1.xml b/openstack-compute-api-2/src/samples/images-page1.xml index b4c87b5..d7e5481 100644 --- a/openstack-compute-api-2/src/samples/images-page1.xml +++ b/openstack-compute-api-2/src/samples/images-page1.xml @@ -1,13 +1,12 @@ - - - - diff --git a/openstack-compute-api-2/src/samples/server-post-req-short.json b/openstack-compute-api-2/src/samples/server-post-req-short.json index 78523dd..d461070 100644 --- a/openstack-compute-api-2/src/samples/server-post-req-short.json +++ b/openstack-compute-api-2/src/samples/server-post-req-short.json @@ -9,7 +9,15 @@ "personality": [ { "path": "/etc/banner.txt", - "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 b25zLiINCg0KLVJpY2hhcmQgQmFjaA==" + "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp + dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k + IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs + c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g + QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo + ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv + dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy + c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 + b25zLiINCg0KLVJpY2hhcmQgQmFjaA==" } ] } diff --git a/openstack-compute-api-2/src/samples/server-post-req.json b/openstack-compute-api-2/src/samples/server-post-req.json index 2269848..44ead2a 100644 --- a/openstack-compute-api-2/src/samples/server-post-req.json +++ b/openstack-compute-api-2/src/samples/server-post-req.json @@ -8,7 +8,15 @@ "name": "new-server-test", "personality": [ { - "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", + "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp + dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k + IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs + c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g + QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo + ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv + dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy + c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 + b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", "path": "/etc/banner.txt" } ] diff --git a/openstack-compute-api-2/src/samples/version.xml b/openstack-compute-api-2/src/samples/version.xml index fb71e65..b01adf3 100644 --- a/openstack-compute-api-2/src/samples/version.xml +++ b/openstack-compute-api-2/src/samples/version.xml @@ -1,23 +1,17 @@ - - - + + - - - - - - - - + + + + diff --git a/openstack-compute-api-2/src/samples/versions.xml b/openstack-compute-api-2/src/samples/versions.xml index bf407cd..f14d54e 100644 --- a/openstack-compute-api-2/src/samples/versions.xml +++ b/openstack-compute-api-2/src/samples/versions.xml @@ -1,18 +1,14 @@ - - - + - - - - + + - - - + + diff --git a/openstack-compute-api-2/src/section_concepts.xml b/openstack-compute-api-2/src/section_concepts.xml new file mode 100644 index 0000000..8cfac65 --- /dev/null +++ b/openstack-compute-api-2/src/section_concepts.xml @@ -0,0 +1,80 @@ + + + + + + + + + GET'> + PUT'> + POST'> + DELETE'> +]> +
+ + Concepts + To use the OpenStack Compute API effectively, you should + understand several key concepts: + + + Server + A virtual machine (VM) instance in the compute + system. Flavor and image are requisite elements when + creating a server. + + + Flavor + An available hardware configuration for a server. + Each flavor has a unique combination of disk space, + memory capacity and priority for CPU time. + + + Image + A collection of files used to create or rebuild a + server. Operators provide a number of pre-built OS + images by default. You may also create custom images + from cloud servers you have launched. These custom + images are useful for backup purposes or for producing + “gold” server images if you plan to deploy a + particular server configuration frequently. + + + Reboot + Use this function to perform either a soft or hard + reboot of a server. With a soft reboot, the operating + system is signaled to restart, which allows for a + graceful shutdown of all processes. A hard reboot is + the equivalent of power cycling the server. The + virtualization platform should ensure that the reboot + action has completed successfully even in cases in + which the underlying domain/VM is paused or + halted/stopped. + + + Rebuild + Use this function to remove all data on the server and + replaces it with the specified image. Server ID and IP + addresses remain the same. + + + Resize + Use this function to convert an existing server to a + different flavor, in essence, scaling the server up or + down. The original server is saved for a period of + time to allow rollback if there is a problem. All + resizes should be tested and explicitly confirmed, at + which time the original server is removed. All resizes + are automatically confirmed after 24 hours if you do not + confirm or revert them. + + +