openstack/openstack-manuals
Code Issues Proposed changes

[install] General edits for install guide

Browse Source 
* Update links to point to pike content
* Improve titles and ToC
* Remove Debian
* Fix formatting
* Update repo url for Pike
* Edit openstack-services

Change-Id: I258d6ce980b0b3408d88b40e487f3079c2b55cdb
This commit is contained in:
Petr Kovar 2017-08-28 19:33:22 +02:00 committed by Emma Foley
parent b44da4c032
commit 7c7791c66d
30 changed files with 239 additions and 376 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
SUSE Memcached Memcached for SUSE
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
The Identity service authentication mechanism for services uses Memcached The Identity service authentication mechanism for services uses Memcached
to cache tokens. The memcached service typically runs on the controller to cache tokens. The memcached service typically runs on the controller
@ -11,18 +11,11 @@ Install and configure components
#. Install the packages: #. Install the packages:
.. code-block:: console
# zypper install memcached python-python-memcached
.. end
.. code-block:: console
# zypper install memcached python-python-memcached
.. end
2. Edit the ``/etc/sysconfig/memcached`` file and complete the 2. Edit the ``/etc/sysconfig/memcached`` file and complete the
following actions: following actions:
@ -41,12 +34,9 @@ Install and configure components
Change the existing line ``MEMCACHED_PARAMS="-l 127.0.0.1,::1"``. Change the existing line ``MEMCACHED_PARAMS="-l 127.0.0.1,::1"``.
Finalize installation Finalize installation
--------------------- ---------------------
* Start the Memcached service and configure it to start when the system * Start the Memcached service and configure it to start when the system
boots: boots:
@ -56,4 +46,3 @@ Finalize installation
# systemctl start memcached.service # systemctl start memcached.service
.. end .. end

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

@ -1,5 +1,5 @@
Red Hat Memcached Memcached for RHEL and CentOS
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Identity service authentication mechanism for services uses Memcached The Identity service authentication mechanism for services uses Memcached
to cache tokens. The memcached service typically runs on the controller to cache tokens. The memcached service typically runs on the controller
@ -11,17 +11,11 @@ Install and configure components
#. Install the packages: #. Install the packages:
.. code-block:: console
# yum install memcached python-memcached
.. code-block:: console .. end
# yum install memcached python-memcached
.. end
2. Edit the ``/etc/sysconfig/memcached`` file and complete the 2. Edit the ``/etc/sysconfig/memcached`` file and complete the
following actions: following actions:
@ -40,13 +34,9 @@ Install and configure components
Change the existing line ``OPTIONS="-l 127.0.0.1,::1"``. Change the existing line ``OPTIONS="-l 127.0.0.1,::1"``.
Finalize installation Finalize installation
--------------------- ---------------------
* Start the Memcached service and configure it to start when the system * Start the Memcached service and configure it to start when the system
boots: boots:
@ -56,4 +46,3 @@ Finalize installation
# systemctl start memcached.service # systemctl start memcached.service
.. end .. end

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

@ -1,5 +1,5 @@
Ubuntu Memcached Memcached for Ubuntu
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The Identity service authentication mechanism for services uses Memcached The Identity service authentication mechanism for services uses Memcached
to cache tokens. The memcached service typically runs on the controller to cache tokens. The memcached service typically runs on the controller
@ -12,15 +12,11 @@ Install and configure components
#. Install the packages: #. Install the packages:
.. code-block:: console .. code-block:: console
# apt install memcached python-memcache
.. end
# apt install memcached python-memcache
.. end
2. Edit the ``/etc/memcached.conf`` file and configure the 2. Edit the ``/etc/memcached.conf`` file and configure the
service to use the management IP address of the controller node. service to use the management IP address of the controller node.
@ -36,13 +32,9 @@ Install and configure components
Change the existing line that had ``-l 127.0.0.1``. Change the existing line that had ``-l 127.0.0.1``.
Finalize installation Finalize installation
--------------------- ---------------------
* Restart the Memcached service: * Restart the Memcached service:
.. code-block:: console .. code-block:: console
@ -50,5 +42,3 @@ Finalize installation
# service memcached restart # service memcached restart
.. end .. end

17
doc/install-guide/source/environment-messaging-obs.rst
View File

