Files
aodh/doc/source/install.rst
Doug Hellmann 1f9bce2609 extend developer documentation
- Add information about the system architecture (modified
  from the wiki to reflect what was implemented).
- Add information about where we want contributions.
- Add information about how to sign up to participate in
  the project and how to be a part of the community.
- Add more detailed instructions for installing the development
  version from git.
- Add a placeholder for documenting the configuration options.
- Add instructions for running the tests after getting
  the source code.
- Add a glossary and index.

tags: DocImpact
bug 1006366

Change-Id: I8927c55e77cdd31804249d101575f9e174e6232d
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-07-05 14:46:37 -04:00

4.5 KiB

Installing and Running the Development Version

Ceilometer has two daemons. The agent runs on the Nova compute node(s) and the collector runs on the cloud's management node(s). In a development environment created by devstack, these two are typically the same server. They do not have to be, though, so some of the instructions below are duplicated. Skip the steps you have already done.

Installing the Collector

double: installing; collector

  1. Install and configure nova.

    The collector daemon imports code from nova, so it needs to be run on a server where nova has already been installed.

    Note

    Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.

  2. Install MongoDB.

    Follow the instructions to install the MongoDB package for your operating system, then start the service.

  3. Clone the ceilometer git repository to the management server:

    $ cd /opt/stack
    $ git clone https://github.com/stackforge/ceilometer.git
  4. As a user with root permissions or sudo privileges, run the ceilometer installer:

    $ cd ceilometer
    $ sudo python setup.py install
  5. Configure ceilometer.

    Ceilometer needs to know about some of the nova configuration options, so the simplest way to start is copying /etc/nova/nova.conf to /etc/ceilometer-collector.conf. Some of the logging settings used in nova break ceilometer, so they need to be removed. For example, as a user with root permissions:

    $ grep -v format_string /etc/nova/nova.conf > /etc/ceilometer-collector.conf

    Refer to configuration for details about any other options you might want to modify before starting the service.

  6. Start the collector.

    $ ./bin/ceilometer-collector

    Note

    The default development configuration of the collector logs to stderr, so you may want to run this step using a screen session or other tool for maintaining a long-running program in the background.

Installing the Compute Agent

double: installing; compute agent

Note

The compute agent must be installed on each nova compute node.

  1. Install and configure nova.

    The collector daemon imports code from nova, so it needs to be run on a server where nova has already been installed.

    Note

    Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.

  2. Clone the ceilometer git repository to the server:

    $ cd /opt/stack
    $ git clone https://github.com/stackforge/ceilometer.git
  3. As a user with root permissions or sudo privileges, run the ceilometer installer:

    $ cd ceilometer
    $ sudo python setup.py install
  4. Configure ceilometer.

    Ceilometer needs to know about some of the nova configuration options, so the simplest way to start is copying /etc/nova/nova.conf to /etc/ceilometer-agent.conf. Some of the logging settings used in nova break ceilometer, so they need to be removed. For example, as a user with root permissions:

    $ grep -v format_string /etc/nova/nova.conf > /etc/ceilometer-agent.conf

    Refer to configuration for details about any other options you might want to modify before starting the service.

  5. Start the agent.

    $ ./bin/ceilometer-agent

    Note

    The default development configuration of the agent logs to stderr, so you may want to run this step using a screen session or other tool for maintaining a long-running program in the background.