openstack/openstack-manuals
Code Issues Proposed changes

First Prepare for Sphinx 1.5

Browse Source 
The new sphinx version introduces some changes that break build:

* Warns if code cannot be parsed for highlighting. Fix the code so that
  it can be parsed, this includes uncommenting "..." lines.
* :option: works only with declared options, replace useage with simple
  ``.

This change only handles a few files, more to come later.

Change-Id: I957b102a0b3fb84f494e7f50ec35fa1c26a98bb5
This commit is contained in:
Andreas Jaeger 2017-01-11 12:51:34 +01:00 committed by Alexandra Settle
parent bd78c76940
commit a00856b1a2
24 changed files with 112 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/admin-guide/source/baremetal-multitenancy.rst
View File

@ -40,7 +40,7 @@ To enable the Networking service ML2 driver, edit the
.. code-block:: ini .. code-block:: ini
[ml2] [ml2]
... # ...
mechanism_drivers = my_mechanism_driver mechanism_drivers = my_mechanism_driver
[my_vendor] [my_vendor]
@ -64,11 +64,11 @@ service:
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
enabled_network_interfaces=flat,neutron enabled_network_interfaces=flat,neutron
[neutron] [neutron]
... # ...
cleaning_network_uuid=$UUID cleaning_network_uuid=$UUID
provisioning_network_uuid=$UUID provisioning_network_uuid=$UUID

27
doc/admin-guide/source/blockstorage-consistency-groups.rst
View File

@ -31,7 +31,8 @@ Here are existing policy entries for consistency groups:
.. code-block:: json .. code-block:: json
"consistencygroup:create": "group:nobody", {
"consistencygroup:create": "group:nobody"
"consistencygroup:delete": "group:nobody", "consistencygroup:delete": "group:nobody",
"consistencygroup:update": "group:nobody", "consistencygroup:update": "group:nobody",
"consistencygroup:get": "group:nobody", "consistencygroup:get": "group:nobody",
@ -40,11 +41,13 @@ Here are existing policy entries for consistency groups:
"consistencygroup:delete_cgsnapshot": "group:nobody", "consistencygroup:delete_cgsnapshot": "group:nobody",
"consistencygroup:get_cgsnapshot": "group:nobody", "consistencygroup:get_cgsnapshot": "group:nobody",
"consistencygroup:get_all_cgsnapshots": "group:nobody", "consistencygroup:get_all_cgsnapshots": "group:nobody",
}
Remove ``group:nobody`` to enable these APIs: Remove ``group:nobody`` to enable these APIs:
.. code-block:: json .. code-block:: json
{
"consistencygroup:create": "", "consistencygroup:create": "",
"consistencygroup:delete": "", "consistencygroup:delete": "",
"consistencygroup:update": "", "consistencygroup:update": "",
@ -54,6 +57,8 @@ Remove ``group:nobody`` to enable these APIs:
"consistencygroup:delete_cgsnapshot": "", "consistencygroup:delete_cgsnapshot": "",
"consistencygroup:get_cgsnapshot": "", "consistencygroup:get_cgsnapshot": "",
"consistencygroup:get_all_cgsnapshots": "", "consistencygroup:get_all_cgsnapshots": "",
}
Restart Block Storage API service after changing policies. Restart Block Storage API service after changing policies.
@ -306,10 +311,11 @@ the consistency group, separated by commas. Default is None.
.. code-block:: console .. code-block:: console
$ cinder consisgroup-update --name 'new name' --description 'new descripti\ $ cinder consisgroup-update --name 'new name' \
on' --add-volumes 0b3923f5-95a4-4596-a536-914c2c84e2db,1c02528b-3781-4e3\ --description 'new description' \
2-929c-618d81f52cf3 --remove-volumes 8c0f6ae4-efb1-458f-a8fc-9da2afcc5fb\ --add-volumes 0b3923f5-95a4-4596-a536-914c2c84e2db,1c02528b-3781-4e32-929c-618d81f52cf3 \
1,a245423f-bb99-4f94-8c8c-02806f9246d8 1de80c27-3b2f-47a6-91a7-e867cbe36462 --remove-volumes 8c0f6ae4-efb1-458f-a8fc-9da2afcc5fb1,a245423f-bb99-4f94-8c8c-02806f9246d8 \
1de80c27-3b2f-47a6-91a7-e867cbe36462
**Create a consistency group from the snapshot of another consistency **Create a consistency group from the snapshot of another consistency
group**: group**:
@ -326,8 +332,9 @@ consistency group:
.. code-block:: console .. code-block:: console
$ cinder consisgroup-create-from-src --cgsnapshot 6d9dfb7d-079a-471e-b75a-\ $ cinder consisgroup-create-from-src \
6e9185ba0c38 --name 'new cg' --description 'new cg from cgsnapshot' --cgsnapshot 6d9dfb7d-079a-471e-b75a-6e9185ba0c38 \
--name 'new cg' --description 'new cg from cgsnapshot'
**Create a consistency group from a source consistency group**: **Create a consistency group from a source consistency group**:
@ -343,6 +350,6 @@ consistency group:
.. code-block:: console .. code-block:: console
$ cinder consisgroup-create-from-src --source-cg 6d9dfb7d-079a-471e-b75a-\ $ cinder consisgroup-create-from-src \
6e9185ba0c38 --name 'new cg' --description 'new cloned cg' --source-cg 6d9dfb7d-079a-471e-b75a-6e9185ba0c38 \
--name 'new cg' --description 'new cloned cg'