@ -1,5 +1,5 @@
SUSE Message queue Message queue for SUSE
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
OpenStack uses a :term:`message queue` to coordinate operations and OpenStack uses a :term:`message queue` to coordinate operations and
status information among services. The message queue service typically status information among services. The message queue service typically
@ -19,16 +19,11 @@ Install and configure components
1. Install the package: 1. Install the package:
.. code-block:: console
# zypper install rabbitmq-server
.. end
.. code-block:: console
# zypper install rabbitmq-server
.. end
2. Start the message queue service and configure it to start when the 2. Start the message queue service and configure it to start when the
system boots: system boots:
@ -62,5 +57,3 @@ Install and configure components
Setting permissions for user "openstack" in vhost "/" ... Setting permissions for user "openstack" in vhost "/" ...
.. end .. end

17
doc/install-guide/source/environment-messaging-rdo.rst
View File

@ -1,5 +1,5 @@
Red Hat Message queue Message queue for RHEL and CentOS
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack uses a :term:`message queue` to coordinate operations and OpenStack uses a :term:`message queue` to coordinate operations and
status information among services. The message queue service typically status information among services. The message queue service typically
@ -19,16 +19,11 @@ Install and configure components
1. Install the package: 1. Install the package:
.. code-block:: console
# yum install rabbitmq-server
.. code-block:: console .. end
# yum install rabbitmq-server
.. end
2. Start the message queue service and configure it to start when the 2. Start the message queue service and configure it to start when the
system boots: system boots:
@ -62,5 +57,3 @@ Install and configure components
Setting permissions for user "openstack" in vhost "/" ... Setting permissions for user "openstack" in vhost "/" ...
.. end .. end

17
doc/install-guide/source/environment-messaging-ubuntu.rst
View File

@ -1,5 +1,5 @@
Ubuntu Message queue Message queue for Ubuntu
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack uses a :term:`message queue` to coordinate operations and OpenStack uses a :term:`message queue` to coordinate operations and
status information among services. The message queue service typically status information among services. The message queue service typically
@ -19,17 +19,11 @@ Install and configure components
1. Install the package: 1. Install the package:
.. code-block:: console
.. code-block:: console # apt install rabbitmq-server
# apt install rabbitmq-server
.. end
.. end
2. Add the ``openstack`` user: 2. Add the ``openstack`` user:
@ -53,4 +47,3 @@ Install and configure components
Setting permissions for user "openstack" in vhost "/" ... Setting permissions for user "openstack" in vhost "/" ...
.. end .. end

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

@ -23,50 +23,50 @@ Configure network interfaces
Replace ``INTERFACE_NAME`` with the actual interface name. For example, Replace ``INTERFACE_NAME`` with the actual interface name. For example,
*eth1* or *ens224*. *eth1* or *ens224*.
For Ubuntu or Debian: For Ubuntu:
* Edit the ``/etc/network/interfaces`` file to contain the following: * Edit the ``/etc/network/interfaces`` file to contain the following:
.. path /etc/network/interfaces .. path /etc/network/interfaces
.. code-block:: bash .. code-block:: bash
# The provider network interface # The provider network interface
auto INTERFACE_NAME auto INTERFACE_NAME
iface INTERFACE_NAME inet manual iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up up ip link set dev $IFACE up
down ip link set dev $IFACE down down ip link set dev $IFACE down
.. end .. end
For Red Hat or CentOS: For RHEL or CentOS:
* Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file * Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following: to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys. Do not change the ``HWADDR`` and ``UUID`` keys.
.. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME
.. code-block:: bash .. code-block:: bash
DEVICE=INTERFACE_NAME DEVICE=INTERFACE_NAME
TYPE=Ethernet TYPE=Ethernet
ONBOOT="yes" ONBOOT="yes"
BOOTPROTO="none" BOOTPROTO="none"
.. end .. end
For SUSE: For SUSE:
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to * Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following: contain the following:
.. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME
.. code-block:: bash .. code-block:: bash
STARTMODE='auto' STARTMODE='auto'
BOOTPROTO='static' BOOTPROTO='static'
.. end .. end
#. Reboot the system to activate the changes. #. Reboot the system to activate the changes.

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

@ -19,50 +19,50 @@ Configure network interfaces
Replace ``INTERFACE_NAME`` with the actual interface name. For example, Replace ``INTERFACE_NAME`` with the actual interface name. For example,
*eth1* or *ens224*. *eth1* or *ens224*.
For Ubuntu or Debian: For Ubuntu:
* Edit the ``/etc/network/interfaces`` file to contain the following: * Edit the ``/etc/network/interfaces`` file to contain the following:
.. path /etc/network/interfaces .. path /etc/network/interfaces
.. code-block:: bash .. code-block:: bash
# The provider network interface # The provider network interface
auto INTERFACE_NAME auto INTERFACE_NAME
iface INTERFACE_NAME inet manual iface INTERFACE_NAME inet manual
up ip link set dev $IFACE up up ip link set dev $IFACE up
down ip link set dev $IFACE down down ip link set dev $IFACE down
.. end .. end
For Red Hat or CentOS: For RHEL or CentOS:
* Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file * Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following: to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys. Do not change the ``HWADDR`` and ``UUID`` keys.
.. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME
.. code-block:: ini .. code-block:: ini
DEVICE=INTERFACE_NAME DEVICE=INTERFACE_NAME
TYPE=Ethernet TYPE=Ethernet
ONBOOT="yes" ONBOOT="yes"
BOOTPROTO="none" BOOTPROTO="none"
.. end .. end
For SUSE: For SUSE:
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to * Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following: contain the following:
.. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME
.. code-block:: ini .. code-block:: ini
STARTMODE='auto' STARTMODE='auto'
BOOTPROTO='static' BOOTPROTO='static'
.. end .. end
#. Reboot the system to activate the changes. #. Reboot the system to activate the changes.

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

@ -80,13 +80,13 @@ among the nodes before proceeding further.
.. note:: .. note::
Red Hat and SUSE enables a restrictive :term:`firewall` by RHEL, CentOS and SUSE distributions enable a restrictive :term:`firewall` by
default. During the installation process, certain steps will fail default. During the installation process, certain steps will fail
unless you alter or disable the firewall. For more information unless you alter or disable the firewall. For more information
about securing your environment, refer to the `OpenStack Security about securing your environment, refer to the `OpenStack Security
Guide <https://docs.openstack.org/security-guide/>`_. Guide <https://docs.openstack.org/security-guide/>`_.
Debian and Ubuntu do not enable a restrictive :term:`firewall` by Ubuntu does not enable a restrictive :term:`firewall` by
default. For more information about securing your environment, default. For more information about securing your environment,
refer to the `OpenStack Security Guide refer to the `OpenStack Security Guide
<https://docs.openstack.org/security-guide/>`_. <https://docs.openstack.org/security-guide/>`_.

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

@ -12,11 +12,10 @@ distribution, see the documentation.
.. seealso:: .. seealso::
* `Debian Network Configuration <https://wiki.debian.org/NetworkConfiguration>`__
* `Ubuntu Network Configuration * `Ubuntu Network Configuration
<https://help.ubuntu.com/lts/serverguide/network-configuration.html>`__ <https://help.ubuntu.com/lts/serverguide/network-configuration.html>`__
* `Red Hat Network Configuration * `RHEL 7 Network Configuration
<https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Networking_Guide/sec-Using_the_Command_Line_Interface.html>`__ <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Networking_Guide/sec-Network_Config_Using_CLI.html>`__
* `SLES 12 * `SLES 12
<https://www.suse.com/documentation/sles-12/book_sle_admin/data/sec_basicnet_manconf.html>`__ <https://www.suse.com/documentation/sles-12/book_sle_admin/data/sec_basicnet_manconf.html>`__
or `openSUSE or `openSUSE
@ -84,8 +83,8 @@ the controller node.
.. note:: .. note::
Red Hat and SUSE distributions enable a restrictive RHEL, CentOS and SUSE distributions enable a restrictive
:term:`firewall` by default. Ubuntu and Debian do not. For more :term:`firewall` by default. Ubuntu does not. For more
information about securing your environment, refer to the information about securing your environment, refer to the
`OpenStack Security Guide `OpenStack Security Guide
<https://docs.openstack.org/security-guide/>`_. <https://docs.openstack.org/security-guide/>`_.

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

