From db92d31f1676908f960fd2553b778870ca7d7308 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Sat, 27 Jun 2015 11:13:10 +0000 Subject: [PATCH] Create a devstack plugin for ceilometer This is mostly a straight port of devstack:lib/ceilometer with some minor cleanups in the code. Notable changes include: * default values are moved to devstack/settings * all services provided by ceilometer are turned on by default, use disable_service to turn them off * mongod smallfiles is no longer used as it is not (apparently) used with deb-based installs and there's a lot of water under the bridge since then, so let's remove the complexity * config handling is broken down into smaller sub-functions * explicitly require python redis driver if needed, otherwise it will not be available in a virtualenv * install_ceilometermiddleware is not included, it is moved to lib/swift Change-Id: If36faa72b8c8d0f58a4ab5d02ed9cf92de3583b7 --- devstack/apache-ceilometer.template | 15 ++ devstack/files/rpms/ceilometer | 1 + devstack/plugin.sh | 405 ++++++++++++++++++++++++++++ devstack/settings | 48 ++++ 4 files changed, 469 insertions(+) create mode 100644 devstack/apache-ceilometer.template create mode 100644 devstack/files/rpms/ceilometer create mode 100644 devstack/plugin.sh create mode 100644 devstack/settings diff --git a/devstack/apache-ceilometer.template b/devstack/apache-ceilometer.template new file mode 100644 index 0000000000..79f14c38ab --- /dev/null +++ b/devstack/apache-ceilometer.template @@ -0,0 +1,15 @@ +Listen %PORT% + + + WSGIDaemonProcess ceilometer-api processes=2 threads=10 user=%USER% display-name=%{GROUP} %VIRTUALENV% + WSGIProcessGroup ceilometer-api + WSGIScriptAlias / %WSGIAPP% + WSGIApplicationGroup %{GLOBAL} + = 2.4> + ErrorLogFormat "%{cu}t %M" + + ErrorLog /var/log/%APACHE_NAME%/ceilometer.log + CustomLog /var/log/%APACHE_NAME%/ceilometer_access.log combined + + +WSGISocketPrefix /var/run/%APACHE_NAME% diff --git a/devstack/files/rpms/ceilometer b/devstack/files/rpms/ceilometer new file mode 100644 index 0000000000..9c87c4016d --- /dev/null +++ b/devstack/files/rpms/ceilometer @@ -0,0 +1 @@ +selinux-policy-targeted diff --git a/devstack/plugin.sh b/devstack/plugin.sh new file mode 100644 index 0000000000..79fcc3790e --- /dev/null +++ b/devstack/plugin.sh @@ -0,0 +1,405 @@ +# Install and start **Ceilometer** service in devstack +# +# To enable Ceilometer in devstack add an entry to local.conf that +# looks like +# +# [[local|localrc]] +# enable_plugin ceilometer git://git.openstack.org/openstack/ceilometer +# +# By default all ceilometer services are started (see +# devstack/settings). To disable a specific service use the +# disable_service function. For example to turn off alarming: +# +# disable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator +# +# NOTE: Currently, there are two ways to get the IPMI based meters in +# OpenStack. One way is to configure Ironic conductor to report those meters +# for the nodes managed by Ironic and to have Ceilometer notification +# agent to collect them. Ironic by default does NOT enable that reporting +# functionality. So in order to do so, users need to set the option of +# conductor.send_sensor_data to true in the ironic.conf configuration file +# for the Ironic conductor service, and also enable the +# ceilometer-anotification service. If you do this disable the IPMI +# polling agent: +# +# disable_service ceilometer-aipmi +# +# The other way is to use Ceilometer ipmi agent only to get the IPMI based +# meters. To avoid duplicated meters, users need to make sure to set the +# option of conductor.send_sensor_data to false in the ironic.conf +# configuration file if the node on which Ceilometer ipmi agent is running +# is also managed by Ironic. +# +# Several variables set in the localrc section adjust common behaviors +# of Ceilometer (see within for additional settings): +# +# CEILOMETER_PIPELINE_INTERVAL: Seconds between pipeline processing runs. Default 600. +# CEILOMETER_BACKEND: Database backend (e.g. 'mysql', 'mongodb', 'es') +# CEILOMETER_COORDINATION_URL: URL for group membership service provided by tooz. +# CEILOMETER_EVENTS: Set to True to enable event collection + +# Support potential entry-points console scripts in VENV or not +if [[ ${USE_VENV} = True ]]; then + PROJECT_VENV["ceilometer"]=${CEILOMETER_DIR}.venv + CEILOMETER_BIN_DIR=${PROJECT_VENV["ceilometer"]}/bin +else + CEILOMETER_BIN_DIR=$(get_python_exec_prefix) +fi + +# Test if any Ceilometer services are enabled +# is_ceilometer_enabled +function is_ceilometer_enabled { + [[ ,${ENABLED_SERVICES} =~ ,"ceilometer-" ]] && return 0 + return 1 +} + +function ceilometer_service_url { + echo "$CEILOMETER_SERVICE_PROTOCOL://$CEILOMETER_SERVICE_HOST:$CEILOMETER_SERVICE_PORT" +} + + +# _install_mongdb - Install mongodb and pyton lib. +function _install_mongodb { + # Server package is the same on all + local packages=mongodb-server + + if is_fedora; then + # mongodb client + packages="${packages} mongodb" + fi + + install_package ${packages} +} + +# _install_redis() - Install the redis server and python lib. +function _install_redis { + if is_ubuntu; then + install_package redis-server + restart_service redis-server + else + # This will fail (correctly) where a redis package is unavailable + install_package redis + restart_service redis + fi + + pip_install_gr redis +} + +# Configure mod_wsgi +function _config_ceilometer_apache_wsgi { + sudo mkdir -p $CEILOMETER_WSGI_DIR + + local ceilometer_apache_conf=$(apache_site_config_for ceilometer) + local apache_version=$(get_apache_version) + local venv_path="" + + # Copy proxy vhost and wsgi file + sudo cp $CEILOMETER_DIR/ceilometer/api/app.wsgi $CEILOMETER_WSGI_DIR/app + + if [[ ${USE_VENV} = True ]]; then + venv_path="python-path=${PROJECT_VENV["ceilometer"]}/lib/$(python_version)/site-packages" + fi + + sudo cp $CEILOMETER_DIR/devstack/apache-ceilometer.template $ceilometer_apache_conf + sudo sed -e " + s|%PORT%|$CEILOMETER_SERVICE_PORT|g; + s|%APACHE_NAME%|$APACHE_NAME|g; + s|%WSGIAPP%|$CEILOMETER_WSGI_DIR/app|g; + s|%USER%|$STACK_USER|g; + s|%VIRTUALENV%|$venv_path|g + " -i $ceilometer_apache_conf +} + +# Install required services for coordination +function _prepare_coordination { + if echo $CEILOMETER_COORDINATION_URL | grep -q '^memcached:'; then + install_package memcached + elif echo $CEILOMETER_COORDINATION_URL | grep -q '^redis:'; then + _install_redis + fi +} + +# Install required services for storage backends +function _prepare_storage_backend { + if [ "$CEILOMETER_BACKEND" = 'mongodb' ] ; then + pip_install_gr pymongo + _install_mongodb + fi + + if [ "$CEILOMETER_BACKEND" = 'es' ] ; then + ${TOP_DIR}/pkg/elasticsearch.sh download + ${TOP_DIR}/pkg/elasticsearch.sh install + fi +} + + +# Install the python modules for inspecting nova virt instances +function _prepare_virt_drivers { + # Only install virt drivers if we're running nova compute + if is_service_enabled n-cpu ; then + if [[ "$VIRT_DRIVER" = 'libvirt' ]]; then + pip_install_gr libvirt-python + fi + + if [[ "$VIRT_DRIVER" = 'vsphere' ]]; then + pip_instal_gr oslo.vmware + fi + fi +} + + +# Create ceilometer related accounts in Keystone +function _create_ceilometer_accounts { + if is_service_enabled ceilometer-api; then + + create_service_user "ceilometer" "admin" + + if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then + local ceilometer_service=$(get_or_create_service "ceilometer" \ + "metering" "OpenStack Telemetry Service") + get_or_create_endpoint $ceilometer_service \ + "$REGION_NAME" \ + "$(ceilometer_service_url)/" \ + "$(ceilometer_service_url)/" \ + "$(ceilometer_service_url)/" + fi + if is_service_enabled swift; then + # Ceilometer needs ResellerAdmin role to access Swift account stats. + get_or_add_user_project_role "ResellerAdmin" "ceilometer" $SERVICE_TENANT_NAME + fi + fi +} + +# Activities to do before ceilometer has been installed. +function preinstall_ceilometer { + echo_summary "Preinstall not in virtualenv context. Skipping." +} + +# Remove WSGI files, disable and remove Apache vhost file +function _cleanup_ceilometer_apache_wsgi { + sudo rm -f $CEILOMETER_WSGI_DIR/* + sudo rm -f $(apache_site_config_for ceilometer) +} + +# cleanup_ceilometer() - Remove residual data files, anything left over +# from previous runs that a clean run would need to clean up +function cleanup_ceilometer { + if [ "$CEILOMETER_BACKEND" = 'mongodb' ] ; then + mongo ceilometer --eval "db.dropDatabase();" + elif [ "$CEILOMETER_BACKEND" = 'es' ] ; then + curl -XDELETE "localhost:9200/events_*" + fi + if [ "$CEILOMETER_USE_MOD_WSGI" == "True" ]; then + _cleanup_ceilometer_apache_wsgi + fi +} + +# Set configuration for storage backend. +function _configure_storage_backend { + if [ "$CEILOMETER_BACKEND" = 'mysql' ] || [ "$CEILOMETER_BACKEND" = 'postgresql' ] ; then + iniset $CEILOMETER_CONF database alarm_connection $(database_connection_url ceilometer) + iniset $CEILOMETER_CONF database event_connection $(database_connection_url ceilometer) + iniset $CEILOMETER_CONF database metering_connection $(database_connection_url ceilometer) + iniset $CEILOMETER_CONF DEFAULT collector_workers $API_WORKERS + elif [ "$CEILOMETER_BACKEND" = 'es' ] ; then + # es is only supported for events. we will use sql for alarming/metering. + iniset $CEILOMETER_CONF database alarm_connection $(database_connection_url ceilometer) + iniset $CEILOMETER_CONF database event_connection es://localhost:9200 + iniset $CEILOMETER_CONF database metering_connection $(database_connection_url ceilometer) + iniset $CEILOMETER_CONF DEFAULT collector_workers $API_WORKERS + ${TOP_DIR}/pkg/elasticsearch.sh start + cleanup_ceilometer + elif [ "$CEILOMETER_BACKEND" = 'mongodb' ] ; then + iniset $CEILOMETER_CONF database alarm_connection mongodb://localhost:27017/ceilometer + iniset $CEILOMETER_CONF database event_connection mongodb://localhost:27017/ceilometer + iniset $CEILOMETER_CONF database metering_connection mongodb://localhost:27017/ceilometer + cleanup_ceilometer + else + die $LINENO "Unable to configure unknown CEILOMETER_BACKEND $CEILOMETER_BACKEND" + fi +} + +# Configure Ceilometer +function configure_ceilometer { + sudo install -d -o $STACK_USER -m 755 $CEILOMETER_CONF_DIR $CEILOMETER_API_LOG_DIR + + iniset_rpc_backend ceilometer $CEILOMETER_CONF + + iniset $CEILOMETER_CONF DEFAULT notification_topics "$CEILOMETER_NOTIFICATION_TOPICS" + iniset $CEILOMETER_CONF DEFAULT verbose True + iniset $CEILOMETER_CONF DEFAULT debug "$ENABLE_DEBUG_LOG_LEVEL" + + if [[ -n "$CEILOMETER_COORDINATION_URL" ]]; then + iniset $CEILOMETER_CONF coordination backend_url $CEILOMETER_COORDINATION_URL + iniset $CEILOMETER_CONF compute workload_partitioning True + fi + + # Install the policy file for the API server + cp $CEILOMETER_DIR/etc/ceilometer/policy.json $CEILOMETER_CONF_DIR + iniset $CEILOMETER_CONF oslo_policy policy_file $CEILOMETER_CONF_DIR/policy.json + + cp $CEILOMETER_DIR/etc/ceilometer/pipeline.yaml $CEILOMETER_CONF_DIR + cp $CEILOMETER_DIR/etc/ceilometer/event_pipeline.yaml $CEILOMETER_CONF_DIR + cp $CEILOMETER_DIR/etc/ceilometer/api_paste.ini $CEILOMETER_CONF_DIR + cp $CEILOMETER_DIR/etc/ceilometer/event_definitions.yaml $CEILOMETER_CONF_DIR + + if [ "$CEILOMETER_PIPELINE_INTERVAL" ]; then + sed -i "s/interval:.*/interval: ${CEILOMETER_PIPELINE_INTERVAL}/" $CEILOMETER_CONF_DIR/pipeline.yaml + fi + + # The compute and central agents need these credentials in order to + # call out to other services' public APIs. + # The alarm evaluator needs these options to call ceilometer APIs + iniset $CEILOMETER_CONF service_credentials os_username ceilometer + iniset $CEILOMETER_CONF service_credentials os_password $SERVICE_PASSWORD + iniset $CEILOMETER_CONF service_credentials os_tenant_name $SERVICE_TENANT_NAME + iniset $CEILOMETER_CONF service_credentials os_region_name $REGION_NAME + iniset $CEILOMETER_CONF service_credentials os_auth_url $KEYSTONE_SERVICE_URI/v2.0 + + configure_auth_token_middleware $CEILOMETER_CONF ceilometer $CEILOMETER_AUTH_CACHE_DIR + + iniset $CEILOMETER_CONF notification store_events $CEILOMETER_EVENTS + + # Configured storage + _configure_storage_backend + + if [[ "$VIRT_DRIVER" = 'vsphere' ]]; then + iniset $CEILOMETER_CONF DEFAULT hypervisor_inspector vsphere + iniset $CEILOMETER_CONF vmware host_ip "$VMWAREAPI_IP" + iniset $CEILOMETER_CONF vmware host_username "$VMWAREAPI_USER" + iniset $CEILOMETER_CONF vmware host_password "$VMWAREAPI_PASSWORD" + fi + + # NOTE: This must come after database configurate as those can + # call cleanup_ceilometer which will wipe the WSGI config. + if [ "$CEILOMETER_USE_MOD_WSGI" == "True" ]; then + iniset $CEILOMETER_CONF api pecan_debug "False" + _config_ceilometer_apache_wsgi + fi + + if is_service_enabled ceilometer-aipmi; then + # Configure rootwrap for the ipmi agent + configure_rootwrap ceilometer + fi +} + +# init_ceilometer() - Initialize etc. +function init_ceilometer { + # Get ceilometer keystone settings in place + _create_ceilometer_accounts + # Create cache dir + sudo install -d -o $STACK_USER $CEILOMETER_AUTH_CACHE_DIR + rm -f $CEILOMETER_AUTH_CACHE_DIR/* + + if is_service_enabled mysql postgresql; then + if [ "$CEILOMETER_BACKEND" = 'mysql' ] || [ "$CEILOMETER_BACKEND" = 'postgresql' ] || [ "$CEILOMETER_BACKEND" = 'es' ] ; then + recreate_database ceilometer + $CEILOMETER_BIN_DIR/ceilometer-dbsync + fi + fi +} + +# Install Ceilometer. +# The storage and coordination backends are installed here because the +# virtualenv context is active at this point and python drivers need to be +# installed. The context is not active during preinstall (when it would +# otherwise makes sense to do the backend services). +function install_ceilometer { + _prepare_coordination + _prepare_storage_backend + _prepare_virt_drivers + install_ceilometerclient + setup_develop $CEILOMETER_DIR +} + +# install_ceilometerclient() - Collect source and prepare +function install_ceilometerclient { + if use_library_from_git "python-ceilometerclient"; then + git_clone_by_name "python-ceilometerclient" + setup_dev_lib "python-ceilometerclient" + sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-ceilometerclient"]}/tools/,/etc/bash_completion.d/}ceilometer.bash_completion + else + pip_install_gr python-ceilometerclient + fi +} + +# start_ceilometer() - Start running processes, including screen +function start_ceilometer { + run_process ceilometer-acentral "$CEILOMETER_BIN_DIR/ceilometer-polling --polling-namespaces central --config-file $CEILOMETER_CONF" + run_process ceilometer-anotification "$CEILOMETER_BIN_DIR/ceilometer-agent-notification --config-file $CEILOMETER_CONF" + run_process ceilometer-collector "$CEILOMETER_BIN_DIR/ceilometer-collector --config-file $CEILOMETER_CONF" + run_process ceilometer-aipmi "$CEILOMETER_BIN_DIR/ceilometer-polling --polling-namespaces ipmi --config-file $CEILOMETER_CONF" + + if [[ "$CEILOMETER_USE_MOD_WSGI" == "False" ]]; then + run_process ceilometer-api "$CEILOMETER_BIN_DIR/ceilometer-api -d -v --log-dir=$CEILOMETER_API_LOG_DIR --config-file $CEILOMETER_CONF" + else + enable_apache_site ceilometer + restart_apache_server + tail_log ceilometer /var/log/$APACHE_NAME/ceilometer.log + tail_log ceilometer-api /var/log/$APACHE_NAME/ceilometer_access.log + fi + + # Start the compute agent late to allow time for the collector to + # fully wake up and connect to the message bus. See bug #1355809 + if [[ "$VIRT_DRIVER" = 'libvirt' ]]; then + run_process ceilometer-acompute "$CEILOMETER_BIN_DIR/ceilometer-polling --polling-namespaces compute --config-file $CEILOMETER_CONF" $LIBVIRT_GROUP + fi + if [[ "$VIRT_DRIVER" = 'vsphere' ]]; then + run_process ceilometer-acompute "$CEILOMETER_BIN_DIR/ceilometer-polling --polling-namespace compute --config-file $CEILOMETER_CONF" + fi + + # Only die on API if it was actually intended to be turned on + if is_service_enabled ceilometer-api; then + echo "Waiting for ceilometer-api to start..." + if ! wait_for_service $SERVICE_TIMEOUT $(ceilometer_service_url)/v2/; then + die $LINENO "ceilometer-api did not start" + fi + fi + + run_process ceilometer-alarm-notifier "$CEILOMETER_BIN_DIR/ceilometer-alarm-notifier --config-file $CEILOMETER_CONF" + run_process ceilometer-alarm-evaluator "$CEILOMETER_BIN_DIR/ceilometer-alarm-evaluator --config-file $CEILOMETER_CONF" +} + +# stop_ceilometer() - Stop running processes +function stop_ceilometer { + if [ "$CEILOMETER_USE_MOD_WSGI" == "True" ]; then + disable_apache_site ceilometer + restart_apache_server + fi + # Kill the ceilometer screen windows + for serv in ceilometer-acompute ceilometer-acentral ceilometer-aipmi ceilometer-anotification ceilometer-collector ceilometer-api ceilometer-alarm-notifier ceilometer-alarm-evaluator; do + stop_process $serv + done +} + +# This is the main for plugin.sh +if is_service_enabled ceilometer; then + if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then + # Set up other services + echo_summary "Configuring system services for Ceilometer" + preinstall_ceilometer + elif [[ "$1" == "stack" && "$2" == "install" ]]; then + echo_summary "Installing Ceilometer" + # Use stack_install_service here to account for vitualenv + stack_install_service ceilometer + elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then + echo_summary "Configuring Ceilometer" + configure_ceilometer + elif [[ "$1" == "stack" && "$2" == "extra" ]]; then + echo_summary "Initializing Ceilometer" + # Tidy base for ceilometer + init_ceilometer + # Start the services + start_ceilometer + fi + + if [[ "$1" == "unstack" ]]; then + echo_summary "Shutting Down Ceilometer" + stop_ceilometer + fi + + if [[ "$1" == "clean" ]]; then + echo_summary "Cleaning Ceilometer" + cleanup_ceilometer + fi +fi diff --git a/devstack/settings b/devstack/settings new file mode 100644 index 0000000000..6b9a48a29d --- /dev/null +++ b/devstack/settings @@ -0,0 +1,48 @@ +# turn on all the ceilometer services by default +# Pollsters +enable_service ceilometer-acompute ceilometer-acentral ceilometer-aipmi +# Notification Agent +enable_service ceilometer-anotification +# Data Collector +enable_service ceilometer-collector +# API service +enable_service ceilometer-api +# Alarming +enable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator + +# Default directories +CEILOMETER_DIR=$DEST/ceilometer +CEILOMETER_CONF_DIR=/etc/ceilometer +CEILOMETER_CONF=$CEILOMETER_CONF_DIR/ceilometer.conf +CEILOMETER_API_LOG_DIR=/var/log/ceilometer-api +CEILOMETER_AUTH_CACHE_DIR=${CEILOMETER_AUTH_CACHE_DIR:-/var/cache/ceilometer} +CEILOMETER_WSGI_DIR=${CEILOMETER_WSGI_DIR:-/var/www/ceilometer} + +# Set up database backend +CEILOMETER_BACKEND=${CEILOMETER_BACKEND:-mysql} + +# Ceilometer connection info. +CEILOMETER_SERVICE_PROTOCOL=http +CEILOMETER_SERVICE_HOST=$SERVICE_HOST +CEILOMETER_SERVICE_PORT=${CEILOMETER_SERVICE_PORT:-8777} +CEILOMETER_USE_MOD_WSGI=${CEILOMETER_USE_MOD_WSGI:-${ENABLE_HTTPD_MOD_WSGI_SERVICES}} + +# To enable OSprofiler change value of this variable to "notifications,profiler" +CEILOMETER_NOTIFICATION_TOPICS=${CEILOMETER_NOTIFICATION_TOPICS:-notifications} +CEILOMETER_EVENTS=${CEILOMETER_EVENTS:-True} + +CEILOMETER_COORDINATION_URL=${CEILOMETER_COORDINATION_URL:-} +CEILOMETER_PIPELINE_INTERVAL=${CEILOMETER_PIPELINE_INTERVAL:-} + +# Tell Tempest this project is present +TEMPEST_SERVICES+=,ceilometer + +# Set up default directories for client and middleware +GITDIR["python-ceilometerclient"]=$DEST/python-ceilometerclient +GITDIR["ceilometermiddleware"]=$DEST/ceilometermiddleware + +# Get rid of this before done. +# Tell emacs to use shell-script-mode +## Local variables: +## mode: shell-script +## End: