openstack/openstack-manuals
Code Issues Proposed changes

[install] move MongoDB installation into environment chapter

Browse Source 
Change-Id: Icb3263b4f55e316f37634020730399a4b0b670bb
This commit is contained in:
Christian Berendt 2015-10-21 09:02:36 +02:00
parent 5990fd26e9
commit bf98002fd2
4 changed files with 181 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,166 +10,15 @@ service in your environment.
To configure prerequisites To configure prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
Before you install and configure Telemetry, you must install ``MongoDB``, Before you install and configure the Telemetry service, you must
create a MongoDB database, service credentials, and API endpoint. create a database, service credentials, and API endpoints. However,
unlike other services, the Telemetry service uses a NoSQL database.
.. only:: obs See :ref:`environment-nosql-database` to install and configure
MongoDB before proceeding further.
#. Enable the Open Build Service repositories for MongoDB based on
your openSUSE or SLES version:
On openSUSE:
.. code-block:: console
# zypper addrepo -f obs://server:database/openSUSE_13.2 Database
On SLES:
.. code-block:: console
# zypper addrepo -f obs://server:database/SLE_12 Database
.. note::
The packages are signed by GPG key ``05905EA8``. You should
verify the fingerprint of the imported GPG key before using it.
.. code-block:: console
Key Name: server:database OBS Project <server:database@build.opensuse.org>
Key Fingerprint: 116EB863 31583E47 E63CDF4D 562111AC 05905EA8
Key Created: Mon 08 Dec 2014 09:54:12 AM UTC
Key Expires: Wed 15 Feb 2017 09:54:12 AM UTC
Install the MongoDB package:
.. code-block:: console
# zypper install mongodb
.. only:: rdo
#. Install the MongoDB package:
.. code-block:: console
# yum install mongodb-server mongodb
.. only:: ubuntu
#. Install the MongoDB package:
.. code-block:: console
# apt-get install mongodb-server mongodb-clients python-pymongo
.. only:: obs
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
* Start the MongoDB services and configure them to start when
the system boots:
.. code-block:: console
# systemctl enable mongodb.service
# systemctl start mongodb.service
.. only:: rdo
.. The use of mongod, and not mongodb, in the below screen is intentional.
2. Edit the ``/etc/mongod.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
* Start the MongoDB services and configure them to start when
the system boots:
.. code-block:: console
# systemctl enable mongod.service
# systemctl start mongod.service
.. only:: ubuntu
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
If you change the journaling configuration, stop the MongoDB
service, remove the initial journal files, and start the service:
.. code-block:: console
# service mongodb stop
# rm /var/lib/mongodb/journal/prealloc.*
# service mongodb start
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
.. only:: obs or ubuntu .. only:: obs or ubuntu
3. Create the ``ceilometer`` database: 1. Create the ``ceilometer`` database:
.. code-block:: console .. code-block:: console
@ -191,12 +40,11 @@ create a MongoDB database, service credentials, and API endpoint.
"_id" : ObjectId("5489c22270d7fad1ba631dc3") "_id" : ObjectId("5489c22270d7fad1ba631dc3")
} }
Replace ``CEILOMETER_DBPASS`` with a suitable password. Replace ``CEILOMETER_DBPASS`` with a suitable password.
.. only:: rdo .. only:: rdo
3. Create the ``ceilometer`` database: 1. Create the ``ceilometer`` database:
.. code-block:: console .. code-block:: console
@ -212,15 +60,14 @@ create a MongoDB database, service credentials, and API endpoint.
Replace ``CEILOMETER_DBPASS`` with a suitable password. Replace ``CEILOMETER_DBPASS`` with a suitable password.
2. Source the ``admin`` credentials to gain access to admin-only
4. Source the ``admin`` credentials to gain access to admin-only
CLI commands: CLI commands:
.. code-block:: console .. code-block:: console
$ source admin-openrc.sh $ source admin-openrc.sh
5. To create the service credentials, complete these steps: 3. To create the service credentials, complete these steps:
* Create the ``ceilometer`` user: * Create the ``ceilometer`` user:

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

@ -1,3 +1,5 @@
.. _install_ceilometer:
======================== ========================
Add the Telemetry module Add the Telemetry module
======================== ========================

169
doc/install-guide/source/environment-nosql-database.rst Normal file
View File

@ -0,0 +1,169 @@
.. _environment-nosql-database:
NoSQL database
~~~~~~~~~~~~~~
The Telemetry service uses a NoSQL database to store information. The database
typically runs on the controller node. The procedures in this guide use
MongoDB.
.. note::
The installation of the NoSQL database server is only necessary when
installing the Telemetry service as documented in :ref:`install_ceilometer`.
Install and configure the database server
-----------------------------------------
.. only:: obs
#. Enable the Open Build Service repositories for MongoDB based on
your openSUSE or SLES version:
On openSUSE:
.. code-block:: console
# zypper addrepo -f obs://server:database/openSUSE_13.2 Database
On SLES:
.. code-block:: console
# zypper addrepo -f obs://server:database/SLE_12 Database
.. note::
The packages are signed by GPG key ``05905EA8``. You should
verify the fingerprint of the imported GPG key before using it.
.. code-block:: console
Key Name: server:database OBS Project <server:database@build.opensuse.org>
Key Fingerprint: 116EB863 31583E47 E63CDF4D 562111AC 05905EA8
Key Created: Mon 08 Dec 2014 09:54:12 AM UTC
Key Expires: Wed 15 Feb 2017 09:54:12 AM UTC
Install the MongoDB package:
.. code-block:: console
# zypper install mongodb
.. only:: rdo
#. Install the MongoDB package:
.. code-block:: console
# yum install mongodb-server mongodb
.. only:: ubuntu
#. Install the MongoDB package:
.. code-block:: console
# apt-get install mongodb-server mongodb-clients python-pymongo
.. only:: obs
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
* Start the MongoDB service and configure it to start when
the system boots:
.. code-block:: console
# systemctl enable mongodb.service
# systemctl start mongodb.service
.. only:: rdo
.. The use of mongod, and not mongodb, in the below screen is intentional.
2. Edit the ``/etc/mongod.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.
* Start the MongoDB service and configure it to start when
the system boots:
.. code-block:: console
# systemctl enable mongod.service
# systemctl start mongod.service
.. only:: ubuntu
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
* Configure the ``bind_ip`` key to use the management interface
IP address of the controller node.
.. code-block:: ini
bind_ip = 10.0.0.11
* By default, MongoDB creates several 1 GB journal files
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
.. code-block:: ini
smallfiles = true
If you change the journaling configuration, stop the MongoDB
service, remove the initial journal files, and start the service:
.. code-block:: console
# service mongodb stop
# rm /var/lib/mongodb/journal/prealloc.*
# service mongodb start
You can also disable journaling. For more information, see the
`MongoDB manual <http://docs.mongodb.org/manual/>`__.

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

@ -73,4 +73,5 @@ Operations Guide <http://docs.openstack.org/ops/>`_.
environment-ntp.rst environment-ntp.rst
environment-packages.rst environment-packages.rst
environment-sql-database.rst environment-sql-database.rst
environment-nosql-database.rst
environment-messaging.rst environment-messaging.rst