@ -11,29 +11,29 @@ Install and configure components
1. Install the packages: 1. Install the packages:
For Debian or Ubuntu: For Ubuntu:
.. code-block:: console .. code-block:: console
# apt install chrony # apt install chrony
.. end .. end
For Red Hat or CentOS: For RHEL or CentOS:
.. code-block:: console .. code-block:: console
# yum install chrony # yum install chrony
.. end .. end
For SUSE: For SUSE:
.. code-block:: console .. code-block:: console
# zypper install chrony # zypper install chrony
.. end .. end
2. Edit the ``/etc/chrony/chrony.conf`` file and add, change, or remove 2. Edit the ``/etc/chrony/chrony.conf`` file and add, change, or remove
these keys as necessary for your environment: these keys as necessary for your environment:
@ -69,19 +69,19 @@ Install and configure components
4. Restart the NTP service: 4. Restart the NTP service:
For Debian or Ubuntu: For Ubuntu:
.. code-block:: console .. code-block:: console
# service chrony restart # service chrony restart
.. end .. end
For Red Hat or SUSE: For RHEL, CentOS, or SUSE:
.. code-block:: console .. code-block:: console
# systemctl enable chronyd.service # systemctl enable chronyd.service
# systemctl start chronyd.service # systemctl start chronyd.service
.. end .. end

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

@ -12,27 +12,27 @@ Install and configure components
1. Install the packages. 1. Install the packages.
For Debian or Ubuntu: For Ubuntu:
.. code-block:: console .. code-block:: console
# apt install chrony # apt install chrony
For Red Hat: For RHEL or CentOS:
.. code-block:: console .. code-block:: console
# yum install chrony # yum install chrony
.. end .. end
For SUSE: For SUSE:
.. code-block:: console .. code-block:: console
# zypper install chrony # zypper install chrony
.. end .. end
2. Edit the ``/etc/chrony/chrony.conf`` file and comment out or remove all 2. Edit the ``/etc/chrony/chrony.conf`` file and comment out or remove all
but one ``server`` key. Change it to reference the controller node: but one ``server`` key. Change it to reference the controller node:
@ -48,19 +48,19 @@ Install and configure components
4. Restart the NTP service. 4. Restart the NTP service.
For Debian or Ubuntu: For Ubuntu:
.. code-block:: console .. code-block:: console
# service chrony restart # service chrony restart
.. end .. end
For Red Hat or SUSE: For RHEL, CentOS, or SUSE:
.. code-block:: console .. code-block:: console
# systemctl enable chronyd.service # systemctl enable chronyd.service
# systemctl start chronyd.service # systemctl start chronyd.service
.. end .. end

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

@ -3,10 +3,10 @@
Network Time Protocol (NTP) Network Time Protocol (NTP)
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
You should install Chrony, an implementation of :term:`NTP <Network Time To properly synchronize services among nodes, you can install Chrony, an
Protocol (NTP)>`, to properly synchronize services among nodes. We recommend implementation of :term:`NTP <Network Time Protocol (NTP)>`. We recommend that
that you configure the controller node to reference more accurate (lower you configure the controller node to reference more accurate (lower stratum)
stratum) servers and other nodes to reference the controller node. servers and other nodes to reference the controller node.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

20
doc/install-guide/source/environment-packages-obs.rst
View File

@ -1,5 +1,5 @@
SUSE OpenStack packages OpenStack packages for SUSE
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Distributions release OpenStack packages as part of the distribution or Distributions release OpenStack packages as part of the distribution or
using other methods because of differing release schedules. Perform using other methods because of differing release schedules. Perform
@ -72,18 +72,16 @@ Enable the OpenStack repository
.. end .. end
Finalize the installation Finalize the installation
------------------------- -------------------------
#. Upgrade the packages on all nodes: #. Upgrade the packages on all nodes:
.. code-block:: console .. code-block:: console
# zypper refresh && zypper dist-upgrade # zypper refresh && zypper dist-upgrade
.. end .. end
.. note:: .. note::
@ -92,10 +90,8 @@ Finalize the installation
#. Install the OpenStack client: #. Install the OpenStack client:
.. code-block:: console .. code-block:: console
# zypper install python-openstackclient
.. end
# zypper install python-openstackclient
.. end

36
doc/install-guide/source/environment-packages-rdo.rst
View File

