From 2d44b2b36ddf045ca223e22e7595b12af821cd7f Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 11 Jan 2017 18:07:14 +0100 Subject: [PATCH] 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. Note that not every config file is an ini-file. Also, the parser seems to have bugs and cannot parse all files. Fix mysql ini file and enable the parameter, see http://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_file_per_table * :option: works only with declared options, replace useage with simple ``. This change only handles a few files, more to come later. Change-Id: I7c7335e514581622dd562ee355f62d6ae1beaa18 --- .../source/blockstorage-backup-disks.rst | 4 +- .../blockstorage-consistency-groups.rst | 2 +- .../source/blockstorage-groups.rst | 16 ++--- .../source/blockstorage-volume-backups.rst | 6 +- .../cli-analyzing-log-files-with-swift.rst | 10 ++-- doc/admin-guide/source/cli-manage-shares.rst | 2 +- .../source/cli-networking-advanced-quotas.rst | 6 +- doc/admin-guide/source/cli-nova-evacuate.rst | 2 +- .../source/cli-nova-specify-host.rst | 4 +- doc/admin-guide/source/compute-arch.rst | 2 +- .../source/compute-configuring-migrations.rst | 4 +- .../source/compute-manage-the-cloud.rst | 2 +- .../source/compute-networking-nova.rst | 4 +- doc/admin-guide/source/compute-node-down.rst | 4 +- .../source/dashboard-customize-configure.rst | 7 +-- doc/admin-guide/source/database.rst | 4 +- .../source/identity-auth-token-middleware.rst | 2 +- .../source/identity-certificates-for-pki.rst | 2 +- doc/admin-guide/source/identity-concepts.rst | 4 +- .../identity-external-authentication.rst | 2 +- .../identity-service-api-protection.rst | 10 ++-- .../source/identity-troubleshoot.rst | 6 +- .../source/networking-adv-config.rst | 3 +- .../source/networking-adv-features.rst | 4 +- doc/admin-guide/source/networking-auth.rst | 12 ++-- .../source/networking-config-agents.rst | 13 ++-- .../source/networking-config-identity.rst | 2 +- .../source/objectstorage-monitoring.rst | 2 +- .../source/shared-file-systems-cgroups.rst | 6 +- .../source/shared-file-systems-crud-share.rst | 2 +- .../shared-file-systems-manage-shares-cli.rst | 2 +- .../source/shared-file-systems-quotas.rst | 2 +- .../shared-file-systems-security-services.rst | 6 +- .../shared-file-systems-share-types.rst | 4 +- .../source/shared-file-systems-snapshots.rst | 2 +- doc/admin-guide/source/support-compute.rst | 2 +- .../source/telemetry-data-collection.rst | 10 ++-- .../source/telemetry-data-pipelines.rst | 2 +- .../source/telemetry-data-retrieval.rst | 7 +-- doc/admin-guide/source/ts-cinder-config.rst | 2 +- ...install-openstack-command-line-clients.rst | 2 +- doc/common/cli-manage-volumes.rst | 12 ++-- ...vironment-variables-using-openstack-rc.rst | 4 +- .../block-storage/drivers/coprhd-driver.rst | 2 +- .../drivers/datera-volume-driver.rst | 2 +- .../block-storage/drivers/dothill-driver.rst | 4 +- .../block-storage/drivers/emc-vmax-driver.rst | 10 ++-- .../block-storage/drivers/emc-vnx-driver.rst | 4 +- .../block-storage/drivers/hds-hnas-driver.rst | 6 +- .../block-storage/drivers/lenovo-driver.rst | 3 +- .../drivers/nexentastor4-driver.rst | 2 +- .../drivers/nexentastor5-driver.rst | 4 +- .../drivers/pure-storage-driver.rst | 2 +- .../drivers/zfssa-iscsi-driver.rst | 2 +- .../drivers/zte-storage-driver.rst | 3 +- .../block-storage/samples/api-paste.ini.rst | 2 +- .../block-storage/samples/policy.json.rst | 2 +- doc/config-reference/source/compute/cells.rst | 2 +- .../source/compute/hypervisor-hyper-v.rst | 30 +++++----- .../source/compute/nova-conf-samples.rst | 4 +- .../source/compute/samples/api-paste.ini.rst | 2 +- .../source/compute/schedulers.rst | 2 +- .../source/image/glance-api-paste.ini.rst | 2 +- .../networking/samples/api-paste.ini.rst | 2 +- .../source/object-storage/features.rst | 2 +- .../source/policy-json-file.rst | 26 ++++---- .../source/shared-file-systems/drivers.rst | 6 +- .../drivers/hitachi-hsp-driver.rst | 4 +- .../samples/event_definitions.yaml.rst | 2 +- .../telemetry/samples/event_pipeline.yaml.rst | 2 +- .../telemetry/samples/pipeline.yaml.rst | 2 +- .../source/quickstart/first-timers.rst | 2 +- .../source/rst-conv/inline-markups.rst | 2 +- .../source/rst-conv/rst2bash.rst | 8 +-- .../source/rst-conv/source-code.rst | 2 +- .../source/vendor-drivers.rst | 2 +- .../source/controller-ha-identity.rst | 4 +- .../source/controller-ha-pacemaker.rst | 12 ++-- .../source/shared-database-manage.rst | 2 +- doc/ha-guide/source/shared-messaging.rst | 2 +- doc/ha-guide/source/storage-ha-block.rst | 2 +- .../source/storage-ha-file-systems.rst | 2 +- doc/ha-guide/source/storage-ha-image.rst | 4 +- doc/image-guide/source/centos-image.rst | 2 +- doc/image-guide/source/openstack-images.rst | 2 +- .../source/cinder-controller-install.rst | 2 +- .../source/cinder-storage-install.rst | 6 +- .../debconf/debconf-dbconfig-common.rst | 2 +- .../debconf/debconf-keystone-authtoken.rst | 2 +- .../source/keystone-install.rst | 4 +- .../neutron-controller-install-option1.rst | 22 +++---- .../neutron-controller-install-option2.rst | 20 +++---- .../source/neutron-controller-install.rst | 4 +- .../source/nova-compute-install.rst | 6 +- .../source/nova-controller-install.rst | 10 ++-- .../source/cinder-storage-install.rst | 2 +- .../environment-networking-controller.rst | 2 +- .../source/environment-ntp-controller.rst | 8 +-- .../source/environment-ntp-other.rst | 4 +- .../source/environment-sql-database.rst | 6 +- doc/install-guide/source/glance-install.rst | 14 ++--- doc/install-guide/source/horizon-install.rst | 60 +++++++++---------- doc/install-guide/source/keystone-install.rst | 6 +- .../neutron-compute-install-option1.rst | 2 +- .../neutron-compute-install-option2.rst | 2 +- .../source/neutron-compute-install.rst | 10 ++-- .../neutron-controller-install-option1.rst | 32 +++++----- .../source/neutron-controller-install.rst | 4 +- .../source/shared/edit_hosts_file.txt | 2 +- .../source/config-dvr-ha-snat.rst | 2 +- doc/networking-guide/source/config-qos.rst | 8 +-- .../source/config-routed-networks.rst | 2 +- doc/networking-guide/source/config-sriov.rst | 4 +- .../source/config-subnet-pools.rst | 6 +- .../source/config-trunking.rst | 2 +- .../source/fwaas-v1-scenario.rst | 15 +++-- .../source/fwaas-v2-scenario.rst | 15 +++-- .../source/migration-database.rst | 8 +-- .../shared/deploy-config-neutron-common.txt | 8 +-- doc/ops-guide/source/app-crypt.rst | 2 +- .../source/ops-customize-objectstorage.rst | 2 +- doc/ops-guide/source/ops-lay-of-the-land.rst | 2 +- doc/ops-guide/source/ops-logging-rsyslog.rst | 4 +- .../source/ops-maintenance-compute.rst | 2 +- doc/ops-guide/source/ops-monitoring.rst | 6 +- doc/ops-guide/source/ops-projects.rst | 4 +- .../source/ops-user-facing-operations.rst | 18 +++--- doc/ops-guide/source/ops-users.rst | 2 +- .../cli-nova-launch-instance-from-image.rst | 2 +- .../source/cli-reboot-an-instance.rst | 4 +- .../cli-search-instance-with-ip-address.rst | 2 +- .../source/cli-swift-manage-access-swift.rst | 4 +- doc/user-guide/source/manage-db-config.rst | 2 +- doc/user-guide/source/set-up-clustering.rst | 2 +- doc/user-guide/source/set-up-replication.rst | 6 +- 135 files changed, 373 insertions(+), 383 deletions(-) diff --git a/doc/admin-guide/source/blockstorage-backup-disks.rst b/doc/admin-guide/source/blockstorage-backup-disks.rst index 27d94bc705..d8535477c0 100644 --- a/doc/admin-guide/source/blockstorage-backup-disks.rst +++ b/doc/admin-guide/source/blockstorage-backup-disks.rst @@ -59,14 +59,14 @@ You can apply this process to volumes of any size. # lvcreate --size 10G --snapshot --name volume-00000001-snapshot \ /dev/cinder-volumes/volume-00000001 - Use the :option:`--snapshot` configuration option to tell LVM that you want a + Use the ``--snapshot`` configuration option to tell LVM that you want a snapshot of an already existing volume. The command includes the size of the space reserved for the snapshot volume, the name of the snapshot, and the path of an already existing volume. Generally, this path is ``/dev/cinder-volumes/VOLUME_NAME``. The size does not have to be the same as the volume of the snapshot. - The :option:`--size` parameter defines the space that LVM reserves + The ``--size`` parameter defines the space that LVM reserves for the snapshot volume. As a precaution, the size should be the same as that of the original volume, even if the whole space is not currently used by the snapshot. diff --git a/doc/admin-guide/source/blockstorage-consistency-groups.rst b/doc/admin-guide/source/blockstorage-consistency-groups.rst index e04155c4b0..df2b4979e2 100644 --- a/doc/admin-guide/source/blockstorage-consistency-groups.rst +++ b/doc/admin-guide/source/blockstorage-consistency-groups.rst @@ -12,7 +12,7 @@ group operations can be performed using the Block Storage command line. .. note:: Only Block Storage V2 API supports consistency groups. You can - specify :option:`--os-volume-api-version 2` when using Block Storage + specify ``--os-volume-api-version 2`` when using Block Storage command line for consistency group operations. Before using consistency groups, make sure the Block Storage driver that diff --git a/doc/admin-guide/source/blockstorage-groups.rst b/doc/admin-guide/source/blockstorage-groups.rst index 476b3c21ea..f40058e826 100644 --- a/doc/admin-guide/source/blockstorage-groups.rst +++ b/doc/admin-guide/source/blockstorage-groups.rst @@ -39,7 +39,7 @@ found in `Cinder specs `__. #. Set the required parameters as environment variables to make running - commands easier. For example, you can add :option:`--os-username` as an + commands easier. For example, you can add ``--os-username`` as an ``openstack`` option, or set it as an environment variable. To set the user name, password, and project as environment variables, use: diff --git a/doc/admin-guide/source/compute-networking-nova.rst b/doc/admin-guide/source/compute-networking-nova.rst index 7f21dc9d48..05bcb1cbba 100644 --- a/doc/admin-guide/source/compute-networking-nova.rst +++ b/doc/admin-guide/source/compute-networking-nova.rst @@ -390,7 +390,7 @@ retrieve the metadata, make a GET request to } Instances also retrieve user data (passed as the ``user_data`` parameter -in the API call or by the :option:`--user_data` flag in the +in the API call or by the ``--user_data`` flag in the :command:`openstack server create` command) through the metadata service, by making a GET request to ``http://169.254.169.254/openstack/2012-08-10/user_data``: @@ -834,7 +834,7 @@ Edit the ``/etc/network/interfaces`` file: iface eth1 inet dhcp If the Virtual Network Service Neutron is installed, you can specify the -networks to attach to the interfaces by using the :option:`--nic` flag with +networks to attach to the interfaces by using the ``--nic`` flag with the :command:`openstack server create` command: .. code-block:: console diff --git a/doc/admin-guide/source/compute-node-down.rst b/doc/admin-guide/source/compute-node-down.rst index 1f7723ecd5..a1e0274e71 100644 --- a/doc/admin-guide/source/compute-node-down.rst +++ b/doc/admin-guide/source/compute-node-down.rst @@ -38,7 +38,7 @@ To manually recover a failed compute node: :command:`nova` commands, you can substitute the ID directly. This example output is truncated: - .. code-block:: mysql + .. code-block:: none mysql> SELECT * FROM instances WHERE id = CONV('15b9', 16, 10) \G; *************************** 1. row *************************** @@ -327,7 +327,7 @@ iSCSI session. This example closes an iSCSI session with the number ``15``: # iscsiadm -m session -u -r 15 -Do not forget the :option:`-r` option. Otherwise, all sessions close. +Do not forget the ``-r`` option. Otherwise, all sessions close. .. warning:: diff --git a/doc/admin-guide/source/dashboard-customize-configure.rst b/doc/admin-guide/source/dashboard-customize-configure.rst index d42eece3e0..721d32c9ea 100644 --- a/doc/admin-guide/source/dashboard-customize-configure.rst +++ b/doc/admin-guide/source/dashboard-customize-configure.rst @@ -1,4 +1,3 @@ - ===================================== Customize and configure the Dashboard ===================================== @@ -357,7 +356,7 @@ Use a domain that fits your current setup. **Example After** - .. code-block:: apacheconf + .. code-block:: none ServerName openstack.example.com @@ -436,7 +435,7 @@ Use a domain that fits your current setup. .. code-block:: ini [DEFAULT] - ... + # ... ssl_only = true cert = /etc/apache2/SSL/openstack.example.com.crt key = /etc/apache2/SSL/openstack.example.com.key @@ -447,5 +446,5 @@ Use a domain that fits your current setup. .. code-block:: ini [DEFAULT] - ... + # ... novncproxy_base_url = https://controller:6080/vnc_auto.html diff --git a/doc/admin-guide/source/database.rst b/doc/admin-guide/source/database.rst index b8ac6fc3e8..d34bba7595 100644 --- a/doc/admin-guide/source/database.rst +++ b/doc/admin-guide/source/database.rst @@ -121,7 +121,7 @@ data store version. - In this example: * - config file - The configuration file to use. - - :option:`--config-file=/etc/trove/trove.conf` + - ``--config-file=/etc/trove/trove.conf`` * - name - Name you want to use for this data store. - ``mysql`` @@ -162,7 +162,7 @@ data store version. * - config file - The configuration file to use. - - :option:`--config-file=/etc/trove/trove.conf` + - ``--config-file=/etc/trove/trove.conf`` * - data store - The name of the data store you just created via diff --git a/doc/admin-guide/source/identity-auth-token-middleware.rst b/doc/admin-guide/source/identity-auth-token-middleware.rst index 9bfebad1ec..291d4f777b 100644 --- a/doc/admin-guide/source/identity-auth-token-middleware.rst +++ b/doc/admin-guide/source/identity-auth-token-middleware.rst @@ -26,7 +26,7 @@ And set the following values in ``nova.conf`` as follows: .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy=keystone [keystone_authtoken] diff --git a/doc/admin-guide/source/identity-certificates-for-pki.rst b/doc/admin-guide/source/identity-certificates-for-pki.rst index 31c6f79d48..9787175e59 100644 --- a/doc/admin-guide/source/identity-certificates-for-pki.rst +++ b/doc/admin-guide/source/identity-certificates-for-pki.rst @@ -22,7 +22,7 @@ the system user that will run the Identity service. going to sign tokens. When generating files with the :command:`keystone-manage pki_setup` command, your best option is to run as the pki user. If you run :command:`keystone-manage` as root, you can - append :option:`--keystone-user` and :option:`--keystone-group` parameters + append ``--keystone-user`` and ``--keystone-group`` parameters to set the user name and group keystone is going to run under. The values that specify where to read the certificates are under the diff --git a/doc/admin-guide/source/identity-concepts.rst b/doc/admin-guide/source/identity-concepts.rst index 6d87726f34..b2d3077a53 100644 --- a/doc/admin-guide/source/identity-concepts.rst +++ b/doc/admin-guide/source/identity-concepts.rst @@ -160,7 +160,7 @@ is required for Compute operations. For example, the following line in the ``/etc/cinder/policy.json`` file does not restrict which users can create volumes: -.. code-block:: json +.. code-block:: none "volume:create": "", @@ -170,7 +170,7 @@ project. To restrict the creation of volumes to users who have the ``compute-user`` role in a particular project, you add ``"role:compute-user"``: -.. code-block:: json +.. code-block:: none "volume:create": "role:compute-user", diff --git a/doc/admin-guide/source/identity-external-authentication.rst b/doc/admin-guide/source/identity-external-authentication.rst index e8f03cf711..62b55714e4 100644 --- a/doc/admin-guide/source/identity-external-authentication.rst +++ b/doc/admin-guide/source/identity-external-authentication.rst @@ -24,7 +24,7 @@ Use X.509 The following Apache configuration snippet authenticates the user based on a valid X.509 certificate from a known CA: -.. code-block:: apacheconf +.. code-block:: none SSLEngine on diff --git a/doc/admin-guide/source/identity-service-api-protection.rst b/doc/admin-guide/source/identity-service-api-protection.rst index 01b640ec3c..99e181ad1b 100644 --- a/doc/admin-guide/source/identity-service-api-protection.rst +++ b/doc/admin-guide/source/identity-service-api-protection.rst @@ -12,7 +12,7 @@ certain actions in defined services. Each Identity API v3 call has a line in the policy file that dictates which level of governance of access applies. -.. code-block:: ini +.. code-block:: none API_NAME: RULE_STATEMENT or MATCH_STATEMENT @@ -25,7 +25,7 @@ Where: token provided by the caller of the API and the parameters or target entities of the API call in question. For example: -.. code-block:: ini +.. code-block:: none "identity:create_user": "role:admin and domain_id:%(user.domain_id)s" @@ -39,7 +39,7 @@ must be scoped to that domain. Each component of a match statement uses this format: -.. code-block:: ini +.. code-block:: none ATTRIB_FROM_TOKEN:CONSTANT or ATTRIB_RELATED_TO_API_CALL @@ -64,7 +64,7 @@ You reference attributes of objects passed with an object.attribute syntax (such as, ``user.domain_id``). The target objects of an API are also available using a target.object.attribute syntax. For instance: -.. code-block:: ini +.. code-block:: none "identity:delete_user": "role:admin and domain_id:%(target.user.domain_id)s" @@ -79,7 +79,7 @@ such as user passwords. List of object attributes: -.. code-block:: ini +.. code-block:: yaml role: target.role.id diff --git a/doc/admin-guide/source/identity-troubleshoot.rst b/doc/admin-guide/source/identity-troubleshoot.rst index 12296127c5..f8971ef52d 100644 --- a/doc/admin-guide/source/identity-troubleshoot.rst +++ b/doc/admin-guide/source/identity-troubleshoot.rst @@ -19,7 +19,7 @@ location of log files. The logs show the components that have come in to the WSGI request, and ideally show an error that explains why an authorization request failed. If you do not see the request in the logs, run keystone with the -:option:`--debug` parameter. Pass the :option:`--debug` parameter before the +``--debug`` parameter. Pass the ``--debug`` parameter before the command parameters. Debug PKI middleware @@ -165,8 +165,8 @@ is owned by ``root:root``. This can present a problem when you run the Identity daemon under the keystone user account (nologin) when you try to run PKI. Unless you run the :command:`chown` command against the files ``keystone:keystone``, or run the :command:`keystone-manage pki_setup` -command with the :option:`--keystone-user` and -:option:`--keystone-group` parameters, you will get an error. +command with the ``--keystone-user`` and +``--keystone-group`` parameters, you will get an error. For example: .. code-block:: console diff --git a/doc/admin-guide/source/networking-adv-config.rst b/doc/admin-guide/source/networking-adv-config.rst index 3fe95a2bd8..85136c9f40 100644 --- a/doc/admin-guide/source/networking-adv-config.rst +++ b/doc/admin-guide/source/networking-adv-config.rst @@ -44,8 +44,7 @@ Currently the only available implementation uses iptables for metering. .. code-block:: ini - driver = neutron.services.metering.drivers. - iptables.iptables_driver.IptablesMeteringDriver + driver = neutron.services.metering.drivers.iptables.iptables_driver.IptablesMeteringDriver L3 metering service driver -------------------------- diff --git a/doc/admin-guide/source/networking-adv-features.rst b/doc/admin-guide/source/networking-adv-features.rst index b5d69861f0..9527ba44c4 100644 --- a/doc/admin-guide/source/networking-adv-features.rst +++ b/doc/admin-guide/source/networking-adv-features.rst @@ -426,11 +426,11 @@ basic LBaaS operations: - Creates a load balancer pool by using specific provider. - :option:`--provider` is an optional argument. If not used, the pool is + ``--provider`` is an optional argument. If not used, the pool is created with default provider for LBaaS service. You should configure the default provider in the ``[service_providers]`` section of the ``neutron.conf`` file. If no default provider is specified for LBaaS, - the :option:`--provider` parameter is required for pool creation. + the ``--provider`` parameter is required for pool creation. .. code-block:: console diff --git a/doc/admin-guide/source/networking-auth.rst b/doc/admin-guide/source/networking-auth.rst index ac2f3bcb63..56be523e3d 100644 --- a/doc/admin-guide/source/networking-auth.rst +++ b/doc/admin-guide/source/networking-auth.rst @@ -90,7 +90,7 @@ This extract is from the default ``policy.json`` file: administrator or the owner of the resource specified in the request (project identifier is equal). - .. code-block:: json + .. code-block:: none { "admin_or_owner": [ @@ -126,7 +126,7 @@ This extract is from the default ``policy.json`` file: - The default policy that is always evaluated if an API operation does not match any of the policies in ``policy.json``. - .. code-block:: json + .. code-block:: none "rule:admin_or_owner" ] @@ -163,7 +163,7 @@ This extract is from the default ``policy.json`` file: - This policy evaluates successfully if either *admin\_or\_owner*, or *shared* evaluates successfully. - .. code-block:: json + .. code-block:: none [ "rule:shared" @@ -177,7 +177,7 @@ This extract is from the default ``policy.json`` file: - This policy restricts the ability to manipulate the *shared* attribute for a network to administrators only. - .. code-block:: json + .. code-block:: none ], "update_network": [ @@ -202,7 +202,7 @@ This extract is from the default ``policy.json`` file: attribute for a port only to administrators and the owner of the network where the port is attached. - .. code-block:: json + .. code-block:: none [ "rule:admin_or_network_owner" @@ -230,7 +230,7 @@ This example shows you how to modify a policy file to permit project to define networks, see their resources, and permit administrative users to perform all other operations: -.. code-block:: ini +.. code-block:: none { "admin_or_owner": [["role:admin"], ["tenant_id:%(tenant_id)s"]], diff --git a/doc/admin-guide/source/networking-config-agents.rst b/doc/admin-guide/source/networking-config-agents.rst index 907a8aef5b..76eace0ce2 100644 --- a/doc/admin-guide/source/networking-config-agents.rst +++ b/doc/admin-guide/source/networking-config-agents.rst @@ -225,7 +225,7 @@ capabilities: communication is interrupted. To avoid this, edit the ``/etc/network/interfaces`` file to contain the following information: - .. code-block:: ini + .. code-block:: shell ## External bridge auto br-ex @@ -332,8 +332,7 @@ The Neutron Metering agent resides beside neutron-l3-agent. .. code-block:: ini - driver = neutron.services.metering.drivers.iptables.iptables_driver - .IptablesMeteringDriver + driver = neutron.services.metering.drivers.iptables.iptables_driver.IptablesMeteringDriver #. Set the ``service_plugins`` option in the ``/etc/neutron/neutron.conf`` file on the host that runs ``neutron-server``: @@ -365,8 +364,7 @@ This example uses Octavia. .. code-block:: ini - service_provider = LOADBALANCERV2:Octavia:neutron_lbaas. - drivers.octavia.driver.OctaviaDriver:default + service_provider = LOADBALANCERV2:Octavia:neutron_lbaas.drivers.octavia.driver.OctaviaDriver:default #. Edit the ``/etc/neutron/neutron.conf`` file and add the @@ -467,8 +465,7 @@ correctly using these enable_metrics_collection = true [SECURITYGROUP] - firewall_driver = hyperv.neutron.security_groups_driver. - HyperVSecurityGroupsDriver + firewall_driver = hyperv.neutron.security_groups_driver.HyperVSecurityGroupsDriver enable_security_group = true #. Start the OpenStack Networking Hyper-V agent: @@ -496,7 +493,7 @@ complete basic operations on agents. - ``$ openstack network agent show AGENT_ID`` * - Update the admin status and description for a specified agent. The command can be used to enable and disable agents by using - :option:`--admin-state-up` parameter set to ``False`` or ``True``. + ``--admin-state-up`` parameter set to ``False`` or ``True``. - ``$ neutron agent-update --admin-state-up False AGENT_ID`` * - Delete a given agent. Consider disabling the agent before deletion. - ``$ openstack network agent delete AGENT_ID`` diff --git a/doc/admin-guide/source/networking-config-identity.rst b/doc/admin-guide/source/networking-config-identity.rst index 7e6faea829..f311c0ef84 100644 --- a/doc/admin-guide/source/networking-config-identity.rst +++ b/doc/admin-guide/source/networking-config-identity.rst @@ -11,7 +11,7 @@ Configure Identity service for Networking a. Add the following function to your ``.bashrc`` file: - .. code-block:: ini + .. code-block:: bash function get_id () { echo `"$@" | awk '/ id / { print $4 }'` diff --git a/doc/admin-guide/source/objectstorage-monitoring.rst b/doc/admin-guide/source/objectstorage-monitoring.rst index 7c06c5d0ae..91691b9f96 100644 --- a/doc/admin-guide/source/objectstorage-monitoring.rst +++ b/doc/admin-guide/source/objectstorage-monitoring.rst @@ -141,7 +141,7 @@ require accuracy (``sample_rate=1``) while others may not. .. code-block:: ini [DEFAULT] - ... + # ... log_statsd_host = 127.0.0.1 log_statsd_port = 8125 log_statsd_default_sample_rate = 1 diff --git a/doc/admin-guide/source/shared-file-systems-cgroups.rst b/doc/admin-guide/source/shared-file-systems-cgroups.rst index a23a99effa..afe7ba1ca8 100644 --- a/doc/admin-guide/source/shared-file-systems-cgroups.rst +++ b/doc/admin-guide/source/shared-file-systems-cgroups.rst @@ -87,7 +87,7 @@ Check that consistency group status is ``available``: +----------------------+--------------------------------------+ To add a share to the consistency group, create a share by adding the -:option:`--consistency-group` option where you specify the ID of the consistency +``--consistency-group`` option where you specify the ID of the consistency group in ``available`` status: .. code-block:: console @@ -207,7 +207,7 @@ description using the :command:`cg-snapshot-update` command, or delete it with the :command:`cg-snapshot-delete` command. A consistency group snapshot can have ``members``. To add a member, -include the :option:`--consistency-group` optional parameter in the +include the ``--consistency-group`` optional parameter in the create share command. This ID must match the ID of the consistency group from which the consistency group snapshot was created. Then, while restoring data, and operating with consistency group snapshots, you can quickly @@ -318,5 +318,5 @@ Print detailed information about new share: As an administrator, you can also reset the state of a consistency group snapshot with the :command:`cg-snapshot-reset-state` command, and force delete a specified consistency group snapshot in any state using the :command:`cg-snapshot-delete` command -with the :option:`--force` key. Use the ``policy.json`` file to grant permissions for +with the ``--force`` key. Use the ``policy.json`` file to grant permissions for these actions to other roles. diff --git a/doc/admin-guide/source/shared-file-systems-crud-share.rst b/doc/admin-guide/source/shared-file-systems-crud-share.rst index f07add5636..6ef224328b 100644 --- a/doc/admin-guide/source/shared-file-systems-crud-share.rst +++ b/doc/admin-guide/source/shared-file-systems-crud-share.rst @@ -582,7 +582,7 @@ Use **manila delete ** command to delete a specified share: .. note:: If you specified :ref:`the consistency group ` - while creating a share, you should provide the :option:`--consistency-group` + while creating a share, you should provide the ``--consistency-group`` parameter to delete the share: .. code-block:: console diff --git a/doc/admin-guide/source/shared-file-systems-manage-shares-cli.rst b/doc/admin-guide/source/shared-file-systems-manage-shares-cli.rst index 9d33af371f..982df2d887 100644 --- a/doc/admin-guide/source/shared-file-systems-manage-shares-cli.rst +++ b/doc/admin-guide/source/shared-file-systems-manage-shares-cli.rst @@ -25,7 +25,7 @@ following example: $ manila migrate shareID destinationHost --force-host-copy True|False -In this example, :option:`--force-host-copy True` forces the generic +In this example, ``--force-host-copy True`` forces the generic host-based migration mechanism and bypasses any driver optimizations. ``destinationHost`` is in this format ``host#pool`` which includes destination host and pool. diff --git a/doc/admin-guide/source/shared-file-systems-quotas.rst b/doc/admin-guide/source/shared-file-systems-quotas.rst index 164ad21c68..53403059ab 100644 --- a/doc/admin-guide/source/shared-file-systems-quotas.rst +++ b/doc/admin-guide/source/shared-file-systems-quotas.rst @@ -86,7 +86,7 @@ Quotas Quota sets provide quota management support. To list the quotas for a project or user, use the :command:`manila quota-show` -command. If you specify the optional :option:`--user` parameter, you get the +command. If you specify the optional ``--user`` parameter, you get the quotas for this user in the specified project. If you omit this parameter, you get the quotas for the specified project. diff --git a/doc/admin-guide/source/shared-file-systems-security-services.rst b/doc/admin-guide/source/shared-file-systems-security-services.rst index 2aa3bf8340..ce136c512d 100644 --- a/doc/admin-guide/source/shared-file-systems-security-services.rst +++ b/doc/admin-guide/source/shared-file-systems-security-services.rst @@ -174,9 +174,9 @@ share networks: The Shared File Systems service allows you to update a security service field using :command:`manila security-service-update` command with optional -arguments such as :option:`--dns-ip`, :option:`--server`, :option:`--domain`, -:option:`--user`, :option:`--password`, :option:`--name`, or -:option:`--description`. +arguments such as ``--dns-ip``, ``--server``, ``--domain``, +``--user``, ``--password``, ``--name``, or +``--description``. To remove a security service not associated with any share networks run: diff --git a/doc/admin-guide/source/shared-file-systems-share-types.rst b/doc/admin-guide/source/shared-file-systems-share-types.rst index f01af5360e..3bf9534930 100644 --- a/doc/admin-guide/source/shared-file-systems-share-types.rst +++ b/doc/admin-guide/source/shared-file-systems-share-types.rst @@ -71,7 +71,7 @@ share type creation with extra specifications to other roles. You set a share type to private or public and :ref:`manage the access` to the private share types. By default a share type is created as publicly accessible. Set -:option:`--is_public` to ``False`` to make the share type private. +``--is_public`` to ``False`` to make the share type private. Share type operations --------------------- @@ -149,7 +149,7 @@ Create a private type: If you run :command:`manila type-list` only public share types appear. To see private share types, run :command:`manila type-list` with - :option:`--all` optional argument. + ``--all`` optional argument. Grant access to created private type for a demo and alt_demo projects by providing their IDs: diff --git a/doc/admin-guide/source/shared-file-systems-snapshots.rst b/doc/admin-guide/source/shared-file-systems-snapshots.rst index ac41569836..6aab59aa50 100644 --- a/doc/admin-guide/source/shared-file-systems-snapshots.rst +++ b/doc/admin-guide/source/shared-file-systems-snapshots.rst @@ -63,7 +63,7 @@ Check that status of a snapshot is ``available``: +-------------+--------------------------------------+ To restore your data from a snapshot, use :command:`manila create` with -key :option:`--snapshot-id`. This creates a new share from an +key ``--snapshot-id``. This creates a new share from an existing snapshot. Create a share from a snapshot and check whether it is available: diff --git a/doc/admin-guide/source/support-compute.rst b/doc/admin-guide/source/support-compute.rst index d58dbd2fab..406c2f0dd3 100644 --- a/doc/admin-guide/source/support-compute.rst +++ b/doc/admin-guide/source/support-compute.rst @@ -221,7 +221,7 @@ instance. For example: $ nova reset-state c6bbbf26-b40a-47e7-8d5c-eb17bf65c485 $ openstack server delete c6bbbf26-b40a-47e7-8d5c-eb17bf65c485 -You can also use the :option:`--active` parameter to force the instance back +You can also use the ``--active`` parameter to force the instance back to an active state instead of an error state. For example: .. code-block:: console diff --git a/doc/admin-guide/source/telemetry-data-collection.rst b/doc/admin-guide/source/telemetry-data-collection.rst index d26e138b67..47bddc2b02 100644 --- a/doc/admin-guide/source/telemetry-data-collection.rst +++ b/doc/admin-guide/source/telemetry-data-collection.rst @@ -508,11 +508,11 @@ If the sample corresponds to an existing meter, then the fields like The required fields for sending a sample using the command-line client are: -- ID of the corresponding resource. (:option:`--resource-id`) +- ID of the corresponding resource. (``--resource-id``) -- Name of meter. (:option:`--meter-name`) +- Name of meter. (``--meter-name``) -- Type of meter. (:option:`--meter-type`) +- Type of meter. (``--meter-type``) Predefined meter types: @@ -522,9 +522,9 @@ are: - Cumulative -- Unit of meter. (:option:`--meter-unit`) +- Unit of meter. (``--meter-unit``) -- Volume of sample. (:option:`--sample-volume`) +- Volume of sample. (``--sample-volume``) To send samples to Telemetry using the command-line client, the following command should be invoked: diff --git a/doc/admin-guide/source/telemetry-data-pipelines.rst b/doc/admin-guide/source/telemetry-data-pipelines.rst index ed774ab992..8f24d154f2 100644 --- a/doc/admin-guide/source/telemetry-data-pipelines.rst +++ b/doc/admin-guide/source/telemetry-data-pipelines.rst @@ -323,7 +323,7 @@ Multi meter arithmetic transformer This transformer enables us to perform arithmetic calculations over one or more meters and/or their metadata, for example: -.. code-block:: json +.. code-block:: none memory_util = 100 * memory.usage / memory diff --git a/doc/admin-guide/source/telemetry-data-retrieval.rst b/doc/admin-guide/source/telemetry-data-retrieval.rst index 38068c6b53..fbe3296309 100644 --- a/doc/admin-guide/source/telemetry-data-retrieval.rst +++ b/doc/admin-guide/source/telemetry-data-retrieval.rst @@ -201,7 +201,7 @@ in the Installation Tutorials and Guides. Similarly to other OpenStack command-line clients, the ``ceilometer`` client uses OpenStack Identity for authentication. The proper -credentials and :option:`--auth_url` parameter have to be defined via command +credentials and ``--auth_url`` parameter have to be defined via command line parameters or environment variables. This section provides some examples without the aim of completeness. @@ -350,7 +350,7 @@ complex operators, it is possible to retrieve a subset of samples for a given VM instance. To request for the first six samples for the ``cpu`` and ``disk.read.bytes`` meters, the following command should be invoked: -.. code-block:: console +.. code-block:: none $ ceilometer query-samples --filter '{"and": \ [{"=":{"resource":"bb52e52b-1e42-4751-b3ac-45c52d83ba07"}},{"or":[{"=":{"counter_name":"cpu"}}, \ @@ -414,8 +414,7 @@ retrieve specific events: .. code-block:: console - $ ceilometer event-list -q 'event_type=compute.instance.exists; \ - instance_type=m1.tiny' + $ ceilometer event-list -q 'event_type=compute.instance.exists;instance_type=m1.tiny' +--------------------------------------+-------------------------+----------------------------+----------------------------------------------------------------------------------+ | Message ID | Event Type | Generated | Traits | +--------------------------------------+-------------------------+----------------------------+----------------------------------------------------------------------------------+ diff --git a/doc/admin-guide/source/ts-cinder-config.rst b/doc/admin-guide/source/ts-cinder-config.rst index 2f220752e6..13fbfe3dfb 100644 --- a/doc/admin-guide/source/ts-cinder-config.rst +++ b/doc/admin-guide/source/ts-cinder-config.rst @@ -194,7 +194,7 @@ To fix this issue, change the content of the ``/etc/tgt/targets.conf`` file from ``include /etc/tgt/conf.d/*.conf`` to ``include /etc/tgt/conf.d/cinder_tgt.conf``, as follows: -.. code-block:: ini +.. code-block:: shell include /etc/tgt/conf.d/cinder_tgt.conf include /etc/tgt/conf.d/cinder.conf diff --git a/doc/common/cli-install-openstack-command-line-clients.rst b/doc/common/cli-install-openstack-command-line-clients.rst index ad20be63eb..a5ad76796e 100644 --- a/doc/common/cli-install-openstack-command-line-clients.rst +++ b/doc/common/cli-install-openstack-command-line-clients.rst @@ -238,7 +238,7 @@ that can be installed without ``pip``. Upgrade or remove clients ~~~~~~~~~~~~~~~~~~~~~~~~~ -To upgrade a client, add the :option:`--upgrade` option to the +To upgrade a client, add the ``--upgrade`` option to the :command:`pip install` command: .. code-block:: console diff --git a/doc/common/cli-manage-volumes.rst b/doc/common/cli-manage-volumes.rst index 6d60dc69fa..60e2e94796 100644 --- a/doc/common/cli-manage-volumes.rst +++ b/doc/common/cli-manage-volumes.rst @@ -33,9 +33,9 @@ following example: --lock-volume -In this example, :option:`--force-host-copy True` forces the generic +In this example, ``--force-host-copy True`` forces the generic host-based migration mechanism and bypasses any driver optimizations. -:option:`--lock-volume ` applies to the available volume. +``--lock-volume `` applies to the available volume. To determine whether the termination of volume migration caused by other commands. ``True`` locks the volume state and does not allow the migration to be aborted. @@ -621,17 +621,17 @@ Manage a snapshot with the :command:`openstack snapshot set` command: The arguments to be passed are: -:option:`--name ` +``--name `` New snapshot name -:option:`--description ` +``--description `` New snapshot description -:option:`--property ` +``--property `` Property to add or modify for this snapshot (repeat option to set multiple properties) -:option:`--state ` +``--state `` New snapshot state. (“available”, “error”, “creating”, “deleting”, or “error_deleting”) (admin only) (This option simply changes the state of the snapshot in the diff --git a/doc/common/cli-set-environment-variables-using-openstack-rc.rst b/doc/common/cli-set-environment-variables-using-openstack-rc.rst index 09459d47d2..d2369d4401 100644 --- a/doc/common/cli-set-environment-variables-using-openstack-rc.rst +++ b/doc/common/cli-set-environment-variables-using-openstack-rc.rst @@ -98,7 +98,7 @@ scratch, if you cannot download the file from the dashboard. lives in clear text format in the ``PROJECT-openrc.sh`` file. Restrict the permissions on this file to avoid security problems. You can also remove the ``OS_PASSWORD`` variable from the file, and - use the :option:`--password` parameter with OpenStack client commands + use the ``--password`` parameter with OpenStack client commands instead. .. note:: @@ -132,7 +132,7 @@ or command-line argument. It is not safe to specify the password using either of these methods. For example, when you specify your password using the command-line -client with the :option:`--os-password` argument, anyone with access to your +client with the ``--os-password`` argument, anyone with access to your computer can view it in plain text with the ``ps`` field. To avoid storing the password in plain text, you can prompt for the diff --git a/doc/config-reference/source/block-storage/drivers/coprhd-driver.rst b/doc/config-reference/source/block-storage/drivers/coprhd-driver.rst index 8b78ff9c25..a1e7ad7885 100644 --- a/doc/config-reference/source/block-storage/drivers/coprhd-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/coprhd-driver.rst @@ -150,7 +150,7 @@ CoprHD drivers - Single back end .. code-block:: ini [DEFAULT] - ... + # ... rpc_response_timeout = 300 #. Now, restart the ``cinder-volume`` service. diff --git a/doc/config-reference/source/block-storage/drivers/datera-volume-driver.rst b/doc/config-reference/source/block-storage/drivers/datera-volume-driver.rst index a4ae618b87..fee70af24f 100644 --- a/doc/config-reference/source/block-storage/drivers/datera-volume-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/datera-volume-driver.rst @@ -136,7 +136,7 @@ The following configuration is for 3.X Linux kernels, some parameters in different Linux distributions may be different. Make the following changes in the ``multipath.conf`` file: -.. code-block:: json +.. code-block:: none defaults { checker_timer 5 diff --git a/doc/config-reference/source/block-storage/drivers/dothill-driver.rst b/doc/config-reference/source/block-storage/drivers/dothill-driver.rst index 7d3e7c8078..bb5e437096 100644 --- a/doc/config-reference/source/block-storage/drivers/dothill-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/dothill-driver.rst @@ -139,10 +139,10 @@ Configuring the array .. code-block:: ini [DEFAULT] - ... + # ... enabled_backends = pool-a,pool-b default_volume_type = dothill - ... + # ... #. Create a new volume type for each distinct ``volume_backend_name`` value that you added to cinder.conf. The example below assumes that the same diff --git a/doc/config-reference/source/block-storage/drivers/emc-vmax-driver.rst b/doc/config-reference/source/block-storage/drivers/emc-vmax-driver.rst index 260898322b..31a073fc91 100644 --- a/doc/config-reference/source/block-storage/drivers/emc-vmax-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/emc-vmax-driver.rst @@ -381,7 +381,7 @@ attached over iSCSI or ``F`` for volumes attached over Fiber Channel. VMAX All Flash and Hybrid -.. code-block:: ini +.. code-block:: none OS-[shortHostName]-[SRP]-[SLO]-[workload]-[protocol]-MV @@ -397,7 +397,7 @@ as required. Names are of the following format. ``[protocol]`` is either ``I`` for volumes attached over iSCSI or ``F`` for volumes attached over Fiber Channel. -.. code-block:: ini +.. code-block:: none OS-[shortHostName]-[protocol]-IG @@ -424,7 +424,7 @@ or ``F`` for volumes attached over Fiber Channel. VMAX All Flash and Hybrid -.. code-block:: ini +.. code-block:: none OS-[shortHostName]-[SRP]-[SLO]-[Workload]-[protocol]-SG @@ -811,7 +811,7 @@ The multipath configuration file may be edited for better management and performance. Log in as a privileged user and make the following changes to :file:`/etc/multipath.conf` on the Compute (nova) node(s). -.. code-block:: ini +.. code-block:: none devices { # Device attributed for EMC VMAX @@ -842,7 +842,7 @@ On Ubuntu: # service open-iscsi restart # service multipath-tools restart -On On openSUSE, SUSE Linux Enterprise Server, Red Hat Enterprise Linux, and +On openSUSE, SUSE Linux Enterprise Server, Red Hat Enterprise Linux, and CentOS: .. code-block:: console diff --git a/doc/config-reference/source/block-storage/drivers/emc-vnx-driver.rst b/doc/config-reference/source/block-storage/drivers/emc-vnx-driver.rst index 7f9ebaab7f..be3f74cdc8 100644 --- a/doc/config-reference/source/block-storage/drivers/emc-vnx-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/emc-vnx-driver.rst @@ -946,8 +946,8 @@ configuration file. Following is the instruction on how to do this. .. code-block:: console - # su -l cinder -c '/opt/Navisphere/bin/naviseccli \ - -AddUserSecurity -user admin -password admin -scope 0 -secfilepath ' + # su -l cinder -c \ + '/opt/Navisphere/bin/naviseccli -AddUserSecurity -user admin -password admin -scope 0 -secfilepath ' #. Change ``cinder:x:113:120::/var/lib/cinder:/bin/bash`` back to ``cinder:x:113:120::/var/lib/cinder:/bin/false`` in ``/etc/passwd`` file. diff --git a/doc/config-reference/source/block-storage/drivers/hds-hnas-driver.rst b/doc/config-reference/source/block-storage/drivers/hds-hnas-driver.rst index 8ae4086164..c3d468bd4f 100644 --- a/doc/config-reference/source/block-storage/drivers/hds-hnas-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/hds-hnas-driver.rst @@ -298,7 +298,7 @@ For example: .. code-block:: ini [hnas-backend] - … + # ... hnas_username = supervisor hnas_password = supervisor @@ -363,7 +363,7 @@ through public key. To configure that: .. code-block:: ini [hnas-backend] - … + # ... hnas_ssh_private_key = /opt/hitachi/ssh/hnaskey Managing volumes @@ -530,7 +530,7 @@ Below are configuration examples for both NFS and iSCSI backends: #. Add the configured exports to the ``nfs_shares`` file: - .. code-block:: ini + .. code-block:: none 172.24.49.21:/gold_export 172.24.49.21:/silver_platinum diff --git a/doc/config-reference/source/block-storage/drivers/lenovo-driver.rst b/doc/config-reference/source/block-storage/drivers/lenovo-driver.rst index 51c77bae3c..8bfe3fbf98 100644 --- a/doc/config-reference/source/block-storage/drivers/lenovo-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/lenovo-driver.rst @@ -129,10 +129,9 @@ Configuring the array .. code-block:: ini [DEFAULT] - ... + # ... enabled_backends = pool-a,pool-b default_volume_type = lenovo - ... #. Create a new volume type for each distinct ``volume_backend_name`` value that you added to the ``cinder.conf`` file. The example below diff --git a/doc/config-reference/source/block-storage/drivers/nexentastor4-driver.rst b/doc/config-reference/source/block-storage/drivers/nexentastor4-driver.rst index b6c5831071..ae1dc6b551 100644 --- a/doc/config-reference/source/block-storage/drivers/nexentastor4-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/nexentastor4-driver.rst @@ -123,7 +123,7 @@ volume driver controls: Add your list of Nexenta NFS servers to the file you specified with the ``nexenta_shares_config`` option. For example, this is how this file should look: - .. code-block:: ini + .. code-block:: none 192.168.1.200:/volumes/VOLUME_NAME/NFS_SHARE http://USER:PASSWORD@192.168.1.200:8457 192.168.1.201:/volumes/VOLUME_NAME/NFS_SHARE http://USER:PASSWORD@192.168.1.201:8457 diff --git a/doc/config-reference/source/block-storage/drivers/nexentastor5-driver.rst b/doc/config-reference/source/block-storage/drivers/nexentastor5-driver.rst index 6b5c83a843..6edd0a5ef6 100644 --- a/doc/config-reference/source/block-storage/drivers/nexentastor5-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/nexentastor5-driver.rst @@ -124,7 +124,7 @@ volume driver controls: #. Create filesystem on appliance and share via NFS. For example: - .. code-block:: ini + .. code-block:: none "securityContexts": [ {"readWriteList": [{"allow": true, "etype": "fqnip", "entity": "1.1.1.1"}], @@ -133,7 +133,7 @@ volume driver controls: #. Create ACL for the filesystem. For example: - .. code-block:: ini + .. code-block:: json {"type": "allow", "principal": "everyone@", diff --git a/doc/config-reference/source/block-storage/drivers/pure-storage-driver.rst b/doc/config-reference/source/block-storage/drivers/pure-storage-driver.rst index feec944dd1..0e66ab7dfa 100644 --- a/doc/config-reference/source/block-storage/drivers/pure-storage-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/pure-storage-driver.rst @@ -293,7 +293,7 @@ environments using the driver filter and weighter methods. Metrics reported include, but are not limited to: -.. code-block:: ini +.. code-block:: none total_capacity_gb free_capacity_gb diff --git a/doc/config-reference/source/block-storage/drivers/zfssa-iscsi-driver.rst b/doc/config-reference/source/block-storage/drivers/zfssa-iscsi-driver.rst index 08da7c9ca3..86bae26de6 100644 --- a/doc/config-reference/source/block-storage/drivers/zfssa-iscsi-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/zfssa-iscsi-driver.rst @@ -103,7 +103,7 @@ Configuration Target interfaces can be seen as follows in the CLI: - .. code-block:: ini + .. code-block:: none zfssa:> configuration net interfaces zfssa:configuration net interfaces> show diff --git a/doc/config-reference/source/block-storage/drivers/zte-storage-driver.rst b/doc/config-reference/source/block-storage/drivers/zte-storage-driver.rst index 583292a66b..898122a5f9 100644 --- a/doc/config-reference/source/block-storage/drivers/zte-storage-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/zte-storage-driver.rst @@ -128,10 +128,9 @@ Configuring the array .. code-block:: ini [DEFAULT] - ... + # ... enabled_backends = pool-a,pool-b default_volume_type = zte - ... #. Create a new volume type for each distinct ``volume_backend_name`` value that you added to the ``cinder.conf`` file. The example below diff --git a/doc/config-reference/source/block-storage/samples/api-paste.ini.rst b/doc/config-reference/source/block-storage/samples/api-paste.ini.rst index 9045b5f171..289766efd1 100644 --- a/doc/config-reference/source/block-storage/samples/api-paste.ini.rst +++ b/doc/config-reference/source/block-storage/samples/api-paste.ini.rst @@ -5,6 +5,6 @@ api-paste.ini Use the ``api-paste.ini`` file to configure the Block Storage API service. -.. remote-code-block:: ini +.. remote-code-block:: none https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=stable/newton diff --git a/doc/config-reference/source/block-storage/samples/policy.json.rst b/doc/config-reference/source/block-storage/samples/policy.json.rst index b5471bff90..bf471083fb 100644 --- a/doc/config-reference/source/block-storage/samples/policy.json.rst +++ b/doc/config-reference/source/block-storage/samples/policy.json.rst @@ -5,6 +5,6 @@ policy.json The ``policy.json`` file defines additional access controls that apply to the Block Storage service. -.. remote-code-block:: ini +.. remote-code-block:: none https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=stable/newton diff --git a/doc/config-reference/source/compute/cells.rst b/doc/config-reference/source/compute/cells.rst index 783cf9c75e..c607159562 100644 --- a/doc/config-reference/source/compute/cells.rst +++ b/doc/config-reference/source/compute/cells.rst @@ -78,7 +78,7 @@ in the ``cell_type`` key: [DEFAULT] compute_api_class=nova.compute.cells_api.ComputeCellsAPI - ... + # ... [cells] cell_type= api diff --git a/doc/config-reference/source/compute/hypervisor-hyper-v.rst b/doc/config-reference/source/compute/hypervisor-hyper-v.rst index 9c4da92861..5607b5fe4e 100644 --- a/doc/config-reference/source/compute/hypervisor-hyper-v.rst +++ b/doc/config-reference/source/compute/hypervisor-hyper-v.rst @@ -66,7 +66,7 @@ http://technet.microsoft.com/en-us/library/hh831823.aspx To quickly enable an interface to be used as a Virtual Interface the following PowerShell may be used: -.. code-block:: powershell +.. code-block:: none PS C:\> $if = Get-NetIPAddress -IPAddress 192* | Get-NetIPInterface PS C:\> New-VMSwitch -NetAdapterName $if.ifAlias -Name YOUR_BRIDGE_NAME -AllowManagementOS $false @@ -84,7 +84,7 @@ To prepare the Hyper-V node to be able to attach to volumes provided by cinder you must first make sure the Windows iSCSI initiator service is running and started automatically. -.. code-block:: powershell +.. code-block:: none PS C:\> Set-Service -Name MSiSCSI -StartupType Automatic PS C:\> Start-Service MSiSCSI @@ -147,10 +147,10 @@ Additional Requirements: How to setup live migration on Hyper-V -------------------------------------- -To enable 'shared nothing live' migration, run the 3 PowerShell +To enable 'shared nothing live' migration, run the 3 instructions below on each Hyper-V host: -.. code-block:: powershell +.. code-block:: none PS C:\> Enable-VMMigration PS C:\> Set-VMMigrationNetwork IP_ADDRESS @@ -203,7 +203,7 @@ working properly on the 64bit version. http://www.python.org/ftp/python/2.7.3/python-2.7.3.msi - .. code-block:: powershell + .. code-block:: none PS C:\> $src = "http://www.python.org/ftp/python/2.7.3/python-2.7.3.msi" PS C:\> $dest = "$env:temp\python-2.7.3.msi" @@ -214,7 +214,7 @@ working properly on the 64bit version. #. Make sure that the ``Python`` and ``Python\Scripts`` paths are set up in the ``PATH`` environment variable. - .. code-block:: powershell + .. code-block:: none PS C:\> $oldPath = [System.Environment]::GetEnvironmentVariable("Path") PS C:\> $newPath = $oldPath + ";C:\python27\;C:\python27\Scripts\" @@ -249,7 +249,7 @@ The following packages must be installed with pip: * amqp * wmi -.. code-block:: powershell +.. code-block:: none PS C:\> pip install ecdsa PS C:\> pip install amqp @@ -292,7 +292,7 @@ Download the nova code run the installer and follow the prompts in the installation wizard. The default should be acceptable for the purposes of this guide. - .. code-block:: powershell + .. code-block:: none PS C:\> $src = "https://github.com/msysgit/msysgit/releases/download/Git-1.9.2-preview20140411/Git-1.9.2-preview20140411.exe" PS C:\> $dest = "$env:temp\Git-1.9.2-preview20140411.exe" @@ -302,7 +302,7 @@ Download the nova code #. Run the following to clone the nova code. - .. code-block:: powershell + .. code-block:: none PS C:\> git.exe clone https://git.openstack.org/openstack/nova @@ -311,7 +311,7 @@ Install nova-compute service To install ``nova-compute``, run: -.. code-block:: powershell +.. code-block:: none PS C:\> cd c:\nova PS C:\> python setup.py install @@ -387,7 +387,7 @@ http://technet.microsoft.com/en-us/library/cc772480.aspx Once you have successfully created a virtual machine, you can then upload the image to glance using the openstack-client: -.. code-block:: powershell +.. code-block:: none PS C:\> openstack image create --name "VM_IMAGE_NAME" --public \ --container-format bare --disk-format vhd @@ -399,7 +399,7 @@ the image to glance using the openstack-client: disk size than the internal size of the disk file. To create VHDs, use the following PowerShell cmdlet: - .. code-block:: powershell + .. code-block:: none PS C:\> New-VHD DISK_NAME.vhd -SizeBytes VHD_SIZE @@ -423,7 +423,7 @@ Run Compute with Hyper-V To start the ``nova-compute`` service, run this command from a console in the Windows server: -.. code-block:: powershell +.. code-block:: none PS C:\> C:\Python27\python.exe c:\Python27\Scripts\nova-compute --config-file c:\etc\nova\nova.conf @@ -440,12 +440,12 @@ Troubleshoot Hyper-V configuration * How do I restart the compute service? - .. code-block:: powershell + .. code-block:: none PS C:\> net stop nova-compute && net start nova-compute * How do I restart the iSCSI initiator service? - .. code-block:: powershell + .. code-block:: none PS C:\> net stop msiscsi && net start msiscsi diff --git a/doc/config-reference/source/compute/nova-conf-samples.rst b/doc/config-reference/source/compute/nova-conf-samples.rst index a0b6fb6638..fd9b13733d 100644 --- a/doc/config-reference/source/compute/nova-conf-samples.rst +++ b/doc/config-reference/source/compute/nova-conf-samples.rst @@ -44,8 +44,8 @@ This example ``nova.conf`` file is from an internal Rackspace test system. .. code-block:: ini - verbose - nodaemon + verbose=True + nodaemon=True network_manager=nova.network.manager.FlatManager image_service=nova.image.glance.GlanceImageService flat_network_bridge=xenbr0 diff --git a/doc/config-reference/source/compute/samples/api-paste.ini.rst b/doc/config-reference/source/compute/samples/api-paste.ini.rst index 3bf7ba33ad..750342cc7c 100644 --- a/doc/config-reference/source/compute/samples/api-paste.ini.rst +++ b/doc/config-reference/source/compute/samples/api-paste.ini.rst @@ -5,6 +5,6 @@ api-paste.ini The Compute service stores its API configuration settings in the ``api-paste.ini`` file. -.. remote-code-block:: ini +.. remote-code-block:: none https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini diff --git a/doc/config-reference/source/compute/schedulers.rst b/doc/config-reference/source/compute/schedulers.rst index 5e381269c3..a7ba242674 100644 --- a/doc/config-reference/source/compute/schedulers.rst +++ b/doc/config-reference/source/compute/schedulers.rst @@ -432,7 +432,7 @@ To enable scheduling instances while overcommitting disk resources on the node, adjust the value of the ``disk_allocation_ratio`` configuration option to greater than ``1.0``: -.. code-block:: ini +.. code-block:: none disk_allocation_ratio > 1.0 diff --git a/doc/config-reference/source/image/glance-api-paste.ini.rst b/doc/config-reference/source/image/glance-api-paste.ini.rst index 214bee0731..2101b3c355 100644 --- a/doc/config-reference/source/image/glance-api-paste.ini.rst +++ b/doc/config-reference/source/image/glance-api-paste.ini.rst @@ -7,6 +7,6 @@ Configuration for the Image service's API middleware pipeline is found in the You should not need to modify this file. -.. remote-code-block:: ini +.. remote-code-block:: none https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=stable/newton diff --git a/doc/config-reference/source/networking/samples/api-paste.ini.rst b/doc/config-reference/source/networking/samples/api-paste.ini.rst index 91ab80ebb4..58531c51e9 100644 --- a/doc/config-reference/source/networking/samples/api-paste.ini.rst +++ b/doc/config-reference/source/networking/samples/api-paste.ini.rst @@ -5,6 +5,6 @@ api-paste.ini The ``api-paste.ini`` file contains configuration for the web services gateway interface (WSGI). -.. remote-code-block:: ini +.. remote-code-block:: none https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=stable/newton diff --git a/doc/config-reference/source/object-storage/features.rst b/doc/config-reference/source/object-storage/features.rst index 52c915fa56..aceaa27f4a 100644 --- a/doc/config-reference/source/object-storage/features.rst +++ b/doc/config-reference/source/object-storage/features.rst @@ -383,7 +383,7 @@ production environment with many devices the impact of one device change is much less. Next, run the replicators to get everything put back into place and then rerun the dispersion report: -.. code-block:: console +.. code-block:: none # start object replicators and monitor logs until they're caught up ... $ swift-dispersion-report diff --git a/doc/config-reference/source/policy-json-file.rst b/doc/config-reference/source/policy-json-file.rst index a39f2ef62f..91268fb85a 100644 --- a/doc/config-reference/source/policy-json-file.rst +++ b/doc/config-reference/source/policy-json-file.rst @@ -46,7 +46,7 @@ Examples A simple rule might look like this: -.. code-block:: json +.. code-block:: none "compute:get_all" : "" @@ -56,7 +56,7 @@ policy allows anybody to list instances. You can also decline permission to use an API: -.. code-block:: json +.. code-block:: none "compute:shelve": "!" @@ -67,7 +67,7 @@ Many APIs can only be called by admin users. This can be expressed by the rule ``"role:admin"``. The following policy ensures that only administrators can create new users in the Identity database: -.. code-block:: json +.. code-block:: none "identity:create_user" : "role:admin" @@ -75,7 +75,7 @@ You can limit APIs to any role. For example, the Orchestration service defines a role named ``heat_stack_user``. Whoever has this role isn't allowed to create stacks: -.. code-block:: json +.. code-block:: none "stacks:create": "not role:heat_stack_user" @@ -84,7 +84,7 @@ can be built using operators ``and``, ``or`` and parentheses. You can define aliases for rules: -.. code-block:: json +.. code-block:: none "deny_stack_user": "not role:heat_stack_user" @@ -92,7 +92,7 @@ The policy engine understands that ``"deny_stack_user"`` is not an API and consequently interprets it as an alias. The stack creation policy above can then be written as: -.. code-block:: json +.. code-block:: none "stacks:create": "rule:deny_stack_user" @@ -100,7 +100,7 @@ This is taken verbatim from ``/etc/heat/policy.json``. Rules can compare API attributes to object attributes. For example: -.. code-block:: json +.. code-block:: none "os_compute_api:servers:start" : "project_id:%(project_id)s" @@ -114,7 +114,7 @@ equal, permission is granted. An admin user always has permission to call APIs. This is how ``/etc/keystone/policy.json`` makes this policy explicit: -.. code-block:: json +.. code-block:: none "admin_required": "role:admin or is_admin:1", "owner" : "user_id:%(user_id)s", @@ -138,7 +138,7 @@ owner or an admin user. As a final example, let's examine a more complex rule: -.. code-block:: json +.. code-block:: none "identity:ec2_delete_credential": "rule:admin_required or (rule:owner and user_id:%(target.credential.user_id)s)" @@ -158,7 +158,7 @@ A ``policy.json`` file consists of policies and aliases of the form ``target:rule`` or ``alias:definition``, separated by commas and enclosed in curly braces: -.. code-block:: json +.. code-block:: none { "alias 1" : "definition 1", @@ -201,7 +201,7 @@ Developers can define additional special checks. Two values are compared in the following way: -.. code-block:: json +.. code-block:: none "value1 : value2" @@ -232,7 +232,7 @@ The alias construct exists for convenience. An alias is short name for a complex or hard to understand rule. It is defined in the same way as a policy: -.. code-block:: json +.. code-block:: none alias name : alias definition @@ -247,7 +247,7 @@ syntax, where JavaScript arrays are used instead of boolean operators. For example, the EC2 credentials rule above would have been written as follows: -.. code-block:: json +.. code-block:: none "identity:ec2_delete_credential": [ [ "rule:admin_required ], [ "rule:owner", "user_id:%(target.credential.user_id)s)" ] ] diff --git a/doc/config-reference/source/shared-file-systems/drivers.rst b/doc/config-reference/source/shared-file-systems/drivers.rst index 2013fdb116..1c757b11d0 100644 --- a/doc/config-reference/source/shared-file-systems/drivers.rst +++ b/doc/config-reference/source/shared-file-systems/drivers.rst @@ -42,7 +42,7 @@ The configuration for all of them follows a common paradigm: .. code-block:: ini [Default] - ... + # ... enabled_backends = Driver1 Driver2 #. Configure a separate section for each driver using these @@ -54,11 +54,11 @@ The configuration for all of them follows a common paradigm: [Driver1] share_driver = manila.share.drivers.generic.GenericShareDriver - ... + # ... [Driver2] share_driver = manila.share.drivers.generic.GenericShareDriver - ... + # ... The share drivers are included in the `Shared File Systems repository `_. diff --git a/doc/config-reference/source/shared-file-systems/drivers/hitachi-hsp-driver.rst b/doc/config-reference/source/shared-file-systems/drivers/hitachi-hsp-driver.rst index 4025f49b99..be622b9b3e 100644 --- a/doc/config-reference/source/shared-file-systems/drivers/hitachi-hsp-driver.rst +++ b/doc/config-reference/source/shared-file-systems/drivers/hitachi-hsp-driver.rst @@ -112,10 +112,10 @@ Back end configuration .. code-block:: ini [DEFAULT] - ... + # ... enabled_share_backends = hsp1 enabled_share_protocols = NFS - ... + # ... [hsp1] share_backend_name = HITACHI1 diff --git a/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst b/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst index 68e2bf5777..1ac6a2efbf 100644 --- a/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst +++ b/doc/config-reference/source/telemetry/samples/event_definitions.yaml.rst @@ -9,6 +9,6 @@ This file provides a standard set of events and corresponding traits that may be of interest. This file can be modified to add and drop traits that operators may find useful. -.. remote-code-block:: ini +.. remote-code-block:: yaml https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=stable/newton diff --git a/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst b/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst index d2d8081682..f0454f0c73 100644 --- a/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst +++ b/doc/config-reference/source/telemetry/samples/event_pipeline.yaml.rst @@ -9,6 +9,6 @@ defined in the ``event_pipeline.yaml`` file. This file can be modified to adjust which notifications to capture and where to publish the events. -.. remote-code-block:: ini +.. remote-code-block:: yaml https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=stable/newton diff --git a/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst b/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst index 83e9eded5d..ed562d8cbc 100644 --- a/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst +++ b/doc/config-reference/source/telemetry/samples/pipeline.yaml.rst @@ -9,6 +9,6 @@ are defined in the ``pipeline.yaml`` file. This file can be modified to adjust polling intervals and the samples generated by the Telemetry module. -.. remote-code-block:: ini +.. remote-code-block:: yaml https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=stable/newton diff --git a/doc/contributor-guide/source/quickstart/first-timers.rst b/doc/contributor-guide/source/quickstart/first-timers.rst index 5c1163b18d..68658b92ab 100644 --- a/doc/contributor-guide/source/quickstart/first-timers.rst +++ b/doc/contributor-guide/source/quickstart/first-timers.rst @@ -44,7 +44,7 @@ You can configure the text editor to do that automatically. For example, in the :file:`.vimrc`: -.. code-block:: ini +.. code-block:: vim set list set listchars=tab:>-,trail:-,extends:#,nbsp:- diff --git a/doc/contributor-guide/source/rst-conv/inline-markups.rst b/doc/contributor-guide/source/rst-conv/inline-markups.rst index 6b0db82776..eb4e0a4221 100644 --- a/doc/contributor-guide/source/rst-conv/inline-markups.rst +++ b/doc/contributor-guide/source/rst-conv/inline-markups.rst @@ -19,7 +19,7 @@ To insert a semantic markup into your document, use the syntax below. **Syntax** -.. code-block:: ini +.. code-block:: rst :markup:`inline text` diff --git a/doc/contributor-guide/source/rst-conv/rst2bash.rst b/doc/contributor-guide/source/rst-conv/rst2bash.rst index 0dec290f48..835aba2e30 100644 --- a/doc/contributor-guide/source/rst-conv/rst2bash.rst +++ b/doc/contributor-guide/source/rst-conv/rst2bash.rst @@ -22,7 +22,7 @@ syntax format. * The ``code-block`` tags should be closed with ``end``. - .. code-block:: ini + .. code-block:: rst .. code-block:: console @@ -39,7 +39,7 @@ syntax format. * Example 1: Run a specific command from a given folder. - .. code-block:: ini + .. code-block:: rst .. path /usr/local/ .. code-block:: console @@ -53,7 +53,7 @@ syntax format. * Example 2: Configure a configuration file. - .. code-block:: ini + .. code-block:: none .. path /etc/keystone/keystone.conf .. code-block:: ini @@ -68,7 +68,7 @@ syntax format. * The ``only`` tags should be closed with ``endonly``. - .. code-block:: ini + .. code-block:: none .. only:: ubuntu or debian diff --git a/doc/contributor-guide/source/rst-conv/source-code.rst b/doc/contributor-guide/source/rst-conv/source-code.rst index 95586dc445..6f5c803dcb 100644 --- a/doc/contributor-guide/source/rst-conv/source-code.rst +++ b/doc/contributor-guide/source/rst-conv/source-code.rst @@ -144,7 +144,7 @@ content from a remote URL (``http`` or ``https``). **Output** -.. code-block:: ini +.. code-block:: yaml ############ # Metadata # diff --git a/doc/contributor-guide/source/vendor-drivers.rst b/doc/contributor-guide/source/vendor-drivers.rst index 9a0aeade80..0ee462c434 100644 --- a/doc/contributor-guide/source/vendor-drivers.rst +++ b/doc/contributor-guide/source/vendor-drivers.rst @@ -68,7 +68,7 @@ Each section should follow this format: * A link with detailed instructions to the vendor site (if there is one). * A default paragraph, for example: - .. code-block:: ini + .. code-block:: rst Set the following in your ``cinder.conf``, and use the following options to configure it. diff --git a/doc/ha-guide/source/controller-ha-identity.rst b/doc/ha-guide/source/controller-ha-identity.rst index d5b4b87c05..0253d2631f 100644 --- a/doc/ha-guide/source/controller-ha-identity.rst +++ b/doc/ha-guide/source/controller-ha-identity.rst @@ -114,10 +114,10 @@ Configure OpenStack Identity service [catalog] driver = keystone.catalog.backends.sql.Catalog - ... + # ... [identity] driver = keystone.identity.backends.sql.Identity - ... + # ... #. If the Identity service will be sending ceilometer notifications and your message bus is configured for high availability, you will diff --git a/doc/ha-guide/source/controller-ha-pacemaker.rst b/doc/ha-guide/source/controller-ha-pacemaker.rst index f4c61dc803..6b24b14190 100644 --- a/doc/ha-guide/source/controller-ha-pacemaker.rst +++ b/doc/ha-guide/source/controller-ha-pacemaker.rst @@ -96,7 +96,7 @@ Set up the cluster with pcs .. note:: - The :option:`-p` option is used to give the password on command + The ``-p`` option is used to give the password on command line and makes it easier to script. #. Create and name the cluster, and then start it: @@ -142,7 +142,7 @@ the Corosync package. An example Corosync configuration file is shown below: **Example Corosync configuration file for multicast (``corosync.conf``)** -.. code-block:: ini +.. code-block:: none totem { version: 2 @@ -279,7 +279,7 @@ Note the following: configuration file ``/etc/corosync/uidgid.d/pacemaker`` to be created with the following content: - .. code-block:: ini + .. code-block:: none uidgid { uid: hacluster @@ -301,7 +301,7 @@ for unicastis is shown below: **Corosync configuration file fragment for unicast (``corosync.conf``)** -.. code-block:: ini +.. code-block:: none totem { #... @@ -403,7 +403,7 @@ disk-based quorum daemon for CMAN, from advanced cluster configurations. A sample votequorum service configuration in the :file:`corosync.conf` file is: -.. code-block:: ini +.. code-block:: none quorum { provider: corosync_votequorum (1) @@ -479,7 +479,7 @@ a Systemd unit file. You can now check the ``corosync`` connectivity with one of these tools. -Use the :command:`corosync-cfgtool` utility with the :option:`-s` option +Use the :command:`corosync-cfgtool` utility with the ``-s`` option to get a summary of the health of the communication rings: .. code-block:: console diff --git a/doc/ha-guide/source/shared-database-manage.rst b/doc/ha-guide/source/shared-database-manage.rst index a7134d92cd..935cb7126c 100644 --- a/doc/ha-guide/source/shared-database-manage.rst +++ b/doc/ha-guide/source/shared-database-manage.rst @@ -208,7 +208,7 @@ use the ``clustercheck`` utility to improve health checks. #. Create a configuration file for the HAProxy monitor service, at ``/etc/xinetd.d/galera-monitor``: - .. code-block:: ini + .. code-block:: none service galera-monitor { diff --git a/doc/ha-guide/source/shared-messaging.rst b/doc/ha-guide/source/shared-messaging.rst index 418d83023b..a986809b14 100644 --- a/doc/ha-guide/source/shared-messaging.rst +++ b/doc/ha-guide/source/shared-messaging.rst @@ -83,7 +83,7 @@ For SLES 12: For SLES 12, the packages are signed by GPG key 893A90DAD85F9316. You should verify the fingerprint of the imported GPG key before using it. - .. code-block:: ini + .. code-block:: none Key ID: 893A90DAD85F9316 Key Name: Cloud:OpenStack OBS Project diff --git a/doc/ha-guide/source/storage-ha-block.rst b/doc/ha-guide/source/storage-ha-block.rst index 52566dfe89..a9000cbfa5 100644 --- a/doc/ha-guide/source/storage-ha-block.rst +++ b/doc/ha-guide/source/storage-ha-block.rst @@ -67,7 +67,7 @@ You can now add the Pacemaker configuration for Block Storage API resource. Connect to the Pacemaker cluster with the :command:`crm configure` command and add the following cluster resources: -.. code-block:: ini +.. code-block:: none primitive p_cinder-api ocf:openstack:cinder-api \ params config="/etc/cinder/cinder.conf" \ diff --git a/doc/ha-guide/source/storage-ha-file-systems.rst b/doc/ha-guide/source/storage-ha-file-systems.rst index 38c61dad4b..11e235812b 100644 --- a/doc/ha-guide/source/storage-ha-file-systems.rst +++ b/doc/ha-guide/source/storage-ha-file-systems.rst @@ -42,7 +42,7 @@ Add Shared File Systems API resource to Pacemaker #. Add the following cluster resources: - .. code-block:: ini + .. code-block:: none primitive p_manila-api ocf:openstack:manila-api \ params config="/etc/manila/manila.conf" \ diff --git a/doc/ha-guide/source/storage-ha-image.rst b/doc/ha-guide/source/storage-ha-image.rst index 06147fe463..89cf502582 100644 --- a/doc/ha-guide/source/storage-ha-image.rst +++ b/doc/ha-guide/source/storage-ha-image.rst @@ -120,9 +120,9 @@ configuration in your :file:`nova.conf` file: .. code-block:: ini [glance] - ... + # ... api_servers = 10.0.0.11 - ... + # ... You must also create the OpenStack Image API endpoint with this IP address. diff --git a/doc/image-guide/source/centos-image.rst b/doc/image-guide/source/centos-image.rst index e8f6408c0e..7b4f1385db 100644 --- a/doc/image-guide/source/centos-image.rst +++ b/doc/image-guide/source/centos-image.rst @@ -325,7 +325,7 @@ on CentOS 7.``x``, you might need to do the following steps: ``GRUB_CMDLINE_LINUX`` option. Delete the ``rhgb quiet`` and add the ``console=tty0 console=ttyS0,115200n8`` to the option: - .. code-block:: ini + .. code-block:: none ... GRUB_CMDLINE_LINUX="crashkernel=auto console=tty0 console=ttyS0,115200n8" diff --git a/doc/image-guide/source/openstack-images.rst b/doc/image-guide/source/openstack-images.rst index 6fb52f13c6..6bfa50b078 100644 --- a/doc/image-guide/source/openstack-images.rst +++ b/doc/image-guide/source/openstack-images.rst @@ -208,7 +208,7 @@ with a different user. For example, to configure ``cloud-init`` to put the key in an account named ``admin``, edit the configuration file so it has the line: -.. code-block:: ini +.. code-block:: yaml user: admin diff --git a/doc/install-guide-debconf/source/cinder-controller-install.rst b/doc/install-guide-debconf/source/cinder-controller-install.rst index 2120406131..b293585456 100644 --- a/doc/install-guide-debconf/source/cinder-controller-install.rst +++ b/doc/install-guide-debconf/source/cinder-controller-install.rst @@ -32,7 +32,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = 10.0.0.11 Configure Compute to use Block Storage diff --git a/doc/install-guide-debconf/source/cinder-storage-install.rst b/doc/install-guide-debconf/source/cinder-storage-install.rst index 593ddbc3c6..71a033dd03 100644 --- a/doc/install-guide-debconf/source/cinder-storage-install.rst +++ b/doc/install-guide-debconf/source/cinder-storage-install.rst @@ -62,7 +62,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:: bash devices { ... @@ -128,7 +128,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS .. end @@ -145,7 +145,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... glance_api_servers = http://controller:9292 .. end diff --git a/doc/install-guide-debconf/source/debconf/debconf-dbconfig-common.rst b/doc/install-guide-debconf/source/debconf/debconf-dbconfig-common.rst index e1ef2082e9..f66cd3b572 100644 --- a/doc/install-guide-debconf/source/debconf/debconf-dbconfig-common.rst +++ b/doc/install-guide-debconf/source/debconf/debconf-dbconfig-common.rst @@ -86,7 +86,7 @@ rights, and create the database for you. Since OpenStack 2014.1.1, all OpenStack packages in Debian are performing the following MySQL query after database creation (if you decide to use MySQL as a back-end): -.. code-block:: ini +.. code-block:: mysql ALTER DATABASE keystone CHARACTER SET utf8 COLLATE utf8_unicode_ci diff --git a/doc/install-guide-debconf/source/debconf/debconf-keystone-authtoken.rst b/doc/install-guide-debconf/source/debconf/debconf-keystone-authtoken.rst index de35171dd1..6b0e1c8ab5 100644 --- a/doc/install-guide-debconf/source/debconf/debconf-keystone-authtoken.rst +++ b/doc/install-guide-debconf/source/debconf/debconf-keystone-authtoken.rst @@ -43,7 +43,7 @@ The following screens show an example Image service configuration: This information is stored in the configuration file for each service. For example: -.. code-block:: ini +.. code-block:: bash /etc/ceilometer/ceilometer.conf /etc/nova/api-paste.ini diff --git a/doc/install-guide-debconf/source/keystone-install.rst b/doc/install-guide-debconf/source/keystone-install.rst index 78933d3890..34161e6b21 100644 --- a/doc/install-guide-debconf/source/keystone-install.rst +++ b/doc/install-guide-debconf/source/keystone-install.rst @@ -23,7 +23,7 @@ Install and configure the components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://keystone:KEYSTONE_DBPASS@controller/keystone If you decide to not use ``dbconfig-common``, then you have to @@ -56,7 +56,7 @@ Install and configure the components .. code-block:: ini [DEFAULT] - ... + # ... admin_token = ADMIN_TOKEN #. Create the ``admin`` project and user: diff --git a/doc/install-guide-debconf/source/neutron-controller-install-option1.rst b/doc/install-guide-debconf/source/neutron-controller-install-option1.rst index 660b80cb80..715c3dae49 100644 --- a/doc/install-guide-debconf/source/neutron-controller-install-option1.rst +++ b/doc/install-guide-debconf/source/neutron-controller-install-option1.rst @@ -38,7 +38,7 @@ Configure the server component .. code-block:: ini [DEFAULT] - ... + # ... service_plugins = * In the ``[DEFAULT]`` and ``[nova]`` sections, configure Networking to @@ -47,12 +47,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 @@ -79,7 +79,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... type_drivers = flat,vlan * In the ``[ml2]`` section, disable self-service networks: @@ -87,7 +87,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... tenant_network_types = * In the ``[ml2]`` section, enable the Linux bridge mechanism: @@ -95,7 +95,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... mechanism_drivers = linuxbridge .. warning:: @@ -108,7 +108,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... extension_drivers = port_security * In the ``[ml2_type_flat]`` section, configure the provider virtual @@ -117,7 +117,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_flat] - ... + # ... flat_networks = provider * In the ``[securitygroup]`` section, enable :term:`ipset` to increase @@ -126,7 +126,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [securitygroup] - ... + # ... enable_ipset = True Configure the Linux bridge agent @@ -163,7 +163,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 @@ -182,7 +182,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-debconf/source/neutron-controller-install-option2.rst b/doc/install-guide-debconf/source/neutron-controller-install-option2.rst index 80ec5d754e..c389b2937a 100644 --- a/doc/install-guide-debconf/source/neutron-controller-install-option2.rst +++ b/doc/install-guide-debconf/source/neutron-controller-install-option2.rst @@ -43,7 +43,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... type_drivers = flat,vlan,vxlan * In the ``[ml2]`` section, enable VXLAN self-service networks: @@ -51,7 +51,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... tenant_network_types = vxlan * In the ``[ml2]`` section, enable the Linux bridge and layer-2 population @@ -60,7 +60,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... mechanism_drivers = linuxbridge,l2population .. warning:: @@ -77,7 +77,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... extension_drivers = port_security * In the ``[ml2_type_flat]`` section, configure the provider virtual @@ -86,7 +86,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_flat] - ... + # ... flat_networks = provider * In the ``[ml2_type_vxlan]`` section, configure the VXLAN network identifier @@ -95,7 +95,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_vxlan] - ... + # ... vni_ranges = 1:1000 * In the ``[securitygroup]`` section, enable :term:`ipset` to increase @@ -104,7 +104,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [securitygroup] - ... + # ... enable_ipset = True Configure the Linux bridge agent @@ -152,7 +152,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 @@ -171,7 +171,7 @@ self-service virtual networks. .. code-block:: ini [DEFAULT] - ... + # ... interface_driver = linuxbridge external_network_bridge = @@ -195,7 +195,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-debconf/source/neutron-controller-install.rst b/doc/install-guide-debconf/source/neutron-controller-install.rst index 2bd3eaaacf..426f4823f4 100644 --- a/doc/install-guide-debconf/source/neutron-controller-install.rst +++ b/doc/install-guide-debconf/source/neutron-controller-install.rst @@ -59,7 +59,7 @@ such as credentials to instances. .. code-block:: ini [DEFAULT] - ... + # ... nova_metadata_ip = controller metadata_proxy_shared_secret = METADATA_SECRET @@ -76,7 +76,7 @@ Configure the Compute service to use the Networking service .. code-block:: ini [neutron] - ... + # ... url = http://controller:9696 auth_url = http://controller:35357 auth_type = password diff --git a/doc/install-guide-debconf/source/nova-compute-install.rst b/doc/install-guide-debconf/source/nova-compute-install.rst index 0a616cb805..ca8c7dfbf4 100644 --- a/doc/install-guide-debconf/source/nova-compute-install.rst +++ b/doc/install-guide-debconf/source/nova-compute-install.rst @@ -49,7 +49,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address @@ -62,7 +62,7 @@ Install and configure components .. code-block:: ini [vnc] - ... + # ... enabled = True vncserver_listen = 0.0.0.0 vncserver_proxyclient_address = $my_ip @@ -87,7 +87,7 @@ Install and configure components .. code-block:: ini [glance] - ... + # ... api_servers = http://controller:9292 #. Ensure the kernel module ``nbd`` is loaded. diff --git a/doc/install-guide-debconf/source/nova-controller-install.rst b/doc/install-guide-debconf/source/nova-controller-install.rst index 9bc5166f78..de847a9fea 100644 --- a/doc/install-guide-debconf/source/nova-controller-install.rst +++ b/doc/install-guide-debconf/source/nova-controller-install.rst @@ -46,7 +46,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... enabled_apis = osapi_compute,metadata * The ``.config`` and ``.postinst`` maintainer scripts of the @@ -58,7 +58,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... my_ip = 10.0.0.11 * In the ``[DEFAULT]`` section, enable support for the Networking service: @@ -66,7 +66,7 @@ Install and configure components .. code-block:: ini [DEFAULT] - ... + # ... use_neutron = True firewall_driver = nova.virt.firewall.NoopFirewallDriver @@ -84,7 +84,7 @@ Install and configure components [vnc] enabled = true - ... + # ... vncserver_listen = $my_ip vncserver_proxyclient_address = $my_ip @@ -102,7 +102,7 @@ Install and configure components .. code-block:: ini [glance] - ... + # ... api_servers = http://controller:9292 Finalize installation diff --git a/doc/install-guide/source/cinder-storage-install.rst b/doc/install-guide/source/cinder-storage-install.rst index 732c2f2fea..344f944bfb 100644 --- a/doc/install-guide/source/cinder-storage-install.rst +++ b/doc/install-guide/source/cinder-storage-install.rst @@ -364,7 +364,7 @@ Install and configure components 3. Create the ``/etc/tgt/conf.d/cinder.conf`` file with the following data: - .. code-block:: ini + .. code-block:: shell include /var/lib/cinder/volumes/* diff --git a/doc/install-guide/source/environment-networking-controller.rst b/doc/install-guide/source/environment-networking-controller.rst index 2bf5482b49..eb4cb0181e 100644 --- a/doc/install-guide/source/environment-networking-controller.rst +++ b/doc/install-guide/source/environment-networking-controller.rst @@ -24,7 +24,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 diff --git a/doc/install-guide/source/environment-ntp-controller.rst b/doc/install-guide/source/environment-ntp-controller.rst index 0a0074b866..7744660337 100644 --- a/doc/install-guide/source/environment-ntp-controller.rst +++ b/doc/install-guide/source/environment-ntp-controller.rst @@ -45,7 +45,7 @@ Install and configure components 2. Edit the ``/etc/chrony/chrony.conf`` file and add, change, or remove these keys as necessary for your environment: - .. code-block:: ini + .. code-block:: shell server NTP_SERVER iburst @@ -64,7 +64,7 @@ Install and configure components 3. To enable other nodes to connect to the chrony daemon on the controller node, add this key to the ``/etc/chrony/chrony.conf`` file: - .. code-block:: ini + .. code-block:: shell allow 10.0.0.0/24 @@ -85,7 +85,7 @@ Install and configure components 2. Edit the ``/etc/chrony.conf`` file and add, change, or remove these keys as necessary for your environment: - .. code-block:: ini + .. code-block:: shell server NTP_SERVER iburst @@ -104,7 +104,7 @@ Install and configure components 3. To enable other nodes to connect to the chrony daemon on the controller node, add this key to the ``/etc/chrony.conf`` file: - .. code-block:: ini + .. code-block:: shell allow 10.0.0.0/24 diff --git a/doc/install-guide/source/environment-ntp-other.rst b/doc/install-guide/source/environment-ntp-other.rst index 2e4d78c6fc..a2b5d255a2 100644 --- a/doc/install-guide/source/environment-ntp-other.rst +++ b/doc/install-guide/source/environment-ntp-other.rst @@ -47,7 +47,7 @@ Install and configure components but one ``server`` key. Change it to reference the controller node: .. path /etc/chrony/chrony.conf - .. code-block:: ini + .. code-block:: shell server controller iburst @@ -71,7 +71,7 @@ Install and configure components ``server`` key. Change it to reference the controller node: .. path /etc/chrony.conf - .. code-block:: ini + .. code-block:: shell server controller iburst diff --git a/doc/install-guide/source/environment-sql-database.rst b/doc/install-guide/source/environment-sql-database.rst index 29cdc5b631..25c51f0a36 100644 --- a/doc/install-guide/source/environment-sql-database.rst +++ b/doc/install-guide/source/environment-sql-database.rst @@ -70,7 +70,7 @@ Install and configure components bind-address = 10.0.0.11 default-storage-engine = innodb - innodb_file_per_table + innodb_file_per_table = on max_connections = 4096 collation-server = utf8_general_ci character-set-server = utf8 @@ -96,7 +96,7 @@ Install and configure components bind-address = 10.0.0.11 default-storage-engine = innodb - innodb_file_per_table + innodb_file_per_table = on max_connections = 4096 collation-server = utf8_general_ci character-set-server = utf8 @@ -122,7 +122,7 @@ Install and configure components bind-address = 10.0.0.11 default-storage-engine = innodb - innodb_file_per_table + innodb_file_per_table = on max_connections = 4096 collation-server = utf8_general_ci character-set-server = utf8 diff --git a/doc/install-guide/source/glance-install.rst b/doc/install-guide/source/glance-install.rst index 56a8f31c69..ea6fd5cea4 100644 --- a/doc/install-guide/source/glance-install.rst +++ b/doc/install-guide/source/glance-install.rst @@ -217,7 +217,7 @@ Install and configure components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://glance:GLANCE_DBPASS@controller/glance .. end @@ -232,7 +232,7 @@ Install and configure components .. code-block:: ini [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -244,7 +244,7 @@ Install and configure components password = GLANCE_PASS [paste_deploy] - ... + # ... flavor = keystone .. end @@ -264,7 +264,7 @@ Install and configure components .. code-block:: ini [glance_store] - ... + # ... stores = file,http default_store = file filesystem_store_datadir = /var/lib/glance/images/ @@ -280,7 +280,7 @@ Install and configure components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://glance:GLANCE_DBPASS@controller/glance .. end @@ -295,7 +295,7 @@ Install and configure components .. code-block:: ini [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -307,7 +307,7 @@ Install and configure components password = GLANCE_PASS [paste_deploy] - ... + # ... flavor = keystone .. end diff --git a/doc/install-guide/source/horizon-install.rst b/doc/install-guide/source/horizon-install.rst index 2b571b0a61..3aafaef7a5 100644 --- a/doc/install-guide/source/horizon-install.rst +++ b/doc/install-guide/source/horizon-install.rst @@ -107,7 +107,7 @@ Install and configure components ``controller`` node: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_HOST = "controller" @@ -116,7 +116,7 @@ Install and configure components * Allow all hosts to access the dashboard: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python ALLOWED_HOSTS = ['*', ] @@ -125,7 +125,7 @@ Install and configure components * Configure the ``memcached`` session storage service: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python SESSION_ENGINE = 'django.contrib.sessions.backends.cache' @@ -145,7 +145,7 @@ Install and configure components * Enable the Identity API version 3: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST @@ -154,7 +154,7 @@ Install and configure components * Enable support for domains: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = True @@ -163,7 +163,7 @@ Install and configure components * Configure API versions: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_API_VERSIONS = { "identity": 3, @@ -177,7 +177,7 @@ Install and configure components via the dashboard: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = "default" @@ -187,7 +187,7 @@ Install and configure components users that you create via the dashboard: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user" @@ -197,7 +197,7 @@ Install and configure components networking services: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_NEUTRON_NETWORK = { ... @@ -216,7 +216,7 @@ Install and configure components * Optionally, configure the time zone: .. path /srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py - .. code-block:: ini + .. code-block:: python TIME_ZONE = "TIME_ZONE" @@ -238,7 +238,7 @@ Install and configure components ``controller`` node: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_HOST = "controller" @@ -247,7 +247,7 @@ Install and configure components * Allow all hosts to access the dashboard: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python ALLOWED_HOSTS = ['*', ] @@ -256,7 +256,7 @@ Install and configure components * Configure the ``memcached`` session storage service: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python SESSION_ENGINE = 'django.contrib.sessions.backends.cache' @@ -276,7 +276,7 @@ Install and configure components * Enable the Identity API version 3: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST @@ -285,7 +285,7 @@ Install and configure components * Enable support for domains: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = True @@ -294,7 +294,7 @@ Install and configure components * Configure API versions: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_API_VERSIONS = { "identity": 3, @@ -308,7 +308,7 @@ Install and configure components via the dashboard: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = "default" @@ -318,7 +318,7 @@ Install and configure components users that you create via the dashboard: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user" @@ -328,7 +328,7 @@ Install and configure components networking services: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python OPENSTACK_NEUTRON_NETWORK = { ... @@ -347,7 +347,7 @@ Install and configure components * Optionally, configure the time zone: .. path /etc/openstack-dashboard/local_settings - .. code-block:: ini + .. code-block:: python TIME_ZONE = "TIME_ZONE" @@ -369,7 +369,7 @@ Install and configure components ``controller`` node: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_HOST = "controller" @@ -378,7 +378,7 @@ Install and configure components * Allow all hosts to access the dashboard: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python ALLOWED_HOSTS = ['*', ] @@ -387,7 +387,7 @@ Install and configure components * Configure the ``memcached`` session storage service: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python SESSION_ENGINE = 'django.contrib.sessions.backends.cache' @@ -407,7 +407,7 @@ Install and configure components * Enable the Identity API version 3: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST @@ -416,7 +416,7 @@ Install and configure components * Enable support for domains: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = True @@ -425,7 +425,7 @@ Install and configure components * Configure API versions: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_API_VERSIONS = { "identity": 3, @@ -439,7 +439,7 @@ Install and configure components via the dashboard: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = "default" @@ -449,7 +449,7 @@ Install and configure components users that you create via the dashboard: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user" @@ -459,7 +459,7 @@ Install and configure components networking services: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python OPENSTACK_NEUTRON_NETWORK = { ... @@ -479,7 +479,7 @@ Install and configure components * Optionally, configure the time zone: .. path /etc/openstack-dashboard/local_settings.py - .. code-block:: ini + .. code-block:: python TIME_ZONE = "TIME_ZONE" diff --git a/doc/install-guide/source/keystone-install.rst b/doc/install-guide/source/keystone-install.rst index 381495f475..20bc98f33d 100644 --- a/doc/install-guide/source/keystone-install.rst +++ b/doc/install-guide/source/keystone-install.rst @@ -118,7 +118,7 @@ Install and configure components .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://keystone:KEYSTONE_DBPASS@controller/keystone .. end @@ -131,7 +131,7 @@ Install and configure components .. code-block:: ini [token] - ... + # ... provider = fernet .. end @@ -228,7 +228,7 @@ Configure the Apache HTTP server ``APACHE_SERVERNAME`` option to reference the controller node: .. path /etc/sysconfig/apache2 - .. code-block:: apache + .. code-block:: shell APACHE_SERVERNAME="controller" diff --git a/doc/install-guide/source/neutron-compute-install-option1.rst b/doc/install-guide/source/neutron-compute-install-option1.rst index 5d7a906d52..c27b0d9a64 100644 --- a/doc/install-guide/source/neutron-compute-install-option1.rst +++ b/doc/install-guide/source/neutron-compute-install-option1.rst @@ -44,7 +44,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 diff --git a/doc/install-guide/source/neutron-compute-install-option2.rst b/doc/install-guide/source/neutron-compute-install-option2.rst index 9704f2bb26..e46a227842 100644 --- a/doc/install-guide/source/neutron-compute-install-option2.rst +++ b/doc/install-guide/source/neutron-compute-install-option2.rst @@ -55,7 +55,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 diff --git a/doc/install-guide/source/neutron-compute-install.rst b/doc/install-guide/source/neutron-compute-install.rst index fca714aae5..7b75e6efff 100644 --- a/doc/install-guide/source/neutron-compute-install.rst +++ b/doc/install-guide/source/neutron-compute-install.rst @@ -69,7 +69,7 @@ authentication mechanism, message queue, and plug-in. .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -84,11 +84,11 @@ authentication mechanism, message queue, and plug-in. .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -117,7 +117,7 @@ authentication mechanism, message queue, and plug-in. .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/neutron/tmp .. end @@ -151,7 +151,7 @@ Configure the Compute service to use the Networking service .. code-block:: ini [neutron] - ... + # ... url = http://controller:9696 auth_url = http://controller:35357 auth_type = password diff --git a/doc/install-guide/source/neutron-controller-install-option1.rst b/doc/install-guide/source/neutron-controller-install-option1.rst index e64c150f57..0f7d8756e1 100644 --- a/doc/install-guide/source/neutron-controller-install-option1.rst +++ b/doc/install-guide/source/neutron-controller-install-option1.rst @@ -63,7 +63,7 @@ and plug-in. .. code-block:: ini [database] - ... + # ... connection = mysql+pymysql://neutron:NEUTRON_DBPASS@controller/neutron .. end @@ -83,7 +83,7 @@ and plug-in. .. code-block:: ini [DEFAULT] - ... + # ... core_plugin = ml2 service_plugins = @@ -96,7 +96,7 @@ and plug-in. .. code-block:: ini [DEFAULT] - ... + # ... transport_url = rabbit://openstack:RABBIT_PASS@controller .. end @@ -111,11 +111,11 @@ and plug-in. .. code-block:: ini [DEFAULT] - ... + # ... auth_strategy = keystone [keystone_authtoken] - ... + # ... auth_uri = http://controller:5000 auth_url = http://controller:35357 memcached_servers = controller:11211 @@ -143,12 +143,12 @@ and plug-in. .. 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 @@ -171,7 +171,7 @@ and plug-in. .. code-block:: ini [oslo_concurrency] - ... + # ... lock_path = /var/lib/neutron/tmp .. end @@ -191,7 +191,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... type_drivers = flat,vlan .. end @@ -202,7 +202,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... tenant_network_types = .. end @@ -213,7 +213,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... mechanism_drivers = linuxbridge .. end @@ -229,7 +229,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2] - ... + # ... extension_drivers = port_security .. end @@ -241,7 +241,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [ml2_type_flat] - ... + # ... flat_networks = provider .. end @@ -253,7 +253,7 @@ and switching) virtual networking infrastructure for instances. .. code-block:: ini [securitygroup] - ... + # ... enable_ipset = True .. end @@ -299,7 +299,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 @@ -321,7 +321,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/neutron-controller-install.rst b/doc/install-guide/source/neutron-controller-install.rst index 93068b94cf..d49eff5821 100644 --- a/doc/install-guide/source/neutron-controller-install.rst +++ b/doc/install-guide/source/neutron-controller-install.rst @@ -218,7 +218,7 @@ such as credentials to instances. .. code-block:: ini [DEFAULT] - ... + # ... nova_metadata_ip = controller metadata_proxy_shared_secret = METADATA_SECRET @@ -238,7 +238,7 @@ Configure the Compute service to use the Networking service .. code-block:: ini [neutron] - ... + # ... url = http://controller:9696 auth_url = http://controller:35357 auth_type = password diff --git a/doc/install-guide/source/shared/edit_hosts_file.txt b/doc/install-guide/source/shared/edit_hosts_file.txt index fe9b410bfe..86ae2ba936 100644 --- a/doc/install-guide/source/shared/edit_hosts_file.txt +++ b/doc/install-guide/source/shared/edit_hosts_file.txt @@ -1,7 +1,7 @@ Edit the ``/etc/hosts`` file to contain the following: .. path /etc/hosts -.. code-block:: ini +.. code-block:: none # controller 10.0.0.11 controller diff --git a/doc/networking-guide/source/config-dvr-ha-snat.rst b/doc/networking-guide/source/config-dvr-ha-snat.rst index 842058bd7d..4009ad5793 100644 --- a/doc/networking-guide/source/config-dvr-ha-snat.rst +++ b/doc/networking-guide/source/config-dvr-ha-snat.rst @@ -56,7 +56,7 @@ Controller node configuration When the ``router_distributed = True`` flag is configured, routers created by all users are distributed. Without it, only privileged users can create - distributed routers by using :option:`--distributed True`. + distributed routers by using ``--distributed True``. Similarly, when the ``l3_ha = True`` flag is configured, routers created by all users default to HA. diff --git a/doc/networking-guide/source/config-qos.rst b/doc/networking-guide/source/config-qos.rst index 63f03fdabc..0d03075d78 100644 --- a/doc/networking-guide/source/config-qos.rst +++ b/doc/networking-guide/source/config-qos.rst @@ -64,7 +64,7 @@ On network nodes: #. Add the QoS service to the ``service_plugins`` setting in ``/etc/neutron/neutron.conf``. For example: - .. code-block:: ini + .. code-block:: none service_plugins = \ neutron.services.l3_router.l3_router_plugin.L3RouterPlugin, @@ -115,7 +115,7 @@ your cloud, neutron's file ``policy.json`` can be modified to allow this. Modify ``/etc/neutron/policy.json`` policy entries as follows: -.. code-block:: json +.. code-block:: none "get_policy": "rule:regular_user", "create_policy": "rule:regular_user", @@ -124,7 +124,7 @@ Modify ``/etc/neutron/policy.json`` policy entries as follows: To enable bandwidth limit rule: -.. code-block:: json +.. code-block:: none "get_policy_bandwidth_limit_rule": "rule:regular_user", "create_policy_bandwidth_limit_rule": "rule:admin_only", @@ -134,7 +134,7 @@ To enable bandwidth limit rule: To enable DSCP marking rule: -.. code-block:: json +.. code-block:: none "get_policy_dscp_marking_rule": "rule:regular_user", "create_dscp_marking_rule": "rule:admin_only", diff --git a/doc/networking-guide/source/config-routed-networks.rst b/doc/networking-guide/source/config-routed-networks.rst index 2f79d6a397..835304978e 100644 --- a/doc/networking-guide/source/config-routed-networks.rst +++ b/doc/networking-guide/source/config-routed-networks.rst @@ -156,7 +156,7 @@ Controller node .. code-block:: ini [DEFAULT] - ... + # ... service_plugins = ..., segments #. Restart the ``neutron-server`` service. diff --git a/doc/networking-guide/source/config-sriov.rst b/doc/networking-guide/source/config-sriov.rst index 5d0f309abc..5eb78cf84d 100644 --- a/doc/networking-guide/source/config-sriov.rst +++ b/doc/networking-guide/source/config-sriov.rst @@ -244,7 +244,7 @@ Configure neutron-server (Controller) service. Edit the appropriate initialization script to configure the ``neutron-server`` service to load the SR-IOV configuration file: - .. code-block:: ini + .. code-block:: bash --config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugin.ini @@ -412,7 +412,7 @@ you must: If ``ebrctl`` does not appear in any of the rootwrap files, add this to the ``/etc/nova/rootwrap.d/compute.filters`` file in the ``[Filters]`` section. - .. code-block:: ini + .. code-block:: none [Filters] ebrctl: CommandFilter, ebrctl, root diff --git a/doc/networking-guide/source/config-subnet-pools.rst b/doc/networking-guide/source/config-subnet-pools.rst index b471867983..4b26bf822d 100644 --- a/doc/networking-guide/source/config-subnet-pools.rst +++ b/doc/networking-guide/source/config-subnet-pools.rst @@ -103,8 +103,8 @@ address family can be marked default. $ openstack subnet pool set --default 74348864-f8bf-4fc0-ab03-81229d189467 If there is a default, it can be requested by passing -:option:`--use-default-subnetpool` instead of -:option:`--subnet-pool SUBNETPOOL`. +``--use-default-subnetpool`` instead of +``--subnet-pool SUBNETPOOL``. Demo ---- @@ -144,7 +144,7 @@ First, as admin, create a shared subnet pool: +-------------------+--------------------------------+ The ``default_prefix_length`` defines the subnet size you will get -if you do not specify :option:`--prefix-length` when creating a subnet. +if you do not specify ``--prefix-length`` when creating a subnet. Do essentially the same thing for IPv6 and there are now two subnet pools. Regular projects can see them. (the output is trimmed a bit diff --git a/doc/networking-guide/source/config-trunking.rst b/doc/networking-guide/source/config-trunking.rst index ce1364ae82..127baf79c8 100644 --- a/doc/networking-guide/source/config-trunking.rst +++ b/doc/networking-guide/source/config-trunking.rst @@ -114,7 +114,7 @@ Create the trunk | network_id | 1b47d3e7-cda5-48e4-b0c8-d20bd7e35f55 | +-------------------+------------------------------------------------------------------------+ -* Create the trunk using :option:`--parent-port` to reference the port from +* Create the trunk using ``--parent-port`` to reference the port from the previous step: .. code-block:: console diff --git a/doc/networking-guide/source/fwaas-v1-scenario.rst b/doc/networking-guide/source/fwaas-v1-scenario.rst index 0699ac3b4c..03cca91097 100644 --- a/doc/networking-guide/source/fwaas-v1-scenario.rst +++ b/doc/networking-guide/source/fwaas-v1-scenario.rst @@ -11,14 +11,13 @@ FWaaS management options are also available in the Dashboard. .. code-block:: ini service_plugins = firewall + [service_providers] - ... - service_provider = FIREWALL:Iptables:neutron.agent.linux.iptables_ - firewall.OVSHybridIptablesFirewallDriver:default + # ... + service_provider = FIREWALL:Iptables:neutron.agent.linux.iptables_firewall.OVSHybridIptablesFirewallDriver:default [fwaas] - driver = neutron_fwaas.services.firewall.drivers.linux.iptables_ - fwaas.IptablesFwaasDriver + driver = neutron_fwaas.services.firewall.drivers.linux.iptables_fwaas.IptablesFwaasDriver enabled = True .. note:: @@ -56,12 +55,12 @@ FWaaS management options are also available in the Dashboard. #. Enable the option in the ``local_settings.py`` file, which is typically located on the controller node: - .. code-block:: ini + .. code-block:: python OPENSTACK_NEUTRON_NETWORK = { - ... + # ... 'enable_firewall' = True, - ... + # ... } .. note:: diff --git a/doc/networking-guide/source/fwaas-v2-scenario.rst b/doc/networking-guide/source/fwaas-v2-scenario.rst index ba905739da..1a72057b21 100644 --- a/doc/networking-guide/source/fwaas-v2-scenario.rst +++ b/doc/networking-guide/source/fwaas-v2-scenario.rst @@ -9,14 +9,13 @@ Enable FWaaS v2 .. code-block:: ini service_plugins = firewall_v2 + [service_providers] - ... - service_provider = FIREWALL:Iptables:neutron.agent.linux.iptables_ - firewall.OVSHybridIptablesFirewallDriver:default + # ... + service_provider = FIREWALL:Iptables:neutron.agent.linux.iptables_firewall.OVSHybridIptablesFirewallDriver:default [fwaas] - driver = neutron_fwaas.services.firewall.drivers.linux.iptables_ - fwaas_v2.IptablesFwaasDriver + driver = neutron_fwaas.services.firewall.drivers.linux.iptables_fwaas_v2.IptablesFwaasDriver enabled = True .. note:: @@ -54,12 +53,12 @@ Enable FWaaS v2 #. Enable the option in the ``local_settings.py`` file, which is typically located on the controller node: - .. code-block:: ini + .. code-block:: python OPENSTACK_NEUTRON_NETWORK = { - ... + # ... 'enable_firewall' = True, - ... + # ... } .. note:: diff --git a/doc/networking-guide/source/migration-database.rst b/doc/networking-guide/source/migration-database.rst index c90d8e52c3..a1422a4af6 100644 --- a/doc/networking-guide/source/migration-database.rst +++ b/doc/networking-guide/source/migration-database.rst @@ -28,7 +28,7 @@ Database management command-line tool ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The database management command-line tool is called -:command:`neutron-db-manage`. Pass the :option:`--help` option to the tool for +:command:`neutron-db-manage`. Pass the ``--help`` option to the tool for usage information. The tool takes some options followed by some commands: @@ -46,10 +46,10 @@ If the configuration is in a different location, use the following command: $ neutron-db-manage --config-file /path/to/neutron.conf -Multiple :option:`--config-file` options can be passed if needed. +Multiple ``--config-file`` options can be passed if needed. Instead of reading the DB connection from the configuration file(s), you can -use the :option:`--database-connection` option: +use the ``--database-connection`` option: .. code-block:: console @@ -57,7 +57,7 @@ use the :option:`--database-connection` option: mysql+pymysql://root:secret@127.0.0.1/neutron?charset=utf8 The `branches`, `current`, and `history` commands all accept a -:option:`--verbose` option, which, when passed, will instruct +``--verbose`` option, which, when passed, will instruct :command:`neutron-db-manage` to display more verbose output for the specified command: diff --git a/doc/networking-guide/source/shared/deploy-config-neutron-common.txt b/doc/networking-guide/source/shared/deploy-config-neutron-common.txt index 3a51870d13..3cd74d87e8 100644 --- a/doc/networking-guide/source/shared/deploy-config-neutron-common.txt +++ b/doc/networking-guide/source/shared/deploy-config-neutron-common.txt @@ -5,16 +5,16 @@ auth_strategy = keystone [database] - ... + # ... [keystone_authtoken] - ... + # ... [nova] - ... + # ... [agent] - ... + # ... See the `Installation Tutorials and Guides `_ and `Configuration Reference `_ for your OpenStack diff --git a/doc/ops-guide/source/app-crypt.rst b/doc/ops-guide/source/app-crypt.rst index a3932a0760..35480419d1 100644 --- a/doc/ops-guide/source/app-crypt.rst +++ b/doc/ops-guide/source/app-crypt.rst @@ -73,7 +73,7 @@ multi-node, non-multi-host setup. One cloud controller acted as a gateway to all compute nodes. VlanManager was used for the network config. This means that the cloud controller and all compute nodes had a different VLAN for each OpenStack -project. We used the :option:`-s` option of ``ping`` to change the packet +project. We used the ``-s`` option of ``ping`` to change the packet size. We watched as sometimes packets would fully return, sometimes they'd only make it out and never back in, and sometimes the packets would stop at a random point. We changed ``tcpdump`` to start displaying the hex dump of diff --git a/doc/ops-guide/source/ops-customize-objectstorage.rst b/doc/ops-guide/source/ops-customize-objectstorage.rst index a6e8f28b13..4963c663d1 100644 --- a/doc/ops-guide/source/ops-customize-objectstorage.rst +++ b/doc/ops-guide/source/ops-customize-objectstorage.rst @@ -262,7 +262,7 @@ directory in the ``shell`` screen and edit your middleware module. #. Among the log statements you'll see the lines: - .. code-block:: ini + .. code-block:: none proxy-server Remote IP: my.instance.ip.address (txn: ...) proxy-server Allow IPs: set(['my.instance.ip.address']) (txn: ...) diff --git a/doc/ops-guide/source/ops-lay-of-the-land.rst b/doc/ops-guide/source/ops-lay-of-the-land.rst index 787e9ae646..e04742691c 100644 --- a/doc/ops-guide/source/ops-lay-of-the-land.rst +++ b/doc/ops-guide/source/ops-lay-of-the-land.rst @@ -185,7 +185,7 @@ Inspecting API Calls -------------------- The command-line tools can be made to show the OpenStack API calls they -make by passing the :option:`--debug` flag to them. For example: +make by passing the ``--debug`` flag to them. For example: .. code-block:: console diff --git a/doc/ops-guide/source/ops-logging-rsyslog.rst b/doc/ops-guide/source/ops-logging-rsyslog.rst index 5b5d0add36..13cc50ef33 100644 --- a/doc/ops-guide/source/ops-logging-rsyslog.rst +++ b/doc/ops-guide/source/ops-logging-rsyslog.rst @@ -48,7 +48,7 @@ By default, Object Storage logs to syslog. Next, create ``/etc/rsyslog.d/client.conf`` with the following line: -.. code-block:: ini +.. code-block:: none *.* @192.168.1.10 @@ -62,7 +62,7 @@ Designate a server as the central logging server. The best practice is to choose a server that is solely dedicated to this purpose. Create a file called ``/etc/rsyslog.d/server.conf`` with the following contents: -.. code-block:: ini +.. code-block:: none # Enable UDP $ModLoad imudp diff --git a/doc/ops-guide/source/ops-maintenance-compute.rst b/doc/ops-guide/source/ops-maintenance-compute.rst index 8ad15c2948..529cd15647 100644 --- a/doc/ops-guide/source/ops-maintenance-compute.rst +++ b/doc/ops-guide/source/ops-maintenance-compute.rst @@ -445,7 +445,7 @@ using neutron ports which contain the IPv4 & IPv6 address. --device_id "" --device_owner "" --binding:host_id "" #. Delete the instance and create a new instance using the - :option:`--nic port-id` option. + ``--nic port-id`` option. **Retrieve an IP address when an instance is deleted before detaching a port** diff --git a/doc/ops-guide/source/ops-monitoring.rst b/doc/ops-guide/source/ops-monitoring.rst index be16dfa2f9..e14e7aa365 100644 --- a/doc/ops-guide/source/ops-monitoring.rst +++ b/doc/ops-guide/source/ops-monitoring.rst @@ -334,7 +334,7 @@ You can create automated alerts for critical processes by using Nagios and NRPE. For example, to ensure that the ``nova-compute`` process is running on the compute nodes, create an alert on your Nagios server: -.. code-block:: ini +.. code-block:: none define service { host_name c01.example.com @@ -358,7 +358,7 @@ all times. For resource alerting, for example, monitor disk capacity on a compute node with Nagios, add the following to your Nagios configuration: -.. code-block:: ini +.. code-block:: none define service { host_name c01.example.com @@ -370,7 +370,7 @@ with Nagios, add the following to your Nagios configuration: On the compute node, add the following to your NRPE configuration: -.. code-block:: ini +.. code-block:: none command[check_all_disks]=/usr/lib/nagios/plugins/check_disk -w $ARG1$ -c $ARG2$ -e diff --git a/doc/ops-guide/source/ops-projects.rst b/doc/ops-guide/source/ops-projects.rst index 1a5c16d19f..88f895eb4f 100644 --- a/doc/ops-guide/source/ops-projects.rst +++ b/doc/ops-guide/source/ops-projects.rst @@ -38,9 +38,9 @@ command line client. # openstack project create demo --domain default This command creates a project named ``demo``. Optionally, you can add a -description string by appending :option:`--description PROJECT_DESCRIPTION`, +description string by appending ``--description PROJECT_DESCRIPTION``, which can be very useful. You can also -create a project in a disabled state by appending :option:`--disable` to the +create a project in a disabled state by appending ``--disable`` to the command. By default, projects are created in an enabled state. diff --git a/doc/ops-guide/source/ops-user-facing-operations.rst b/doc/ops-guide/source/ops-user-facing-operations.rst index e57d60a5e3..fca4f28e05 100644 --- a/doc/ops-guide/source/ops-user-facing-operations.rst +++ b/doc/ops-guide/source/ops-user-facing-operations.rst @@ -34,7 +34,7 @@ and used for testing purposes. To add this image, simply do: --disk-format qcow2 "cirros image" The :command:`openstack image create` command provides a large set of options -for working with your image. For example, the :option:`--min-disk` option is +for working with your image. For example, the ``--min-disk`` option is useful for images that require root disks of a certain size (for example, large Windows images). To view these options, run: @@ -42,12 +42,12 @@ large Windows images). To view these options, run: $ openstack help image create -The :option:`location` option is important to note. It does not copy the +The ``location`` option is important to note. It does not copy the entire image into the Image service, but references an original location where the image can be found. Upon launching an instance of that image, the Image service accesses the image from the location specified. -The :option:`copy-from` option copies the image from the location specified +The ``copy-from`` option copies the image from the location specified into the ``/var/lib/glance/images`` directory. The same thing is done when using the STDIN redirection with <, as shown in the example. @@ -125,7 +125,7 @@ signed images: #. Create context - .. code-block:: python + .. code-block:: console $ python >>> from keystoneclient.v3 import client @@ -727,7 +727,7 @@ rules to allow each new member of the cluster. The code is similar to the above example of :command:`openstack security group rule create`. To use RemoteGroup, specify -:option:`--remote-group` instead of :option:`--remote-ip`. +``--remote-group`` instead of ``--remote-ip``. For example: .. code-block:: console @@ -1771,7 +1771,7 @@ Use this command to register an existing key with OpenStack: You must have the matching private key to access instances associated with this key. -To associate a key with an instance on boot, add :option:`--key-name mykey` to +To associate a key with an instance on boot, add ``--key-name mykey`` to your command line. For example: .. code-block:: console @@ -1781,7 +1781,7 @@ your command line. For example: When booting a server, you can also add arbitrary metadata so that you can more easily identify it among other running instances. Use the -:option:`--property` option with a key-value pair, where you can make up +``--property`` option with a key-value pair, where you can make up the string for both the key and the value. For example, you could add a description and also the creator of the server: @@ -1844,7 +1844,7 @@ user data. This user data can be put in a file on your local system and then passed in at instance creation with the flag -:option:`--user-data` ````. +``--user-data ``. For example @@ -1862,7 +1862,7 @@ File injection -------------- Arbitrary local files can also be placed into the instance file system -at creation time by using the :option:`--file` ```` option. +at creation time by using the ``--file `` option. You may store up to five files. For example, let's say you have a special ``authorized_keys`` file named diff --git a/doc/ops-guide/source/ops-users.rst b/doc/ops-guide/source/ops-users.rst index d398b67d72..2d63ec0d79 100644 --- a/doc/ops-guide/source/ops-users.rst +++ b/doc/ops-guide/source/ops-users.rst @@ -176,7 +176,7 @@ Generic rules Here are snippets of the default nova ``policy.json`` file: -.. code-block:: json +.. code-block:: none { "context_is_admin": [["role:admin"]], diff --git a/doc/user-guide/source/cli-nova-launch-instance-from-image.rst b/doc/user-guide/source/cli-nova-launch-instance-from-image.rst index 1990630e57..8dbcb3d57b 100644 --- a/doc/user-guide/source/cli-nova-launch-instance-from-image.rst +++ b/doc/user-guide/source/cli-nova-launch-instance-from-image.rst @@ -99,7 +99,7 @@ Follow the steps below to launch an instance from an image. option. You can store up to five files. For example, if you have a special authorized keys file named ``special_authorized_keysfile`` that you want to put on the instance rather than using the regular SSH key - injection, you can use the :option:`--file` option as shown in the following + injection, you can use the ``--file`` option as shown in the following example. .. code-block:: console diff --git a/doc/user-guide/source/cli-reboot-an-instance.rst b/doc/user-guide/source/cli-reboot-an-instance.rst index d475504f02..6dff9567cb 100644 --- a/doc/user-guide/source/cli-reboot-an-instance.rst +++ b/doc/user-guide/source/cli-reboot-an-instance.rst @@ -12,7 +12,7 @@ By default, when you reboot an instance, it is a soft reboot. $ openstack server reboot SERVER -To perform a hard reboot, pass the :option:`--hard` parameter, as follows: +To perform a hard reboot, pass the ``--hard`` parameter, as follows: .. code-block:: console @@ -68,7 +68,7 @@ command: $ openstack server unrescue SERVER If you want to rescue an instance with a specific image, rather than the -default one, use the :option:`--rescue_image_ref` parameter: +default one, use the ``--rescue_image_ref`` parameter: .. code-block:: console diff --git a/doc/user-guide/source/cli-search-instance-with-ip-address.rst b/doc/user-guide/source/cli-search-instance-with-ip-address.rst index 40cb155d95..7d475cdb67 100644 --- a/doc/user-guide/source/cli-search-instance-with-ip-address.rst +++ b/doc/user-guide/source/cli-search-instance-with-ip-address.rst @@ -2,7 +2,7 @@ Search for an instance using IP address ======================================= -You can search for an instance using the IP address parameter, :option:`--ip`, +You can search for an instance using the IP address parameter, ``--ip``, with the :command:`openstack server list` command. .. code-block:: console diff --git a/doc/user-guide/source/cli-swift-manage-access-swift.rst b/doc/user-guide/source/cli-swift-manage-access-swift.rst index 056d571160..294de88bac 100644 --- a/doc/user-guide/source/cli-swift-manage-access-swift.rst +++ b/doc/user-guide/source/cli-swift-manage-access-swift.rst @@ -9,8 +9,8 @@ Manage access ``X-Container-Read`` and ``X-Container-Write`` headers. To give a user read access, use the :command:`swift post` command with the - :option:`-r` parameter. To give a user write access, use the - :option:`-w` parameter. + ``-r`` parameter. To give a user write access, use the + ``-w`` parameter. - The following are examples of `read` ACLs for containers: diff --git a/doc/user-guide/source/manage-db-config.rst b/doc/user-guide/source/manage-db-config.rst index cd40b9701c..d9f4711d92 100644 --- a/doc/user-guide/source/manage-db-config.rst +++ b/doc/user-guide/source/manage-db-config.rst @@ -108,7 +108,7 @@ Bulk-configure a database or databases .. code-block:: json - {"myFirstKey" : "someString", "mySecondKey" : someInt} + {"myFirstKey" : "someString", "mySecondKey" : 1} This example creates a configuration group called ``group1``. ``group1`` contains just one key and value pair, and this pair sets diff --git a/doc/user-guide/source/set-up-clustering.rst b/doc/user-guide/source/set-up-clustering.rst index dbf8d9bad1..018b6da4d3 100644 --- a/doc/user-guide/source/set-up-clustering.rst +++ b/doc/user-guide/source/set-up-clustering.rst @@ -44,7 +44,7 @@ Set up clustering - The name and version of the datastore you want to use. - The three instances you want to include in the replication set for - the first shard. Specify each instance by using the :option:`--instance` + the first shard. Specify each instance by using the ``--instance`` argument and the associated flavor ID and volume size. Use the same flavor ID and volume size for each instance. In this example, flavor ``7`` is a custom flavor that meets the MongoDB minimum diff --git a/doc/user-guide/source/set-up-replication.rst b/doc/user-guide/source/set-up-replication.rst index 998e8057da..18610471d0 100644 --- a/doc/user-guide/source/set-up-replication.rst +++ b/doc/user-guide/source/set-up-replication.rst @@ -8,8 +8,8 @@ applies those changes to the replica. - Replicas are read-only. -- When you create a replica, do not specify the :option:`--users` or - :option:`--databases` options. +- When you create a replica, do not specify the ``--users`` or + ``--databases`` options. - You can choose a smaller volume or flavor for a replica than for the original, but the replica's volume must be big enough to hold the @@ -36,7 +36,7 @@ Set up replication #. **Create the replica** Create a new instance that will be a replica of the original - instance. You do this by passing in the :option:`--replica_of` option with + instance. You do this by passing in the ``--replica_of`` option with the :command:`trove create` command. This example creates a replica called ``replica_1``. ``replica_1`` is a replica of the original instance, ``base_1``: