From a10df9b8b2b368c8a212da36bea4fe67649df708 Mon Sep 17 00:00:00 2001 From: Karen Bradshaw Date: Fri, 17 Jul 2015 14:40:23 -0400 Subject: [PATCH] Install guide packages, prereqs to RST -Converts Basic Environment packages and prerequisites sections from DocBook to RST. Change-Id: I3f65fe73c3fd5dbfb7ee64db42b38cd22569d5cd Implements: blueprint installguide-liberty --- .../source/basic_environment.rst | 7 +- .../source/basics-packages.rst | 237 ++++++++++++++++++ .../source/basics-prerequisites.rst | 54 ++++ 3 files changed, 296 insertions(+), 2 deletions(-) create mode 100644 doc/install-guide-rst/source/basics-packages.rst create mode 100644 doc/install-guide-rst/source/basics-prerequisites.rst diff --git a/doc/install-guide-rst/source/basic_environment.rst b/doc/install-guide-rst/source/basic_environment.rst index 499bee3ead..d3c3d288d4 100644 --- a/doc/install-guide-rst/source/basic_environment.rst +++ b/doc/install-guide-rst/source/basic_environment.rst @@ -38,20 +38,23 @@ and three-node architecture with OpenStack Networking files. This warning can be ignored. +.. include:: basics-prerequisites.rst .. include:: basics-security.rst +.. include:: basics-packages.rst .. include:: basics-database.rst .. include:: basics-queue.rst + .. toctree:: :hidden: + basics-prerequisites.rst basics-security.rst + basics-packages.rst basics-database.rst basics-queue.rst .. TODO(karenb) - section_basics-prerequisites.xml section_basics-networking.xml section_basics-ntp.xml - section_basics-packages.xml diff --git a/doc/install-guide-rst/source/basics-packages.rst b/doc/install-guide-rst/source/basics-packages.rst new file mode 100644 index 0000000000..37a71852a8 --- /dev/null +++ b/doc/install-guide-rst/source/basics-packages.rst @@ -0,0 +1,237 @@ +OpenStack packages +~~~~~~~~~~~~~~~~~~ + +Distributions release OpenStack packages as part of the distribution or +using other methods because of differing release schedules. Perform +these procedures on all nodes. + +.. note:: + + Disable or remove any automatic update services because they can + impact your OpenStack environment. + +.. only:: ubuntu + + **To enable the OpenStack repository** + + * Install the Ubuntu Cloud archive keyring and repository: + + .. code-block:: console + + # apt-get install ubuntu-cloud-keyring + # echo "deb http://ubuntu-cloud.archive.canonical.com/ubuntu" \ + "trusty-updates/kilo main" > /etc/apt/sources.list.d/ \ + cloudarchive-kilo.list + +.. only:: rdo + + **To configure prerequisites** + + #. On RHEL and CentOS, enable the + `EPEL `_ repository: + + .. code-block:: console + + # yum install http://dl.fedoraproject.org/pub/epel/7/x86_64/e/epel-release-7-5.noarch.rpm + + .. note:: + + Fedora does not require this repository. + + #. On RHEL, enable additional repositories using the subscription + manager: + + .. code-block:: console + + # subscription-manager repos --enable=rhel-7-server-optional-rpms + # subscription-manager repos --enable=rhel-7-server-extras-rpms + + .. note:: + + CentOS and Fedora do not require these repositories. + +.. only:: rdo + + **To enable the OpenStack repository** + + + * Install the ``rdo-release-kilo`` package to enable the RDO repository: + + .. code-block:: console + + # yum install http://rdo.fedorapeople.org/openstack-kilo/rdo-release-kilo.rpm + +.. only:: obs + + **To enable the OpenStack repository** + + * Enable the Open Build Service repositories based on your openSUSE or + SLES version: + + **On openSUSE 13.2:** + + .. code-block:: console + + # zypper addrepo -f obs://Cloud:OpenStack:Kilo/openSUSE_13.2 Kilo + + The openSUSE distribution uses the concept of patterns to represent + collections of packages. If you selected 'Minimal Server Selection (Text + Mode)' during the initial installation, you may be presented with a + dependency conflict when you attempt to install the OpenStack packages. + To avoid this, remove the minimal\_base-conflicts package: + + .. code-block:: console + + # zypper rm patterns-openSUSE-minimal_base-conflicts + + **On SLES 12:** + + .. code-block:: console + + # zypper addrepo -f obs://Cloud:OpenStack:Kilo/SLE_12 Kilo + + .. note:: + + The packages are signed by GPG key 893A90DAD85F9316. You should + verify the fingerprint of the imported GPG key before using it. + + :: + + Key ID: 893A90DAD85F9316 + Key Name: Cloud:OpenStack OBS Project + Key Fingerprint: 35B34E18ABC1076D66D5A86B893A90DAD85F9316 + Key Created: Tue Oct 8 13:34:21 2013 + Key Expires: Thu Dec 17 13:34:21 2015 + +.. only:: debian + + ** To use the Debian Wheezy backports archive for Juno** + + The Juno release is available only in Debian Experimental (otherwise + called rc-buggy), as Jessie is frozen soon, and will contain Icehouse. + However, the Debian maintainers of OpenStack also maintain a + non-official Debian repository for OpenStack containing Wheezy + backports. + + #. On all nodes, install the Debian Wheezy backport repository Juno: + + .. code-block:: console + + # echo "deb http://archive.gplhost.com/debian juno-backports main" \ + >>/etc/apt/sources.list + + #. Install the Debian Wheezy OpenStack repository for Juno: + + .. code-block:: console + + # echo "deb http://archive.gplhost.com/debian juno-backports main" \ + >>/etc/apt/sources.list + + #. Update the repository database and install the key: + + :: + + $ apt-get update && apt-get install gplhost-archive-keyring + + #. Update the package database, upgrade your system, and reboot + for all changes to take effect: + + .. code-block:: console + + $ apt-get update && apt-get dist-upgrade + $ reboot + + Numerous archive.gplhost.com mirrors are available around the world. All + are available with both FTP and HTTP protocols (you should use the + closest mirror). The list of mirrors is available at + `http://archive.gplhost.com/readme.mirrors + `_ . + + **Manually install python-argparse** + + The Debian OpenStack packages are maintained on Debian Sid (also known + as Debian Unstable) - the current development version. Backported + packages run correctly on Debian Wheezy with one caveat: + + All OpenStack packages are written in Python. All packages support + version 2.7; porting to Python version 3 is ongoing. Note that Debian + Wheezy uses Python 2.6 and 2.7, with Python 2.7 as the default + interpreter; Sid has only Python 2.7. There is one packaging change + between these two. In Python 2.6, you installed the ``python-argparse`` + package separately. In Python 2.7, this package is installed by default. + Unfortunately, in Python 2.7, this package does not include ``Provides: + python-argparse`` directive. + + #. Because the packages are maintained in Sid where the + ``Provides: python-argparse`` directive causes an error, and the Debian + OpenStack maintainer wants to maintain one version of the OpenStack + packages, you must manually install the ``python-argparse`` on each + OpenStack system that runs Debian Wheezy before you install the other + OpenStack packages. Use the following command to install the package: + + .. code-block:: console + + # apt-get install python-argparse + + This caveat applies to most OpenStack packages in Wheezy. + +| + +**To finalize the installation** + +.. only:: ubuntu or debian + + * Upgrade the packages on your system: + + :: + + $ apt-get update && apt-get dist-upgrade + + .. note:: + + If the upgrade process includes a new kernel, reboot your system + to activate it. + +.. only:: rdo + + #. Upgrade the packages on your system: + + .. code-block:: console + + # yum upgrade + + .. note:: + + If the upgrade process includes a new kernel, reboot your system + to activate it. + +.. only:: obs + + * Upgrade the packages on your system: + + :: + + $ zypper refresh && zypper dist-upgrade + + .. note:: + + If the upgrade process includes a new kernel, reboot your system + to activate it. + +.. only:: rdo + + 2. RHEL and CentOS enable :term:`SELinux` by default. Install the + ``openstack-selinux`` package to automatically manage security + policies for OpenStack services: + + .. code-block:: console + + # yum install openstack-selinux + + .. note:: + + Fedora does not require this package. + + .. note:: + + The installation process for this package can take a while. diff --git a/doc/install-guide-rst/source/basics-prerequisites.rst b/doc/install-guide-rst/source/basics-prerequisites.rst new file mode 100644 index 0000000000..e4aaac123e --- /dev/null +++ b/doc/install-guide-rst/source/basics-prerequisites.rst @@ -0,0 +1,54 @@ +Before you begin +~~~~~~~~~~~~~~~~ + +For best performance, we recommend that your environment meets or +exceeds the hardware requirements in +:ref:`figure-neutron-network-hw` or +:ref:`figure-legacy-network-hw`. However, OpenStack does not require a +significant amount of resources and the following minimum requirements +should support a proof-of-concept environment with core services +and several :term:`CirrOS` instances: + +- Controller Node: 1 processor, 2 GB memory, and 5 GB storage + +- Network Node: 1 processor, 512 MB memory, and 5 GB storage + +- Compute Node: 1 processor, 2 GB memory, and 10 GB storage + +To minimize clutter and provide more resources for OpenStack, we +recommend a minimal installation of your Linux distribution. Also, we +strongly recommend that you install a 64-bit version of your +distribution on at least the compute node. If you install a 32-bit +version of your distribution on the compute node, attempting to start an +instance using a 64-bit image will fail. + +.. note:: + + A single disk partition on each node works for most basic + installations. However, you should consider + :term:`Logical Volume Manager (LVM)` for installations with + optional services such as Block Storage. + +Many users build their test environment on a +:term:`virtual machine (VM)`. The primary benefits of VMs include +the following: + +- One physical server can support multiple nodes, each with almost any + number of network interfaces. + +- Ability to take periodic "snap shots" throughout the installation + process and "roll back" to a working configuration in the event of a + problem. + +However, VMs will reduce performance of your instances, particularly if +your hypervisor and/or processor lacks support for hardware acceleration +of nested VMs. + +.. note:: + + If you choose to install on VMs, make sure your hypervisor permits + :term:`promiscuous mode` and disables MAC address filtering on the + :term:`external network`. + +For more information about system requirements, see the `OpenStack +Operations Guide `_.