@ -1,5 +1,5 @@
Red Hat OpenStack packages OpenStack packages for RHEL and CentOS
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Distributions release OpenStack packages as part of the distribution or Distributions release OpenStack packages as part of the distribution or
using other methods because of differing release schedules. Perform using other methods because of differing release schedules. Perform
@ -20,8 +20,6 @@ these procedures on all nodes.
Disable or remove any automatic update services because they can Disable or remove any automatic update services because they can
impact your OpenStack environment. impact your OpenStack environment.
Prerequisites Prerequisites
------------- -------------
@ -55,8 +53,6 @@ Prerequisites
.. end .. end
Enable the OpenStack repository Enable the OpenStack repository
------------------------------- -------------------------------
@ -65,9 +61,11 @@ Enable the OpenStack repository
default, so you can simply install the package to enable the OpenStack default, so you can simply install the package to enable the OpenStack
repository. repository.
**When installing the Pike release, run:**
.. code-block:: console .. code-block:: console
# yum install centos-release-openstack-ocata # yum install centos-release-openstack-pike
.. end .. end
@ -80,22 +78,18 @@ Enable the OpenStack repository
.. end .. end
The RDO repository RPM installs the latest available OpenStack release.
Finalize the installation Finalize the installation
------------------------- -------------------------
1. Upgrade the packages on all nodes: 1. Upgrade the packages on all nodes:
.. code-block:: console
# yum upgrade
.. code-block:: console .. end
# yum upgrade
.. end
.. note:: .. note::
@ -104,16 +98,11 @@ Finalize the installation
2. Install the OpenStack client: 2. Install the OpenStack client:
.. code-block:: console
# yum install python-openstackclient
.. code-block:: console .. end
# yum install python-openstackclient
.. end
3. RHEL and CentOS enable :term:`SELinux` by default. Install the 3. RHEL and CentOS enable :term:`SELinux` by default. Install the
``openstack-selinux`` package to automatically manage security ``openstack-selinux`` package to automatically manage security
@ -124,4 +113,3 @@ Finalize the installation
# yum install openstack-selinux # yum install openstack-selinux
.. end .. end

31
doc/install-guide/source/environment-packages-ubuntu.rst
View File

@ -1,5 +1,5 @@
Ubuntu OpenStack packages OpenStack packages for Ubuntu
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Distributions release OpenStack packages as part of the distribution or Distributions release OpenStack packages as part of the distribution or
using other methods because of differing release schedules. Perform using other methods because of differing release schedules. Perform
@ -27,28 +27,20 @@ Enable the OpenStack repository
.. code-block:: console .. code-block:: console
# apt install software-properties-common # apt install software-properties-common
# add-apt-repository cloud-archive:ocata # add-apt-repository cloud-archive:pike
.. end .. end
Finalize the installation Finalize the installation
------------------------- -------------------------
1. Upgrade the packages on all nodes: 1. Upgrade the packages on all nodes:
.. code-block:: console
.. code-block:: console # apt update && apt dist-upgrade
# apt update && apt dist-upgrade
.. end
.. end
.. note:: .. note::
@ -57,13 +49,8 @@ Finalize the installation
2. Install the OpenStack client: 2. Install the OpenStack client:
.. code-block:: console
.. code-block:: console # apt install python-openstackclient
# apt install python-openstackclient
.. end
.. end

4
doc/install-guide/source/environment-security.rst
View File

@ -70,8 +70,8 @@ during installation and operation. In some cases, services perform
modifications to the host that can interfere with deployment automation modifications to the host that can interfere with deployment automation
tools such as Ansible, Chef, and Puppet. For example, some OpenStack tools such as Ansible, Chef, and Puppet. For example, some OpenStack
services add a root wrapper to ``sudo`` that can interfere with security services add a root wrapper to ``sudo`` that can interfere with security
policies. See the `OpenStack Administrator Guide <https://docs.openstack.org/ policies. See the
admin-guide/compute-root-wrap-reference.html>`__ `Compute service documentation for Pike <https://docs.openstack.org/nova/pike/admin/root-wrap-reference.html>`__
for more information. for more information.
The Networking service assumes default values for kernel network The Networking service assumes default values for kernel network

35
doc/install-guide/source/environment-sql-database-obs.rst
View File

@ -1,5 +1,5 @@
SUSE SQL database SQL database for SUSE
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
Most OpenStack services use an SQL database to store information. The Most OpenStack services use an SQL database to store information. The
database typically runs on the controller node. The procedures in this database typically runs on the controller node. The procedures in this
@ -7,25 +7,16 @@ guide use MariaDB or MySQL depending on the distribution. OpenStack
services also support other SQL databases including services also support other SQL databases including
`PostgreSQL <https://www.postgresql.org/>`__. `PostgreSQL <https://www.postgresql.org/>`__.
Install and configure components Install and configure components
-------------------------------- --------------------------------
#. Install the packages: #. Install the packages:
.. code-block:: console
# zypper install mariadb-client mariadb python-PyMySQL
.. end
.. code-block:: console
# zypper install mariadb-client mariadb python-PyMySQL
.. end
2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file 2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file
and complete the following actions: and complete the following actions:
@ -50,25 +41,18 @@ Install and configure components
.. end .. end
Finalize installation Finalize installation
--------------------- ---------------------
#. 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: boots:
.. code-block:: console
# systemctl enable mysql.service
# systemctl start mysql.service
.. code-block:: console .. end
# systemctl enable mysql.service
# systemctl start mysql.service
.. end
2. Secure the database service by running the ``mysql_secure_installation`` 2. Secure the database service by running the ``mysql_secure_installation``
script. In particular, choose a suitable password for the database script. In particular, choose a suitable password for the database
@ -79,4 +63,3 @@ Finalize installation
# mysql_secure_installation # mysql_secure_installation
.. end .. end

