Permalink
Browse files

Removes RST documentation and moves it to openstack-manuals

Avoiding redundant information and confusion.

Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
  • Loading branch information...
1 parent ca50cf4 commit fd6b21b9483f8f49d38b2278720cfb32e1ff30c4 annegentle committed Apr 30, 2012
Showing with 6 additions and 4,005 deletions.
  1. +0 −123 doc/source/api_ext/ext_aggregates.rst
  2. +0 −227 doc/source/api_ext/ext_config_drive.rst
  3. +0 −203 doc/source/api_ext/ext_floating_ip_dns.rst
  4. +0 −165 doc/source/api_ext/ext_floating_ips.rst
  5. +0 −103 doc/source/api_ext/ext_keypairs.rst
  6. +0 −111 doc/source/api_ext/ext_multinic.rst
  7. +0 −100 doc/source/api_ext/ext_quotas.rst
  8. +0 −111 doc/source/api_ext/ext_rescue.rst
  9. +0 −112 doc/source/api_ext/ext_security_group.rst
  10. +0 −110 doc/source/api_ext/ext_virtual_interfaces.rst
  11. +0 −112 doc/source/api_ext/ext_volumes.rst
  12. +0 −56 doc/source/api_ext/index.rst
  13. +0 −105 doc/source/api_ext/rst_extension_template.rst
  14. +0 −90 doc/source/cloud101.rst
  15. +0 −103 doc/source/community.rst
  16. +6 −26 doc/source/index.rst
  17. +0 −12 doc/source/installer.rst
  18. +0 −231 doc/source/nova.concepts.rst
  19. +0 −77 doc/source/object.model.rst
  20. +0 −31 doc/source/quickstart.rst
  21. +0 −57 doc/source/runnova/binaries.rst
  22. +0 −49 doc/source/runnova/euca2ools.rst
  23. +0 −36 doc/source/runnova/flags.rst
  24. +0 −96 doc/source/runnova/index.rst
  25. +0 −26 doc/source/runnova/managing.images.rst
  26. +0 −86 doc/source/runnova/managing.instance.types.rst
  27. +0 −59 doc/source/runnova/managing.instances.rst
  28. +0 −92 doc/source/runnova/managing.networks.rst
  29. +0 −77 doc/source/runnova/managing.projects.rst
  30. +0 −82 doc/source/runnova/managing.users.rst
  31. +0 −37 doc/source/runnova/managingsecurity.rst
  32. +0 −27 doc/source/runnova/monitoring.rst
  33. +0 −60 doc/source/runnova/network.flat.rst
  34. +0 −176 doc/source/runnova/network.vlan.rst
  35. +0 −263 doc/source/runnova/nova.manage.rst
  36. +0 −271 doc/source/runnova/vncconsole.rst
  37. +0 −77 doc/source/service.architecture.rst
  38. +0 −226 doc/source/vmwareapi_readme.rst
