From 7c7791c66da80a21fd6da3803e0b20350af05952 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Mon, 28 Aug 2017 19:33:22 +0200 Subject: [PATCH] [install] General edits for install guide * 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 --- .../source/environment-memcached-obs.rst | 21 ++----- .../source/environment-memcached-rdo.rst | 21 ++----- .../source/environment-memcached-ubuntu.rst | 20 ++----- .../source/environment-messaging-obs.rst | 17 ++---- .../source/environment-messaging-rdo.rst | 17 ++---- .../source/environment-messaging-ubuntu.rst | 17 ++---- .../source/environment-networking-compute.rst | 56 +++++++++---------- .../environment-networking-controller.rst | 56 +++++++++---------- .../source/environment-networking-verify.rst | 4 +- .../source/environment-networking.rst | 9 ++- .../source/environment-ntp-controller.rst | 40 ++++++------- .../source/environment-ntp-other.rst | 38 ++++++------- doc/install-guide/source/environment-ntp.rst | 8 +-- .../source/environment-packages-obs.rst | 20 +++---- .../source/environment-packages-rdo.rst | 36 ++++-------- .../source/environment-packages-ubuntu.rst | 31 +++------- .../source/environment-security.rst | 4 +- .../source/environment-sql-database-obs.rst | 35 +++--------- .../source/environment-sql-database-rdo.rst | 35 +++--------- .../environment-sql-database-ubuntu.rst | 28 ++-------- doc/install-guide/source/environment.rst | 8 +-- .../source/get-started-with-openstack.rst | 10 +++- doc/install-guide/source/index.rst | 2 +- .../source/launch-instance-cinder.rst | 5 +- .../source/launch-instance-provider.rst | 6 +- .../source/launch-instance-selfservice.rst | 6 +- doc/install-guide/source/launch-instance.rst | 15 ++--- .../source/openstack-services.rst | 28 ++++++---- doc/install-guide/source/overview.rst | 4 +- doc/install-guide/source/preface.rst | 18 ------ 30 files changed, 239 insertions(+), 376 deletions(-) diff --git a/doc/install-guide/source/environment-memcached-obs.rst b/doc/install-guide/source/environment-memcached-obs.rst index 1c490e9acd..80adabfe9d 100644 --- a/doc/install-guide/source/environment-memcached-obs.rst +++ b/doc/install-guide/source/environment-memcached-obs.rst @@ -1,5 +1,5 @@ -SUSE Memcached -~~~~~~~~~~~~~~ +Memcached for SUSE +~~~~~~~~~~~~~~~~~~ The Identity service authentication mechanism for services uses Memcached to cache tokens. The memcached service typically runs on the controller @@ -11,18 +11,11 @@ Install and configure components #. Install the packages: + .. code-block:: console + # zypper install memcached python-python-memcached - -.. code-block:: console - - # zypper install memcached python-python-memcached - -.. end - - - - + .. end 2. Edit the ``/etc/sysconfig/memcached`` file and complete the following actions: @@ -41,12 +34,9 @@ Install and configure components Change the existing line ``MEMCACHED_PARAMS="-l 127.0.0.1,::1"``. - Finalize installation --------------------- - - * Start the Memcached service and configure it to start when the system boots: @@ -56,4 +46,3 @@ Finalize installation # systemctl start memcached.service .. end - diff --git a/doc/install-guide/source/environment-memcached-rdo.rst b/doc/install-guide/source/environment-memcached-rdo.rst index a350bf951e..b793c92329 100644 --- a/doc/install-guide/source/environment-memcached-rdo.rst +++ b/doc/install-guide/source/environment-memcached-rdo.rst @@ -1,5 +1,5 @@ -Red Hat Memcached -~~~~~~~~~~~~~~~~~ +Memcached for RHEL and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The Identity service authentication mechanism for services uses Memcached to cache tokens. The memcached service typically runs on the controller @@ -11,17 +11,11 @@ Install and configure components #. Install the packages: + .. code-block:: console + # yum install memcached python-memcached -.. code-block:: console - - # yum install memcached python-memcached - -.. end - - - - + .. end 2. Edit the ``/etc/sysconfig/memcached`` file and complete the following actions: @@ -40,13 +34,9 @@ Install and configure components Change the existing line ``OPTIONS="-l 127.0.0.1,::1"``. - - Finalize installation --------------------- - - * Start the Memcached service and configure it to start when the system boots: @@ -56,4 +46,3 @@ Finalize installation # systemctl start memcached.service .. end - diff --git a/doc/install-guide/source/environment-memcached-ubuntu.rst b/doc/install-guide/source/environment-memcached-ubuntu.rst index fe9292d598..9c43cb3584 100644 --- a/doc/install-guide/source/environment-memcached-ubuntu.rst +++ b/doc/install-guide/source/environment-memcached-ubuntu.rst @@ -1,5 +1,5 @@ -Ubuntu Memcached -~~~~~~~~~~~~~~~~ +Memcached for Ubuntu +~~~~~~~~~~~~~~~~~~~~ The Identity service authentication mechanism for services uses Memcached to cache tokens. The memcached service typically runs on the controller @@ -12,15 +12,11 @@ Install and configure components #. Install the packages: -.. code-block:: console - - # apt install memcached python-memcache - -.. end - - + .. code-block:: console + # apt install memcached python-memcache + .. end 2. Edit the ``/etc/memcached.conf`` file and configure the 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``. - - - Finalize installation --------------------- - * Restart the Memcached service: .. code-block:: console @@ -50,5 +42,3 @@ Finalize installation # service memcached restart .. end - - diff --git a/doc/install-guide/source/environment-messaging-obs.rst b/doc/install-guide/source/environment-messaging-obs.rst index 195144c448..e658f6c444 100644 --- a/doc/install-guide/source/environment-messaging-obs.rst +++ b/doc/install-guide/source/environment-messaging-obs.rst @@ -1,5 +1,5 @@ -SUSE Message queue -~~~~~~~~~~~~~~~~~~ +Message queue for SUSE +~~~~~~~~~~~~~~~~~~~~~~ OpenStack uses a :term:`message queue` to coordinate operations and status information among services. The message queue service typically @@ -19,16 +19,11 @@ Install and configure components 1. Install the package: + .. code-block:: console + # zypper install rabbitmq-server - -.. code-block:: console - - # zypper install rabbitmq-server - -.. end - - + .. end 2. Start the message queue service and configure it to start when the system boots: @@ -62,5 +57,3 @@ Install and configure components Setting permissions for user "openstack" in vhost "/" ... .. end - - diff --git a/doc/install-guide/source/environment-messaging-rdo.rst b/doc/install-guide/source/environment-messaging-rdo.rst index e3615b5b3c..5c94944f6e 100644 --- a/doc/install-guide/source/environment-messaging-rdo.rst +++ b/doc/install-guide/source/environment-messaging-rdo.rst @@ -1,5 +1,5 @@ -Red Hat Message queue -~~~~~~~~~~~~~~~~~~~~~ +Message queue for RHEL and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ OpenStack uses a :term:`message queue` to coordinate operations and status information among services. The message queue service typically @@ -19,16 +19,11 @@ Install and configure components 1. Install the package: + .. code-block:: console + # yum install rabbitmq-server -.. code-block:: console - - # yum install rabbitmq-server - -.. end - - - + .. end 2. Start the message queue service and configure it to start when the system boots: @@ -62,5 +57,3 @@ Install and configure components Setting permissions for user "openstack" in vhost "/" ... .. end - - diff --git a/doc/install-guide/source/environment-messaging-ubuntu.rst b/doc/install-guide/source/environment-messaging-ubuntu.rst index 9b11f1007b..a31f5a077a 100644 --- a/doc/install-guide/source/environment-messaging-ubuntu.rst +++ b/doc/install-guide/source/environment-messaging-ubuntu.rst @@ -1,5 +1,5 @@ -Ubuntu Message queue -~~~~~~~~~~~~~~~~~~~~ +Message queue for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~~ OpenStack uses a :term:`message queue` to coordinate operations and status information among services. The message queue service typically @@ -19,17 +19,11 @@ Install and configure components 1. Install the package: + .. code-block:: console -.. code-block:: console - - # apt install rabbitmq-server - -.. end - - - - + # apt install rabbitmq-server + .. end 2. Add the ``openstack`` user: @@ -53,4 +47,3 @@ Install and configure components Setting permissions for user "openstack" in vhost "/" ... .. end - diff --git a/doc/install-guide/source/environment-networking-compute.rst b/doc/install-guide/source/environment-networking-compute.rst index 7e169c8bf7..df5b2271d5 100644 --- a/doc/install-guide/source/environment-networking-compute.rst +++ b/doc/install-guide/source/environment-networking-compute.rst @@ -23,50 +23,50 @@ Configure network interfaces Replace ``INTERFACE_NAME`` with the actual interface name. For example, *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 - .. code-block:: bash + .. path /etc/network/interfaces + .. code-block:: bash - # The provider 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 provider network interface + auto INTERFACE_NAME + iface INTERFACE_NAME inet manual + up ip link set dev $IFACE up + 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 - 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. - .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME - .. code-block:: bash + .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME + .. code-block:: bash - DEVICE=INTERFACE_NAME - TYPE=Ethernet - ONBOOT="yes" - BOOTPROTO="none" + DEVICE=INTERFACE_NAME + TYPE=Ethernet + ONBOOT="yes" + BOOTPROTO="none" - .. end + .. end For SUSE: - * 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: - .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME - .. code-block:: bash + .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME + .. code-block:: bash - STARTMODE='auto' - BOOTPROTO='static' + STARTMODE='auto' + BOOTPROTO='static' - .. end + .. end #. Reboot the system to activate the changes. diff --git a/doc/install-guide/source/environment-networking-controller.rst b/doc/install-guide/source/environment-networking-controller.rst index 334e178c70..ebf63d8c51 100644 --- a/doc/install-guide/source/environment-networking-controller.rst +++ b/doc/install-guide/source/environment-networking-controller.rst @@ -19,50 +19,50 @@ Configure network interfaces Replace ``INTERFACE_NAME`` with the actual interface name. For example, *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 - .. code-block:: bash + .. path /etc/network/interfaces + .. code-block:: bash - # The provider 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 provider network interface + auto INTERFACE_NAME + iface INTERFACE_NAME inet manual + up ip link set dev $IFACE up + 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 - 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. - .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME - .. code-block:: ini + .. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME + .. code-block:: ini - DEVICE=INTERFACE_NAME - TYPE=Ethernet - ONBOOT="yes" - BOOTPROTO="none" + DEVICE=INTERFACE_NAME + TYPE=Ethernet + ONBOOT="yes" + BOOTPROTO="none" - .. end + .. end For SUSE: - * 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: - .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME - .. code-block:: ini + .. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME + .. code-block:: ini - STARTMODE='auto' - BOOTPROTO='static' + STARTMODE='auto' + BOOTPROTO='static' - .. end + .. end #. Reboot the system to activate the changes. diff --git a/doc/install-guide/source/environment-networking-verify.rst b/doc/install-guide/source/environment-networking-verify.rst index 24da9c8bae..3d333a94e1 100644 --- a/doc/install-guide/source/environment-networking-verify.rst +++ b/doc/install-guide/source/environment-networking-verify.rst @@ -80,13 +80,13 @@ among the nodes before proceeding further. .. 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 unless you alter or disable the firewall. For more information about securing your environment, refer to the `OpenStack 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, refer to the `OpenStack Security Guide `_. diff --git a/doc/install-guide/source/environment-networking.rst b/doc/install-guide/source/environment-networking.rst index ac9b7aa155..f996f28ab8 100644 --- a/doc/install-guide/source/environment-networking.rst +++ b/doc/install-guide/source/environment-networking.rst @@ -12,11 +12,10 @@ distribution, see the documentation. .. seealso:: - * `Debian Network Configuration `__ * `Ubuntu Network Configuration `__ - * `Red Hat Network Configuration - `__ + * `RHEL 7 Network Configuration + `__ * `SLES 12 `__ or `openSUSE @@ -84,8 +83,8 @@ the controller node. .. note:: - Red Hat and SUSE distributions enable a restrictive - :term:`firewall` by default. Ubuntu and Debian do not. For more + RHEL, CentOS and SUSE distributions enable a restrictive + :term:`firewall` by default. Ubuntu does not. For more information about securing your environment, refer to the `OpenStack Security Guide `_. diff --git a/doc/install-guide/source/environment-ntp-controller.rst b/doc/install-guide/source/environment-ntp-controller.rst index b7866e5df6..203f094c1d 100644 --- a/doc/install-guide/source/environment-ntp-controller.rst +++ b/doc/install-guide/source/environment-ntp-controller.rst @@ -11,29 +11,29 @@ Install and configure components 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: - .. 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 these keys as necessary for your environment: @@ -69,19 +69,19 @@ Install and configure components 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 start chronyd.service + # systemctl enable chronyd.service + # systemctl start chronyd.service - .. end + .. end diff --git a/doc/install-guide/source/environment-ntp-other.rst b/doc/install-guide/source/environment-ntp-other.rst index 089723de0b..99afd736b9 100644 --- a/doc/install-guide/source/environment-ntp-other.rst +++ b/doc/install-guide/source/environment-ntp-other.rst @@ -12,27 +12,27 @@ Install and configure components 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: - .. 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 but one ``server`` key. Change it to reference the controller node: @@ -48,19 +48,19 @@ Install and configure components 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 start chronyd.service + # systemctl enable chronyd.service + # systemctl start chronyd.service - .. end + .. end diff --git a/doc/install-guide/source/environment-ntp.rst b/doc/install-guide/source/environment-ntp.rst index 40aa60ae1e..eba8f709bd 100644 --- a/doc/install-guide/source/environment-ntp.rst +++ b/doc/install-guide/source/environment-ntp.rst @@ -3,10 +3,10 @@ Network Time Protocol (NTP) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You should install Chrony, an implementation of :term:`NTP `, to properly synchronize services among nodes. We recommend -that you configure the controller node to reference more accurate (lower -stratum) servers and other nodes to reference the controller node. +To properly synchronize services among nodes, you can install Chrony, an +implementation of :term:`NTP `. We recommend that +you configure the controller node to reference more accurate (lower stratum) +servers and other nodes to reference the controller node. .. toctree:: :maxdepth: 1 diff --git a/doc/install-guide/source/environment-packages-obs.rst b/doc/install-guide/source/environment-packages-obs.rst index 3bc965b85c..c4d35a50c4 100644 --- a/doc/install-guide/source/environment-packages-obs.rst +++ b/doc/install-guide/source/environment-packages-obs.rst @@ -1,5 +1,5 @@ -SUSE OpenStack packages -~~~~~~~~~~~~~~~~~~~~~~~ +OpenStack packages for SUSE +~~~~~~~~~~~~~~~~~~~~~~~~~~~ Distributions release OpenStack packages as part of the distribution or using other methods because of differing release schedules. Perform @@ -72,18 +72,16 @@ Enable the OpenStack repository .. end - - Finalize the installation ------------------------- #. 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:: @@ -92,10 +90,8 @@ Finalize the installation #. Install the OpenStack client: -.. code-block:: console - - # zypper install python-openstackclient - -.. end + .. code-block:: console + # zypper install python-openstackclient + .. end diff --git a/doc/install-guide/source/environment-packages-rdo.rst b/doc/install-guide/source/environment-packages-rdo.rst index 688a717699..fd60613c11 100644 --- a/doc/install-guide/source/environment-packages-rdo.rst +++ b/doc/install-guide/source/environment-packages-rdo.rst @@ -1,5 +1,5 @@ -Red Hat OpenStack packages -~~~~~~~~~~~~~~~~~~~~~~~~~~ +OpenStack packages for RHEL and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Distributions release OpenStack packages as part of the distribution or 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 impact your OpenStack environment. - - Prerequisites ------------- @@ -55,8 +53,6 @@ Prerequisites .. end - - Enable the OpenStack repository ------------------------------- @@ -65,9 +61,11 @@ Enable the OpenStack repository default, so you can simply install the package to enable the OpenStack repository. + **When installing the Pike release, run:** + .. code-block:: console - # yum install centos-release-openstack-ocata + # yum install centos-release-openstack-pike .. end @@ -80,22 +78,18 @@ Enable the OpenStack repository .. end - + The RDO repository RPM installs the latest available OpenStack release. Finalize the installation ------------------------- 1. Upgrade the packages on all nodes: + .. code-block:: console + # yum upgrade -.. code-block:: console - - # yum upgrade - -.. end - - + .. end .. note:: @@ -104,16 +98,11 @@ Finalize the installation 2. Install the OpenStack client: + .. code-block:: console + # yum install python-openstackclient -.. code-block:: console - - # yum install python-openstackclient - -.. end - - - + .. end 3. RHEL and CentOS enable :term:`SELinux` by default. Install the ``openstack-selinux`` package to automatically manage security @@ -124,4 +113,3 @@ Finalize the installation # yum install openstack-selinux .. end - diff --git a/doc/install-guide/source/environment-packages-ubuntu.rst b/doc/install-guide/source/environment-packages-ubuntu.rst index d2bd189853..d6681978b9 100644 --- a/doc/install-guide/source/environment-packages-ubuntu.rst +++ b/doc/install-guide/source/environment-packages-ubuntu.rst @@ -1,5 +1,5 @@ -Ubuntu OpenStack packages -~~~~~~~~~~~~~~~~~~~~~~~~~ +OpenStack packages for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Distributions release OpenStack packages as part of the distribution or using other methods because of differing release schedules. Perform @@ -27,28 +27,20 @@ Enable the OpenStack repository .. code-block:: console # apt install software-properties-common - # add-apt-repository cloud-archive:ocata + # add-apt-repository cloud-archive:pike .. end - - - - Finalize the installation ------------------------- 1. Upgrade the packages on all nodes: + .. code-block:: console -.. code-block:: console - - # apt update && apt dist-upgrade - -.. end - - + # apt update && apt dist-upgrade + .. end .. note:: @@ -57,13 +49,8 @@ Finalize the installation 2. Install the OpenStack client: + .. code-block:: console -.. code-block:: console - - # apt install python-openstackclient - -.. end - - - + # apt install python-openstackclient + .. end diff --git a/doc/install-guide/source/environment-security.rst b/doc/install-guide/source/environment-security.rst index 0c7f3ae125..c9be3a5e5c 100644 --- a/doc/install-guide/source/environment-security.rst +++ b/doc/install-guide/source/environment-security.rst @@ -70,8 +70,8 @@ during installation and operation. In some cases, services perform modifications to the host that can interfere with deployment automation tools such as Ansible, Chef, and Puppet. For example, some OpenStack services add a root wrapper to ``sudo`` that can interfere with security -policies. See the `OpenStack Administrator Guide `__ +policies. See the +`Compute service documentation for Pike `__ for more information. The Networking service assumes default values for kernel network diff --git a/doc/install-guide/source/environment-sql-database-obs.rst b/doc/install-guide/source/environment-sql-database-obs.rst index 382155b3a5..e9d5269568 100644 --- a/doc/install-guide/source/environment-sql-database-obs.rst +++ b/doc/install-guide/source/environment-sql-database-obs.rst @@ -1,5 +1,5 @@ -SUSE SQL database -~~~~~~~~~~~~~~~~~ +SQL database for SUSE +~~~~~~~~~~~~~~~~~~~~~ Most OpenStack services use an SQL database to store information. The 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 `PostgreSQL `__. - Install and configure components -------------------------------- #. Install the packages: + .. code-block:: console + # zypper install mariadb-client mariadb python-PyMySQL - - -.. code-block:: console - - # zypper install mariadb-client mariadb python-PyMySQL - -.. end - - - - + .. end 2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file and complete the following actions: @@ -50,25 +41,18 @@ Install and configure components .. end - Finalize installation --------------------- - - #. Start the database service and configure it to start when the system boots: + .. code-block:: console + # systemctl enable mysql.service + # systemctl start mysql.service -.. code-block:: console - - # systemctl enable mysql.service - # systemctl start mysql.service - -.. end - - + .. end 2. Secure the database service by running the ``mysql_secure_installation`` script. In particular, choose a suitable password for the database @@ -79,4 +63,3 @@ Finalize installation # mysql_secure_installation .. end - diff --git a/doc/install-guide/source/environment-sql-database-rdo.rst b/doc/install-guide/source/environment-sql-database-rdo.rst index f621f80366..1f192e6cb2 100644 --- a/doc/install-guide/source/environment-sql-database-rdo.rst +++ b/doc/install-guide/source/environment-sql-database-rdo.rst @@ -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 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 `PostgreSQL `__. - Install and configure components -------------------------------- #. Install the packages: + .. code-block:: console + # yum install mariadb mariadb-server python2-PyMySQL - -.. code-block:: console - - # yum install mariadb mariadb-server python2-PyMySQL - -.. end - - - - - + .. end 2. Create and edit the ``/etc/my.cnf.d/openstack.cnf`` file and complete the following actions: @@ -50,25 +41,18 @@ Install and configure components .. end - Finalize installation --------------------- - - #. Start the database service and configure it to start when the system boots: + .. code-block:: console -.. code-block:: console - - # systemctl enable mariadb.service - # systemctl start mariadb.service - -.. end - - + # systemctl enable mariadb.service + # systemctl start mariadb.service + .. end 2. Secure the database service by running the ``mysql_secure_installation`` script. In particular, choose a suitable password for the database @@ -79,4 +63,3 @@ Finalize installation # mysql_secure_installation .. end - diff --git a/doc/install-guide/source/environment-sql-database-ubuntu.rst b/doc/install-guide/source/environment-sql-database-ubuntu.rst index 0deaa718a3..08f7280407 100644 --- a/doc/install-guide/source/environment-sql-database-ubuntu.rst +++ b/doc/install-guide/source/environment-sql-database-ubuntu.rst @@ -1,5 +1,5 @@ -Ubuntu SQL database -~~~~~~~~~~~~~~~~~~~ +SQL database for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~ Most OpenStack services use an SQL database to store information. The 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 `PostgreSQL `__. - .. note:: 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 server. - Install and configure components -------------------------------- #. Install the packages: + .. code-block:: console -.. code-block:: console - - # apt install mariadb-server python-pymysql - -.. end - - - - - + # apt install mariadb-server python-pymysql + .. end 2. Create and edit the ``/etc/mysql/mariadb.conf.d/99-openstack.cnf`` file and complete the following actions: @@ -55,14 +46,12 @@ Install and configure components max_connections = 4096 collation-server = utf8_general_ci character-set-server = utf8 + .. end - - Finalize installation --------------------- - #. Restart the database service: .. code-block:: console @@ -71,10 +60,6 @@ Finalize installation .. end - - - - 2. Secure the database service by running the ``mysql_secure_installation`` script. In particular, choose a suitable password for the database ``root`` account: @@ -84,4 +69,3 @@ Finalize installation # mysql_secure_installation .. end - diff --git a/doc/install-guide/source/environment.rst b/doc/install-guide/source/environment.rst index 7ef6cc7aa9..834aff1e77 100644 --- a/doc/install-guide/source/environment.rst +++ b/doc/install-guide/source/environment.rst @@ -8,8 +8,8 @@ node using the example architecture. Although most environments include Identity, Image service, Compute, at least one networking service, and the Dashboard, the Object Storage service 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 +`_ after configuring the appropriate nodes for it. 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 interface. -For more information about system requirements, see the `OpenStack -Operations Guide `_. +For more information about system requirements, see the +`OpenStack Pike Administrator Guides `_. .. toctree:: :maxdepth: 1 diff --git a/doc/install-guide/source/get-started-with-openstack.rst b/doc/install-guide/source/get-started-with-openstack.rst index f859e492a4..c26fc365f5 100644 --- a/doc/install-guide/source/get-started-with-openstack.rst +++ b/doc/install-guide/source/get-started-with-openstack.rst @@ -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 services. +The OpenStack services +====================== + The following table describes the OpenStack services that make up the OpenStack architecture: -.. list-table:: OpenStack Services +.. list-table:: The OpenStack services :header-rows: 1 :widths: 10 10 40 @@ -81,6 +84,11 @@ OpenStack architecture: by specifying parameters like Hadoop version, cluster topology and nodes hardware details. +The OpenStack architecture +========================== + +The following sections describe the OpenStack architecture in more detail: + .. toctree:: :maxdepth: 2 diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index fdd99243fc..ce06ee9d9e 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -5,9 +5,9 @@ .. toctree:: :maxdepth: 3 + common/conventions.rst preface get-started-with-openstack - common/conventions.rst overview.rst environment.rst openstack-services.rst diff --git a/doc/install-guide/source/launch-instance-cinder.rst b/doc/install-guide/source/launch-instance-cinder.rst index 050b61c958..6f03ad8469 100644 --- a/doc/install-guide/source/launch-instance-cinder.rst +++ b/doc/install-guide/source/launch-instance-cinder.rst @@ -138,8 +138,7 @@ Attach the volume to an instance to use the volume. For more information about how to manage volumes, see the -`Manage volumes -`__ -in OpenStack End User Guide. +`python-openstackclient documentation for Pike +`__. Return to :ref:`launch-instance`. diff --git a/doc/install-guide/source/launch-instance-provider.rst b/doc/install-guide/source/launch-instance-provider.rst index 3636824668..d50d6d2cb3 100644 --- a/doc/install-guide/source/launch-instance-provider.rst +++ b/doc/install-guide/source/launch-instance-provider.rst @@ -268,9 +268,9 @@ Access the instance remotely .. end If your instance does not launch or seem to work as you expect, see the -`Instance Boot Failures -`__ -section in OpenStack Operations Guide for more information or use one of +`Troubleshoot Compute documentation for Pike +`__ +for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance-selfservice.rst b/doc/install-guide/source/launch-instance-selfservice.rst index 2da502c07a..4378be90ba 100644 --- a/doc/install-guide/source/launch-instance-selfservice.rst +++ b/doc/install-guide/source/launch-instance-selfservice.rst @@ -308,9 +308,9 @@ Access the instance remotely .. end If your instance does not launch or seem to work as you expect, see the -`Instance Boot Failures -`__ -section in OpenStack Operations Guide for more information or use one of +`Troubleshoot Compute documentation for Pike +`__ +for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance.rst b/doc/install-guide/source/launch-instance.rst index 25f3cc50b6..7931c2d577 100644 --- a/doc/install-guide/source/launch-instance.rst +++ b/doc/install-guide/source/launch-instance.rst @@ -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 on any host that the tools are installed. For more information on the CLI tools, see the -`OpenStack End User Guide -`__. +`OpenStackClient documentation for Pike +`__. To use the dashboard, see the -`OpenStack End User Guide -`__. +`Dashboard User Documentation for Pike +`__. .. _launch-instance-networks: @@ -219,7 +219,8 @@ If your environment includes the Orchestration service, you can create a stack that launches an instance. For more information, see the -`Orchestration installation guide `_. +`Orchestration installation guide for Pike +`_. 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. For more information, see the -`Shared File Systems installation guide -`_. +`Shared File Systems installation guide for Pike +`_. diff --git a/doc/install-guide/source/openstack-services.rst b/doc/install-guide/source/openstack-services.rst index 23262ba3c2..03c9147cb9 100644 --- a/doc/install-guide/source/openstack-services.rst +++ b/doc/install-guide/source/openstack-services.rst @@ -6,23 +6,29 @@ The installation of individual OpenStack services is covered in the Project Installation Guides that are available at the following locations: -* `OpenStack Pike Installation Tutorials and Guides +* `OpenStack Installation Tutorials and Guides for Pike `_ - .. Note that this guide is release independent, so we will add more entries to the list above. +Minimal deployment +================== -At minimal you need to install - in this order - the following -components: +At a minimum, you need to install the following services. Install the services +in the order specified below: -* Identity service (keystone) -* Image service (glance) -* Compute service (nova) -* Networking service (neutron) +* Identity service – `keystone installation for Pike + `_ +* Image service – `glance installation for Pike + `_ +* Compute service – `nova installation for Pike + `_ +* Networking service – `neutron installation for Pike + `_ -We advise to also install afterwards: +We advise to also install the following components after you have installed the +minimal deployment services: -* Dashboard (horizon) -* Block Storage service (cinder) +* Dashboard – `horizon installation for Pike `_ +* Block Storage service – `cinder installation for Pike `_ diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 23d2464826..1f82627207 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -60,8 +60,8 @@ follows: For more information on production architectures, see the `Architecture Design Guide `_, -`OpenStack Operations Guide `_, and -`OpenStack Networking Guide `_. +`OpenStack Networking Guide for Pike `_, +and `OpenStack Administrator Guides for Pike `_. .. _figure-hwreqs: diff --git a/doc/install-guide/source/preface.rst b/doc/install-guide/source/preface.rst index 029e7a3f7b..16c4965809 100644 --- a/doc/install-guide/source/preface.rst +++ b/doc/install-guide/source/preface.rst @@ -36,24 +36,6 @@ Pike release. It will cover multiple releases in the future. 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 +++++++++++++++++++++++++++++++++++++++++