35
doc/install-guide/source/environment-sql-database-rdo.rst
View File

@ -1,5 +1,5 @@
Red Hat SQL database SQL database for RHEL and CentOS
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most OpenStack services use an SQL database to store information. The Most OpenStack services use an SQL database to store information. The
database typically runs on the controller node. The procedures in this database typically runs on the controller node. The procedures in this
@ -7,25 +7,16 @@ guide use MariaDB or MySQL depending on the distribution. OpenStack
services also support other SQL databases including services also support other SQL databases including
`PostgreSQL <https://www.postgresql.org/>`__. `PostgreSQL <https://www.postgresql.org/>`__.
Install and configure components Install and configure components
-------------------------------- --------------------------------
#. Install the packages: #. Install the packages:
.. code-block:: console
# yum install mariadb mariadb-server python2-PyMySQL
.. end
.. code-block:: console
# yum install mariadb mariadb-server python2-PyMySQL
.. end
2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file 2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file
and complete the following actions: and complete the following actions:
@ -50,25 +41,18 @@ Install and configure components
.. end .. end
Finalize installation Finalize installation
--------------------- ---------------------
#. 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: boots:
.. code-block:: console
.. code-block:: console # systemctl enable mariadb.service
# systemctl start mariadb.service
# systemctl enable mariadb.service
# systemctl start mariadb.service
.. end
.. end
2. Secure the database service by running the ``mysql_secure_installation`` 2. Secure the database service by running the ``mysql_secure_installation``
script. In particular, choose a suitable password for the database script. In particular, choose a suitable password for the database
@ -79,4 +63,3 @@ Finalize installation
# mysql_secure_installation # mysql_secure_installation
.. end .. end

28
doc/install-guide/source/environment-sql-database-ubuntu.rst
View File

@ -1,5 +1,5 @@
Ubuntu SQL database SQL database for Ubuntu
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Most OpenStack services use an SQL database to store information. The Most OpenStack services use an SQL database to store information. The
database typically runs on the controller node. The procedures in this database typically runs on the controller node. The procedures in this
@ -7,7 +7,6 @@ guide use MariaDB or MySQL depending on the distribution. OpenStack
services also support other SQL databases including services also support other SQL databases including
`PostgreSQL <https://www.postgresql.org/>`__. `PostgreSQL <https://www.postgresql.org/>`__.
.. note:: .. note::
As of Ubuntu 16.04, MariaDB was changed to use As of Ubuntu 16.04, MariaDB was changed to use
@ -17,24 +16,16 @@ services also support other SQL databases including
the root user no longer uses a password for local access to the root user no longer uses a password for local access to
the server. the server.
Install and configure components Install and configure components
-------------------------------- --------------------------------
#. Install the packages: #. Install the packages:
.. code-block:: console
.. code-block:: console # apt install mariadb-server python-pymysql
# apt install mariadb-server python-pymysql
.. end
.. end
2. Create and edit the ``/etc/mysql/mariadb.conf.d/99-openstack.cnf`` file 2. Create and edit the ``/etc/mysql/mariadb.conf.d/99-openstack.cnf`` file
and complete the following actions: and complete the following actions:
@ -55,14 +46,12 @@ Install and configure components
max_connections = 4096 max_connections = 4096
collation-server = utf8_general_ci collation-server = utf8_general_ci
character-set-server = utf8 character-set-server = utf8
.. end .. end
Finalize installation Finalize installation
--------------------- ---------------------
#. Restart the database service: #. Restart the database service:
.. code-block:: console .. code-block:: console
@ -71,10 +60,6 @@ Finalize installation
.. end .. end
2. Secure the database service by running the ``mysql_secure_installation`` 2. Secure the database service by running the ``mysql_secure_installation``
script. In particular, choose a suitable password for the database script. In particular, choose a suitable password for the database
``root`` account: ``root`` account:
@ -84,4 +69,3 @@ Finalize installation
# mysql_secure_installation # mysql_secure_installation
.. end .. end

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

