From a00856b1a2bce59e6f45c6ec0fc17871a8046780 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 11 Jan 2017 12:51:34 +0100 Subject: [PATCH] First Prepare for Sphinx 1.5 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 --- .../source/baremetal-multitenancy.rst | 6 ++-- .../blockstorage-consistency-groups.rst | 27 ++++++++------ .../source/blockstorage-glusterfs-backend.rst | 6 ++-- .../source/blockstorage-nfs-backend.rst | 2 +- .../source/blockstorage-over-subscription.rst | 4 +-- .../cli-analyzing-log-files-with-swift.rst | 4 +-- .../source/cli-networking-advanced-quotas.rst | 2 +- .../source/compute-images-instances.rst | 2 ++ .../source/compute-manage-logs.rst | 11 +++--- .../source/cinder-backup-install.rst | 2 +- .../source/cinder-controller-install.rst | 12 +++---- .../source/cinder-storage-install.rst | 20 +++++------ .../source/environment-memcached.rst | 2 +- .../source/environment-networking-compute.rst | 6 ++-- .../neutron-controller-install-option2.rst | 36 +++++++++---------- .../source/nova-compute-install.rst | 26 +++++++------- .../source/nova-controller-install.rst | 26 +++++++------- .../source/backup-db-incremental.rst | 2 +- doc/user-guide/source/backup-db.rst | 2 +- .../cli-access-instance-through-a-console.rst | 2 +- doc/user-guide/source/cli-ceilometer.rst | 4 +-- .../source/cli-create-and-manage-networks.rst | 4 +-- .../source/cli-create-and-manage-stacks.rst | 6 ++-- .../source/cli-manage-ip-addresses.rst | 2 +- 24 files changed, 112 insertions(+), 104 deletions(-) diff --git a/doc/admin-guide/source/baremetal-multitenancy.rst b/doc/admin-guide/source/baremetal-multitenancy.rst index 0eea6c44c9..c4634a710d 100644 --- a/doc/admin-guide/source/baremetal-multitenancy.rst +++ b/doc/admin-guide/source/baremetal-multitenancy.rst @@ -40,7 +40,7 @@ To enable the Networking service ML2 driver, edit the .. code-block:: ini [ml2] - ... + # ... mechanism_drivers = my_mechanism_driver [my_vendor] @@ -64,11 +64,11 @@ service: .. code-block:: ini [DEFAULT] - ... + # ... enabled_network_interfaces=flat,neutron [neutron] - ... + # ... cleaning_network_uuid=$UUID provisioning_network_uuid=$UUID diff --git a/doc/admin-guide/source/blockstorage-consistency-groups.rst b/doc/admin-guide/source/blockstorage-consistency-groups.rst index ac49bb278a..e04155c4b0 100644 --- a/doc/admin-guide/source/blockstorage-consistency-groups.rst +++ b/doc/admin-guide/source/blockstorage-consistency-groups.rst @@ -31,7 +31,8 @@ Here are existing policy entries for consistency groups: .. code-block:: json - "consistencygroup:create": "group:nobody", + { + "consistencygroup:create": "group:nobody" "consistencygroup:delete": "group:nobody", "consistencygroup:update": "group:nobody", "consistencygroup:get": "group:nobody", @@ -40,11 +41,13 @@ Here are existing policy entries for consistency groups: "consistencygroup:delete_cgsnapshot": "group:nobody", "consistencygroup:get_cgsnapshot": "group:nobody", "consistencygroup:get_all_cgsnapshots": "group:nobody", + } Remove ``group:nobody`` to enable these APIs: .. code-block:: json + { "consistencygroup:create": "", "consistencygroup:delete": "", "consistencygroup:update": "", @@ -54,6 +57,8 @@ Remove ``group:nobody`` to enable these APIs: "consistencygroup:delete_cgsnapshot": "", "consistencygroup:get_cgsnapshot": "", "consistencygroup:get_all_cgsnapshots": "", + } + Restart Block Storage API service after changing policies. @@ -306,10 +311,11 @@ the consistency group, separated by commas. Default is None. .. code-block:: console - $ cinder consisgroup-update --name 'new name' --description 'new descripti\ - on' --add-volumes 0b3923f5-95a4-4596-a536-914c2c84e2db,1c02528b-3781-4e3\ - 2-929c-618d81f52cf3 --remove-volumes 8c0f6ae4-efb1-458f-a8fc-9da2afcc5fb\ - 1,a245423f-bb99-4f94-8c8c-02806f9246d8 1de80c27-3b2f-47a6-91a7-e867cbe36462 + $ cinder consisgroup-update --name 'new name' \ + --description 'new description' \ + --add-volumes 0b3923f5-95a4-4596-a536-914c2c84e2db,1c02528b-3781-4e32-929c-618d81f52cf3 \ + --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 group**: @@ -326,8 +332,9 @@ consistency group: .. code-block:: console - $ cinder consisgroup-create-from-src --cgsnapshot 6d9dfb7d-079a-471e-b75a-\ - 6e9185ba0c38 --name 'new cg' --description 'new cg from cgsnapshot' + $ cinder consisgroup-create-from-src \ + --cgsnapshot 6d9dfb7d-079a-471e-b75a-6e9185ba0c38 \ + --name 'new cg' --description 'new cg from cgsnapshot' **Create a consistency group from a source consistency group**: @@ -343,6 +350,6 @@ consistency group: .. code-block:: console - $ cinder consisgroup-create-from-src --source-cg 6d9dfb7d-079a-471e-b75a-\ - 6e9185ba0c38 --name 'new cg' --description 'new cloned cg' - + $ cinder consisgroup-create-from-src \ + --source-cg 6d9dfb7d-079a-471e-b75a-6e9185ba0c38 \ + --name 'new cg' --description 'new cloned cg' diff --git a/doc/admin-guide/source/blockstorage-glusterfs-backend.rst b/doc/admin-guide/source/blockstorage-glusterfs-backend.rst index 1c16840202..65754f1fb5 100644 --- a/doc/admin-guide/source/blockstorage-glusterfs-backend.rst +++ b/doc/admin-guide/source/blockstorage-glusterfs-backend.rst @@ -75,7 +75,7 @@ OpenStack Block Storage to use GlusterFS shares: #. Enable client connections from unprivileged ports. To do this, add the following line to ``/etc/glusterfs/glusterd.vol``: - .. code-block:: ini + .. code-block:: none 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 format: - .. code-block:: ini + .. code-block:: none 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 a share, you can add them to the share's entry: - .. code-block:: ini + .. code-block:: yaml HOST:/VOL_NAME -o OPTIONS diff --git a/doc/admin-guide/source/blockstorage-nfs-backend.rst b/doc/admin-guide/source/blockstorage-nfs-backend.rst index 34e09cc5e2..192d4b6408 100644 --- a/doc/admin-guide/source/blockstorage-nfs-backend.rst +++ b/doc/admin-guide/source/blockstorage-nfs-backend.rst @@ -36,7 +36,7 @@ that hosts the ``cinder`` volume service. Each entry should be a separate line, and should use the following format: - .. code-block:: ini + .. code-block:: none HOST:SHARE diff --git a/doc/admin-guide/source/blockstorage-over-subscription.rst b/doc/admin-guide/source/blockstorage-over-subscription.rst index b01c0a691a..0eedacc958 100644 --- a/doc/admin-guide/source/blockstorage-over-subscription.rst +++ b/doc/admin-guide/source/blockstorage-over-subscription.rst @@ -74,7 +74,7 @@ Volume type extra specs If volume type is provided as part of the volume creation request, it can have the following extra specs defined: -.. code-block:: ini +.. code-block:: none 'capabilities:thin_provisioning_support': ' True' or ' False' 'capabilities:thick_provisioning_support': ' True' or ' False' @@ -84,7 +84,7 @@ have the following extra specs defined: ``capabilities`` scope key before ``thin_provisioning_support`` and ``thick_provisioning_support`` is not required. So the following works too: -.. code-block:: ini +.. code-block:: none 'thin_provisioning_support': ' True' or ' False' 'thick_provisioning_support': ' True' or ' False' diff --git a/doc/admin-guide/source/cli-analyzing-log-files-with-swift.rst b/doc/admin-guide/source/cli-analyzing-log-files-with-swift.rst index bf6843a1b1..0cef68b0c6 100644 --- a/doc/admin-guide/source/cli-analyzing-log-files-with-swift.rst +++ b/doc/admin-guide/source/cli-analyzing-log-files-with-swift.rst @@ -121,8 +121,8 @@ return code combination. .. code-block:: console $ 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 \ - $9"-"$12}' | sort | uniq -c + download -o - logtest 2010-11-16-22_access.log | \ + awk '{ print $9"-"$12}' | sort | uniq -c .. code-block:: console diff --git a/doc/admin-guide/source/cli-networking-advanced-quotas.rst b/doc/admin-guide/source/cli-networking-advanced-quotas.rst index 899fed159d..9c74f9de0c 100644 --- a/doc/admin-guide/source/cli-networking-advanced-quotas.rst +++ b/doc/admin-guide/source/cli-networking-advanced-quotas.rst @@ -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 more resources than the quota allows, an error occurs: -.. code-block:: ini +.. code-block:: console $ openstack network create test_net Quota exceeded for resources: ['network'] diff --git a/doc/admin-guide/source/compute-images-instances.rst b/doc/admin-guide/source/compute-images-instances.rst index bbb09b6505..a2dd5d11a4 100644 --- a/doc/admin-guide/source/compute-images-instances.rst +++ b/doc/admin-guide/source/compute-images-instances.rst @@ -220,8 +220,10 @@ can also be used to set policies for Image service actions. .. code-block:: json + { "download_image": "upload_image": + } #. Define which roles or policies can manage which properties in a property protections configuration file. For example: diff --git a/doc/admin-guide/source/compute-manage-logs.rst b/doc/admin-guide/source/compute-manage-logs.rst index 55edb8b4b9..a51eee2cf0 100644 --- a/doc/admin-guide/source/compute-manage-logs.rst +++ b/doc/admin-guide/source/compute-manage-logs.rst @@ -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. 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 On each compute host, create a file named ``/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 *.*;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 [serial_console] - ... + # ... enabled = true #. 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 [serial_console] - ... + # ... base_url = ws://controller:6083/ listen = 0.0.0.0 proxyclient_address = MANAGEMENT_INTERFACE_IP_ADDRESS @@ -208,8 +208,7 @@ also requires a websocket client to access the serial console. .. code-block:: console - $ curl -i 'http://:8774/v2.1//servers/ - /action' \ + $ curl -i 'http://:8774/v2.1//servers//action' \ -X POST \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ diff --git a/doc/install-guide/source/cinder-backup-install.rst b/doc/install-guide/source/cinder-backup-install.rst index 687441e944..10acee8952 100644 --- a/doc/install-guide/source/cinder-backup-install.rst +++ b/doc/install-guide/source/cinder-backup-install.rst @@ -67,7 +67,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... backup_driver = cinder.backup.drivers.swift backup_swift_url = SWIFT_URL diff --git a/doc/install-guide/source/cinder-controller-install.rst b/doc/install-guide/source/cinder-controller-install.rst index 37a0afd725..394a7a91f7 100644 --- a/doc/install-guide/source/cinder-controller-install.rst +++ b/doc/install-guide/source/cinder-controller-install.rst @@ -297,7 +297,7 @@ Install and configure components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder .. end @@ -312,7 +312,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -327,11 +327,11 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -359,7 +359,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = 10.0.0.11 .. end @@ -372,7 +372,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/cinder/tmp .. end diff --git a/doc/install-guide/source/cinder-storage-install.rst b/doc/install-guide/source/cinder-storage-install.rst index 7118db0eb4..732c2f2fea 100644 --- a/doc/install-guide/source/cinder-storage-install.rst +++ b/doc/install-guide/source/cinder-storage-install.rst @@ -121,7 +121,7 @@ storage node, you must prepare the storage device. ``/dev/sdb`` device and rejects all other devices: .. path /etc/lvm/lvm.conf - .. code-block:: ini + .. code-block:: none devices { ... @@ -209,7 +209,7 @@ Install and configure components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder .. end @@ -224,7 +224,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -239,11 +239,11 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -270,7 +270,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS .. end @@ -290,7 +290,7 @@ Install and configure components .. code-block:: ini [lvm] - ... + # ... volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver volume_group = cinder-volumes iscsi_protocol = iscsi @@ -326,7 +326,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... enabled_backends = lvm .. end @@ -343,7 +343,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... glance_api_servers = http://controller:9292 .. end @@ -354,7 +354,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/cinder/tmp .. end diff --git a/doc/install-guide/source/environment-memcached.rst b/doc/install-guide/source/environment-memcached.rst index 682b4d440e..4340885282 100644 --- a/doc/install-guide/source/environment-memcached.rst +++ b/doc/install-guide/source/environment-memcached.rst @@ -47,7 +47,7 @@ Install and configure components service to use the management IP address of the controller node to enable access by other nodes via the management network: - .. code-block:: ini + .. code-block:: none -l 10.0.0.11 diff --git a/doc/install-guide/source/environment-networking-compute.rst b/doc/install-guide/source/environment-networking-compute.rst index 1761394fd6..c5f9ae89e6 100644 --- a/doc/install-guide/source/environment-networking-compute.rst +++ b/doc/install-guide/source/environment-networking-compute.rst @@ -28,7 +28,7 @@ Configure network interfaces * Edit the ``/etc/network/interfaces`` file to contain the following: .. path /etc/network/interfaces - .. code-block:: ini + .. code-block:: bash # The provider network interface auto INTERFACE_NAME @@ -48,7 +48,7 @@ Configure network interfaces Do not change the ``HWADDR`` and ``UUID`` keys. .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME - .. code-block:: ini + .. code-block:: bash DEVICE=INTERFACE_NAME TYPE=Ethernet @@ -65,7 +65,7 @@ Configure network interfaces contain the following: .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME - .. code-block:: ini + .. code-block:: bash STARTMODE='auto' BOOTPROTO='static' diff --git a/doc/install-guide/source/neutron-controller-install-option2.rst b/doc/install-guide/source/neutron-controller-install-option2.rst index f24a1bd5e4..d75cf916e2 100644 --- a/doc/install-guide/source/neutron-controller-install-option2.rst +++ b/doc/install-guide/source/neutron-controller-install-option2.rst @@ -65,7 +65,7 @@ Configure the server component .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://neutron:NEUTRON_DBPASS@controller/neutron .. end @@ -85,7 +85,7 @@ Configure the server component .. code-block:: ini [DEFAULT] - ... + # ... core_plugin = ml2 service_plugins = router allow_overlapping_ips = True @@ -99,7 +99,7 @@ Configure the server component .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -114,11 +114,11 @@ Configure the server component .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -146,12 +146,12 @@ Configure the server component .. code-block:: ini [DEFAULT] - ... + # ... notify_nova_on_port_status_changes = True notify_nova_on_port_data_changes = True [nova] - ... + # ... auth_url = http://controller:35357 auth_type = password project_domain_name = default @@ -174,7 +174,7 @@ Configure the server component .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/neutron/tmp .. end @@ -194,7 +194,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... type_drivers = flat,vlan,vxlan .. end @@ -205,7 +205,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... tenant_network_types = vxlan .. end @@ -217,7 +217,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... mechanism_drivers = linuxbridge,l2population .. end @@ -237,7 +237,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... extension_drivers = port_security .. end @@ -249,7 +249,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_flat] - ... + # ... flat_networks = provider .. end @@ -261,7 +261,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_vxlan] - ... + # ... vni_ranges = 1:1000 .. end @@ -273,7 +273,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [securitygroup] - ... + # ... enable_ipset = True .. end @@ -330,7 +330,7 @@ networking infrastructure for instances and handles security groups. .. code-block:: ini [securitygroup] - ... + # ... enable_security_group = True firewall_driver = neutron.agent.linux.iptables_firewall.IptablesFirewallDriver @@ -352,7 +352,7 @@ self-service virtual networks. .. code-block:: ini [DEFAULT] - ... + # ... interface_driver = linuxbridge .. end @@ -373,7 +373,7 @@ The :term:`DHCP agent` provides DHCP services for virtual networks. .. code-block:: ini [DEFAULT] - ... + # ... interface_driver = linuxbridge dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq enable_isolated_metadata = True diff --git a/doc/install-guide/source/nova-compute-install.rst b/doc/install-guide/source/nova-compute-install.rst index 9f425d2955..25a3bdc8eb 100644 --- a/doc/install-guide/source/nova-compute-install.rst +++ b/doc/install-guide/source/nova-compute-install.rst @@ -86,7 +86,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... enabled_apis = osapi_compute,metadata .. end @@ -100,7 +100,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -115,11 +115,11 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -150,7 +150,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS .. end @@ -170,7 +170,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS .. end @@ -186,7 +186,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... use_neutron = True firewall_driver = nova.virt.firewall.NoopFirewallDriver @@ -207,7 +207,7 @@ Install and configure components .. code-block:: ini [vnc] - ... + # ... enabled = True vncserver_listen = 0.0.0.0 vncserver_proxyclient_address = $my_ip @@ -235,7 +235,7 @@ Install and configure components .. code-block:: ini [glance] - ... + # ... api_servers = http://controller:9292 .. end @@ -248,7 +248,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/run/nova .. end @@ -263,7 +263,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/nova/tmp .. end @@ -325,7 +325,7 @@ Finalize installation .. code-block:: ini [libvirt] - ... + # ... virt_type = qemu .. end @@ -341,7 +341,7 @@ Finalize installation .. code-block:: ini [libvirt] - ... + # ... virt_type = qemu .. end diff --git a/doc/install-guide/source/nova-controller-install.rst b/doc/install-guide/source/nova-controller-install.rst index ec57143062..c2c4ff2aca 100644 --- a/doc/install-guide/source/nova-controller-install.rst +++ b/doc/install-guide/source/nova-controller-install.rst @@ -254,7 +254,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... enabled_apis = osapi_compute,metadata .. end @@ -268,11 +268,11 @@ Install and configure components .. code-block:: ini [api_database] - ... + # ... connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova_api [database] - ... + # ... connection = mysql+pymysql://nova:NOVA_DBPASS@controller/nova .. end @@ -287,7 +287,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -302,11 +302,11 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -334,7 +334,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = 10.0.0.11 .. end @@ -347,7 +347,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... use_neutron = True firewall_driver = nova.virt.firewall.NoopFirewallDriver @@ -370,7 +370,7 @@ Install and configure components [vnc] enabled = true - ... + # ... vncserver_listen = $my_ip vncserver_proxyclient_address = $my_ip @@ -397,7 +397,7 @@ Install and configure components .. code-block:: ini [glance] - ... + # ... api_servers = http://controller:9292 .. end @@ -410,7 +410,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/run/nova .. end @@ -425,7 +425,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/nova/tmp .. end @@ -440,7 +440,7 @@ Install and configure components .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/nova/tmp .. end diff --git a/doc/user-guide/source/backup-db-incremental.rst b/doc/user-guide/source/backup-db-incremental.rst index fa96ff1f72..cd08792532 100644 --- a/doc/user-guide/source/backup-db-incremental.rst +++ b/doc/user-guide/source/backup-db-incremental.rst @@ -98,7 +98,7 @@ Create and use incremental backups instance called ``guest2``. 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 complexities of applying the chain of all previous incremental backups. diff --git a/doc/user-guide/source/backup-db.rst b/doc/user-guide/source/backup-db.rst index 7edc324d7e..cb7f26f2b2 100644 --- a/doc/user-guide/source/backup-db.rst +++ b/doc/user-guide/source/backup-db.rst @@ -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 ``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 ``BACKUP_ID``. In this example, replace ``BACKUP_ID`` with ``8af30763-61fd-4aab-8fe8-57d528911138``. diff --git a/doc/user-guide/source/cli-access-instance-through-a-console.rst b/doc/user-guide/source/cli-access-instance-through-a-console.rst index cc78675522..7d0725c1c1 100644 --- a/doc/user-guide/source/cli-access-instance-through-a-console.rst +++ b/doc/user-guide/source/cli-access-instance-through-a-console.rst @@ -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 | +--------+------------------------------------------------------------------------------+ -: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. When using SPICE to view the console of an instance, a browser plugin diff --git a/doc/user-guide/source/cli-ceilometer.rst b/doc/user-guide/source/cli-ceilometer.rst index e3e9deb77b..d75a3bc8bd 100644 --- a/doc/user-guide/source/cli-ceilometer.rst +++ b/doc/user-guide/source/cli-ceilometer.rst @@ -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. #. Create an auto-scaling stack by running the following command. - The :option:`-f` option specifies the name of the stack template - file, and the :option:`-P` option specifies the ``KeyName`` + The ``-f`` option specifies the name of the stack template + file, and the ``-P`` option specifies the ``KeyName`` parameter as ``heat_key``: .. code-block:: console diff --git a/doc/user-guide/source/cli-create-and-manage-networks.rst b/doc/user-guide/source/cli-create-and-manage-networks.rst index 21c70b1f26..05b44febf1 100644 --- a/doc/user-guide/source/cli-create-and-manage-networks.rst +++ b/doc/user-guide/source/cli-create-and-manage-networks.rst @@ -244,7 +244,7 @@ Create ports +-----------------------+-----------------------------------------+ In the previous command, ``net1`` is the network name, which is a - positional argument. :option:`--fixed-ip subnet,ip-address=192.168.2.40` is + positional argument. ``--fixed-ip subnet,ip-address=192.168.2.40`` is an option which specifies the port's fixed IP address we wanted. .. note:: @@ -295,7 +295,7 @@ Create ports .. 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`` or ``ff:ff:ff:ff:ff:ff``, you will get an error. diff --git a/doc/user-guide/source/cli-create-and-manage-stacks.rst b/doc/user-guide/source/cli-create-and-manage-stacks.rst index a3aa44f8c6..1355e3aa4a 100644 --- a/doc/user-guide/source/cli-create-and-manage-stacks.rst +++ b/doc/user-guide/source/cli-create-and-manage-stacks.rst @@ -32,9 +32,9 @@ Create a stack from an example template file $ openstack stack create --template server_console.yaml \ --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 - 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: @@ -54,7 +54,7 @@ Create a stack from an example template file | 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 template file without creating a stack from it. diff --git a/doc/user-guide/source/cli-manage-ip-addresses.rst b/doc/user-guide/source/cli-manage-ip-addresses.rst index fdb4a3cf32..b86f409721 100644 --- a/doc/user-guide/source/cli-manage-ip-addresses.rst +++ b/doc/user-guide/source/cli-manage-ip-addresses.rst @@ -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 floating IP address with a specific fixed IP address using the optional - :option:`--fixed-address` parameter: + ``--fixed-address`` parameter: .. code-block:: console