diff options
Diffstat (limited to 'doc')
30 files changed, 175 insertions, 126 deletions
diff --git a/doc/README.rst b/doc/README.rst index 92db83b49b..dbaaa40b3e 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -12,7 +12,7 @@ environment, such as the virtualenv created by ``run_tests.sh`` or ``tools/install_venv.py``. A leaner but sufficient environment can be created by starting with one that is suitable for running Nova (such as the one created by DevStack) and then using pip to install -oslo.sphinx. +oslosphinx. Building the docs ----------------- diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json index 3c25de219d..078ba1545d 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.json +++ b/doc/api_samples/all_extensions/extensions-get-resp.json @@ -631,6 +631,14 @@ "name": "Volumes", "namespace": "http://docs.openstack.org/compute/ext/volumes/api/v1.1", "updated": "2011-03-25T00:00:00+00:00" + }, + { + "alias": "os-extended-services-delete", + "description": "Services deletion support.", + "links": [], + "name": "ExtendedServicesDelete", + "namespace": "http://docs.openstack.org/compute/ext/extended_services_delete/api/v2", + "updated": "2013-12-10T00:00:00+00:00" } ] } diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml index 5a1adebbde..6fcacf603b 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.xml +++ b/doc/api_samples/all_extensions/extensions-get-resp.xml @@ -257,4 +257,7 @@ <extension alias="os-volumes" updated="2011-03-25T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/volumes/api/v1.1" name="Volumes"> <description>Volumes support.</description> </extension> + <extension alias="os-extended-services-delete" updated="2013-12-10T00:00:00" namespace="http://docs.openstack.org/compute/ext/extended_services_delete/api/v2" name="ExtendedServicesDelete"> + <description>Services deletion support.</description> + </extension> </extensions> diff --git a/doc/api_samples/os-consoles/get-rdp-console-post-req.json b/doc/api_samples/os-consoles/get-rdp-console-post-req.json new file mode 100644 index 0000000000..00956b90e4 --- /dev/null +++ b/doc/api_samples/os-consoles/get-rdp-console-post-req.json @@ -0,0 +1,5 @@ +{ + "os-getRDPConsole": { + "type": "rdp-html5" + } +} diff --git a/doc/api_samples/os-consoles/get-rdp-console-post-req.xml b/doc/api_samples/os-consoles/get-rdp-console-post-req.xml new file mode 100644 index 0000000000..16cf28832d --- /dev/null +++ b/doc/api_samples/os-consoles/get-rdp-console-post-req.xml @@ -0,0 +1,2 @@ +<?xml version="1.0" encoding="UTF-8"?> +<os-getRDPConsole type="rdp-html5" /> diff --git a/doc/api_samples/os-consoles/get-rdp-console-post-resp.json b/doc/api_samples/os-consoles/get-rdp-console-post-resp.json new file mode 100644 index 0000000000..583d9c1e40 --- /dev/null +++ b/doc/api_samples/os-consoles/get-rdp-console-post-resp.json @@ -0,0 +1,6 @@ +{ + "console": { + "type": "rdp-html5", + "url": "http://example.com:6083/?token=f9906a48-b71e-4f18-baca-c987da3ebdb3&title=dafa(75ecef58-3b8e-4659-ab3b-5501454188e9)" + } +} diff --git a/doc/api_samples/os-consoles/get-rdp-console-post-resp.xml b/doc/api_samples/os-consoles/get-rdp-console-post-resp.xml new file mode 100644 index 0000000000..6c45d6e269 --- /dev/null +++ b/doc/api_samples/os-consoles/get-rdp-console-post-resp.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='UTF-8'?> +<console> + <type>rdp-html5</type> + <url>http://example.com:6083/?token=f9906a48-b71e-4f18-baca-c987da3ebdb3</url> +</console> diff --git a/doc/api_samples/os-extended-services-delete/services-get-resp.json b/doc/api_samples/os-extended-services-delete/services-get-resp.json new file mode 100644 index 0000000000..fefb0474c2 --- /dev/null +++ b/doc/api_samples/os-extended-services-delete/services-get-resp.json @@ -0,0 +1,40 @@ +{ + "services": [ + { + "id": 1, + "binary": "nova-scheduler", + "host": "host1", + "state": "up", + "status": "disabled", + "updated_at": "2012-10-29T13:42:02.000000", + "zone": "internal" + }, + { + "id": 2, + "binary": "nova-compute", + "host": "host1", + "state": "up", + "status": "disabled", + "updated_at": "2012-10-29T13:42:05.000000", + "zone": "nova" + }, + { + "id": 3, + "binary": "nova-scheduler", + "host": "host2", + "state": "down", + "status": "enabled", + "updated_at": "2012-09-19T06:55:34.000000", + "zone": "internal" + }, + { + "id": 4, + "binary": "nova-compute", + "host": "host2", + "state": "down", + "status": "disabled", + "updated_at": "2012-09-18T08:03:38.000000", + "zone": "nova" + } + ] +} diff --git a/doc/api_samples/os-extended-services-delete/services-get-resp.xml b/doc/api_samples/os-extended-services-delete/services-get-resp.xml new file mode 100644 index 0000000000..bb5b46770a --- /dev/null +++ b/doc/api_samples/os-extended-services-delete/services-get-resp.xml @@ -0,0 +1,6 @@ +<services> + <service status="disabled" binary="nova-scheduler" zone="internal" state="up" host="host1" updated_at="2012-10-29T13:42:02.000000" id="1"/> + <service status="disabled" binary="nova-compute" zone="nova" state="up" host="host1" updated_at="2012-10-29T13:42:05.000000" id="2"/> + <service status="enabled" binary="nova-scheduler" zone="internal" state="down" host="host2" updated_at="2012-09-19T06:55:34.000000" id="3"/> + <service status="disabled" binary="nova-compute" zone="nova" state="down" host="host2" updated_at="2012-09-18T08:03:38.000000" id="4"/> +</services> diff --git a/doc/source/conf.py b/doc/source/conf.py index 95126b67e0..0ae450f4f2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,7 +34,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', - 'oslo.sphinx', + 'oslosphinx', ] todo_include_todos = True diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst index 5699315e8d..686d215a62 100644 --- a/doc/source/devref/development.environment.rst +++ b/doc/source/devref/development.environment.rst @@ -35,7 +35,7 @@ Virtual environments -------------------- Nova development uses a set of shell scripts in DevStack. Virtual -enviroments with venv are also available with the source code. +environments with venv are also available with the source code. The easiest way to build a fully functional development environment is with DevStack. Create a machine (such as a VM or Vagrant box) running a diff --git a/doc/source/images/rpc/arch.svg b/doc/source/images/rpc/arch.svg index efed6e9814..f95624d1cb 100644 --- a/doc/source/images/rpc/arch.svg +++ b/doc/source/images/rpc/arch.svg @@ -176,7 +176,7 @@ x="4" dy="1.2em" class="st3">Network<v:newlineChar/></tspan><tspan x="4" dy="1.2em" class="st3">VPN</tspan></text> </g>
<g id="shape16-56" v:mID="16" v:groupContext="shape" transform="translate(14.4132,-30.9923)">
<title>Sheet.16</title>
- <desc>VM instance Security group Volume Snapshot VM image IP addres...</desc>
+ <desc>VM instance Security group Volume Snapshot VM image IP address...</desc>
<v:textBlock v:margins="rect(4,4,4,4)" v:tabSpace="42.5197"/>
<v:textRect cx="42.5197" cy="340.209" width="85.04" height="34.0157"/>
<rect x="0" y="323.201" width="85.0394" height="34.0157" class="st9"/>
diff --git a/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json b/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json deleted file mode 100644 index e3fbc1aa66..0000000000 --- a/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "instance_usage_audit_log": { - "hosts_not_run": [ - "defac351f91940668301096238d26b47" - ], - "log": {}, - "num_hosts": 1, - "num_hosts_done": 0, - "num_hosts_not_run": 1, - "num_hosts_running": 0, - "overall_status": "0 of 1 hosts done. 0 errors.", - "period_beginning": "2013-08-01 00:00:00", - "period_ending": "2013-09-01 00:00:00", - "total_errors": 0, - "total_instances": 0 - } -}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json b/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json deleted file mode 100644 index 27dfafe198..0000000000 --- a/doc/v3/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "instance_usage_audit_log": { - "hosts_not_run": [ - "ccf86bf6d0104fe69ee658eaa31a7469" - ], - "log": {}, - "num_hosts": 1, - "num_hosts_done": 0, - "num_hosts_not_run": 1, - "num_hosts_running": 0, - "overall_status": "0 of 1 hosts done. 0 errors.", - "period_beginning": "2012-06-01 00:00:00", - "period_ending": "2012-07-01 00:00:00", - "total_errors": 0, - "total_instances": 0 - } -}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-admin-actions/admin-actions-live-migrate.json b/doc/v3/api_samples/os-migrate-server/live-migrate-server.json index 10369816aa..10369816aa 100644 --- a/doc/v3/api_samples/os-admin-actions/admin-actions-live-migrate.json +++ b/doc/v3/api_samples/os-migrate-server/live-migrate-server.json diff --git a/doc/v3/api_samples/os-admin-actions/admin-actions-migrate.json b/doc/v3/api_samples/os-migrate-server/migrate-server.json index c42f2c63fb..c42f2c63fb 100644 --- a/doc/v3/api_samples/os-admin-actions/admin-actions-migrate.json +++ b/doc/v3/api_samples/os-migrate-server/migrate-server.json diff --git a/doc/v3/api_samples/os-simple-tenant-usage/server-post-req.json b/doc/v3/api_samples/os-migrate-server/server-post-req.json index 2eedab6147..2eedab6147 100644 --- a/doc/v3/api_samples/os-simple-tenant-usage/server-post-req.json +++ b/doc/v3/api_samples/os-migrate-server/server-post-req.json diff --git a/doc/v3/api_samples/os-simple-tenant-usage/server-post-resp.json b/doc/v3/api_samples/os-migrate-server/server-post-resp.json index 17eaae6dc1..270cb84634 100644 --- a/doc/v3/api_samples/os-simple-tenant-usage/server-post-resp.json +++ b/doc/v3/api_samples/os-migrate-server/server-post-resp.json @@ -1,14 +1,14 @@ { "server": { - "admin_password": "andqf3WBEYDj", - "id": "69eaa1f4-7be0-42d5-934f-320cdc80981d", + "admin_password": "DM3QzjhGTzLB", + "id": "bebeec79-497e-4711-a311-d0d2e3dfc73b", "links": [ { - "href": "http://openstack.example.com/v3/servers/69eaa1f4-7be0-42d5-934f-320cdc80981d", + "href": "http://openstack.example.com/v3/servers/bebeec79-497e-4711-a311-d0d2e3dfc73b", "rel": "self" }, { - "href": "http://openstack.example.com/servers/69eaa1f4-7be0-42d5-934f-320cdc80981d", + "href": "http://openstack.example.com/servers/bebeec79-497e-4711-a311-d0d2e3dfc73b", "rel": "bookmark" } ] diff --git a/doc/v3/api_samples/os-multinic/multinic-add-fixed-ip-req.json b/doc/v3/api_samples/os-multinic/multinic-add-fixed-ip-req.json index 8127b212cc..3c17283906 100644 --- a/doc/v3/api_samples/os-multinic/multinic-add-fixed-ip-req.json +++ b/doc/v3/api_samples/os-multinic/multinic-add-fixed-ip-req.json @@ -1,5 +1,5 @@ { - "addFixedIp":{ - "networkId": 1 + "add_fixed_ip":{ + "network_id": 1 } }
\ No newline at end of file diff --git a/doc/v3/api_samples/os-pci/pci-detail-resp.json b/doc/v3/api_samples/os-pci/pci-detail-resp.json new file mode 100644 index 0000000000..61cb17c6b4 --- /dev/null +++ b/doc/v3/api_samples/os-pci/pci-detail-resp.json @@ -0,0 +1,36 @@ +{ + "pci_devices": [ + { + "address": "0000:04:10.0", + "compute_node_id": 1, + "dev_id": "pci_0000_04_10_0", + "dev_type": "type-VF", + "extra_info": { + "key1": "value1", + "key2": "value2" + }, + "id": 1, + "server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1", + "label": "label_8086_1520", + "product_id": "1520", + "status": "available", + "vendor_id": "8086" + }, + { + "address": "0000:04:10.1", + "compute_node_id": 1, + "dev_id": "pci_0000_04_10_1", + "dev_type": "type-VF", + "extra_info": { + "key3": "value3", + "key4": "value4" + }, + "id": 2, + "server_uuid": "d5b446a6-a1b4-4d01-b4f0-eac37b3a62fc", + "label": "label_8086_1520", + "product_id": "1520", + "status": "available", + "vendor_id": "8086" + } + ] +} diff --git a/doc/v3/api_samples/os-pci/pci-index-resp.json b/doc/v3/api_samples/os-pci/pci-index-resp.json new file mode 100644 index 0000000000..6268f316df --- /dev/null +++ b/doc/v3/api_samples/os-pci/pci-index-resp.json @@ -0,0 +1,20 @@ +{ + "pci_devices": [ + { + "address": "0000:04:10.0", + "compute_node_id": 1, + "id": 1, + "product_id": "1520", + "status": "available", + "vendor_id": "8086" + }, + { + "address": "0000:04:10.1", + "compute_node_id": 1, + "id": 2, + "product_id": "1520", + "status": "available", + "vendor_id": "8086" + } + ] +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-pci/pci-show-resp.json b/doc/v3/api_samples/os-pci/pci-show-resp.json new file mode 100644 index 0000000000..9977769881 --- /dev/null +++ b/doc/v3/api_samples/os-pci/pci-show-resp.json @@ -0,0 +1,18 @@ +{ + "pci_device": { + "address": "0000:04:10.0", + "compute_node_id": 1, + "dev_id": "pci_0000_04_10_0", + "dev_type": "type-VF", + "extra_info": { + "key1": "value1", + "key2": "value2" + }, + "id": 1, + "server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1", + "label": "label_8086_1520", + "product_id": "1520", + "status": "available", + "vendor_id": "8086" + } +} diff --git a/doc/v3/api_samples/os-quota-class-sets/quota-classes-show-get-resp.json b/doc/v3/api_samples/os-quota-class-sets/quota-classes-show-get-resp.json deleted file mode 100644 index f7f01611c4..0000000000 --- a/doc/v3/api_samples/os-quota-class-sets/quota-classes-show-get-resp.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "quota_class_set": { - "cores": 20, - "fixed_ips": -1, - "floating_ips": 10, - "id": "test_class", - "instances": 10, - "key_pairs": 100, - "metadata_items": 128, - "ram": 51200, - "security_group_rules": 20, - "security_groups": 10 - } -} diff --git a/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-req.json b/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-req.json deleted file mode 100644 index 4858f1bf5d..0000000000 --- a/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-req.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "quota_class_set": { - "instances": 50, - "cores": 50, - "ram": 51200, - "floating_ips": 10, - "fixed_ips": -1, - "metadata_items": 128, - "security_groups": 10, - "security_group_rules": 20, - "key_pairs": 100 - } -} diff --git a/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-resp.json b/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-resp.json deleted file mode 100644 index a271766ca9..0000000000 --- a/doc/v3/api_samples/os-quota-class-sets/quota-classes-update-post-resp.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "quota_class_set": { - "cores": 50, - "fixed_ips": -1, - "floating_ips": 10, - "id": "test_class", - "instances": 50, - "key_pairs": 100, - "metadata_items": 128, - "ram": 51200, - "security_group_rules": 20, - "security_groups": 10 - } -} diff --git a/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-req.json b/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-req.json new file mode 100644 index 0000000000..075d3b28a8 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-req.json @@ -0,0 +1,5 @@ +{ + "get_rdp_console": { + "type": "rdp-html5" + } +} diff --git a/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-resp.json b/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-resp.json new file mode 100644 index 0000000000..09f3ca3d8c --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-rdp-console-post-resp.json @@ -0,0 +1,6 @@ +{ + "console": { + "type": "rdp-html5", + "url": "http://127.0.0.1:6083/?token=191996c3-7b0f-42f3-95a7-f1839f2da6ed" + } +} diff --git a/doc/v3/api_samples/os-services/services-list-get-resp.json b/doc/v3/api_samples/os-services/services-list-get-resp.json index 40b3bf2521..1b2c5bf343 100644 --- a/doc/v3/api_samples/os-services/services-list-get-resp.json +++ b/doc/v3/api_samples/os-services/services-list-get-resp.json @@ -1,6 +1,7 @@ { "services": [ { + "id": 1, "binary": "nova-scheduler", "disabled_reason": "test1", "host": "host1", @@ -10,6 +11,7 @@ "zone": "internal" }, { + "id": 2, "binary": "nova-compute", "disabled_reason": "test2", "host": "host1", @@ -19,6 +21,7 @@ "zone": "nova" }, { + "id": 3, "binary": "nova-scheduler", "disabled_reason": "", "host": "host2", @@ -28,6 +31,7 @@ "zone": "internal" }, { + "id": 4, "binary": "nova-compute", "disabled_reason": "test4", "host": "host2", @@ -37,4 +41,4 @@ "zone": "nova" } ] -}
\ No newline at end of file +} diff --git a/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json b/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json deleted file mode 100644 index a6cd1e7a3b..0000000000 --- a/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "tenant_usage": { - "server_usages": [ - { - "ended_at": null, - "flavor": "m1.tiny", - "hours": 1.0, - "instance_id": "bf2fbe78-ae1c-4f6b-a68b-390f12b1b983", - "local_gb": 1, - "memory_mb": 512, - "name": "new-server-test", - "started_at": "2013-09-09T13:18:28.101337", - "state": "active", - "tenant_id": "openstack", - "uptime": 3600, - "vcpus": 1 - } - ], - "start": "2013-09-09T13:18:28.101337", - "stop": "2013-09-09T14:18:28.101337", - "tenant_id": "openstack", - "total_hours": 1.0, - "total_local_gb_usage": 1.0, - "total_memory_mb_usage": 512.0, - "total_vcpus_usage": 1.0 - } -} diff --git a/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json b/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json deleted file mode 100644 index ca66bcb847..0000000000 --- a/doc/v3/api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "tenant_usages": [ - { - "start": "2013-09-09T13:18:27.898411", - "stop": "2013-09-09T14:18:27.898411", - "tenant_id": "openstack", - "total_hours": 1.0, - "total_local_gb_usage": 1.0, - "total_memory_mb_usage": 512.0, - "total_vcpus_usage": 1.0 - } - ] -} |
