monasca-api/devstack
jayonlau 95747eec73 Clean up extra spaces
Although these errors are not important, they affect the code specification.

Change-Id: Iab8e8ce9e73722c78283323a2e350149e8713e78
2021-10-01 18:31:14 +00:00
..
files Fix log-metric configuration 2021-04-06 10:24:10 +00:00
lib [goal] Migrate testing to ubuntu focal 2020-10-12 15:38:05 +02:00
README.md Update DevStack plugin Readme 2019-12-17 13:17:28 +01:00
Vagrantfile Fix Vagrantfile 2021-10-01 16:26:59 +02:00
override-defaults Disable mod-wsgi deployment of keystone 2017-07-17 05:50:02 +00:00
plugin.sh Clean up extra spaces 2021-10-01 18:31:14 +00:00
settings [goal] Migrate testing to ubuntu focal 2020-10-12 15:38:05 +02:00

README.md

Monasca DevStack Plugin

The Monasca DevStack plugin currently only works on Ubuntu 18.04 (Bionic). More Linux Distributions will be supported in the future.

Running the Monasca DevStack plugin requires a machine with 10GB of RAM.

Directions for installing and running Devstack can be found here:

https://docs.openstack.org/devstack/latest/

To run Monasca in DevStack, do the following three steps.

  1. Clone the DevStack repo.
git clone https://opendev.org/openstack/devstack
  1. Add the following to the DevStack local.conf file in the root of the devstack directory. You may need to create the local.conf if it does not already exist.
# BEGIN DEVSTACK LOCAL.CONF CONTENTS

[[local|localrc]]
DATABASE_PASSWORD=secretdatabase
RABBIT_PASSWORD=secretrabbit
ADMIN_PASSWORD=secretadmin
SERVICE_PASSWORD=secretservice

LOGFILE=$DEST/logs/stack.sh.log
LOGDIR=$DEST/logs
LOG_COLOR=False

# The following variable allow switching between Java and Python for
# the implementations of the Monasca Persister. If this variable is not set,
# then the default is to install the Python implementation of
# the Monasca Persister.

# Uncomment of the following two lines to choose Java or Python for
# the Monasca Pesister.
# MONASCA_PERSISTER_IMPLEMENTATION_LANG=${MONASCA_PERSISTER_IMPLEMENTATION_LANG:-java}
MONASCA_PERSISTER_IMPLEMENTATION_LANG=${MONASCA_PERSISTER_IMPLEMENTATION_LANG:-python}

# Uncomment one of the following two lines to choose either InfluxDB or
# Apache Cassandra.
# default "influxdb" is selected as metric DB.
MONASCA_METRICS_DB=${MONASCA_METRICS_DB:-influxdb}
# MONASCA_METRICS_DB=${MONASCA_METRICS_DB:-cassandra}

# This line will enable all of Monasca.
enable_plugin monasca-api https://opendev.org/openstack/monasca-api

# END DEVSTACK LOCAL.CONF CONTENTS
  1. Run './stack.sh' from the root of the devstack directory.

If you want to run Monasca with the bare mininum of OpenStack components you can add the following two lines to the local.conf file.

disable_all_services
enable_service rabbit mysql key

If you also want the Tempest tests to be installed then add tempest and monasca-tempest-plugin.

enable_service rabbit mysql key tempest
enable_plugin monasca-tempest-plugin https://opendev.org/openstack/monasca-tempest-plugin

To enable Horizon and the Monasca UI add horizon

enable_service rabbit mysql key horizon tempest

Using Vagrant

Vagrant can be used to deploy a VM with Devstack and Monasca running in it using the Vagrantfile. After installing Vagrant, just run the command vagrant up as usual in the ../monasca-api/devstack directory.

To use local repositories in the devstack install, commit your changes to the master branch of the local repo, then modify the _REPO variable in the settings file that corresponds to the local repo to use file://my/local/repo/location. To use a local instance of the monasca-api repo, change the enable_plugin monasca-api https://opendev.org/openstack/monasca-api to enable_plugin monasca-api file://my/repo/is/here. Both of these settings will only take effect on a rebuild of the devstack VM.

Enforcing Apache mirror

If, for any reason, APACHE_MIRROR that is picked is not working, you can enforce it in following way:

APACHE_MIRROR=http://www-us.apache.org/dist/

Using WSGI

Monasca-api can be deployed with Apache using uwsgi and gunicorn. By default monasca-api runs under uwsgi. If you wish to use gunicorn make sure that devstack/local.conf contains:

MONASCA_API_USE_MOD_WSGI=False

License

(c) Copyright 2015-2016 Hewlett Packard Enterprise Development Company LP
Copyright Fujitsu LIMITED 2017

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.