@ -8,8 +8,8 @@ node using the example architecture.
Although most environments include Identity, Image service, Compute, at least Although most environments include Identity, Image service, Compute, at least
one networking service, and the Dashboard, the Object Storage service can one networking service, and the Dashboard, the Object Storage service can
operate independently. If your use case only involves Object Storage, you can operate independently. If your use case only involves Object Storage, you can
skip to `Object Storage Installation Guide skip to `Object Storage Installation Guide for Pike
<https://docs.openstack.org/swift/>`_ <https://docs.openstack.org/swift/pike/install/>`_
after configuring the appropriate nodes for it. after configuring the appropriate nodes for it.
You must use an account with administrative privileges to configure each node. You must use an account with administrative privileges to configure each node.
@ -67,8 +67,8 @@ of nested VMs.
a way to disable MAC address filtering on the provider network a way to disable MAC address filtering on the provider network
interface. interface.
For more information about system requirements, see the `OpenStack For more information about system requirements, see the
Operations Guide <https://docs.openstack.org/ops-guide/>`_. `OpenStack Pike Administrator Guides <https://docs.openstack.org/pike/admin/>`_.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

10
doc/install-guide/source/get-started-with-openstack.rst
View File

@ -13,10 +13,13 @@ through a set of interrelated services. Each service offers an
integration. Depending on your needs, you can install some or all integration. Depending on your needs, you can install some or all
services. services.
The OpenStack services
======================
The following table describes the OpenStack services that make up the The following table describes the OpenStack services that make up the
OpenStack architecture: OpenStack architecture:
.. list-table:: OpenStack Services .. list-table:: The OpenStack services
:header-rows: 1 :header-rows: 1
:widths: 10 10 40 :widths: 10 10 40
@ -81,6 +84,11 @@ OpenStack architecture:
by specifying parameters like Hadoop version, cluster topology and nodes by specifying parameters like Hadoop version, cluster topology and nodes
hardware details. hardware details.
The OpenStack architecture
==========================
The following sections describe the OpenStack architecture in more detail:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

2
doc/install-guide/source/index.rst
View File

@ -5,9 +5,9 @@
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
common/conventions.rst
preface preface
get-started-with-openstack get-started-with-openstack
common/conventions.rst
overview.rst overview.rst
environment.rst environment.rst
openstack-services.rst openstack-services.rst

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

@ -138,8 +138,7 @@ Attach the volume to an instance
to use the volume. to use the volume.
For more information about how to manage volumes, see the For more information about how to manage volumes, see the
`Manage volumes `python-openstackclient documentation for Pike
<https://docs.openstack.org/user-guide/common/cli-manage-volumes.html>`__ <https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/volume.html>`__.
in OpenStack End User Guide.
Return to :ref:`launch-instance`. Return to :ref:`launch-instance`.

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

@ -268,9 +268,9 @@ Access the instance remotely
.. end .. end
If your instance does not launch or seem to work as you expect, see the If your instance does not launch or seem to work as you expect, see the
`Instance Boot Failures `Troubleshoot Compute documentation for Pike
<https://docs.openstack.org/ops-guide/ops-maintenance-compute.html#instances>`__ <https://docs.openstack.org/nova/pike/admin/support-compute.html>`__
section in OpenStack Operations Guide for more information or use one of for more information or use one of
the :doc:`many other options <common/app-support>` the :doc:`many other options <common/app-support>`
to seek assistance. We want your first installation to work! to seek assistance. We want your first installation to work!

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

@ -308,9 +308,9 @@ Access the instance remotely
.. end .. end
If your instance does not launch or seem to work as you expect, see the If your instance does not launch or seem to work as you expect, see the
`Instance Boot Failures `Troubleshoot Compute documentation for Pike
<https://docs.openstack.org/ops-guide/ops-maintenance-compute.html#instances>`__ <https://docs.openstack.org/nova/pike/admin/support-compute.html>`__
section in OpenStack Operations Guide for more information or use one of for more information or use one of
the :doc:`many other options <common/app-support>` the :doc:`many other options <common/app-support>`
to seek assistance. We want your first installation to work! to seek assistance. We want your first installation to work!

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

