openstack/openstack-ansible
Code Issues Proposed changes

Merge "Docs: Clean up multiple make html warnings"

Browse Source
This commit is contained in:
Jenkins 2016-04-28 21:38:38 +00:00 committed by Gerrit Code Review
commit 55f6f0686a
3 changed files with 178 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/developer-docs/quickstart-aio.rst
View File

@ -126,6 +126,7 @@ for the OpenStack Deployment. This preparation is completed by executing:
.. code-block:: bash
$ scripts/bootstrap-aio.sh
If you wish to add any additional configuration entries for the OpenStack configuration
then this can be done now by editing
``/etc/openstack_deploy/user_variables.yml``. Please see the `Install Guide`_

144
doc/source/install-guide/configure-aodh.rst
View File

@ -1,63 +1,67 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
=======================================
Configuring the Aodh service (optional)
---------------------------------------------
=======================================
The Alarming services of the Telemetry perform the following functions:
The Telemetry Alarming services perform the following functions:
- Creates an API endpoint for controlling alarms.
- Allows you to set alarms based on threshold evaluation for a collection of samples.
Aodh on OSA requires a mongodb backend to be configured prior to running the aodh
playbooks. The connection data will then need to be given in the ``user_variables.yml``
file (see section `Configuring the user data`_ below).
Aodh on OSA requires a configured MongoDB back end prior to running
the Aodh playbooks. To specify the connection data, the deployer has to edit in the
``user_variables.yml`` file (see section `Configuring the user data`_
below).
Setting up a Mongodb database for Aodh
############################################
Setting up a MongoDB database for Aodh
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Install the MongoDB package:
.. code-block:: shell-session
.. code-block:: console
# apt-get install mongodb-server mongodb-clients python-pymongo
# apt-get install mongodb-server mongodb-clients python-pymongo
2. Edit the ``/etc/mongodb.conf`` file and change the bind_ip to the management interface of the node your running this on.
.. code-block:: shell-session
2. Edit the ``/etc/mongodb.conf`` file and change ``bind_ip`` to the
management interface of the node running Aodh.
bind_ip = 10.0.0.11
.. code-block:: ini
3. Edit the ``/etc/mongodb.conf`` file and enable smallfiles
bind_ip = 10.0.0.11
.. code-block:: shell-session
smallfiles = true
3. Edit the ``/etc/mongodb.conf`` file and enable smallfiles:
4. Restart the mongodb service
.. code-block:: ini
.. code-block:: shell-session
smallfiles = true
# service mongodb restart
5. Create the aodh database
4. Restart the MongoDB service:
.. code-block:: shell-session
.. code-block:: console
# mongo --host controller --eval '
db = db.getSiblingDB("aodh");
db.addUser({user: "aodh",
pwd: "AODH_DBPASS",
roles: [ "readWrite", "dbAdmin" ]})'
# service mongodb restart
This should return:
.. code-block:: shell-session
5. Create the Aodh database
MongoDB shell version: 2.4.x
connecting to: controller:27017/test
{
.. code-block:: console
# mongo --host controller --eval 'db = db.getSiblingDB("aodh"); db.addUser({user: "aodh", pwd: "AODH_DBPASS", roles: [ "readWrite", "dbAdmin" ]});'
This returns:
.. code-block:: console
MongoDB shell version: 2.4.x
connecting to: controller:27017/test
{
"user" : "aodh",
"pwd" : "72f25aeee7ad4be52437d7cd3fc60f6f",
"roles" : [
@ -65,54 +69,78 @@ Setting up a Mongodb database for Aodh
"dbAdmin"
],
"_id" : ObjectId("5489c22270d7fad1ba631dc3")
}
}
.. note:: The ``AODH_DBPASS`` must match the
``aodh_container_db_password`` in the
``/etc/openstack_deploy/user_secrets.yml`` file. This
allows Ansible to configure the connection string within
the Aodh configuration files.
NOTE: The ``AODH_DBPASS`` must match the ``aodh_container_db_password`` in the ``/etc/openstack_deploy/user_secrets.yml`` file. This is how ansible knows how to configure the connection string within the aodh configuration files.
Configuring the hosts
#####################
~~~~~~~~~~~~~~~~~~~~~
Aodh can be configured by specifying the ``metering-alarm_hosts`` directive in the ``/etc/openstack_deploy/conf.d/aodh.yml`` file. Below is the example included in the ``etc/openstack_deploy/conf.d/aodh.yml.example`` file:
Configure Aodh by specifying the ``metering-alarm_hosts`` directive in
the ``/etc/openstack_deploy/conf.d/aodh.yml`` file. The following shows
the example included in the
``etc/openstack_deploy/conf.d/aodh.yml.example`` file:
.. code-block:: yaml
.. code-block:: yaml
# The infra nodes that the aodh services will run on.
metering-alarm_hosts:
infra1:
ip: 172.20.236.111
infra2:
ip: 172.20.236.112
infra3:
ip: 172.20.236.113
# The infra nodes that the aodh services will run on.
metering-alarm_hosts:
infra1:
ip: 172.20.236.111
infra2:
ip: 172.20.236.112
infra3:
ip: 172.20.236.113
The ``metering-alarm_hosts`` houses several services:
The ``metering-alarm_hosts`` provides several services:
- An API server (aodh-api). Runs on one or more central management servers to provide access to the alarm information stored in the data store.
- An API server (aodh-api). Runs on one or more central management
servers to provide access to the alarm information stored in the
data store.
- An alarm evaluator (aodh-evaluator). Runs on one or more central management servers to determine when alarms fire due to the associated statistic trend crossing a threshold over a sliding time window.
- An alarm evaluator (aodh-evaluator). Runs on one or more central
management servers to determine when alarms fire due to the
associated statistic trend crossing a threshold over a sliding
time window.
- A notification listener (aodh-listener). Runs on a central management server and fire alarms based on defined rules against event captured by the Telemetry module's notification agents.
- A notification listener (aodh-listener). Runs on a central
management server and fire alarms based on defined rules against
event captured by the Telemetry module's notification agents.
- An alarm notifier (aodh-notifier). Runs on one or more central management servers to allow alarms to be set based on the threshold evaluation for a collection of samples.
- An alarm notifier (aodh-notifier). Runs on one or more central
management servers to allow alarms to be set based on the
threshold evaluation for a collection of samples.
These services communicate by using the OpenStack messaging bus. Only the API server has access to the data store.
These services communicate by using the OpenStack messaging bus. Only
the API server has access to the data store.
Configuring the user data
#########################
In addition to adding these hosts in the ``/etc/openstack_deploy/conf.d/aodh.yml`` file, other configurations must be specified in the ``/etc/openstack_deploy/user_variables.yml`` file. These configurations are listed below, along with a description:
~~~~~~~~~~~~~~~~~~~~~~~~~
In addition to adding these hosts in the
``/etc/openstack_deploy/conf.d/aodh.yml`` file, other configurations
must be specified in the ``/etc/openstack_deploy/user_variables.yml``
file. These configurations are listed below, along with a description:
The type of database backend aodh will use. Currently only mongodb is supported:
``aodh_db_type: mongodb``
- The type of database backend aodh will use. Currently only MongoDB
is supported: ``aodh_db_type: mongodb``
The IP address of the MonogoDB host:
``aodh_db_ip: localhost``
- The IP address of the MonogoDB host: ``aodh_db_ip: localhost``
The port of the Mongodb service:
``aodh_db_port: 27017``
- The port of the MongoDB service: ``aodh_db_port: 27017``
Once all of these steps are complete, you are ready to run the os-aodh-install.yml playbook! Or, if deploying a new stack, simply run setup-openstack.yml. The aodh playbooks will run as part of this playbook.
After all of these steps are complete, run the ``os-aodh-install.yml``
playbook. If deploying a new openstack (instead of only aodh),
run ``setup-openstack.yml``. The aodh playbooks run as part of this
playbook.
--------------

