diff --git a/api-ref/pom.xml b/api-ref/pom.xml index c903b22b5..b9c3a3db3 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -32,7 +32,7 @@ generate-sources - api-ref.xml, api-ref-compute.xml, api-ref-compute-ext.xml, + api-ref.xml, api-ref-blockstorage.xml, api-ref-compute.xml, api-ref-compute-ext.xml, api-ref-identity.xml, api-ref-image.xml, api-ref-networking.xml, api-ref-objectstorage.xml, api-ref-blockstorage.xml, api-ref-orchestration.xml, @@ -54,7 +54,7 @@ bk-api-ref.xml api-ref - --> + os-api-ref-blockstorage @@ -153,7 +153,7 @@ bk-api-ref-telemetry.xml api-ref-telemetry - + --> diff --git a/api-ref/src/docbkx/api-ref-blockstorage.xml b/api-ref/src/docbkx/api-ref-blockstorage.xml index 3349edce9..bce149ea2 100644 --- a/api-ref/src/docbkx/api-ref-blockstorage.xml +++ b/api-ref/src/docbkx/api-ref-blockstorage.xml @@ -7,15 +7,17 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-blockstorage"> - - OpenStack Block Storage APIs + + OpenStack Block Storage API 2010-2014 + + + - diff --git a/api-ref/src/docbkx/api-ref-compute-ext.xml b/api-ref/src/docbkx/api-ref-compute-ext.xml index c4110415a..d01a03818 100644 --- a/api-ref/src/docbkx/api-ref-compute-ext.xml +++ b/api-ref/src/docbkx/api-ref-compute-ext.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-compute-ext"> - + OpenStack Compute API extensions 2010-2014 @@ -15,7 +15,9 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-compute.xml b/api-ref/src/docbkx/api-ref-compute.xml index bd6101419..7ca973a1a 100644 --- a/api-ref/src/docbkx/api-ref-compute.xml +++ b/api-ref/src/docbkx/api-ref-compute.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-compute"> - + OpenStack Compute API 2010-2014 @@ -15,7 +15,9 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-identity.xml b/api-ref/src/docbkx/api-ref-identity.xml index 2361c5360..1253739a1 100644 --- a/api-ref/src/docbkx/api-ref-identity.xml +++ b/api-ref/src/docbkx/api-ref-identity.xml @@ -6,8 +6,8 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" - xml:id="api.openstack.org-identity"> - + xml:id="api.openstack.org-identity-v2"> + OpenStack Identity Service APIs and extensions 2010-2014 @@ -15,8 +15,10 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-image.xml b/api-ref/src/docbkx/api-ref-image.xml index d26af33e9..bff3907a9 100644 --- a/api-ref/src/docbkx/api-ref-image.xml +++ b/api-ref/src/docbkx/api-ref-image.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-image"> - + OpenStack Image Service APIs 2010-2014 @@ -15,8 +15,10 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-networking.xml b/api-ref/src/docbkx/api-ref-networking.xml index 8c9919981..e893f88f1 100644 --- a/api-ref/src/docbkx/api-ref-networking.xml +++ b/api-ref/src/docbkx/api-ref-networking.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-networking"> - + OpenStack Networking APIs and extensions 2010-2014 @@ -15,8 +15,10 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-objectstorage.xml b/api-ref/src/docbkx/api-ref-objectstorage.xml index 39c90e8da..863cf3a0c 100644 --- a/api-ref/src/docbkx/api-ref-objectstorage.xml +++ b/api-ref/src/docbkx/api-ref-objectstorage.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-objectstorage"> - + OpenStack Object Storage API 2010-2014 @@ -15,7 +15,9 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-orchestration.xml b/api-ref/src/docbkx/api-ref-orchestration.xml index e80aa58ba..092a0888c 100644 --- a/api-ref/src/docbkx/api-ref-orchestration.xml +++ b/api-ref/src/docbkx/api-ref-orchestration.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-orchestration"> - + OpenStack Orchestration API 2010-2014 @@ -15,7 +15,9 @@ + + + - diff --git a/api-ref/src/docbkx/api-ref-telemetry.xml b/api-ref/src/docbkx/api-ref-telemetry.xml index ac2d7d2ec..ab3e7e50e 100644 --- a/api-ref/src/docbkx/api-ref-telemetry.xml +++ b/api-ref/src/docbkx/api-ref-telemetry.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-telemetry"> - + OpenStack Telemetry API 2010-2014 @@ -15,7 +15,9 @@ + + + - diff --git a/api-ref/src/docbkx/ch_blockstorage-api.xml b/api-ref/src/docbkx/ch_blockstorage-api.xml index 4f2064d14..4db060083 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2"> Block Storage API v2.0 - Manages volumes and snapshots for use with the Block Storage + Manage volumes and snapshots for use with the Block Storage API, also known as cinder services.
Volumes diff --git a/api-ref/src/docbkx/ch_compute-core.xml b/api-ref/src/docbkx/ch_compute-core.xml index 0bd0e45bb..bf66e83be 100644 --- a/api-ref/src/docbkx/ch_compute-core.xml +++ b/api-ref/src/docbkx/ch_compute-core.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - Compute API v2 - Launches virtual machines from images or images stored on + Compute API v2 + Launch virtual machines from images or images stored on persistent volumes. API v1.1 is identical to API v2.
Versions - Gets information about a specific version of the + Get information about a specific version of the API.
Extensions - Lists all available extensions and gets details for a + List all available extensions and get details for a specified extension. Extensions introduce features and vendor-specific functionality in the API without requiring a version change. @@ -52,7 +39,7 @@
Limits - Gets rate and absolute limits. + Get rate and absolute limits. @@ -62,7 +49,7 @@
Servers - Lists, creates, gets details for, updates, and deletes + List, create, get details for, update, and delete servers. - +
Server metadata - Sets, lists, gets details for, and deletes server + Set, list, get details for, and delete server metadata or metadata items.
Server addresses - Lists addresses for a specified server or a specified + List addresses for a specified server or a specified server and network.
Server actions - Performs actions for a specified server, including + Perform actions for a specified server, including change administrator password, reboot, rebuild, resize, and create image from server. @@ -134,7 +121,7 @@
Flavors - Lists available flavors and gets details for a specified + List available flavors and get details for a specified flavor. A flavor is a hardware configuration for a server. Each flavor is a unique combination of disk space and memory capacity. @@ -155,9 +142,9 @@
Images - Lists available images, gets details for a specified - image, and deletes an image. - Also, sets, lists, gets details for, and deletes image + List available images, get details for a specified + image, and delete an image. + Also, set, list, get details for, and delete image metadata. An image is a collection of files that you use to create or rebuild a server. By default, operators provide @@ -182,7 +169,7 @@
Image metadata - Sets, lists, gets details for, and deletes image + Set, list, get details for, and delete image metadata or metadata items. Compute API v2 extensions - Adds capabilities to the core Compute API. Use extensions to - add features, MIME types, actions, states, headers, - parameters, and resources to the core API. Query the Compute - API to list available extensions with a &GET; request to - v2/extensions. + Extensions add features, MIME types, actions, states, + headers, parameters, and resources to the core Compute API. + Query the Compute API to list available extensions with a + &GET; request to v2/extensions.
Server admin actions (action) - Permits administrators to perform actions on a server. - Specify the action in the request body. + Administrator only. Perform actions on a server. Specify + the action in the request body.
Server console output (os-console-output) - Gets console output for a server instance. + Get console output for a server instance.
Server console (os-consoles) - Gets a console for a server instance. + Get a console for a server instance.
Server deferred delete (os-deferred-delete) - Force-deletes a server or restores a deleted + Force-delete a server or restore a deleted server.
Server diagnostics (diagnostics) - Gets the usage data for a server. + Get the usage data for a server.
Flavor access (flavors) - Creates and gets details for private flavors. Also, - lists, adds and removes tenants' access to private - flavors. + Create and get details for private flavors. Also, list, + add, and remove tenants' access to private flavors.
Flavors with FlavorDisabled attribute (flavors) - Gets details for a flavor, and lists details for - available flavors. Includes the + Get details for a flavor, and list details for available + flavors. Includes the OS-FLV-DISABLED:disabled extended attribute.
Flavor extra-specs (os-extra-specs) - Lists, creates, and updates the extra-specs or keys for - a flavor. + List, create, and update the extra-specs or keys for a + flavor. @@ -82,8 +80,8 @@
Flavors with rxtx_factor extended attribute (flavors) - Creates a flavor, gets details for a specified flavor, - and lists details for available flavors. Includes the + Create a flavor, get details for a specified flavor, and + list details for available flavors. Includes the rxtx_factor extended attribute, related to configured bandwidth cap values.
Flavors with extended attributes (flavors) - Creates a flavor, gets details for a flavor, and lists + Create a flavor, get details for a flavor, and list details for available flavors. Includes the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and @@ -103,14 +101,14 @@
Flavors create or delete (flavors) - Creates or deletes flavors. + Create or delete flavors.
Images with size attribute (images) - Lists details for available images or gets details for a + List details for available images or get details for a specified image. Includes the OS-EXT-IMG-SIZE:size extended attribute, which shows the image size. @@ -120,7 +118,7 @@
Limits with project usage (limits) - Extends limits to show the project usage. Shows + Extend limits to show the project usage. Show information such as RAM or instance quotas usage. Limits with project usage for administrators (limits) - Extends limits to enable administrators to show the - project usage for a specified customer project ID. Shows + Extend limits to enable administrators to show the + project usage for a specified customer project ID. Show information such as RAM or instance quotas usage.
Guest agents (os-agents) - Creates, updates, and deletes guest agents. Use guest + Create, update, and delete guest agents. Use guest agents to access files on the disk, configure networking, or run other applications or scripts in the guest while it runs. This hypervisor-specific extension is not currently @@ -151,16 +149,16 @@
Host aggregates (os-aggregates) - Creates and manages host aggregates. An aggregate - assigns metadata to groups of compute nodes. Aggregates - are only visible to the cloud provider. + Create and manage host aggregates. An aggregate assigns + metadata to groups of compute nodes. Aggregates are only + visible to the cloud provider.
Attach interfaces (os-attach-interfaces) - Creates, lists, and gets details for port + Create, list, and get details for port interfaces.
Root certificates (os-certificates) - Creates and shows details for a root certificate. + Creates and show details for a root certificate.
Cloudpipe (os-cloudpipe) - Manages virtual VPNs for projects. + Manage virtual VPNs for projects. @@ -189,7 +187,7 @@
Fixed IPs (os-fixed-ips) Shows data for a specified fixed IP, such as host name, - CIDR, and address. Also, reserves or frees a fixed + CIDR, and address. Also, reserve or free a fixed IP.
Floating IP DNS records (os-floating-ip-dns) - Manages DNS records associated with IP addresses - allocated by the Floating IPs extension. Requests are + Manage DNS records associated with IP addresses + allocated by the floating IPs extension. Requests are dispatched to a DNS driver selected at startup.
Floating IP pools (os-floating-ip-pools) - Manages groups of floating IPs. + Manage groups of floating IPs.
Floating IPs (os-floating-ips) - Assigns and allocates floating IP addresses to instances + Assign and allocate floating IP addresses to instances that run in an OpenStack cloud.
Floating IPs bulk (os-floating-ips-bulk) - Bulk creates, deletes, and lists floating IPs. By - default, the pool is named nova. Use the + Bulk create, delete, and list floating IPs. By default, + the pool is named nova. Use the os-floating-ip-pools extension to view available pools.
Hosts (os-hosts) - Manages physical hosts. + Manage physical hosts.
Hypervisors (os-hypervisors) - Displays extra statistical information from the machine + Display extra statistical information from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).
Server actions (os-instance-actions) - Permits all users to list available actions for a - specified server. Permits administrators to get details - for a specified action for a specified server. + List available actions for a specified server. + Administrators can get details for a specified action for + a specified server.
Keypairs (os-keypairs) - Generates, imports, and deletes SSH keys. + Generate, import, and delete SSH keys.
Migrations (os-migrations) - Enables administrative users to fetch in-progress - migrations for a region or a specified cell in a - region. + Administrators only. Fetch in-progress migrations for a + region or a specified cell in a region.
Networks (os-networks) - Shows network information for or deletes networks. Also, - disassociates a network from a project if you use vlan + Show network information for or delete networks. Also, + disassociate a network from a project if you use vlan mode.
Quota sets (os-quota-sets) - Permits administrators, depending on policy settings, to - view quotas for a tenant and view and update default + Administrators only, depending on policy settings. View + quotas for a tenant and view and update default quotas.
Server rescue and unrescue (os-rescue) - Puts a server into rescue mode or unrescues a server in + Put a server into rescue mode or unrescue a server in rescue mode.
Server start and stop (os-server-start-stop) - Starts a stopped server or stops a running - server. + Start a stopped server or stop a running server.
Security groups (os-security-groups) - Lists, shows information for, creates, and deletes - security groups. + List, show information for, create, and delete security + groups. @@ -315,23 +311,23 @@
Rules for default security group (os-security-group-default-rules) - Lists, shows information for, and creates default - security group rules. + List, show information for, and create default security + group rules.
Server password (os-server-password) - Retrieves and resets the encrypted admin password set - through metadata service. + Get and reset the encrypted admin password set through + the metadata service.
Manage services (os-services) - Lists, enables, and disables Compute services in all + List, enable, and disable Compute services in all hosts.
Usage reports (os-simple-tenant-usage) - Reports usage statistics on compute and storage + Report usage statistics on compute and storage resources.
Virtual interfaces (os-virtual-interfaces) - Lists the virtual interfaces for a specified server + List the virtual interfaces for a specified server instance.
Volume extension (os-volumes, os-snapshots) - Manages volumes and snapshots for use with the Compute + Manage volumes and snapshots for use with the Compute API.
Volume attachments (os-volume_attachments) - Attaches volumes created through the volume API to - server instances. Also, lists volume attachments for a - server instance, gets volume details for a volume - attachment, and deletes a volume attachment. + Attach volumes created through the volume API to server + instances. Also, list volume attachments for a server + instance, get volume details for a volume attachment, and + delete a volume attachment. @@ -374,7 +370,7 @@
Servers with block device mapping format (servers) - Creates a server with a block device mapping. + Create a server with a block device mapping. @@ -382,7 +378,7 @@
Server OS-EXT-IPS-MAC:mac_addr extended attribute (servers) - Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you + Add OS-EXT-IPS-MAC:mac_addr extended attribute when you create, show information for, or list servers.
Configuration drive (servers) - Extends servers and images with a configuration + Extend servers and images with a configuration drive. Servers with extended availability zones (servers) - Shows the instance availability zone for compute nodes + Show the instance availability zone for compute nodes (nova-compute). Internal services appear in their own internal availability zone. @@ -410,13 +406,13 @@
Servers and images with disk config (servers, images) - Extends servers with the diskConfig attribute. + Extend servers with the diskConfig attribute.
Server IP type (servers) - Shows the type of the IP addresses assigned to an + Show the type of the IP addresses assigned to an instance. Type is either fixed or floating.
Server extended attributes (servers) - Shows metadata for servers. + Show metadata for servers.
Server extended status (servers) - Shows extended status information, vm_state, task_state, + Show extended status information, vm_state, task_state, and power_state, in detailed server responses.
Servers with scheduler hints (servers) - Creates a server with scheduler hints. + Create a server with scheduler hints.
Servers multiple create (servers) - Creates one or more servers with an optional reservation + Create one or more servers with an optional reservation ID. The request and response examples show how to create multiple servers with or without a reservation ID. Image Service API v1 - Loads images for use at launch time by the Compute API. - Also, assigns metadata to images. Some cloud implementations - do not expose this API and offer pretested images only. + Load images for use at launch time by the Compute API. Also, + assign metadata to images. + Some cloud implementations do not expose this API and offer + pretested images only. diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml index ff17ed701..27212c86d 100644 --- a/api-ref/src/docbkx/ch_images-v2.xml +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -10,15 +10,15 @@ Image Service API v2.0, API v2.1, and API v2.2.
Images - Creates, updates, and deletes image metadata records. - Enables users to share images with each other. Also, - uploads and downloads raw image data. + Create, update, and delete image metadata records. + Enable users to share images with each other. Also, + upload and download raw image data.
Image schemas - Gets a JSON-schema document that represents an images or + Get a JSON-schema document that represents an images or image entity. Networking API v2.0 - Provides virtual networking services among devices that are + Use virtual networking services among devices that are managed by the OpenStack Compute service. The Networking API v2.0 combines the API v1.1 functionality with some essential Internet Protocol Address Management (IPAM) functionality. diff --git a/api-ref/src/docbkx/ch_objectstorage-v1.xml b/api-ref/src/docbkx/ch_objectstorage-v1.xml index 14247f832..d81a0da9e 100644 --- a/api-ref/src/docbkx/ch_objectstorage-v1.xml +++ b/api-ref/src/docbkx/ch_objectstorage-v1.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="objectstorage-v1"> Object Storage API v1 - Manages the accounts, containers, and objects in the Object + Manage the accounts, containers, and objects in the Object Storage system. To run the cURL command examples for these requests, set these environment variables: @@ -46,9 +46,8 @@ Accept-Ranges: bytes >Header Field Definitions.
Accounts - Lists containers for a specified account. Creates, - updates, and deletes account metadata. Shows account - metadata. + List containers for a specified account. Create, + update, show, and delete account metadata. @@ -60,9 +59,9 @@ Accept-Ranges: bytes
Containers - Lists objects in a specified container. Creates, shows - details for, and deletes containers. Creates, updates, - shows, and deletes container metadata. + List objects in a specified container. Create, show + details for, and delete containers. Create, update, + show, and delete container metadata. @@ -76,9 +75,9 @@ Accept-Ranges: bytes
Objects - Creates, replaces, shows details for, and deletes - objects. Copies objects with another object with a new or - different name. Updates object metadata. + Create, replace, show details for, and delete + objects. Copy objects from another object with a new or + different name. Update object metadata. diff --git a/api-ref/src/docbkx/ch_orchestration-v1.xml b/api-ref/src/docbkx/ch_orchestration-v1.xml index e9d1d3383..7347b54a4 100644 --- a/api-ref/src/docbkx/ch_orchestration-v1.xml +++ b/api-ref/src/docbkx/ch_orchestration-v1.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="orchestration-v1"> Orchestration API v1.0 - Uses a template language to orchestrate OpenStack + Use a template language to orchestrate OpenStack services.
Stacks diff --git a/api-ref/src/docbkx/ch_telemetry-v2.xml b/api-ref/src/docbkx/ch_telemetry-v2.xml index af2d4cb79..0cdb60cc4 100644 --- a/api-ref/src/docbkx/ch_telemetry-v2.xml +++ b/api-ref/src/docbkx/ch_telemetry-v2.xml @@ -7,7 +7,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="telemetry-v2"> Telemetry API v2.0 - Manages telemetry operations. + Manage telemetry operations.
Alarms Lists, creates, gets details for, updates, and deletes @@ -36,7 +36,7 @@
Meters - Gets information for meters. + Get information for meters. @@ -55,7 +55,7 @@
Resources - Gets information for resources. + Get information for resources. diff --git a/api-ref/src/docbkx/itemizedlist-service-list.xml b/api-ref/src/docbkx/itemizedlist-service-list.xml new file mode 100644 index 000000000..99cc88304 --- /dev/null +++ b/api-ref/src/docbkx/itemizedlist-service-list.xml @@ -0,0 +1,45 @@ + + + + Block + Storage Service API + + + Compute + API + + + Compute API + extensions + + + Identity + Service API and extensions + + + Image Service + API + + + Networking + API and extensions + + + Object + Storage API + + + Orchestration API + + + Telemetry + API + + diff --git a/api-ref/src/docbkx/preface.xml b/api-ref/src/docbkx/preface.xml index 4d8c41a68..fae7fe92d 100644 --- a/api-ref/src/docbkx/preface.xml +++ b/api-ref/src/docbkx/preface.xml @@ -1,3 +1,4 @@ + @@ -16,44 +17,7 @@ OpenStack API Complete Reference Use the OpenStack APIs and extensions in your OpenStack cloud. - - - Block - Storage Service API - - - Compute - API - - - Compute - API extensions - - - Identity - Service API and extensions - - - Image Service - API - - - Networking API and extensions - - - Object - Storage API - - - Orchestration API - - - Telemetry - API - - + You must install the packages for each API separately. After you authenticate through the Identity Service diff --git a/pom.xml b/pom.xml index 6083f6516..4bedb783c 100644 --- a/pom.xml +++ b/pom.xml @@ -40,7 +40,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 1.13.0 + 1.13.1-SNAPSHOT