openstack/openstack-manuals
Code Issues Proposed changes

[install] cleanup list syntax

Browse Source 
* replace 1., 2., .. with #. where possible
* replace a., b., .. with *
* flatten some lists

Change-Id: Icdae64a44fee7911022331081c07d717d797506e
Implements: blueprint installguide-liberty
This commit is contained in:
Christian Berendt 2015-10-08 12:24:39 +02:00
parent 7a26b3f5d4
commit e708842d7b
20 changed files with 686 additions and 686 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,7 +12,7 @@ To configure prerequisites
Edit the ``/etc/cinder/cinder.conf`` file and complete the
following actions:
1. In the ``[DEFAULT]`` section, configure notifications:
#. In the ``[DEFAULT]`` section, configure notifications:
.. code-block:: ini

352
doc/install-guide/source/ceilometer-controller-install.rst
View File

@ -15,7 +15,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. only:: obs
1. Enable the Open Build Service repositories for MongoDB based on
#. Enable the Open Build Service repositories for MongoDB based on
your openSUSE or SLES version:
On openSUSE:
@ -51,7 +51,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. only:: rdo
1. Install the MongoDB package:
#. Install the MongoDB package:
.. code-block:: console
@ -59,7 +59,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. only:: ubuntu
1. Install the MongoDB package:
#. Install the MongoDB package:
.. code-block:: console
@ -70,33 +70,33 @@ create a MongoDB database, service credentials, and API endpoint.
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
.. code-block:: ini
bind_ip = 10.0.0.11
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
.. code-block:: ini
smallfiles = true
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
c. Start the MongoDB services and configure them to start when
the system boots:
* Start the MongoDB services and configure them to start when
the system boots:
.. code-block:: console
.. code-block:: console
# systemctl enable mongodb.service
# systemctl start mongodb.service
# systemctl enable mongodb.service
# systemctl start mongodb.service
.. only:: rdo
@ -105,67 +105,67 @@ create a MongoDB database, service credentials, and API endpoint.
2. Edit the ``/etc/mongod.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
.. code-block:: ini
bind_ip = 10.0.0.11
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
.. code-block:: ini
smallfiles = true
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
c. Start the MongoDB services and configure them to start when
the system boots:
* Start the MongoDB services and configure them to start when
the system boots:
.. code-block:: console
.. code-block:: console
# systemctl enable mongod.service
# systemctl start mongod.service
# systemctl enable mongod.service
# systemctl start mongod.service
.. only:: ubuntu
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
.. code-block:: ini
bind_ip = 10.0.0.11
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
.. code-block:: ini
smallfiles = true
smallfiles = true
If you change the journaling configuration, stop the MongoDB
service, remove the initial journal files, and start the service:
If you change the journaling configuration, stop the MongoDB
service, remove the initial journal files, and start the service:
.. code-block:: console
.. code-block:: console
# service mongodb stop
# rm /var/lib/mongodb/journal/prealloc.*
# service mongodb start
# service mongodb stop
# rm /var/lib/mongodb/journal/prealloc.*
# service mongodb start
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
.. only:: obs or ubuntu
@ -222,50 +222,50 @@ create a MongoDB database, service credentials, and API endpoint.
5. To create the service credentials, complete these steps:
a. Create the ``ceilometer`` user:
* Create the ``ceilometer`` user:
.. code-block:: console
.. code-block:: console
$ openstack user create --password-prompt ceilometer
User Password:
Repeat User Password:
+----------+----------------------------------+
| Field | Value |
+----------+----------------------------------+
| email | None |
| enabled | True |
| id | b7657c9ea07a4556aef5d34cf70713a3 |
| name | ceilometer |
| username | ceilometer |
+----------+----------------------------------+
$ openstack user create --password-prompt ceilometer
User Password:
Repeat User Password:
+----------+----------------------------------+
| Field | Value |
+----------+----------------------------------+
| email | None |
| enabled | True |
| id | b7657c9ea07a4556aef5d34cf70713a3 |
| name | ceilometer |
| username | ceilometer |
+----------+----------------------------------+
b. Add the ``admin`` role to the ``ceilometer`` user.
* Add the ``admin`` role to the ``ceilometer`` user.
.. code-block:: console
.. code-block:: console
$ openstack role add --project service --user ceilometer admin
+-------+----------------------------------+
| Field | Value |
+-------+----------------------------------+
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
| name | admin |
+-------+----------------------------------+
$ openstack role add --project service --user ceilometer admin
+-------+----------------------------------+
| Field | Value |
+-------+----------------------------------+
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
| name | admin |
+-------+----------------------------------+
c. Create the ``ceilometer`` service entity:
* Create the ``ceilometer`` service entity:
.. code-block:: console
.. code-block:: console
$ openstack service create --name ceilometer \
--description "Telemetry" metering
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | Telemetry |
| enabled | True |
| id | 3405453b14da441ebb258edfeba96d83 |
| name | ceilometer |
| type | metering |
+-------------+----------------------------------+
$ openstack service create --name ceilometer \
--description "Telemetry" metering
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | Telemetry |
| enabled | True |
| id | 3405453b14da441ebb258edfeba96d83 |
| name | ceilometer |
| type | metering |
+-------------+----------------------------------+
6. Create the Telemetry module API endpoint:
@ -324,7 +324,7 @@ To install and configure the Telemetry module components
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -337,7 +337,7 @@ To install and configure the Telemetry module components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -348,7 +348,7 @@ To install and configure the Telemetry module components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -366,124 +366,124 @@ To install and configure the Telemetry module components
3. Edit the ``/etc/ceilometer/ceilometer.conf`` file and complete
the following actions:
a. In the ``[database]`` section, configure database access:
* In the ``[database]`` section, configure database access:
.. code-block:: ini
.. code-block:: ini
[database]
...
connection = mongodb://ceilometer:CEILOMETER_DBPASS@controller:27017/ceilometer
[database]
...
connection = mongodb://ceilometer:CEILOMETER_DBPASS@controller:27017/ceilometer
Replace ``CEILOMETER_DBPASS`` with the password you chose for the
Telemetry module database. You must escape special characters such
as ':', '/', '+', and '@' in the connection string in accordance
with RFC2396.
Replace ``CEILOMETER_DBPASS`` with the password you chose for the
Telemetry module database. You must escape special characters such
as ':', '/', '+', and '@' in the connection string in accordance
with RFC2396.
b. In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
rpc_backend = rabbit
[DEFAULT]
...
rpc_backend = rabbit
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
c. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
auth_strategy = keystone
[DEFAULT]
...
auth_strategy = keystone
[keystone_authtoken]
...
auth_uri = http://controller:5000/v2.0
identity_uri = http://controller:35357
admin_tenant_name = service
admin_user = ceilometer
admin_password = CEILOMETER_PASS
[keystone_authtoken]
...
auth_uri = http://controller:5000/v2.0
identity_uri = http://controller:35357
admin_tenant_name = service
admin_user = ceilometer
admin_password = CEILOMETER_PASS
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
.. note::
.. note::
Comment out any ``auth_host``, ``auth_port``, and ``auth_protocol``
options because the ``identity_uri`` option replaces them.
Comment out any ``auth_host``, ``auth_port``, and ``auth_protocol``
options because the ``identity_uri`` option replaces them.
d. In the ``[service_credentials]`` section, configure service credentials:
* In the ``[service_credentials]`` section, configure service credentials:
.. code-block:: ini
.. code-block:: ini
[service_credentials]
...
os_auth_url = http://controller:5000/v2.0
os_username = ceilometer
os_tenant_name = service
os_password = CEILOMETER_PASS
os_endpoint_type = internalURL
os_region_name = RegionOne
[service_credentials]
...
os_auth_url = http://controller:5000/v2.0
os_username = ceilometer
os_tenant_name = service
os_password = CEILOMETER_PASS
os_endpoint_type = internalURL
os_region_name = RegionOne
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
e. In the ``[publisher]`` section, configure the telemetry secret:
* In the ``[publisher]`` section, configure the telemetry secret:
.. code-block:: ini
.. code-block:: ini
[publisher]
...
telemetry_secret = TELEMETRY_SECRET
[publisher]
...
telemetry_secret = TELEMETRY_SECRET
Replace TELEMETRY_SECRET with the telemetry secret
that you generated in a previous step.
Replace TELEMETRY_SECRET with the telemetry secret
that you generated in a previous step.
.. only:: obs
f. In the ``[collector]`` section, configure the dispatcher:
* In the ``[collector]`` section, configure the dispatcher:
.. code-block:: ini
.. code-block:: ini
[collector]
...
dispatcher = database
[collector]
...
dispatcher = database
g. (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
* (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
verbose = True
[DEFAULT]
...
verbose = True
.. only:: rdo or ubuntu
f. (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
* (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
verbose = True
[DEFAULT]
...
verbose = True
To finalize installation
~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: obs
1. Start the Telemetry services and configure them to start when the
#. Start the Telemetry services and configure them to start when the
system boots:
.. code-block:: console
@ -503,7 +503,7 @@ To finalize installation
.. only:: rdo
1. Start the Telemetry services and configure them to start when the
#. Start the Telemetry services and configure them to start when the
system boots:
.. code-block:: console
@ -523,7 +523,7 @@ To finalize installation
.. only:: ubuntu
1. Restart the Telemetry services:
#. Restart the Telemetry services:
.. code-block:: console

2
doc/install-guide/source/ceilometer-glance.rst
View File

@ -10,7 +10,7 @@ Edit the ``/etc/glance/glance-api.conf`` and
``/etc/glance/glance-registry.conf`` files and
complete the following actions:
1. In the ``[DEFAULT]`` section, configure notifications
#. In the ``[DEFAULT]`` section, configure notifications
and RabbitMQ message broker access:
.. code-block:: ini

118
doc/install-guide/source/ceilometer-nova.rst
View File

@ -10,7 +10,7 @@ To install and configure the agent
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -18,7 +18,7 @@ To install and configure the agent
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -26,7 +26,7 @@ To install and configure the agent
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -35,82 +35,82 @@ To install and configure the agent
2. Edit the ``/etc/ceilometer/ceilometer.conf`` file and
complete the following actions:
a. In the ``[publisher]`` section, configure the telemetry secret:
* In the ``[publisher]`` section, configure the telemetry secret:
.. code-block:: ini
.. code-block:: ini
[publisher]
...
telemetry_secret = TELEMETRY_SECRET
Replace ``TELEMETRY_SECRET`` with the telemetry secret you
chose for the Telemetry module.
Replace ``TELEMETRY_SECRET`` with the telemetry secret you
chose for the Telemetry module.
b. In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
rpc_backend = rabbit
[DEFAULT]
...
rpc_backend = rabbit
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
c. In the ``[keystone_authtoken]`` section,
configure Identity service access:
* In the ``[keystone_authtoken]`` section,
configure Identity service access:
.. code-block:: ini
.. code-block:: ini
[keystone_authtoken]
...
auth_uri = http://controller:5000/v2.0
identity_uri = http://controller:35357
admin_tenant_name = service
admin_user = ceilometer
admin_password = CEILOMETER_PASS
[keystone_authtoken]
...
auth_uri = http://controller:5000/v2.0
identity_uri = http://controller:35357
admin_tenant_name = service
admin_user = ceilometer
admin_password = CEILOMETER_PASS
Replace ``CEILOMETER_PASS`` with the password you chose for the
Telemetry module database.
Replace ``CEILOMETER_PASS`` with the password you chose for the
Telemetry module database.
.. note::
.. note::
Comment out any ``auth_host``, ``auth_port``, and
``auth_protocol`` options because the ``identity_uri``
option replaces them.
Comment out any ``auth_host``, ``auth_port``, and
``auth_protocol`` options because the ``identity_uri``
option replaces them.
d. In the ``[service_credentials]`` section, configure service
credentials:
* In the ``[service_credentials]`` section, configure service
credentials:
.. code-block:: ini
.. code-block:: ini
[service_credentials]
...
os_auth_url = http://controller:5000/v2.0
os_username = ceilometer
os_tenant_name = service
os_password = CEILOMETER_PASS
os_endpoint_type = internalURL
os_region_name = RegionOne
[service_credentials]
...
os_auth_url = http://controller:5000/v2.0
os_username = ceilometer
os_tenant_name = service
os_password = CEILOMETER_PASS
os_endpoint_type = internalURL
os_region_name = RegionOne
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
Replace ``CEILOMETER_PASS`` with the password you chose for
the ``ceilometer`` user in the Identity service.
e. (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
* (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
verbose = True
[DEFAULT]
...
verbose = True
To configure notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -165,7 +165,7 @@ To finalize installation
.. only:: obs
1. Start the Telemetry agent and configure it to start when the
#. Start the Telemetry agent and configure it to start when the
system boots:
.. code-block:: console
@ -175,7 +175,7 @@ To finalize installation
.. only:: rdo
1. Start the Telemetry agent and configure it to start when the
#. Start the Telemetry agent and configure it to start when the
system boots:
.. code-block:: console
@ -193,13 +193,13 @@ To finalize installation
.. only:: ubuntu
1. Restart the agent:
#. Restart the agent:
.. code-block:: console
# service ceilometer-agent-compute restart
2. Restart the Compute service:
#. Restart the Compute service:
.. code-block:: console

56
doc/install-guide/source/ceilometer-swift.rst
View File

@ -12,14 +12,14 @@ The Telemetry service requires access to the Object Storage
service using the ``ResellerAdmin`` role. Perform
these steps on the controller node.
1. Source the ``admin`` credentials to gain access to admin-only
#. Source the ``admin`` credentials to gain access to admin-only
CLI commands.
.. code-block:: console
$ source admin-openrc.sh
2. Create the ``ResellerAdmin`` role:
#. Create the ``ResellerAdmin`` role:
.. code-block:: console
@ -31,7 +31,7 @@ these steps on the controller node.
| name | ResellerAdmin |
+-------+----------------------------------+
3. Add the ``ResellerAdmin`` role to the ``service`` tenant and
#. Add the ``ResellerAdmin`` role to the ``service`` tenant and
``ceilometer`` user:
.. code-block:: console
@ -50,43 +50,43 @@ To configure notifications
Perform these steps on the controller and any other nodes that
run the Object Storage proxy service.
1. Edit the ``/etc/swift/proxy-server.conf`` file
#. Edit the ``/etc/swift/proxy-server.conf`` file
and complete the following actions:
a. In the ``[filter:keystoneauth]`` section, add the
``ResellerAdmin`` role:
* In the ``[filter:keystoneauth]`` section, add the
``ResellerAdmin`` role:
.. code-block:: ini
.. code-block:: ini
[filter:keystoneauth]
...
operator_roles = admin,user,ResellerAdmin
[filter:keystoneauth]
...
operator_roles = admin,user,ResellerAdmin
b. In the ``[pipeline:main]`` section, add ``ceilometer``:
* In the ``[pipeline:main]`` section, add ``ceilometer``:
.. code-block:: ini
.. code-block:: ini
[pipeline:main]
...
pipeline = authtoken cache healthcheck keystoneauth proxy-logging ceilometer proxy-server
[pipeline:main]
...
pipeline = authtoken cache healthcheck keystoneauth proxy-logging ceilometer proxy-server
c. In the ``[filter:ceilometer]`` section, configure notifications:
* In the ``[filter:ceilometer]`` section, configure notifications:
.. code-block:: ini
.. code-block:: ini
[filter:ceilometer]
...
paste.filter_factory = ceilometermiddleware.swift:filter_factory
control_exchange = swift
url = rabbit://openstack:RABBIT_PASS@controller:5672/
driver = messagingv2
topic = notifications
log_level = WARN
[filter:ceilometer]
...
paste.filter_factory = ceilometermiddleware.swift:filter_factory
control_exchange = swift
url = rabbit://openstack:RABBIT_PASS@controller:5672/
driver = messagingv2
topic = notifications
log_level = WARN
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
2. Add the ``swift`` system user to the ``ceilometer`` system group
#. Add the ``swift`` system user to the ``ceilometer`` system group
to permit access to the Telemetry configuration files by the
Object Storage service:

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

@ -13,109 +13,109 @@ To configure prerequisites
Before you install and configure the Block Storage service, you
must create a database, service credentials, and API endpoint.
1. To create the database, complete these steps:
#. To create the database, complete these steps:
a. Use the database access client to connect to the database
server as the ``root`` user:
* Use the database access client to connect to the database
server as the ``root`` user:
.. code-block:: console
.. code-block:: console
$ mysql -u root -p
$ mysql -u root -p
b. Create the ``cinder`` database:
* Create the ``cinder`` database:
.. code-block:: console
.. code-block:: console
CREATE DATABASE cinder;
CREATE DATABASE cinder;
c. Grant proper access to the ``cinder`` database:
* Grant proper access to the ``cinder`` database:
.. code-block:: console
.. code-block:: console
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \
IDENTIFIED BY 'CINDER_DBPASS';
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \
IDENTIFIED BY 'CINDER_DBPASS';
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \
IDENTIFIED BY 'CINDER_DBPASS';
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \
IDENTIFIED BY 'CINDER_DBPASS';
Replace ``CINDER_DBPASS`` with a suitable password.
Replace ``CINDER_DBPASS`` with a suitable password.
d. Exit the database access client.
* Exit the database access client.
2. Source the ``admin`` credentials to gain access to admin-only
#. Source the ``admin`` credentials to gain access to admin-only
CLI commands:
.. code-block:: console
$ source admin-openrc.sh
3. To create the service credentials, complete these steps:
#. To create the service credentials, complete these steps:
a. Create a ``cinder`` user:
* Create a ``cinder`` user:
.. code-block:: console
.. code-block:: console
$ openstack user create --password-prompt cinder
User Password:
Repeat User Password:
+----------+----------------------------------+
| Field | Value |
+----------+----------------------------------+
| email | None |
| enabled | True |
| id | 881ab2de4f7941e79504a759a83308be |
| name | cinder |
| username | cinder |
+----------+----------------------------------+
$ openstack user create --password-prompt cinder
User Password:
Repeat User Password:
+----------+----------------------------------+
| Field | Value |
+----------+----------------------------------+
| email | None |
| enabled | True |
| id | 881ab2de4f7941e79504a759a83308be |
| name | cinder |
| username | cinder |
+----------+----------------------------------+
b. Add the ``admin`` role to the ``cinder`` user:
* Add the ``admin`` role to the ``cinder`` user:
.. code-block:: console
.. code-block:: console
$ openstack role add --project service --user cinder admin
+-------+----------------------------------+
| Field | Value |
+-------+----------------------------------+
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
| name | admin |
+-------+----------------------------------+
$ openstack role add --project service --user cinder admin
+-------+----------------------------------+
| Field | Value |
+-------+----------------------------------+
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
| name | admin |
+-------+----------------------------------+
c. Create the ``cinder`` service entities:
* Create the ``cinder`` service entities:
.. code-block:: console
.. code-block:: console
$ openstack service create --name cinder \
--description "OpenStack Block Storage" volume
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | OpenStack Block Storage |
| enabled | True |
| id | 1e494c3e22a24baaafcaf777d4d467eb |
| name | cinder |
| type | volume |
+-------------+----------------------------------+
$ openstack service create --name cinder \
--description "OpenStack Block Storage" volume
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | OpenStack Block Storage |
| enabled | True |
| id | 1e494c3e22a24baaafcaf777d4d467eb |
| name | cinder |
| type | volume |
+-------------+----------------------------------+
.. code-block:: console
.. code-block:: console
$ openstack service create --name cinderv2 \
--description "OpenStack Block Storage" volumev2
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | OpenStack Block Storage |
| enabled | True |
| id | 16e038e449c94b40868277f1d801edb5 |
| name | cinderv2 |
| type | volumev2 |
+-------------+----------------------------------+
$ openstack service create --name cinderv2 \
--description "OpenStack Block Storage" volumev2
+-------------+----------------------------------+
| Field | Value |
+-------------+----------------------------------+
| description | OpenStack Block Storage |
| enabled | True |
| id | 16e038e449c94b40868277f1d801edb5 |
| name | cinderv2 |
| type | volumev2 |
+-------------+----------------------------------+
.. note::
.. note::
The Block Storage service requires both the ``volume`` and
``volumev2`` services. However, both services use the same API
endpoint that references the Block Storage version 2 API.
The Block Storage service requires both the ``volume`` and
``volumev2`` services. However, both services use the same API
endpoint that references the Block Storage version 2 API.
4. Create the Block Storage service API endpoints:
#. Create the Block Storage service API endpoints:
.. code-block:: console
@ -164,7 +164,7 @@ To install and configure Block Storage controller components
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -172,7 +172,7 @@ To install and configure Block Storage controller components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -180,7 +180,7 @@ To install and configure Block Storage controller components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -205,88 +205,88 @@ To install and configure Block Storage controller components
Edit the ``/etc/cinder/cinder.conf`` file and complete the
following actions:
a. In the ``[database]`` section, configure database access:
* In the ``[database]`` section, configure database access:
.. code-block:: ini
.. code-block:: ini
[database]
...
connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder
[database]
...
connection = mysql+pymysql://cinder:CINDER_DBPASS@controller/cinder
Replace ``CINDER_DBPASS`` with the password you chose for the
Block Storage database.
Replace ``CINDER_DBPASS`` with the password you chose for the
Block Storage database.
b. In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
rpc_backend = rabbit
[DEFAULT]
...
rpc_backend = rabbit
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
Replace ``RABBIT_PASS`` with the password you chose for the
``openstack`` account in ``RabbitMQ``.
c. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
auth_strategy = keystone
[DEFAULT]
...
auth_strategy = keystone
[keystone_authtoken]
...
auth_uri = http://controller:5000
auth_url = http://controller:35357
auth_plugin = password
project_domain_id = default
user_domain_id = default
project_name = service
username = cinder
password = CINDER_PASS
[keystone_authtoken]
...
auth_uri = http://controller:5000
auth_url = http://controller:35357
auth_plugin = password
project_domain_id = default
user_domain_id = default
project_name = service
username = cinder
password = CINDER_PASS
Replace ``CINDER_PASS`` with the password you chose for
the ``cinder`` user in the Identity service.
Replace ``CINDER_PASS`` with the password you chose for
the ``cinder`` user in the Identity service.
.. note::
.. note::
Comment out or remove any other options in the
``[keystone_authtoken]`` section.
Comment out or remove any other options in the
``[keystone_authtoken]`` section.
d. In the ``[DEFAULT]`` section, configure the ``my_ip`` option to
use the management interface IP address of the controller node:
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option to
use the management interface IP address of the controller node:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
my_ip = 10.0.0.11
[DEFAULT]
...
my_ip = 10.0.0.11
e. In the ``[oslo_concurrency]`` section, configure the lock path:
* In the ``[oslo_concurrency]`` section, configure the lock path:
.. code-block:: ini
.. code-block:: ini
[oslo_concurrency]
...
lock_path = /var/lock/cinder
[oslo_concurrency]
...
lock_path = /var/lock/cinder
f. (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
* (Optional) To assist with troubleshooting, enable verbose
logging in the ``[DEFAULT]`` section:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
verbose = True
[DEFAULT]
...
verbose = True
3. Populate the Block Storage database:
@ -299,7 +299,7 @@ To finalize installation
.. only:: obs or rdo
1. Start the Block Storage services and configure them to start when
#. Start the Block Storage services and configure them to start when
the system boots:
@ -310,14 +310,14 @@ To finalize installation
.. only:: ubuntu
1. Restart the Block Storage services:
#. Restart the Block Storage services:
.. code-block:: console
# service cinder-scheduler restart
# service cinder-api restart
2. By default, the Ubuntu packages create an SQLite database.
#. By default, the Ubuntu packages create an SQLite database.
Because this configuration uses an SQL database server,
you can remove the SQLite database file:

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

@ -132,45 +132,45 @@ environment. For more information, see :ref:`environment`.
that contain the ``cinder-volume`` volume group. Edit the
``/etc/lvm/lvm.conf`` file and complete the following actions:
a. In the ``devices`` section, add a filter that accepts the
``/dev/sdb`` device and rejects all other devices::
* In the ``devices`` section, add a filter that accepts the
``/dev/sdb`` device and rejects all other devices::
devices {
...
filter = [ "a/sdb/", "r/.*/"]
Each item in the filter array begins with ``a`` for **accept** or
``r`` for **reject** and includes a regular expression for the
device name. The array must end with ``r/.*/`` to reject any
remaining devices. You can use the :command:`vgs -vvvv` command
to test filters.
Each item in the filter array begins with ``a`` for **accept** or
``r`` for **reject** and includes a regular expression for the
device name. The array must end with ``r/.*/`` to reject any
remaining devices. You can use the :command:`vgs -vvvv` command
to test filters.
.. warning::
.. warning::
If your storage nodes use LVM on the operating system disk, you
must also add the associated device to the filter. For example,
if the ``/dev/sda`` device contains the operating system:
If your storage nodes use LVM on the operating system disk, you
must also add the associated device to the filter. For example,
if the ``/dev/sda`` device contains the operating system:
.. code-block:: ini
.. code-block:: ini
filter = [ "a/sda/", "a/sdb/", "r/.*/"]
filter = [ "a/sda/", "a/sdb/", "r/.*/"]
Similarly, if your compute nodes use LVM on the operating
system disk, you must also modify the filter in the
``/etc/lvm/lvm.conf`` file on those nodes to include only
the operating system disk. For example, if the ``/dev/sda``
device contains the operating system:
Similarly, if your compute nodes use LVM on the operating
system disk, you must also modify the filter in the
``/etc/lvm/lvm.conf`` file on those nodes to include only
the operating system disk. For example, if the ``/dev/sda``
device contains the operating system:
.. code-block:: ini
.. code-block:: ini
filter = [ "a/sda/", "r/.*/"]
filter = [ "a/sda/", "r/.*/"]
Install and configure Block Storage volume components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -178,7 +178,7 @@ Install and configure Block Storage volume components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -190,7 +190,7 @@ Install and configure Block Storage volume components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -199,7 +199,7 @@ Install and configure Block Storage volume components
2. Edit the ``/etc/cinder/cinder.conf`` file
and complete the following actions:
a. In the ``[database]`` section, configure database access:
* In the ``[database]`` section, configure database access:
.. code-block:: ini
@ -210,140 +210,140 @@ Install and configure Block Storage volume components
Replace ``CINDER_DBPASS`` with the password you chose for
the Block Storage database.
b. In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
configure ``RabbitMQ`` message queue access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
rpc_backend = rabbit
[DEFAULT]
...
rpc_backend = rabbit
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
[oslo_messaging_rabbit]
...
rabbit_host = controller
rabbit_userid = openstack
rabbit_password = RABBIT_PASS
Replace ``RABBIT_PASS`` with the password you chose for
the ``openstack`` account in ``RabbitMQ``.
Replace ``RABBIT_PASS`` with the password you chose for
the ``openstack`` account in ``RabbitMQ``.
c. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
configure Identity service access:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
auth_strategy = keystone
[DEFAULT]
...
auth_strategy = keystone
[keystone_authtoken]
...
auth_uri = http://controller:5000
auth_url = http://controller:35357
auth_plugin = password
project_domain_id = default
user_domain_id = default
project_name = service
username = cinder
password = CINDER_PASS
[keystone_authtoken]
...
auth_uri = http://controller:5000
auth_url = http://controller:35357
auth_plugin = password
project_domain_id = default
user_domain_id = default
project_name = service
username = cinder
password = CINDER_PASS
Replace ``CINDER_PASS`` with the password you chose for the
``cinder`` user in the Identity service.
Replace ``CINDER_PASS`` with the password you chose for the
``cinder`` user in the Identity service.
.. note::
.. note::
Comment out or remove any other options in the
``[keystone_authtoken]`` section.
Comment out or remove any other options in the
``[keystone_authtoken]`` section.
d. In the ``[DEFAULT]`` section, configure the ``my_ip`` option:
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
[DEFAULT]
...
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address
of the management network interface on your storage node,
typically 10.0.0.41 for the first node in the
:ref:`example architecture <overview-example-architectures>`.
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address
of the management network interface on your storage node,
typically 10.0.0.41 for the first node in the
:ref:`example architecture <overview-example-architectures>`.
.. only:: obs or ubuntu
e. In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service:
* In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service:
.. code-block:: ini
.. code-block:: ini
[lvm]
...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
[lvm]
...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
.. only:: rdo
e. In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service:
* In the ``[lvm]`` section, configure the LVM back end with the
LVM driver, ``cinder-volumes`` volume group, iSCSI protocol,
and appropriate iSCSI service:
.. code-block:: ini
.. code-block:: ini
[lvm]
...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = lioadm
[lvm]
...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = lioadm
f. In the ``[DEFAULT]`` section, enable the LVM back end:
* In the ``[DEFAULT]`` section, enable the LVM back end:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
enabled_backends = lvm
[DEFAULT]
...
enabled_backends = lvm
.. note::
.. note::
Back-end names are arbitrary. As an example, this guide
uses the name of the driver as the name of the back end.
Back-end names are arbitrary. As an example, this guide
uses the name of the driver as the name of the back end.
g. In the ``[DEFAULT]`` section, configure the location of the
Image service:
* In the ``[DEFAULT]`` section, configure the location of the
Image service:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
glance_host = controller
[DEFAULT]
...
glance_host = controller
h. In the ``[oslo_concurrency]`` section, configure the lock path:
* In the ``[oslo_concurrency]`` section, configure the lock path:
.. code-block:: ini
.. code-block:: ini
[oslo_concurrency]
...
lock_path = /var/lock/cinder
[oslo_concurrency]
...
lock_path = /var/lock/cinder
i. (Optional) To assist with troubleshooting, enable verbose logging
in the ``[DEFAULT]`` section:
* (Optional) To assist with troubleshooting, enable verbose logging
in the ``[DEFAULT]`` section:
.. code-block:: ini
.. code-block:: ini
[DEFAULT]
...
verbose = True
[DEFAULT]
...
verbose = True
To finalize installation
~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: obs
1. Start the Block Storage volume service including its dependencies
#. Start the Block Storage volume service including its dependencies
and configure them to start when the system boots:
.. code-block:: console
@ -353,7 +353,7 @@ To finalize installation
.. only:: rdo
1. Start the Block Storage volume service including its dependencies
#. Start the Block Storage volume service including its dependencies
and configure them to start when the system boots:
.. code-block:: console
@ -363,14 +363,14 @@ To finalize installation
.. only:: ubuntu
1. Restart the Block Storage volume service including its dependencies:
#. Restart the Block Storage volume service including its dependencies:
.. code-block:: console
# service tgt restart
# service cinder-volume restart
2. By default, the Ubuntu packages create an SQLite database.
#. By default, the Ubuntu packages create an SQLite database.
Because this configuration uses an SQL database server,
remove the SQLite database file:

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

@ -255,7 +255,7 @@ services also support other SQL databases including
Install and configure the database server
-----------------------------------------
1. Install the packages:
#. Install the packages:
.. only:: rdo or ubuntu or obs
@ -353,7 +353,7 @@ To finalize installation
.. only:: ubuntu or debian
1. Restart the database service:
#. Restart the database service:
.. code-block:: console
@ -361,7 +361,7 @@ To finalize installation
.. only:: rdo or obs
1. Start the database service and configure it to start when the system
#. Start the database service and configure it to start when the system
boots:
.. only:: rdo

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

@ -25,39 +25,39 @@ Configure network interfaces
.. only:: ubuntu or debian
a. Edit the ``/etc/network/interfaces`` file to contain the following:
* Edit the ``/etc/network/interfaces`` file to contain the following:
.. code-block:: ini
.. code-block:: ini
# The public network interface
auto INTERFACE_NAME
iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up
down ip link set dev $IFACE down
# The public network interface
auto INTERFACE_NAME
iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up
down ip link set dev $IFACE down
.. only:: rdo
a. Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
* Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys.
Do not change the ``HWADDR`` and ``UUID`` keys.
.. code-block:: ini
.. code-block:: ini
DEVICE=INTERFACE_NAME
TYPE=Ethernet
ONBOOT="yes"
BOOTPROTO="none"
DEVICE=INTERFACE_NAME
TYPE=Ethernet
ONBOOT="yes"
BOOTPROTO="none"
.. only:: obs
a. Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. code-block:: ini
.. code-block:: ini
STARTMODE='auto'
BOOTPROTO='static'
STARTMODE='auto'
BOOTPROTO='static'
#. Reboot the system to activate the changes.

40
doc/install-guide/source/environment-networking-controller.rst
View File

@ -21,39 +21,39 @@ Configure network interfaces
.. only:: ubuntu or debian
a. Edit the ``/etc/network/interfaces`` file to contain the following:
* Edit the ``/etc/network/interfaces`` file to contain the following:
.. code-block:: ini
.. code-block:: ini
# The public network interface
auto INTERFACE_NAME
iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up
down ip link set dev $IFACE down
# The public network interface
auto INTERFACE_NAME
iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up
down ip link set dev $IFACE down
.. only:: rdo
a. Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
* Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys.
Do not change the ``HWADDR`` and ``UUID`` keys.
.. code-block:: ini
.. code-block:: ini
DEVICE=INTERFACE_NAME
TYPE=Ethernet
ONBOOT="yes"
BOOTPROTO="none"
DEVICE=INTERFACE_NAME
TYPE=Ethernet
ONBOOT="yes"
BOOTPROTO="none"
.. only:: obs
a. Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. code-block:: ini
.. code-block:: ini
STARTMODE='auto'
BOOTPROTO='static'
STARTMODE='auto'
BOOTPROTO='static'
#. Reboot the system to activate the changes.

8
doc/install-guide/source/environment-ntp-other.rst
View File

@ -43,14 +43,14 @@ node.
.. only:: ubuntu or debian
1. Edit the ``/etc/chrony/chrony.conf`` file and comment out or remove all
#. Edit the ``/etc/chrony/chrony.conf`` file and comment out or remove all
but one ``server`` key. Change it to reference the controller node:
.. code-block:: ini
server controller iburst
2. Restart the NTP service:
#. Restart the NTP service:
.. code-block:: console
@ -58,14 +58,14 @@ node.
.. only:: rdo or obs
1. Edit the ``/etc/chrony.conf`` file and comment out or remove all but one
#. Edit the ``/etc/chrony.conf`` file and comment out or remove all but one
``server`` key. Change it to reference the controller node:
.. code-block:: ini
server controller iburst
2. Start the NTP service and configure it to start when the system boots:
#. Start the NTP service and configure it to start when the system boots:
.. code-block:: console

16
doc/install-guide/source/glance-install.rst
View File

@ -154,7 +154,7 @@ Install and configure components
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -162,7 +162,7 @@ Install and configure components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -173,7 +173,7 @@ Install and configure components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -329,19 +329,19 @@ Install and configure components
.. only:: debian
1. Install the packages:
#. Install the packages:
.. code-block:: console
# apt-get install glance python-glanceclient
2. Respond to prompts for
#. Respond to prompts for
:doc:`database management <debconf/debconf-dbconfig-common>`,
:doc:`Identity service credentials <debconf/debconf-keystone-authtoken>`,
:doc:`service endpoint registration <debconf/debconf-api-endpoints>`,
and :doc:`message broker credentials <debconf/debconf-rabbitmq>`.
3. Select the ``keystone`` pipeline to configure the Image service
#. Select the ``keystone`` pipeline to configure the Image service
to use the Identity service:
.. image:: figures/debconf-screenshots/glance-common_pipeline_flavor.png
@ -352,7 +352,7 @@ Finalize installation
.. only:: obs or rdo
1. Start the Image service services and configure them to start when
#. Start the Image service services and configure them to start when
the system boots:
.. code-block:: console
@ -364,7 +364,7 @@ Finalize installation
.. only:: ubuntu or debian
1. Restart the Image service services:
#. Restart the Image service services:
.. code-block:: console

16
doc/install-guide/source/heat-install.rst
View File

@ -254,7 +254,7 @@ To install and configure the Orchestration components
.. only:: obs
1. Run the following commands to install the packages:
#. Run the following commands to install the packages:
.. code-block:: console
@ -263,7 +263,7 @@ To install and configure the Orchestration components
.. only:: rdo
1. Run the following commands to install the packages:
#. Run the following commands to install the packages:
.. code-block:: console
@ -272,7 +272,7 @@ To install and configure the Orchestration components
.. only:: ubuntu
1. Run the following commands to install the packages:
#. Run the following commands to install the packages:
.. code-block:: console
@ -414,19 +414,19 @@ To install and configure the Orchestration components
.. only:: debian
1. Run the following commands to install the packages:
#. Run the following commands to install the packages:
.. code-block:: console
# apt-get install heat-api heat-api-cfn heat-engine python-heat-client
2. Respond to prompts for
#. Respond to prompts for
:doc:`database management <debconf/debconf-dbconfig-common>`,
:doc:`Identity service credentials <debconf/debconf-keystone-authtoken>`,
:doc:`service endpoint registration <debconf/debconf-api-endpoints>`,
and :doc:`message broker credentials <debconf/debconf-rabbitmq>`.
3. Edit the ``/etc/heat/heat.conf`` file and complete the following
#. Edit the ``/etc/heat/heat.conf`` file and complete the following
actions:
* In the ``[ec2authtoken]`` section, configure Identity service access:
@ -442,7 +442,7 @@ To finalize installation
.. only:: obs or rdo
1. Start the Orchestration services and configure them to start
#. Start the Orchestration services and configure them to start
when the system boots:
.. code-block:: console
@ -454,7 +454,7 @@ To finalize installation
.. only:: ubuntu or debian
1. Restart the Orchestration services:
#. Restart the Orchestration services:
.. code-block:: console

4
doc/install-guide/source/keystone-verify.rst
View File

@ -6,7 +6,7 @@ services.
.. only:: obs or ubuntu
1. For security reasons, disable the temporary authentication
#. For security reasons, disable the temporary authentication
token mechanism:
Edit the ``/etc/keystone/keystone-paste.ini``
@ -16,7 +16,7 @@ services.
.. only:: rdo
1. For security reasons, disable the temporary authentication
#. For security reasons, disable the temporary authentication
token mechanism:
Edit the ``/usr/share/keystone/keystone-dist-paste.ini``

52
doc/install-guide/source/launch-instance-private.rst
View File

@ -68,7 +68,7 @@ name, network, security group, key, and instance name.
This instance uses the ``private`` project network. However, you must
reference this network using the ID instead of the name.
4. List available security groups:
#. List available security groups:
.. code-block:: console
@ -81,7 +81,7 @@ name, network, security group, key, and instance name.
This instance uses the ``default`` security group.
5. Launch the instance:
#. Launch the instance:
Replace ``PRIVATE_NET_ID`` with the ID of the ``private`` project network.
@ -120,7 +120,7 @@ name, network, security group, key, and instance name.
| user_id | 684286a9079845359882afc3aa5011fb |
+--------------------------------------+-----------------------------------------------+
6. Check the status of your instance:
#. Check the status of your instance:
.. code-block:: console
@ -138,7 +138,7 @@ name, network, security group, key, and instance name.
Access the instance using a virtual console
-------------------------------------------
1. Obtain a :term:`Virtual Network Computing (VNC)`
#. Obtain a :term:`Virtual Network Computing (VNC)`
session URL for your instance and access it from a web browser:
.. code-block:: console
@ -161,35 +161,35 @@ Access the instance using a virtual console
After logging into CirrOS, we recommend that you verify network
connectivity using ``ping``.
#. Verify access to the ``private`` project network gateway:
#. Verify access to the ``private`` project network gateway:
.. code-block:: console
.. code-block:: console
$ ping -c 4 172.16.1.1
PING 172.16.1.1 (172.16.1.1) 56(84) bytes of data.
64 bytes from 172.16.1.1: icmp_req=1 ttl=64 time=0.357 ms
64 bytes from 172.16.1.1: icmp_req=2 ttl=64 time=0.473 ms
64 bytes from 172.16.1.1: icmp_req=3 ttl=64 time=0.504 ms
64 bytes from 172.16.1.1: icmp_req=4 ttl=64 time=0.470 ms
$ ping -c 4 172.16.1.1
PING 172.16.1.1 (172.16.1.1) 56(84) bytes of data.
64 bytes from 172.16.1.1: icmp_req=1 ttl=64 time=0.357 ms
64 bytes from 172.16.1.1: icmp_req=2 ttl=64 time=0.473 ms
64 bytes from 172.16.1.1: icmp_req=3 ttl=64 time=0.504 ms
64 bytes from 172.16.1.1: icmp_req=4 ttl=64 time=0.470 ms
--- 172.16.1.1 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2998ms
rtt min/avg/max/mdev = 0.357/0.451/0.504/0.055 ms
--- 172.16.1.1 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2998ms
rtt min/avg/max/mdev = 0.357/0.451/0.504/0.055 ms
#. Verify access to the internet:
#. Verify access to the internet:
.. code-block:: console
.. code-block:: console
$ ping -c 4 openstack.org
PING openstack.org (174.143.194.225) 56(84) bytes of data.
64 bytes from 174.143.194.225: icmp_req=1 ttl=53 time=17.4 ms
64 bytes from 174.143.194.225: icmp_req=2 ttl=53 time=17.5 ms
64 bytes from 174.143.194.225: icmp_req=3 ttl=53 time=17.7 ms
64 bytes from 174.143.194.225: icmp_req=4 ttl=53 time=17.5 ms
$ ping -c 4 openstack.org
PING openstack.org (174.143.194.225) 56(84) bytes of data.
64 bytes from 174.143.194.225: icmp_req=1 ttl=53 time=17.4 ms
64 bytes from 174.143.194.225: icmp_req=2 ttl=53 time=17.5 ms
64 bytes from 174.143.194.225: icmp_req=3 ttl=53 time=17.7 ms
64 bytes from 174.143.194.225: icmp_req=4 ttl=53 time=17.5 ms
--- openstack.org ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3003ms
rtt min/avg/max/mdev = 17.431/17.575/17.734/0.143 ms
--- openstack.org ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3003ms
rtt min/avg/max/mdev = 17.431/17.575/17.734/0.143 ms
Access the instance remotely
----------------------------

44
doc/install-guide/source/launch-instance-public.rst
View File

@ -172,35 +172,35 @@ Access the instance using the virtual console
After logging into CirrOS, we recommend that you verify network
connectivity using ``ping``.
#. Verify access to the public provider network gateway:
#. Verify access to the public provider network gateway:
.. code-block:: console
.. code-block:: console
$ ping -c 4 203.0.113.1
PING 203.0.113.1 (203.0.113.1) 56(84) bytes of data.
64 bytes from 203.0.113.1: icmp_req=1 ttl=64 time=0.357 ms
64 bytes from 203.0.113.1: icmp_req=2 ttl=64 time=0.473 ms
64 bytes from 203.0.113.1: icmp_req=3 ttl=64 time=0.504 ms
64 bytes from 203.0.113.1: icmp_req=4 ttl=64 time=0.470 ms
$ ping -c 4 203.0.113.1
PING 203.0.113.1 (203.0.113.1) 56(84) bytes of data.
64 bytes from 203.0.113.1: icmp_req=1 ttl=64 time=0.357 ms
64 bytes from 203.0.113.1: icmp_req=2 ttl=64 time=0.473 ms
64 bytes from 203.0.113.1: icmp_req=3 ttl=64 time=0.504 ms
64 bytes from 203.0.113.1: icmp_req=4 ttl=64 time=0.470 ms
--- 203.0.113.1 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2998ms
rtt min/avg/max/mdev = 0.357/0.451/0.504/0.055 ms
--- 203.0.113.1 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2998ms
rtt min/avg/max/mdev = 0.357/0.451/0.504/0.055 ms
#. Verify access to the internet:
#. Verify access to the internet:
.. code-block:: console
.. code-block:: console
$ ping -c 4 openstack.org
PING openstack.org (174.143.194.225) 56(84) bytes of data.
64 bytes from 174.143.194.225: icmp_req=1 ttl=53 time=17.4 ms
64 bytes from 174.143.194.225: icmp_req=2 ttl=53 time=17.5 ms
64 bytes from 174.143.194.225: icmp_req=3 ttl=53 time=17.7 ms
64 bytes from 174.143.194.225: icmp_req=4 ttl=53 time=17.5 ms
$ ping -c 4 openstack.org
PING openstack.org (174.143.194.225) 56(84) bytes of data.
64 bytes from 174.143.194.225: icmp_req=1 ttl=53 time=17.4 ms
64 bytes from 174.143.194.225: icmp_req=2 ttl=53 time=17.5 ms
64 bytes from 174.143.194.225: icmp_req=3 ttl=53 time=17.7 ms
64 bytes from 174.143.194.225: icmp_req=4 ttl=53 time=17.5 ms
--- openstack.org ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3003ms
rtt min/avg/max/mdev = 17.431/17.575/17.734/0.143 ms
--- openstack.org ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3003ms
rtt min/avg/max/mdev = 17.431/17.575/17.734/0.143 ms
Access the instance remotely
----------------------------

32
doc/install-guide/source/launch-instance.rst
View File

@ -81,27 +81,27 @@ secure shell (SSH).
#. Add rules to the ``default`` security group:
#. Permit :term:`ICMP` (ping):
* Permit :term:`ICMP` (ping):
.. code-block:: console
.. code-block:: console
$ nova secgroup-add-rule default icmp -1 -1 0.0.0.0/0
+-------------+-----------+---------+-----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+-----------+--------------+
| icmp | -1 | -1 | 0.0.0.0/0 | |
+-------------+-----------+---------+-----------+--------------+
$ nova secgroup-add-rule default icmp -1 -1 0.0.0.0/0
+-------------+-----------+---------+-----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+-----------+--------------+
| icmp | -1 | -1 | 0.0.0.0/0 | |
+-------------+-----------+---------+-----------+--------------+
#. Permit secure shell (SSH) access:
* Permit secure shell (SSH) access:
.. code-block:: console
.. code-block:: console
$ nova secgroup-add-rule default tcp 22 22 0.0.0.0/0
+-------------+-----------+---------+-----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+-----------+--------------+
| tcp | 22 | 22 | 0.0.0.0/0 | |
+-------------+-----------+---------+-----------+--------------+
$ nova secgroup-add-rule default tcp 22 22 0.0.0.0/0
+-------------+-----------+---------+-----------+--------------+
| IP Protocol | From Port | To Port | IP Range | Source Group |
+-------------+-----------+---------+-----------+--------------+
| tcp | 22 | 22 | 0.0.0.0/0 | |
+-------------+-----------+---------+-----------+--------------+
Launch an instance
------------------

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

@ -28,7 +28,7 @@ Install and configure components
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -36,7 +36,7 @@ Install and configure components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -44,7 +44,7 @@ Install and configure components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -206,7 +206,7 @@ Install and configure components
Finalize installation
---------------------
1. Determine whether your compute node supports hardware acceleration
#. Determine whether your compute node supports hardware acceleration
for virtual machines:
.. code-block:: console

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

@ -148,7 +148,7 @@ Install and configure components
.. only:: obs
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -159,7 +159,7 @@ Install and configure components
.. only:: rdo
1. Install the packages:
#. Install the packages:
.. code-block:: console
@ -170,7 +170,7 @@ Install and configure components
.. only:: ubuntu
1. Install the packages:
#. Install the packages:
.. code-block:: console

68
doc/install-guide/source/swift-finalize-installation.rst
View File

@ -16,31 +16,31 @@ Finalize installation
#. Edit the ``/etc/swift/swift.conf`` file and complete the following
actions:
a. In the ``[swift-hash]`` section, configure the hash path prefix and
suffix for your environment.
* In the ``[swift-hash]`` section, configure the hash path prefix and
suffix for your environment.
.. code-block:: ini
.. code-block:: ini
[swift-hash]
...
swift_hash_path_suffix = HASH_PATH_PREFIX
swift_hash_path_prefix = HASH_PATH_SUFFIX
[swift-hash]
...
swift_hash_path_suffix = HASH_PATH_PREFIX
swift_hash_path_prefix = HASH_PATH_SUFFIX
Replace HASH_PATH_PREFIX and HASH_PATH_SUFFIX with unique values.
Replace HASH_PATH_PREFIX and HASH_PATH_SUFFIX with unique values.
.. warning::
.. warning::
Keep these values secret and do not change or lose them.
Keep these values secret and do not change or lose them.
b. In the ``[storage-policy:0]`` section, configure the default
storage policy:
* In the ``[storage-policy:0]`` section, configure the default
storage policy:
.. code-block:: ini
.. code-block:: ini
[storage-policy:0]
...
name = Policy-0
default = yes
[storage-policy:0]
...
name = Policy-0
default = yes
#. Copy the ``swift.conf`` file to the ``/etc/swift`` directory on
each storage node and any additional nodes running the proxy service.
@ -50,31 +50,31 @@ Finalize installation
#. Edit the ``/etc/swift/swift.conf`` file and complete the following
actions:
a. In the ``[swift-hash]`` section, configure the hash path prefix and
suffix for your environment.
* In the ``[swift-hash]`` section, configure the hash path prefix and
suffix for your environment.
.. code-block:: ini
.. code-block:: ini
[swift-hash]
...
swift_hash_path_suffix = HASH_PATH_PREFIX
swift_hash_path_prefix = HASH_PATH_SUFFIX
[swift-hash]
...
swift_hash_path_suffix = HASH_PATH_PREFIX
swift_hash_path_prefix = HASH_PATH_SUFFIX
Replace HASH_PATH_PREFIX and HASH_PATH_SUFFIX with unique values.
Replace HASH_PATH_PREFIX and HASH_PATH_SUFFIX with unique values.
.. warning::
.. warning::
Keep these values secret and do not change or lose them.
Keep these values secret and do not change or lose them.
b. In the ``[storage-policy:0]`` section, configure the default
storage policy:
* In the ``[storage-policy:0]`` section, configure the default
storage policy:
.. code-block:: ini
.. code-block:: ini
[storage-policy:0]
...
name = Policy-0
default = yes
[storage-policy:0]
...
name = Policy-0
default = yes
#. Copy the ``swift.conf`` file to the ``/etc/swift`` directory on
each storage node and any additional nodes running the proxy service.