6
doc/admin-guide/source/blockstorage-glusterfs-backend.rst
View File

@ -75,7 +75,7 @@ OpenStack Block Storage to use GlusterFS shares:
#. Enable client connections from unprivileged ports. To do this, #. Enable client connections from unprivileged ports. To do this,
add the following line to ``/etc/glusterfs/glusterd.vol``: add the following line to ``/etc/glusterfs/glusterd.vol``:
.. code-block:: ini .. code-block:: none
option rpc-auth-allow-insecure on option rpc-auth-allow-insecure on
@ -99,7 +99,7 @@ After you configure the GlusterFS service, complete these steps:
Each entry should be a separate line, and should use the following Each entry should be a separate line, and should use the following
format: format:
.. code-block:: ini .. code-block:: none
HOST:/VOL_NAME HOST:/VOL_NAME
@ -116,7 +116,7 @@ After you configure the GlusterFS service, complete these steps:
Optionally, if your environment requires additional mount options for Optionally, if your environment requires additional mount options for
a share, you can add them to the share's entry: a share, you can add them to the share's entry:
.. code-block:: ini .. code-block:: yaml
HOST:/VOL_NAME -o OPTIONS HOST:/VOL_NAME -o OPTIONS

2
doc/admin-guide/source/blockstorage-nfs-backend.rst
View File

@ -36,7 +36,7 @@ that hosts the ``cinder`` volume service.
Each entry should be a separate line, and should use the following Each entry should be a separate line, and should use the following
format: format:
.. code-block:: ini .. code-block:: none
HOST:SHARE HOST:SHARE

4
doc/admin-guide/source/blockstorage-over-subscription.rst
View File

@ -74,7 +74,7 @@ Volume type extra specs
If volume type is provided as part of the volume creation request, it can If volume type is provided as part of the volume creation request, it can
have the following extra specs defined: have the following extra specs defined:
.. code-block:: ini .. code-block:: none
'capabilities:thin_provisioning_support': '<is> True' or '<is> False' 'capabilities:thin_provisioning_support': '<is> True' or '<is> False'
'capabilities:thick_provisioning_support': '<is> True' or '<is> False' 'capabilities:thick_provisioning_support': '<is> True' or '<is> False'
@ -84,7 +84,7 @@ have the following extra specs defined:
``capabilities`` scope key before ``thin_provisioning_support`` and ``capabilities`` scope key before ``thin_provisioning_support`` and
``thick_provisioning_support`` is not required. So the following works too: ``thick_provisioning_support`` is not required. So the following works too:
.. code-block:: ini .. code-block:: none
'thin_provisioning_support': '<is> True' or '<is> False' 'thin_provisioning_support': '<is> True' or '<is> False'
'thick_provisioning_support': '<is> True' or '<is> False' 'thick_provisioning_support': '<is> True' or '<is> False'

4
doc/admin-guide/source/cli-analyzing-log-files-with-swift.rst
View File

@ -121,8 +121,8 @@ return code combination.
.. code-block:: console .. code-block:: console
$ swift -A http://swift-auth.com:11000/v1.0 -U test:tester -K testing \ $ swift -A http://swift-auth.com:11000/v1.0 -U test:tester -K testing \
download -o - logtest 2010-11-16-22_access.log | awk '{ print \ download -o - logtest 2010-11-16-22_access.log | \
$9"-"$12}' | sort | uniq -c awk '{ print $9"-"$12}' | sort | uniq -c
.. code-block:: console .. code-block:: console

2
doc/admin-guide/source/cli-networking-advanced-quotas.rst
View File

@ -6,7 +6,7 @@ A quota limits the number of available resources. A default
quota might be enforced for all projects. When you try to create quota might be enforced for all projects. When you try to create
more resources than the quota allows, an error occurs: more resources than the quota allows, an error occurs:
.. code-block:: ini .. code-block:: console
$ openstack network create test_net $ openstack network create test_net
Quota exceeded for resources: ['network'] Quota exceeded for resources: ['network']

2
doc/admin-guide/source/compute-images-instances.rst
View File

@ -220,8 +220,10 @@ can also be used to set policies for Image service actions.
.. code-block:: json .. code-block:: json
{
"download_image": "download_image":
"upload_image": "upload_image":
}
#. Define which roles or policies can manage which properties in a property #. Define which roles or policies can manage which properties in a property
protections configuration file. For example: protections configuration file. For example:

11
doc/admin-guide/source/compute-manage-logs.rst
View File

@ -105,14 +105,14 @@ on the log server host, which receives the log files
Add a filter rule to ``/etc/rsyslog.conf`` which looks for a host name. Add a filter rule to ``/etc/rsyslog.conf`` which looks for a host name.
This example uses COMPUTE_01 as the compute host name: This example uses COMPUTE_01 as the compute host name:
.. code-block:: ini .. code-block:: none
:hostname, isequal, "COMPUTE_01" /mnt/rsyslog/logs/compute-01.log :hostname, isequal, "COMPUTE_01" /mnt/rsyslog/logs/compute-01.log
On each compute host, create a file named On each compute host, create a file named
``/etc/rsyslog.d/60-nova.conf``, with the following content: ``/etc/rsyslog.d/60-nova.conf``, with the following content:
.. code-block:: console .. code-block:: none
# prevent debug from dnsmasq with the daemon.none parameter # prevent debug from dnsmasq with the daemon.none parameter
*.*;auth,authpriv.none,daemon.none,local0.none -/var/log/syslog *.*;auth,authpriv.none,daemon.none,local0.none -/var/log/syslog
@ -147,7 +147,7 @@ also requires a websocket client to access the serial console.
.. code-block:: ini .. code-block:: ini
[serial_console] [serial_console]
... # ...
enabled = true enabled = true
#. In the ``[serial_console]`` section, configure the serial console proxy #. In the ``[serial_console]`` section, configure the serial console proxy
@ -156,7 +156,7 @@ also requires a websocket client to access the serial console.
.. code-block:: ini .. code-block:: ini
[serial_console] [serial_console]
... # ...
base_url = ws://controller:6083/ base_url = ws://controller:6083/
listen = 0.0.0.0 listen = 0.0.0.0
proxyclient_address = MANAGEMENT_INTERFACE_IP_ADDRESS proxyclient_address = MANAGEMENT_INTERFACE_IP_ADDRESS
@ -208,8 +208,7 @@ also requires a websocket client to access the serial console.
.. code-block:: console .. code-block:: console
$ curl -i 'http://<controller>:8774/v2.1/<tenant_uuid>/servers/ $ curl -i 'http://<controller>:8774/v2.1/<tenant_uuid>/servers/<instance_uuid>/action' \
<instance_uuid>/action' \
-X POST \ -X POST \
-H "Accept: application/json" \ -H "Accept: application/json" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \

2
doc/install-guide/source/cinder-backup-install.rst
View File

@ -67,7 +67,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
backup_driver = cinder.backup.drivers.swift backup_driver = cinder.backup.drivers.swift
backup_swift_url = SWIFT_URL backup_swift_url = SWIFT_URL

12
doc/install-guide/source/cinder-controller-install.rst
View File

@ -297,7 +297,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[database] [database]
... # ...
connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder
.. end .. end
@ -312,7 +312,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
transport_url = rabbit://openstack:RABBIT_PASS@controller transport_url = rabbit://openstack:RABBIT_PASS@controller
.. end .. end
@ -327,11 +327,11 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... # ...
auth_uri = http://controller:5000 auth_uri = http://controller:5000
auth_url = http://controller:35357 auth_url = http://controller:35357
memcached_servers = controller:11211 memcached_servers = controller:11211
@ -359,7 +359,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
my_ip = 10.0.0.11 my_ip = 10.0.0.11
.. end .. end
@ -372,7 +372,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/cinder/tmp lock_path = /var/lib/cinder/tmp
.. end .. end

20
doc/install-guide/source/cinder-storage-install.rst
View File

@ -121,7 +121,7 @@ storage node, you must prepare the storage device.
``/dev/sdb`` device and rejects all other devices: ``/dev/sdb`` device and rejects all other devices:
.. path /etc/lvm/lvm.conf .. path /etc/lvm/lvm.conf
.. code-block:: ini .. code-block:: none
devices { devices {
... ...
@ -209,7 +209,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[database] [database]
... # ...
connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder
.. end .. end
@ -224,7 +224,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
transport_url = rabbit://openstack:RABBIT_PASS@controller transport_url = rabbit://openstack:RABBIT_PASS@controller
.. end .. end
@ -239,11 +239,11 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... # ...
auth_uri = http://controller:5000 auth_uri = http://controller:5000
auth_url = http://controller:35357 auth_url = http://controller:35357
memcached_servers = controller:11211 memcached_servers = controller:11211
@ -270,7 +270,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
.. end .. end
@ -290,7 +290,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[lvm] [lvm]
... # ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes volume_group = cinder-volumes
iscsi_protocol = iscsi iscsi_protocol = iscsi
@ -326,7 +326,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
enabled_backends = lvm enabled_backends = lvm
.. end .. end
@ -343,7 +343,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
glance_api_servers = http://controller:9292 glance_api_servers = http://controller:9292
.. end .. end
@ -354,7 +354,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/cinder/tmp lock_path = /var/lib/cinder/tmp
.. end .. end

2
doc/install-guide/source/environment-memcached.rst
View File

@ -47,7 +47,7 @@ Install and configure components
service to use the management IP address of the controller node service to use the management IP address of the controller node
to enable access by other nodes via the management network: to enable access by other nodes via the management network:
.. code-block:: ini .. code-block:: none
-l 10.0.0.11 -l 10.0.0.11

6
doc/install-guide/source/environment-networking-compute.rst
View File

@ -28,7 +28,7 @@ Configure network interfaces
* Edit the ``/etc/network/interfaces`` file to contain the following: * Edit the ``/etc/network/interfaces`` file to contain the following:
.. path /etc/network/interfaces .. path /etc/network/interfaces
.. code-block:: ini .. code-block:: bash
# The provider network interface # The provider network interface
auto INTERFACE_NAME auto INTERFACE_NAME
@ -48,7 +48,7 @@ Configure network interfaces
Do not change the ``HWADDR`` and ``UUID`` keys. Do not change the ``HWADDR`` and ``UUID`` keys.
.. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME
.. code-block:: ini .. code-block:: bash
DEVICE=INTERFACE_NAME DEVICE=INTERFACE_NAME
TYPE=Ethernet TYPE=Ethernet
@ -65,7 +65,7 @@ Configure network interfaces
contain the following: contain the following:
.. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME
.. code-block:: ini .. code-block:: bash
STARTMODE='auto' STARTMODE='auto'
BOOTPROTO='static' BOOTPROTO='static'

36
doc/install-guide/source/neutron-controller-install-option2.rst
View File

@ -65,7 +65,7 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[database] [database]
... # ...
connection = mysql+pymysql://neutron:NEUTRON_DBPASS@controller/neutron connection = mysql+pymysql://neutron:NEUTRON_DBPASS@controller/neutron
.. end .. end
@ -85,7 +85,7 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
core_plugin = ml2 core_plugin = ml2
service_plugins = router service_plugins = router
allow_overlapping_ips = True allow_overlapping_ips = True
@ -99,7 +99,7 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
transport_url = rabbit://openstack:RABBIT_PASS@controller transport_url = rabbit://openstack:RABBIT_PASS@controller
.. end .. end
@ -114,11 +114,11 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... # ...
auth_uri = http://controller:5000 auth_uri = http://controller:5000
auth_url = http://controller:35357 auth_url = http://controller:35357
memcached_servers = controller:11211 memcached_servers = controller:11211
@ -146,12 +146,12 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
notify_nova_on_port_status_changes = True notify_nova_on_port_status_changes = True
notify_nova_on_port_data_changes = True notify_nova_on_port_data_changes = True
[nova] [nova]
... # ...
auth_url = http://controller:35357 auth_url = http://controller:35357
auth_type = password auth_type = password
project_domain_name = default project_domain_name = default
@ -174,7 +174,7 @@ Configure the server component
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/neutron/tmp lock_path = /var/lib/neutron/tmp
.. end .. end
@ -194,7 +194,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2] [ml2]
... # ...
type_drivers = flat,vlan,vxlan type_drivers = flat,vlan,vxlan
.. end .. end
@ -205,7 +205,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2] [ml2]
... # ...
tenant_network_types = vxlan tenant_network_types = vxlan
.. end .. end
@ -217,7 +217,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2] [ml2]
... # ...
mechanism_drivers = linuxbridge,l2population mechanism_drivers = linuxbridge,l2population
.. end .. end
@ -237,7 +237,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2] [ml2]
... # ...
extension_drivers = port_security extension_drivers = port_security
.. end .. end
@ -249,7 +249,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2_type_flat] [ml2_type_flat]
... # ...
flat_networks = provider flat_networks = provider
.. end .. end
@ -261,7 +261,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[ml2_type_vxlan] [ml2_type_vxlan]
... # ...
vni_ranges = 1:1000 vni_ranges = 1:1000
.. end .. end
@ -273,7 +273,7 @@ and switching) virtual networking infrastructure for instances.
.. code-block:: ini .. code-block:: ini
[securitygroup] [securitygroup]
... # ...
enable_ipset = True enable_ipset = True
.. end .. end
@ -330,7 +330,7 @@ networking infrastructure for instances and handles security groups.
.. code-block:: ini .. code-block:: ini
[securitygroup] [securitygroup]
... # ...
enable_security_group = True enable_security_group = True
firewall_driver = neutron.agent.linux.iptables_firewall.IptablesFirewallDriver firewall_driver = neutron.agent.linux.iptables_firewall.IptablesFirewallDriver
@ -352,7 +352,7 @@ self-service virtual networks.
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
interface_driver = linuxbridge interface_driver = linuxbridge
.. end .. end
@ -373,7 +373,7 @@ The :term:`DHCP agent` provides DHCP services for virtual networks.
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
interface_driver = linuxbridge interface_driver = linuxbridge
dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq
enable_isolated_metadata = True enable_isolated_metadata = True

