From 187bda14471e03d4ce2f989f2bb33d05dfc47e12 Mon Sep 17 00:00:00 2001 From: Joseph Davis Date: Mon, 7 Oct 2019 11:15:28 -0700 Subject: [PATCH] Improve documentation on Ceilosca not needing Gnocchi There was a recent question in IRC about how to configure Ceilosca. These edits should make it clearer that Gnocchi is not needed in a Ceilosca deployment, and how to disable it. Change-Id: I25b894e1ad222e3b55c6787c0625c03b9ebdcbf1 --- README.rst | 20 ++++++++++++++++++++ devstack/README.md | 18 ++++++++++-------- devstack/sample-local.conf | 3 +++ 3 files changed, 33 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 4072500..2504bf0 100644 --- a/README.rst +++ b/README.rst @@ -33,6 +33,26 @@ DevStack. 1. Run devstack to get openstack installed, including Monasca and Ceilometer plugins. + a. Not all Ceilometer components are required. The following may be + disabled in ``local.conf`` if using an older Ceilometer release. + :: + + disable_service ceilometer-alarm-notifier + disable_service ceilometer-alarm-evaluator + disable_service ceilometer-collector + + b. Panko and Aodh from the Telemetry project are not required, + as Monasca will be providing these types of services. + + c. Gnocchi is also not required, as Monasca uses a configured + Time-Series Database for measurement storage. + + Gnocchi installation in DevStack may be skipped by setting the + following in ``local.conf``. + :: + + CEILOMETER_BACKEND=none + 2. Install python-monascaclient. :: diff --git a/devstack/README.md b/devstack/README.md index e9f7c1d..5154d98 100644 --- a/devstack/README.md +++ b/devstack/README.md @@ -3,21 +3,22 @@ There are a few options for configuring Ceilosca on top of a Ceilometer and Monasca deployment. Choose one: -- DevStack can be instructed through the local.conf to "enable ceilosca". Reference the included - devstack/sample-local.conf for one example configuration. +- DevStack can be instructed through the `local.conf` to "enable ceilosca". Reference the included + `devstack/sample-local.conf` for one example configuration. - Use the included Vagrantfile to create and provision a VM. This will provision a new Ubuntu 16.04 VM and run the ceilosca.sh. -- Under certain conditions the monasca_test_setup.py may be used to set up Ceilosca for testing. This .py may also be +- Under certain conditions the `monasca_test_setup.py` may be used to set up Ceilosca for testing. This .py may also be useful reference if you choose to write your own integration scripts. -- The devstack/ceilosca.sh script will copy Ceilosca components on top of Ceilometer. +- The `devstack/ceilosca.sh` script will copy Ceilosca components on top of Ceilometer. - ceilosca.sh has been updated to the Newton release. - ceilosca.sh is also used by the Vagrant deployment option. - - The script should be tweaked before execution, particularly the lines. - - export SERVICE_HOST=192.168.10.6 - - export HOST_IP_IFACE=eth0 + - The script should be tweaked before execution, particularly the lines below + should be set to match the environment. + - `export SERVICE_HOST=192.168.10.6` + - `export HOST_IP_IFACE=eth0` - The script should be run by a sudoers user with no password required. Such as is described in https://docs.openstack.org/devstack/latest/ - And note ceilosca.sh does not configure Horizon @@ -39,6 +40,7 @@ export OS_USERNAME=mini-mon - Devstack includes a cirros 3.5 image by default. This will be represented in an `image.size` metric in monasca with a datasource of `ceilometer`. - Cause further metrics to be created by doing more OpenStack operations. + Here are a few examples. - Create another image - wget -c http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img -o cirros-0.4.0-x86_64-disk.img - openstack image create --disk-format qcow2 --container-format bare cirros-0.4.0 < cirros-0.4.0-x86_64-disk.img @@ -53,5 +55,5 @@ export OS_USERNAME=mini-mon - openstack security group rule create --proto tcp --dst-port 22 - openstack server create --flavor --image --security-group mytest - Check the progress with `openstack server list` - - Look for additional metrics with `datasource: ceilometer` in `monasca metric-list` +- Look for additional metrics with `datasource: ceilometer` in `monasca metric-list` - Explore the samples (aka. measurements) in `monasca measurement-list image.size -120` and similar commands. diff --git a/devstack/sample-local.conf b/devstack/sample-local.conf index 65f73c3..119225f 100644 --- a/devstack/sample-local.conf +++ b/devstack/sample-local.conf @@ -27,6 +27,9 @@ MONASCA_METRICS_DB=${MONASCA_METRICS_DB:-influxdb} # MONASCA_METRICS_DB=${MONASCA_METRICS_DB:-cassandra} # MONASCA_METRICS_DB=${MONASCA_METRICS_DB:-vertica} +# Disable Gnocchi (Ceilometer default backend), as it is not needed for Ceilometer +CEILOMETER_BACKEND=none + # Monasca services to enable enable_service monasca enable_service monasca-influxdb