# Install and start **Vitrage** service in devstack # # To enable vitragebehaviortack add an entry to local.conf that # looks like # # [[local|localrc]] # enable_plugin vitrage git://git.openstack.org/openstack/vitrage # # By default all vitrage services are started (see # devstack/settings). # # Defaults # -------- GITDIR["python-vitrageclient"]=$DEST/python-vitrageclient GITREPO["python-vitrageclient"]=${VITRAGECLIENT_REPO:-${GIT_BASE}/openstack/python-vitrageclient.git} GITBRANCH["python-vitrageclient"]=${VITRAGECLIENT_BRANCH:-master} # Support potential entry-points console scripts in VENV or not if [[ ${USE_VENV} = True ]]; then PROJECT_VENV["vitrage"]=${VITRAGE_DIR}.venv VITRAGE_BIN_DIR=${PROJECT_VENV["vitrage"]}/bin else VITRAGE_BIN_DIR=$(get_python_exec_prefix) fi if [ -z "$VITRAGE_DEPLOY" ]; then # Default VITRAGE_DEPLOY=simple # Fallback to common wsgi devstack configuration if [ "$ENABLE_HTTPD_MOD_WSGI_SERVICES" == "True" ]; then VITRAGE_DEPLOY=mod_wsgi # Deprecated config elif [ -n "$VITRAGE_USE_MOD_WSGI" ] ; then echo_summary "VITRAGE_USE_MOD_WSGI is deprecated, use VITRAGE_DEPLOY instead" if [ "$VITRAGE_USE_MOD_WSGI" == True ]; then VITRAGE_DEPLOY=mod_wsgi fi fi fi # Test if any Vitrage services are enabled # is_vitrage_enabled function is_vitrage_enabled { [[ ,${ENABLED_SERVICES} =~ ,"vitrage-" ]] && return 0 return 1 } function vitrage_service_url { echo "$VITRAGE_SERVICE_PROTOCOL://$VITRAGE_SERVICE_HOST:$VITRAGE_SERVICE_PORT" } # Configure mod_wsgi function _vitrage_config_apache_wsgi { sudo mkdir -p $VITRAGE_WSGI_DIR local vitrage_apache_conf=$(apache_site_config_for vitrage) local apache_version=$(get_apache_version) local venv_path="" # Copy proxy vhost and wsgi file sudo cp $VITRAGE_DIR/vitrage/api/app.wsgi $VITRAGE_WSGI_DIR/app if [[ ${USE_VENV} = True ]]; then venv_path="python-path=${PROJECT_VENV["vitrage"]}/lib/$(python_version)/site-packages" fi sudo cp $VITRAGE_DIR/devstack/apache-vitrage.template $vitrage_apache_conf sudo sed -e " s|%PORT%|$VITRAGE_SERVICE_PORT|g; s|%APACHE_NAME%|$APACHE_NAME|g; s|%WSGIAPP%|$VITRAGE_WSGI_DIR/app|g; s|%USER%|$STACK_USER|g; s|%APIWORKERS%|$API_WORKERS|g; s|%VIRTUALENV%|$venv_path|g " -i $vitrage_apache_conf } # Create vitrage related accounts in Keystone function _vitrage_create_accounts { if is_service_enabled vitrage-api; then get_or_create_user "vitrage" "$ADMIN_PASSWORD" "$ADMIN_DOMAIN_NAME" get_or_add_user_project_role "admin" "vitrage" "$SERVICE_PROJECT_NAME" "$SERVICE_DOMAIN_NAME" "$SERVICE_DOMAIN_NAME" get_or_add_user_project_role "admin" "vitrage" "admin" "$ADMIN_DOMAIN_NAME" "$ADMIN_DOMAIN_NAME" local vitrage_service=$(get_or_create_service "vitrage" \ "rca" "Root Cause Analysis Service") get_or_create_endpoint $vitrage_service \ "$REGION_NAME" \ "$(vitrage_service_url)" \ "$(vitrage_service_url)" \ "$(vitrage_service_url)" fi } # Activities to do before vitrage has been installed. function preinstall_vitrage { # Nothing for now : } # Remove WSGI files, disable and remove Apache vhost file function _vitrage_cleanup_apache_wsgi { sudo rm -f $VITRAGE_WSGI_DIR/* sudo rm -f $(apache_site_config_for vitrage) } # cleanup_vitrage() - Remove residual data files, anything left over # from previous runs that a clean run would need to clean up function cleanup_vitrage { if [ "$VITRAGE_DEPLOY" == "mod_wsgi" ]; then _vitrage_cleanup_apache_wsgi fi # delete all vitrage configurations sudo rm -rf /etc/vitrage/* } function disable_vitrage_datasource { local enabled_datasources=",${VITRAGE_DEFAULT_DATASOURCES}," local datasource for datasource in $@; do enabled_datasources=${enabled_datasources//,$datasource,/,} done VITRAGE_DEFAULT_DATASOURCES=$(_cleanup_service_list "$enabled_datasources") } # Set configuration for database backend. function vitrage_configure_db_backend { if [ "$VITRAGE_DATABASE" = 'mysql' ] || [ "$VITRAGE_DATABASE" = 'postgresql' ] ; then iniset $VITRAGE_CONF database connection $(database_connection_url vitrage) else die $LINENO "Unable to configure unknown VITRAGE_DATABASE $VITRAGE_DATABASE" fi } # Configure Vitrage function configure_vitrage { iniset_rpc_backend vitrage $VITRAGE_CONF iniset $VITRAGE_CONF DEFAULT debug "$ENABLE_DEBUG_LOG_LEVEL" # Set up logging if [ "$SYSLOG" != "False" ]; then iniset $VITRAGE_CONF DEFAULT use_syslog "True" fi # Format logging if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ] && [ "$VITRAGE_DEPLOY" != "mod_wsgi" ]; then setup_colorized_logging $VITRAGE_CONF DEFAULT fi cp $VITRAGE_DIR/etc/vitrage/api-paste.ini $VITRAGE_CONF_DIR # Service credentials - openstack clients using keystone iniset $VITRAGE_CONF service_credentials auth_type password iniset $VITRAGE_CONF service_credentials username vitrage iniset $VITRAGE_CONF service_credentials user_domain_id default iniset $VITRAGE_CONF service_credentials project_domain_id default iniset $VITRAGE_CONF service_credentials password $ADMIN_PASSWORD iniset $VITRAGE_CONF service_credentials project_name admin iniset $VITRAGE_CONF service_credentials region_name $REGION_NAME iniset $VITRAGE_CONF service_credentials auth_url $KEYSTONE_SERVICE_URI # Configured db vitrage_configure_db_backend # remove neutron vitrage datasource if neutron datasource not installed if ! is_service_enabled neutron; then disable_vitrage_datasource neutron.network neutron.port fi # remove aodh vitrage datasource if aodh datasource not installed if ! is_service_enabled aodh; then disable_vitrage_datasource aodh fi # remove heat vitrage datasource if heat datasource not installed if ! is_service_enabled heat; then disable_vitrage_datasource heat.stack fi # remove nagios vitrage datasource if nagios datasource not installed if [ "$VITRAGE_USE_NAGIOS" == "False" ]; then disable_vitrage_datasource nagios fi # add default datasources iniset $VITRAGE_CONF datasources types $VITRAGE_DEFAULT_DATASOURCES # create some folders mkdir -p $VITRAGE_CONF_DIR/datasources_values mkdir -p $VITRAGE_CONF_DIR/static_datasources mkdir -p $VITRAGE_CONF_DIR/templates # copy datasources cp $VITRAGE_DIR/etc/vitrage/datasources_values/*.yaml $VITRAGE_CONF_DIR/datasources_values configure_auth_token_middleware $VITRAGE_CONF vitrage $VITRAGE_AUTH_CACHE_DIR iniset $VITRAGE_CONF "keystone_authtoken" password $ADMIN_PASSWORD iniset $VITRAGE_CONF "keystone_authtoken" user_domain_name $admin_domain_name iniset $VITRAGE_CONF "keystone_authtoken" project_name $admin_project_name iniset $VITRAGE_CONF "keystone_authtoken" project_domain_name $admin_domain_name if [ "$VITRAGE_DEPLOY" == "mod_wsgi" ]; then _vitrage_config_apache_wsgi elif [ "$VITRAGE_DEPLOY" == "uwsgi" ]; then # iniset creates these files when it's called if they don't exist. VITRAGE_UWSGI_FILE=$VITRAGE_CONF_DIR/vitrage-uwsgi.ini rm -f "$VITRAGE_UWSGI_FILE" iniset "$VITRAGE_UWSGI_FILE" uwsgi http $VITRAGE_SERVICE_HOST:$VITRAGE_SERVICE_PORT iniset "$VITRAGE_UWSGI_FILE" uwsgi wsgi-file "$VITRAGE_DIR/vitrage/api/app.wsgi" # This is running standalone iniset "$VITRAGE_UWSGI_FILE" uwsgi master true # Set die-on-term & exit-on-reload so that uwsgi shuts down iniset "$VITRAGE_UWSGI_FILE" uwsgi die-on-term true iniset "$VITRAGE_UWSGI_FILE" uwsgi exit-on-reload true iniset "$VITRAGE_UWSGI_FILE" uwsgi threads 10 iniset "$VITRAGE_UWSGI_FILE" uwsgi processes $API_WORKERS iniset "$VITRAGE_UWSGI_FILE" uwsgi enable-threads true iniset "$VITRAGE_UWSGI_FILE" uwsgi plugins python iniset "$VITRAGE_UWSGI_FILE" uwsgi lazy-apps true # uwsgi recommends this to prevent thundering herd on accept. iniset "$VITRAGE_UWSGI_FILE" uwsgi thunder-lock true # Override default size for headers from the 4k default. iniset "$VITRAGE_UWSGI_FILE" uwsgi buffer-size 65535 # Make sure client doesn't try to re-use the connection. iniset "$VITRAGE_UWSGI_FILE" uwsgi add-header "Connection: close" fi } # init_vitrage() - Initialize etc. function init_vitrage { # Get vitrage keystone settings in place _vitrage_create_accounts # Create and upgrade database only when used if is_service_enabled mysql postgresql; then if [ "$VITRAGE_DATABASE" = 'mysql' ] || [ "$VITRAGE_DATABASE" = 'postgresql' ] ; then recreate_database vitrage $VITRAGE_BIN_DIR/vitrage-dbsync fi fi # Create cache dir sudo install -d -o $STACK_USER $VITRAGE_AUTH_CACHE_DIR rm -f $VITRAGE_AUTH_CACHE_DIR/* } # Install Vitrage. function install_vitrage { install_vitrageclient setup_develop "$VITRAGE_DIR" sudo install -d -o $STACK_USER -m 755 $VITRAGE_CONF_DIR if [ "$VITRAGE_DEPLOY" == "mod_wsgi" ]; then install_apache_wsgi elif [ "$VITRAGE_DEPLOY" == "uwsgi" ]; then pip_install uwsgi fi } # install_vitrageclient() function install_vitrageclient { if use_library_from_git "python-vitrageclient"; then git_clone_by_name "python-vitrageclient" setup_dev_lib "python-vitrageclient" sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-vitrageclient"]}/tools/,/etc/bash_completion.d/}vitrage.bash_completion else pip_install_gr python-vitrageclient fi } # start_vitrage() - Start running processes function start_vitrage { if [[ "$VITRAGE_DEPLOY" == "mod_wsgi" ]]; then enable_apache_site vitrage restart_apache_server elif [ "$VITRAGE_DEPLOY" == "uwsgi" ]; then run_process vitrage-api "$VITRAGE_BIN_DIR/uwsgi $VITRAGE_UWSGI_FILE" else run_process vitrage-api "$VITRAGE_BIN_DIR/vitrage-api -d -v --config-file $VITRAGE_CONF" fi # Only die on API if it was actually intended to be turned on if is_service_enabled vitrage-api; then echo "Waiting for vitrage-api to start..." if ! wait_for_service $SERVICE_TIMEOUT $(vitrage_service_url)/v1/; then die $LINENO "vitrage-api did not start" fi fi run_process vitrage-collector "$VITRAGE_BIN_DIR/vitrage-collector --config-file $VITRAGE_CONF" run_process vitrage-graph "$VITRAGE_BIN_DIR/vitrage-graph --config-file $VITRAGE_CONF" run_process vitrage-notifier "$VITRAGE_BIN_DIR/vitrage-notifier --config-file $VITRAGE_CONF" run_process vitrage-ml "$VITRAGE_BIN_DIR/vitrage-ml --config-file $VITRAGE_CONF" run_process vitrage-persistor "$VITRAGE_BIN_DIR/vitrage-persistor --config-file $VITRAGE_CONF" write_systemd_dependency vitrage-graph vitrage-collector } function write_systemd_dependency { local service_after=$1 local service_before=$2 local systemd_service_after="devstack@$service_after.service" local systemd_service_before="devstack@$service_before.service" local unitfile_after="$SYSTEMD_DIR/$systemd_service_after" local unitfile_before="$SYSTEMD_DIR/$systemd_service_before" iniset -sudo $unitfile_after "Unit" "Requires" "$systemd_service_before" iniset -sudo $unitfile_after "Unit" "After" "$systemd_service_before" iniset -sudo $unitfile_before "Unit" "Requires" "$systemd_service_after" iniset -sudo $unitfile_before "Unit" "Before" "$systemd_service_after" $SYSTEMCTL daemon-reload } # stop_vitrage() - Stop running processes function stop_vitrage { if [ "$VITRAGE_DEPLOY" == "mod_wsgi" ]; then disable_apache_site vitrage restart_apache_server fi for serv in vitrage-api vitrage-collector vitrage-graph vitrage-notifier vitrage-persistor; do stop_process $serv done } function modify_heat_global_index_policy_rule { if is_service_enabled heat; then cat << EOF > /etc/heat/policy.yaml # List stacks globally. # GET /v1/{tenant_id}/stacks "stacks:global_index": "rule:deny_stack_user" EOF fi } # This is the main for plugin.sh if is_service_enabled vitrage; then if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then # Set up other services echo_summary "Configuring system services for Vitrage" preinstall_vitrage elif [[ "$1" == "stack" && "$2" == "install" ]]; then echo_summary "Installing Vitrage" # Use stack_install_service here to account for virtualenv stack_install_service vitrage elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then echo_summary "Configuring Vitrage" configure_vitrage elif [[ "$1" == "stack" && "$2" == "extra" ]]; then echo_summary "Initializing Vitrage" # enable global index modify_heat_global_index_policy_rule # Tidy base for vitrage init_vitrage # Start the services start_vitrage fi if [[ "$1" == "unstack" ]]; then echo_summary "Shutting Down Vitrage" stop_vitrage fi if [[ "$1" == "clean" ]]; then echo_summary "Cleaning Vitrage" cleanup_vitrage fi fi