26
doc/install-guide/source/nova-compute-install.rst
View File

@ -86,7 +86,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
enabled_apis = osapi_compute,metadata enabled_apis = osapi_compute,metadata
.. end .. end
@ -100,7 +100,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
transport_url = rabbit://openstack:RABBIT_PASS@controller transport_url = rabbit://openstack:RABBIT_PASS@controller
.. end .. end
@ -115,11 +115,11 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... # ...
auth_uri = http://controller:5000 auth_uri = http://controller:5000
auth_url = http://controller:35357 auth_url = http://controller:35357
memcached_servers = controller:11211 memcached_servers = controller:11211
@ -150,7 +150,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
.. end .. end
@ -170,7 +170,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
.. end .. end
@ -186,7 +186,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
use_neutron = True use_neutron = True
firewall_driver = nova.virt.firewall.NoopFirewallDriver firewall_driver = nova.virt.firewall.NoopFirewallDriver
@ -207,7 +207,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[vnc] [vnc]
... # ...
enabled = True enabled = True
vncserver_listen = 0.0.0.0 vncserver_listen = 0.0.0.0
vncserver_proxyclient_address = $my_ip vncserver_proxyclient_address = $my_ip
@ -235,7 +235,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[glance] [glance]
... # ...
api_servers = http://controller:9292 api_servers = http://controller:9292
.. end .. end
@ -248,7 +248,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/run/nova lock_path = /var/run/nova
.. end .. end
@ -263,7 +263,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/nova/tmp lock_path = /var/lib/nova/tmp
.. end .. end
@ -325,7 +325,7 @@ Finalize installation
.. code-block:: ini .. code-block:: ini
[libvirt] [libvirt]
... # ...
virt_type = qemu virt_type = qemu
.. end .. end
@ -341,7 +341,7 @@ Finalize installation
.. code-block:: ini .. code-block:: ini
[libvirt] [libvirt]
... # ...
virt_type = qemu virt_type = qemu
.. end .. end