@@ -1,123 +0,0 @@
-The Host Aggregates Extension
-=================================================================
-About this Extension
---------------------
-This extension introduces the concept of aggregates into Nova. Host aggregates are different from zones and availability zones: while the former allows the partition of Nova deployments into logical groups for load balancing and instance distribution, the latter are for providing some form of physical isolation and redundancy from other availability zones (e.g. by using separate power supply and network gears). Availability zones do not necessarily mean geographic distribution whereas zones usually do. Host aggregates can be regarded as a mechanism to further partitioning an availability zone, i.e. into multiple groups of hosts that share common resources like storage and network. This enables a finer level of granularity in which to structure an entire OpenStack deployment. Aggregates allows higher availability of a single guest instance within an availability zone, it enables advanced VM placement strategies, and more importantly it enables hosts' zero-downtime upgrades (for example, via VM live migration across members of the aggregate, thus causing no disruption to guest instances).
-
-You can use this extension when you have multiple Compute nodes installed (only XenServer/XCP via xenapi driver is currently supported), and you want to leverage the capabilities of the underlying hypervisor resource pools. For example, you want to enable VM live migration (i.e. VM migration within the pool) or enable host maintenance with zero-downtime for guest instances. Please, note that VM migration across pools (i.e. storage migration) is not yet supported in XenServer/XCP, but will be added when available. Bear in mind that the two migration techniques are not mutually exclusive and can be used in combination for a higher level of flexibility in your cloud management.
-
-To find more about it, please read http://wiki.openstack.org/host-aggregates or quick-search for 'aggregates' on the Nova developer guide.
-
-Pre-requisites depend on the kind of hypervisor support you are going to use. As for XenServer/XCP, the same requirements for resource pools apply.
-
-To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
-
-Extension Overview
-~~~~~~~~~~~~~~~~~~
-
-Name
- Host Aggregates
-
-Namespace
- http://docs.openstack.org/compute/ext/aggregates/api/v1.1
-
-Alias
- OS-AGGREGATES
-
-Contact
- Armando Migliaccio <armando.migliaccio@citrix.com>
-
-Status
- Released
-
-Extension Version
- v1.0 (2012-02-28)
-
-Dependencies
- Compute API 1.1
-
-Doc Link (PDF)
- http://
-
-Doc Link (WADL)
- http://
-
-Short Description
- This extension enables the use of hypervisor resource pools in Nova.
-
-Sample Query Responses
-~~~~~~~~~~~~~~~~~~~~~~
-
-As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
-
-Extension Query Response: XML::
-
- <extension name="Aggregates" namespace="http://docs.openstack.org/compute/ext/aggregates/api/v1.1" alias="os-aggregates" updated="2012-01-12T00:00:00+00:00"><description>Admin-only aggregate administration</description></extension>
-
-Extension Query Response: JSON::
-
- {"extension": {"updated": "2012-01-12T00:00:00+00:00", "name": "Aggregates", "links": [], "namespace": "http://docs.openstack.org/compute/ext/aggregates/api/v1.1", "alias": "os-aggregates", "description": "Admin-only aggregate administration"}}
-
-Document Change History
-~~~~~~~~~~~~~~~~~~~~~~~
-
-============= =====================================
-Revision Date Summary of Changes
-2012-02-28 Initial draft
-2012-03-30 Reformat of content
-============= =====================================
-
-
-Summary of Changes
-------------------
-This extension to the OpenStack Compute API allows the creation and management of host aggregates (i.e. pools of compute nodes).
-
-This support is provided by the addition of new actions.
-
-New Actions
-~~~~~~~~~~~
-When a new aggregate has been created, actions can be executed using:
-
- POST /v1.1/<tenant-id>/os-aggregates/<aggregate-id>/action
-
-Valid actions are:
-
-set_metadata
-add_host
-remove_host
-
-Normal response Code: 200
-
-For example, to set metadata for an aggregate the following xml must be submitted:
-
-{"set_metadata": {"metadata": {"foo_key": "foo_value"}}}
-
-For example, to add a host to an aggregate, the following xml must be submitted:
-
-{"add_host": {"host": "<host-id>"}}
-
-For example, to remove a host from an aggregate, the following xml must be submitted:
-
-{"remove_host": {"host": "<host-id>"}}
-
-Error Response Code(s) conflict (409), badRequest (400), itemNotFound (404)
-
-New Faults
-~~~~~~~~~~
-None
-
-New Headers
-~~~~~~~~~~~
-None
-
-New Resources
-~~~~~~~~~~~~~
-None
-
-New States
-~~~~~~~~~~
-None
-
-Changes to the Cloud Servers Specification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-None
@@ -1,227 +0,0 @@
-The Config Drive Extension
-=================================================================
-About this Extension
---------------------
-The config-drive extension enables attaching a separate drive to the Compute guest on instance create. It is used with the OpenStack Compute 1.1 API to write configuration data into guest for those guests whose root filesystems cannot be mounted by the Compute host.
-
-To use this extension, you must have installed Compute, with libvirt or Xen using local disk.
-
-To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://example.com/v1.1/tenant/extensions.
-
-Extension Overview
-~~~~~~~~~~~~~~~~~~
-
-Name
- Config Drive
-
-Namespace
- http://docs.openstack.org/ext/config-drive/api/v1.1
-
-Alias
- ORG-EXT
-
-Contact
- Christopher MacGown <chris@pistoncloud.com>
-
-Status
- Alpha
-
-Extension Version
- v1.0 (2011-09-16)
-
-Dependencies
- Compute API 1.1
-
-Doc Link (PDF)
- http://
-
-Doc Link (WADL)
- http://
-
-Short Description
- This extension enables the assignment of config-drives to a
- compute guest on instance create running in an OpenStack cloud.
-
-Sample Query Responses
-~~~~~~~~~~~~~~~~~~~~~~
-
-As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.
-
-Extension Query Response: XML::
-
- TBD
-
-.. todo:: Provide example of extension query XML response.
-
-Extension Query Response: JSON::
-
- TBD
-
-.. todo:: Provide example of extension query JSON response.
-
-Document Change History
-~~~~~~~~~~~~~~~~~~~~~~~
-
-============= =====================================
-Revision Date Summary of Changes
-2011-09-16 Initial draft
-2012-03-30 Reformat of content
-============= =====================================
-
-
-Summary of Changes
-------------------
-This extension to the OpenStack Compute API allows the addition of a configuration drive to an instance.
-
-This support is provided by the addition of new resources.
-
-New Actions
-~~~~~~~~~~~
-None
-
-New Faults
-~~~~~~~~~~
-None
-
-New Headers
-~~~~~~~~~~~
-None
-
-New Resources
-~~~~~~~~~~~~~
-This extension to the OpenStack Compute API adds the following resources:
-
-A config_drive attribute to the servers API that is None by default, but can optionally be True or the imageRef of a config-drive image.
-
-Upon instance create, a guest built with a True config_drive attribute will create a local volume and partition it as a fat32 drive, all passed in metadata, networks, and keys will be written to the config_drive which is associated as the last available disk on the instance.
-Upon instance create, a guest built with an imageRef config_drive attribute will create a local volume from the image.
-
-New States
-~~~~~~~~~~
-None
-
-Changes to the Cloud Servers Specification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In section 4.1.2 (Create Servers) of the API Specification: Examples 4.3 and 4.4 should optionally add the config-drive attribute as in the below examples:
-
-
-Example XML with config_drive attribute = True:
-
-::
-
- <?xml version="1.0" encoding="UTF-8"?>
- <server xmlns="http://docs.openstack.org/compute/api/v1.1"
- imageRef="http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54"
- flavorRef="52415800-8b69-11e0-9b19-734f1195ff37"
- name="new-server-test"
- config=drive="True"
- >
- <metadata>
- <meta key="My Server Name">Apache1</meta>
- </metadata>
- <personality>
- <file path="/etc/banner.txt">
- ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
- dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
- IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
- c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
- QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
- ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
- dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
- c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
- b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
- </file>
- </personality>
- </server>
-
-Example XML with config_drive attribute is an imageRef:
-
-::
-
- <?xml version="1.0" encoding="UTF-8"?>
- <server xmlns="http://docs.openstack.org/compute/api/v1.1"
- imageRef="http://servers.api.openstack.org/1234/images/
- 52415800-8b69-11e0-9b19-734f6f006e54"
- flavorRef="52415800-8b69-11e0-9b19-734f1195ff37"
- name="new-server-test"
- config_drive="http://servers.api.openstack.org/1234/images/52415800-8b69-1341-9b19-734f6f006e54"
- >
- <metadata>
- <meta key="My Server Name">Apache1</meta>
- </metadata>
- <personality>
- <file path="/etc/banner.txt">
- ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
- dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
- IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
- c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
- QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
- ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
- dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
- c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
- b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
- </file>
- </personality>
- </server>
-
-
-Example JSON with config_drive attribute is true:
-
-::
-
- {
- "server" : {
- "name" : "new-server-test",
- "imageRef" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
- "flavorRef" : "52415800-8b69-11e0-9b19-734f1195ff37",
- "config_drive" : "true",
- "metadata" : {
- "My Server Name" : "Apache1"
- },
- "personality" : [
- {
- "path" : "/etc/banner.txt",
- "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
- dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
- IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
- c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
- QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
- ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
- dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
- c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
- b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
- }
- ]
- }
- }
-
-Example JSON with config_drive attribute is an imageRef:
-
-::
-
- {
- "server" : {
- "name" : "new-server-test",
- "imageRef" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
- "flavorRef" : "52415800-8b69-11e0-9b19-734f1195ff37",
- "config_drive" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f6f006e54",
- "metadata" : {
- "My Server Name" : "Apache1"
- },
- "personality" : [
- {
- "path" : "/etc/banner.txt",
- "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
- dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
- IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
- c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
- QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
- ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
- dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
- c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
- b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
- }
- ]
- }
- }
Oops, something went wrong.

0 comments on commit fd6b21b

Please sign in to comment.