160
doc/source/install-guide/configure-ceilometer.rst
View File

@ -1,9 +1,10 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
=============================================
Configuring the Ceilometer service (optional)
---------------------------------------------
=============================================
The Telemetry module(Ceilometer) performs the following functions:
The Telemetry module (Ceilometer) performs the following functions:
- Efficiently polls metering data related to OpenStack services.
@ -13,58 +14,55 @@ The Telemetry module(Ceilometer) performs the following functions:
.. note::
The alarming functionality was moved to a separate component in Liberty. It will be handled
by the metering-alarm containers through the aodh services. For configuring these services,
please see the Aodh docs.
The alarming functionality was moved to a separate component in
Liberty. It will be handled by the metering-alarm containers
through the aodh services. For configuring these services, please
see the Aodh docs.
Ceilometer on OSA requires a mongodb backend to be configured prior to running
Ceilometer on OSA requires a MongoDB backend to be configured prior to running
the ceilometer playbooks. The connection data will then need to be given in the
``user_variables.yml`` file (see section `Configuring the user data`_ below).
Setting up a Mongodb database for ceilometer
############################################
Setting up a MongoDB database for Ceilometer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Install the MongoDB package:
.. code-block:: shell-session
.. code-block:: console
# apt-get install mongodb-server mongodb-clients python-pymongo
# apt-get install mongodb-server mongodb-clients python-pymongo
2. Edit the ``/etc/mongodb.conf`` file and change the bind_ip to the management interface of the node the service is running on.
.. code-block:: shell-session
.. code-block:: ini
bind_ip = 10.0.0.11
bind_ip = 10.0.0.11
3. Edit the ``/etc/mongodb.conf`` file and enable smallfiles
.. code-block:: shell-session
.. code-block:: ini
smallfiles = true
smallfiles = true
4. Restart the mongodb service
4. Restart the MongoDB service
.. code-block:: shell-session
.. code-block:: console
# service mongodb restart
# service mongodb restart
5. Create the ceilometer database
.. code-block:: shell-session
.. code-block:: console
# mongo --host controller --eval '
db = db.getSiblingDB("ceilometer");
db.addUser({user: "ceilometer",
pwd: "CEILOMETER_DBPASS",
roles: [ "readWrite", "dbAdmin" ]})'
# mongo --host controller --eval 'db = db.getSiblingDB("ceilometer"); db.addUser({user: "ceilometer", pwd: "CEILOMETER_DBPASS", roles: [ "readWrite", "dbAdmin" ]})'
This should return:
.. code-block:: shell-session
.. code-block:: console
MongoDB shell version: 2.4.x
connecting to: controller:27017/test
MongoDB shell version: 2.4.x
connecting to: controller:27017/test
{
"user" : "ceilometer",
"pwd" : "72f25aeee7ad4be52437d7cd3fc60f6f",
@ -75,47 +73,67 @@ Setting up a Mongodb database for ceilometer
"_id" : ObjectId("5489c22270d7fad1ba631dc3")
}
NOTE: The ``CEILOMETER_DBPASS`` must match the ``ceilometer_container_db_password`` in the ``/etc/openstack_deploy/user_secrets.yml`` file. This is how ansible knows how to configure the connection string within the ceilometer configuration files.
.. note:: The ``CEILOMETER_DBPASS`` must match the
``ceilometer_container_db_password`` in the
``/etc/openstack_deploy/user_secrets.yml`` file. This is
how ansible knows how to configure the connection string
within the ceilometer configuration files.
Configuring the hosts
#####################
~~~~~~~~~~~~~~~~~~~~~
Ceilometer can be configured by specifying the ``metering-compute_hosts`` and
Configure Ceilometer by specifying the ``metering-compute_hosts`` and
``metering-infra_hosts`` directives in the
``/etc/openstack_deploy/conf.d/ceilometer.yml`` file. Below is the example
included in the ``etc/openstack_deploy/conf.d/ceilometer.yml.example`` file:
``/etc/openstack_deploy/conf.d/ceilometer.yml`` file. Below is the
example included in the
``etc/openstack_deploy/conf.d/ceilometer.yml.example`` file:
.. code-block:: yaml
.. code-block:: bash
# The compute host that the ceilometer compute agent will be running on.
metering-compute_hosts:
# The compute host that the ceilometer compute agent runs on
metering-compute_hosts:
compute1:
ip: 172.20.236.110
# The infra node that the central agents will be running on
metering-infra_hosts:
# The infra node that the central agents runs on
metering-infra_hosts:
infra1:
ip: 172.20.236.111
# Adding more than one host requires further configuration for ceilometer
# to work properly. See 'Configuring the hosts for an HA deployment' section.
# to work properly. See the "Configuring the hosts for an HA deployment" section.
infra2:
ip: 172.20.236.112
infra3:
ip: 172.20.236.113
The ``metering-compute_hosts`` houses the ``ceilometer-agent-compute`` service. It runs on each compute node and polls for resource utilization statistics.
The ``metering-infra_hosts`` houses serveral services:
The ``metering-compute_hosts`` houses the ``ceilometer-agent-compute``
service. It runs on each compute node and polls for resource
utilization statistics. The ``metering-infra_hosts`` houses serveral
services:
- A central agent (ceilometer-agent-central): Runs on a central management server to poll for resource utilization statistics for resources not tied to instances or compute nodes. Multiple agents can be started to enable workload partitioning (See HA section below).
- A central agent (ceilometer-agent-central): Runs on a central
management server to poll for resource utilization statistics for
resources not tied to instances or compute nodes. Multiple agents
can be started to enable workload partitioning (See HA section
below).
- A notification agent (ceilometer-agent-notification): Runs on a central management server(s) and consumes messages from the message queue(s) to build event and metering data. Multiple notification agents can be started to enable workload partitioning (See HA section below).
- A notification agent (ceilometer-agent-notification): Runs on a
central management server(s) and consumes messages from the
message queue(s) to build event and metering data. Multiple
notification agents can be started to enable workload partitioning
(See HA section below).
- A collector (ceilometer-collector): Runs on central management server(s) and dispatches collected telemetry data to a data store or external consumer without modification.
- A collector (ceilometer-collector): Runs on central management
server(s) and dispatches collected telemetry data to a data store
or external consumer without modification.
- An API server (ceilometer-api): Runs on one or more central
management servers to provide data access from the data store.
- An API server (ceilometer-api): Runs on one or more central management servers to provide data access from the data store.
Configuring the hosts for an HA deployment
##########################################
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ceilometer supports running the polling and notification agents in an
HA deployment, meaning that several of these services can be run in parallel
with workload divided among these services.
@ -146,50 +164,54 @@ options used in ceilometer.conf for an HA deployment. An example
notification:
workload_partitioning: True
Configuring the user data
#########################
~~~~~~~~~~~~~~~~~~~~~~~~~
In addition to adding these hosts in the
``/etc/openstack_deploy/conf.d/ceilometer.yml`` file, other configurations
must be specified in the ``/etc/openstack_deploy/user_variables.yml`` file.
These configurations are listed below, along with a description:
- The type of database backend ceilometer will use. Currently only
MongoDB is supported: ``ceilometer_db_type: mongodb``
The type of database backend ceilometer will use. Currently only mongodb is supported:
``ceilometer_db_type: mongodb``
- The IP address of the MonogoDB host: ``ceilometer_db_ip:
localhost``
The IP address of the MonogoDB host:
``ceilometer_db_ip: localhost``
- The port of the MongoDB service: ``ceilometer_db_port: 27017``
The port of the Mongodb service:
``ceilometer_db_port: 27017``
- This configures swift to send notifications to the message bus:
``swift_ceilometer_enabled: False``
This configures swift to send notifications to the message bus:
``swift_ceilometer_enabled: False``
- This configures heat to send notifications to the message bus:
``heat_ceilometer_enabled: False``
This configures heat to send notifications to the message bus:
``heat_ceilometer_enabled: False``
- This configures cinder to send notifications to the message bus:
``cinder_ceilometer_enabled: False``
This configures cinder to send notifications to the message bus:
``cinder_ceilometer_enabled: False``
- This configures glance to send notifications to the message bus:
``glance_ceilometer_enabled: False``
This configures glance to send notifications to the message bus:
``glance_ceilometer_enabled: False``
- This configures nova to send notifications to the message bus:
``nova_ceilometer_enabled: False``
This configures nova to send notifications to the message bus:
``nova_ceilometer_enabled: False``
- This configures neutron to send notifications to the message bus:
``neutron_ceilometer_enabled: False``
This configures neutron to send notifications to the message bus:
``neutron_ceilometer_enabled: False``
- This configures keystone to send notifications to the message bus:
``keystone_ceilometer_enabled: False``
This configures keystone to send notifications to the message bus:
``keystone_ceilometer_enabled: False``
After all of these steps are complete, run the
``os-ceilometer-install.yml`` playbook. If deploying a new OpenStack
(instead of only ceilometer), run ``setup-openstack.yml``. The
ceilometer playbooks run as part of this
playbook.
Once all of these steps are complete, you are ready to run the
os-ceilometer-install.yml playbook! Or, if deploying a new stack, simply run
setup-openstack.yml. The ceilometer playbooks will run as part of this playbook
References
##########
~~~~~~~~~~
[1] `Ceilometer Admin Guide`_
.. _Ceilometer Admin Guide: http://docs.openstack.org/admin-guide/telemetry-data-collection.html