26
doc/install-guide/source/nova-controller-install.rst
View File

@ -254,7 +254,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
enabled_apis = osapi_compute,metadata enabled_apis = osapi_compute,metadata
.. end .. end
@ -268,11 +268,11 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[api_database] [api_database]
... # ...
connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova_api connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova_api
[database] [database]
... # ...
connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova
.. end .. end
@ -287,7 +287,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
transport_url = rabbit://openstack:RABBIT_PASS@controller transport_url = rabbit://openstack:RABBIT_PASS@controller
.. end .. end
@ -302,11 +302,11 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
auth_strategy = keystone auth_strategy = keystone
[keystone_authtoken] [keystone_authtoken]
... # ...
auth_uri = http://controller:5000 auth_uri = http://controller:5000
auth_url = http://controller:35357 auth_url = http://controller:35357
memcached_servers = controller:11211 memcached_servers = controller:11211
@ -334,7 +334,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
my_ip = 10.0.0.11 my_ip = 10.0.0.11
.. end .. end
@ -347,7 +347,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[DEFAULT] [DEFAULT]
... # ...
use_neutron = True use_neutron = True
firewall_driver = nova.virt.firewall.NoopFirewallDriver firewall_driver = nova.virt.firewall.NoopFirewallDriver
@ -370,7 +370,7 @@ Install and configure components
[vnc] [vnc]
enabled = true enabled = true
... # ...
vncserver_listen = $my_ip vncserver_listen = $my_ip
vncserver_proxyclient_address = $my_ip vncserver_proxyclient_address = $my_ip
@ -397,7 +397,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[glance] [glance]
... # ...
api_servers = http://controller:9292 api_servers = http://controller:9292
.. end .. end
@ -410,7 +410,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/run/nova lock_path = /var/run/nova
.. end .. end
@ -425,7 +425,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/nova/tmp lock_path = /var/lib/nova/tmp
.. end .. end
@ -440,7 +440,7 @@ Install and configure components
.. code-block:: ini .. code-block:: ini
[oslo_concurrency] [oslo_concurrency]
... # ...
lock_path = /var/lib/nova/tmp lock_path = /var/lib/nova/tmp
.. end .. end

2
doc/user-guide/source/backup-db-incremental.rst
View File