@ -13,11 +13,11 @@ The instructions in this section use command-line interface (CLI)
tools on the controller node. However, you can follow the instructions tools on the controller node. However, you can follow the instructions
on any host that the tools are installed. on any host that the tools are installed.
For more information on the CLI tools, see the For more information on the CLI tools, see the
`OpenStack End User Guide `OpenStackClient documentation for Pike
<https://docs.openstack.org/user-guide/cli-launch-instances.html>`__. <https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/server.html#server-create>`__.
To use the dashboard, see the To use the dashboard, see the
`OpenStack End User Guide `Dashboard User Documentation for Pike
<https://docs.openstack.org/user-guide/dashboard.html>`__. <https://docs.openstack.org/horizon/pike/user/>`__.
.. _launch-instance-networks: .. _launch-instance-networks:
@ -219,7 +219,8 @@ If your environment includes the Orchestration service, you can create
a stack that launches an instance. a stack that launches an instance.
For more information, see the For more information, see the
`Orchestration installation guide <https://docs.openstack.org/orchestration/>`_. `Orchestration installation guide for Pike
<https://docs.openstack.org/heat/pike/>`_.
Shared File Systems Shared File Systems
------------------- -------------------
@ -228,5 +229,5 @@ If your environment includes the Shared File Systems service, you can create
a share and mount it in an instance. a share and mount it in an instance.
For more information, see the For more information, see the
`Shared File Systems installation guide `Shared File Systems installation guide for Pike
<https://docs.openstack.org/shared-file-system/>`_. <https://docs.openstack.org/manila/pike/>`_.

28
doc/install-guide/source/openstack-services.rst
View File

@ -6,23 +6,29 @@ The installation of individual OpenStack services is covered in the
Project Installation Guides that are available at the following Project Installation Guides that are available at the following
locations: locations:
* `OpenStack Pike Installation Tutorials and Guides * `OpenStack Installation Tutorials and Guides for Pike
<https://docs.openstack.org/pike/install/>`_ <https://docs.openstack.org/pike/install/>`_
.. Note that this guide is release independent, so we will add more .. Note that this guide is release independent, so we will add more
entries to the list above. entries to the list above.
Minimal deployment
==================
At minimal you need to install - in this order - the following At a minimum, you need to install the following services. Install the services
components: in the order specified below:
* Identity service (keystone) * Identity service – `keystone installation for Pike
* Image service (glance) <https://docs.openstack.org/keystone/pike/install/>`_
* Compute service (nova) * Image service – `glance installation for Pike
* Networking service (neutron) <https://docs.openstack.org/glance/pike/install/>`_
* Compute service – `nova installation for Pike
<https://docs.openstack.org/nova/pike/install/>`_
* Networking service – `neutron installation for Pike
<https://docs.openstack.org/neutron/pike/install/>`_
We advise to also install afterwards: We advise to also install the following components after you have installed the
minimal deployment services:
* Dashboard (horizon) * Dashboard – `horizon installation for Pike <https://docs.openstack.org/horizon/pike/install/>`_
* Block Storage service (cinder) * Block Storage service – `cinder installation for Pike <https://docs.openstack.org/cinder/pike/install/>`_

4
doc/install-guide/source/overview.rst
View File

@ -60,8 +60,8 @@ follows:
For more information on production architectures, see the For more information on production architectures, see the
`Architecture Design Guide <https://docs.openstack.org/arch-design/>`_, `Architecture Design Guide <https://docs.openstack.org/arch-design/>`_,
`OpenStack Operations Guide <https://docs.openstack.org/ops-guide/>`_, and `OpenStack Networking Guide for Pike <https://docs.openstack.org/neutron/pike/admin/>`_,
`OpenStack Networking Guide <https://docs.openstack.org/ocata/networking-guide/>`_. and `OpenStack Administrator Guides for Pike <https://docs.openstack.org/pike/admin/>`_.
.. _figure-hwreqs: .. _figure-hwreqs:

18
doc/install-guide/source/preface.rst
View File

@ -36,24 +36,6 @@ Pike release. It will cover multiple releases in the future.
Operating Systems Operating Systems
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
Debian
++++++
This guide walks through an installation by using packages
available through Debian 8 (code name: Jessie).
.. note::
This guide uses installation with debconf set to non-interactive
mode. That is, there will be no debconf prompt. To configure a computer
to use this mode, run the following command:
.. code-block:: console
# dpkg-reconfigure debconf
.. end
openSUSE and SUSE Linux Enterprise Server openSUSE and SUSE Linux Enterprise Server
+++++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++++++