swift/doc/source/install/controller-install-debian.rst

.. _controller-debian:

Install and configure the controller node for Debian
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This section describes how to install and configure the proxy service that
handles requests for the account, container, and object services operating
on the storage nodes. For simplicity, this guide installs and configures
the proxy service on the controller node. However, you can run the proxy
service on any node with network connectivity to the storage nodes.
Additionally, you can install and configure the proxy service on multiple
nodes to increase performance and redundancy. For more information, see the
`Deployment Guide <https://docs.openstack.org/swift/latest/deployment_guide.html>`__.

This section applies to Debian.

.. include:: controller-common_prerequisites.txt

Install and configure components
--------------------------------

.. note::

   Default configuration files vary by distribution. You might need
   to add these sections and options rather than modifying existing
   sections and options. Also, an ellipsis (``...``) in the configuration
   snippets indicates potential default configuration options that you
   should retain.

#. Install the packages:

   .. code-block:: console

      # apt-get install swift swift-proxy python-swiftclient \
        python-keystoneclient python-keystonemiddleware \
        memcached

   .. note::

      Complete OpenStack environments already include some of these
      packages.

   2. Create the ``/etc/swift`` directory.

   3. Obtain the proxy service configuration file from the Object Storage
      source repository:

      .. code-block:: console

         # curl -o /etc/swift/proxy-server.conf https://opendev.org/openstack/swift/raw/branch/master/etc/proxy-server.conf-sample

   4. .. include:: controller-include.txt
Add install-guide for swift This adds swift-specific contents from the OpenStack Installation Guide in the swift repo per [1]. A separate change will remove the swift contents from the OpenStack Installation Guide for Newton per [2]. The swift install-guide structure is based on the Install Guide Cookiecutter [3]. Also adds tox.ini environment for install-guide and adds openstackdocs-theme to test-requirements.txt. [1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html [2] http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html [3] http://git.openstack.org/cgit/openstack/installguide-cookiecutter/ Change-Id: I59b92eebaf5acc657b97bcf10d9ff2cf2db05885 Partially-Implements: blueprint projectspecificinstallguides Depends-On: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9 2016-06-15 18:35:05 +02:00			`.. _controller-debian:`

			`Install and configure the controller node for Debian`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`

			`This section describes how to install and configure the proxy service that`
			`handles requests for the account, container, and object services operating`
			`on the storage nodes. For simplicity, this guide installs and configures`
			`the proxy service on the controller node. However, you can run the proxy`
			`service on any node with network connectivity to the storage nodes.`
			`Additionally, you can install and configure the proxy service on multiple`
			`nodes to increase performance and redundancy. For more information, see the`
Correct the unused doc link address Update the doc link brought by the doc migration. Although we had some effort to fix these, it still left lots of bad doc link, I separate these changes into 3 patches aim to fix all of these, this is the 3rd patch for doc/source/install. Change-Id: I1b0c12cd5f893f1a84d12782ddc39f6d06beb2aa 2017-09-05 19:16:30 +08:00			`Deployment Guide <https://docs.openstack.org/swift/latest/deployment_guide.html>`__.
Add install-guide for swift This adds swift-specific contents from the OpenStack Installation Guide in the swift repo per [1]. A separate change will remove the swift contents from the OpenStack Installation Guide for Newton per [2]. The swift install-guide structure is based on the Install Guide Cookiecutter [3]. Also adds tox.ini environment for install-guide and adds openstackdocs-theme to test-requirements.txt. [1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html [2] http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html [3] http://git.openstack.org/cgit/openstack/installguide-cookiecutter/ Change-Id: I59b92eebaf5acc657b97bcf10d9ff2cf2db05885 Partially-Implements: blueprint projectspecificinstallguides Depends-On: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9 2016-06-15 18:35:05 +02:00
			`This section applies to Debian.`

			`.. include:: controller-common_prerequisites.txt`

			`Install and configure components`
			`--------------------------------`

			`.. note::`

			`Default configuration files vary by distribution. You might need`
			`to add these sections and options rather than modifying existing`
			sections and options. Also, an ellipsis (``...``) in the configuration
			`snippets indicates potential default configuration options that you`
			`should retain.`

			`#. Install the packages:`

			`.. code-block:: console`

			`# apt-get install swift swift-proxy python-swiftclient \`
			`python-keystoneclient python-keystonemiddleware \`
			`memcached`

			`.. note::`

			`Complete OpenStack environments already include some of these`
			`packages.`

			2. Create the ``/etc/swift`` directory.

			`3. Obtain the proxy service configuration file from the Object Storage`
			`source repository:`

			`.. code-block:: console`

Modify the version path URL of the configuration file In the main branch, I think it is necessary to modify the configuration file path in the document as the main branch path, and to change the path to a stable version when the version is released. Change-Id: Ib1bc4c59ed4c7624782b8b1cdea20847c14c90bf 2019-05-23 10:53:31 +08:00			`# curl -o /etc/swift/proxy-server.conf https://opendev.org/openstack/swift/raw/branch/master/etc/proxy-server.conf-sample`
Controller install Debian missing proxy-server.conf configuration Missing proxy-server.conf configuration document for installing control nodes in Debian Change-Id: I174ba8841ed638732bcf933602c25aad8e62f0ca 2019-05-22 14:55:16 +08:00
			`4. .. include:: controller-include.txt`