@ -98,7 +98,7 @@ Create and use incremental backups
instance called ``guest2``. instance called ``guest2``.
To incorporate your incremental backups, you simply use the To incorporate your incremental backups, you simply use the
:option:`--backup` parameter to pass in the ``BACKUP_ID`` of your most `--backup`` parameter to pass in the ``BACKUP_ID`` of your most
recent incremental backup. The Database service handles the recent incremental backup. The Database service handles the
complexities of applying the chain of all previous incremental complexities of applying the chain of all previous incremental
backups. backups.

2
doc/user-guide/source/backup-db.rst
View File

@ -116,7 +116,7 @@ This example shows you how to back up and restore a MySQL database.
(``10``) and the same root volume size (``2``) as the original (``10``) and the same root volume size (``2``) as the original
``guest1`` instance. ``guest1`` instance.
- You use the :option:`--backup` argument to indicate that this new - You use the ``--backup`` argument to indicate that this new
instance is based on the backup artifact identified by instance is based on the backup artifact identified by
``BACKUP_ID``. In this example, replace ``BACKUP_ID`` with ``BACKUP_ID``. In this example, replace ``BACKUP_ID`` with
``8af30763-61fd-4aab-8fe8-57d528911138``. ``8af30763-61fd-4aab-8fe8-57d528911138``.

2
doc/user-guide/source/cli-access-instance-through-a-console.rst
View File

@ -39,7 +39,7 @@ The command returns a URL from which you can access your instance:
| xvpvnc | http://192.168.5.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c | | xvpvnc | http://192.168.5.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c |
+--------+------------------------------------------------------------------------------+ +--------+------------------------------------------------------------------------------+
:option:`--xvpvnc` can be replaced by any of the above values as connection ``--xvpvnc`` can be replaced by any of the above values as connection
types. types.
When using SPICE to view the console of an instance, a browser plugin When using SPICE to view the console of an instance, a browser plugin

4
doc/user-guide/source/cli-ceilometer.rst
View File

@ -63,8 +63,8 @@ This example uses the :command:`openstack` client to create an auto-scaling
stack and the :command:`ceilometer` client to measure resources. stack and the :command:`ceilometer` client to measure resources.
#. Create an auto-scaling stack by running the following command. #. Create an auto-scaling stack by running the following command.
The :option:`-f` option specifies the name of the stack template The ``-f`` option specifies the name of the stack template
file, and the :option:`-P` option specifies the ``KeyName`` file, and the ``-P`` option specifies the ``KeyName``
parameter as ``heat_key``: parameter as ``heat_key``:
.. code-block:: console .. code-block:: console

4
doc/user-guide/source/cli-create-and-manage-networks.rst
View File

@ -244,7 +244,7 @@ Create ports
+-----------------------+-----------------------------------------+ +-----------------------+-----------------------------------------+
In the previous command, ``net1`` is the network name, which is a In the previous command, ``net1`` is the network name, which is a
positional argument. :option:`--fixed-ip subnet<subnet>,ip-address=192.168.2.40` is positional argument. ``--fixed-ip subnet<subnet>,ip-address=192.168.2.40`` is
an option which specifies the port's fixed IP address we wanted. an option which specifies the port's fixed IP address we wanted.
.. note:: .. note::
@ -295,7 +295,7 @@ Create ports
.. note:: .. note::
You can specify a MAC address with :option:`--mac-address MAC_ADDRESS`. You can specify a MAC address with ``--mac-address MAC_ADDRESS``.
If you specify an invalid MAC address, including ``00:00:00:00:00:00`` If you specify an invalid MAC address, including ``00:00:00:00:00:00``
or ``ff:ff:ff:ff:ff:ff``, you will get an error. or ``ff:ff:ff:ff:ff:ff``, you will get an error.

6
doc/user-guide/source/cli-create-and-manage-stacks.rst
View File

@ -32,9 +32,9 @@ Create a stack from an example template file
$ openstack stack create --template server_console.yaml \ $ openstack stack create --template server_console.yaml \
--parameter "image=cirros" MYSTACK --parameter "image=cirros" MYSTACK
The :option:`--parameter` values that you specify depend on the parameters The ``--parameter`` values that you specify depend on the parameters
that are defined in the template. If a website hosts the template that are defined in the template. If a website hosts the template
file, you can also specify the URL with the :option:`--template` parameter. file, you can also specify the URL with the ``--template`` parameter.
The command returns the following output: The command returns the following output:
@ -54,7 +54,7 @@ Create a stack from an example template file
| stack_status_reason | | | stack_status_reason | |
+---------------------+----------------------------------------------------------------+ +---------------------+----------------------------------------------------------------+
- You can also use the :option:`--dry-run` option with the - You can also use the ``--dry-run`` option with the
:command:`openstack stack create` command to validate a :command:`openstack stack create` command to validate a
template file without creating a stack from it. template file without creating a stack from it.

2
doc/user-guide/source/cli-manage-ip-addresses.rst
View File

@ -142,7 +142,7 @@ You can assign a floating IP address to a project and to an instance.
If an instance is connected to multiple networks, you can associate a If an instance is connected to multiple networks, you can associate a
floating IP address with a specific fixed IP address using the optional floating IP address with a specific fixed IP address using the optional
:option:`--fixed-address` parameter: ``--fixed-address`` parameter:
.. code-block:: console .. code-block:: console