Monasca REST API
Go to file
Zuul 471c0fb8ce Merge "Add keystone parameters to authenticate webhook notifications" 2018-08-09 09:42:39 +00:00
api-ref Prepare foundation for doc migration 2017-07-31 10:43:49 +00:00
common Restore user condition but with zuul 2017-10-19 06:08:28 +02:00
config-generator Using oslo.policy for monasca-api 2018-06-05 12:25:07 +00:00
contrib Remove bundled intree monasca-api tempest plugin 2018-01-31 11:50:16 +05:30
devstack Merge "Add keystone parameters to authenticate webhook notifications" 2018-08-09 09:42:39 +00:00
doc Add monasca_db command line tool 2018-08-01 11:10:14 +00:00
docs Replace chinese double quotes to English double quotes 2018-06-17 16:29:35 +08:00
etc Enable uWSGI support in devstack 2018-06-12 14:36:46 +02:00
java upper common and persister pom version to 1.3.0 2017-12-19 13:09:28 -08:00
monasca_api Merge "Remove usage of future library" 2018-08-08 10:29:10 +00:00
perf Add read performance testing to monasca-api 2018-01-25 08:18:13 -08:00
playbooks/legacy/monasca-tempest-base Remove bundled intree monasca-api tempest plugin 2018-01-31 11:50:16 +05:30
releasenotes Merge "Upgrade Apache Kafka to ver. 1.0.1 in devstack" 2018-08-08 10:49:27 +00:00
tools Avoid tox_install.sh for constraints support 2017-12-01 15:37:36 +01:00
.coveragerc Migrate test run to ostestr 2017-01-14 19:47:29 +00:00
.gitignore Add .stestr.conf . 2017-09-22 13:41:11 +02:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:30:33 +00:00
.stestr.conf Add .stestr.conf . 2017-09-22 13:41:11 +02:00
.testr.conf Migrate test run to ostestr 2017-01-14 19:47:29 +00:00
.zuul.yaml Add irrelevant-files to monasca-tempest-base job 2018-04-25 15:26:44 +02:00
LICENSE Added license file 2014-05-01 16:22:11 -07:00
README.rst Fix README.rst and add syntax check 2018-08-06 14:23:12 +02:00
babel.cfg initial python implementation 2014-09-15 13:18:10 -04:00
bindep.txt Add libssl to fix pep8 2017-06-07 15:54:02 -06:00
lower-constraints.txt uncap eventlet 2018-04-12 18:33:28 +02:00
pom.xml Update links in pom.xml 2018-01-12 16:27:30 +08:00
requirements.txt Using oslo.policy for monasca-api 2018-06-05 12:25:07 +00:00
run_maven.sh Ensure the same branch is used for common build 2016-02-10 09:11:02 -07:00
setup.cfg Add monasca_db command line tool 2018-08-01 11:10:14 +00:00
setup.py Updated from global requirements 2017-03-02 11:47:00 +00:00
test-requirements.txt Switch to using stestr 2018-06-29 12:00:48 -04:00
tox.ini Fix README.rst and add syntax check 2018-08-06 14:23:12 +02:00

README.rst

Team and repository tags

image

Overview

monasca-api is a RESTful API server that is designed with a layered architecture.

Documentation

The full API Specification can be found in docs/monasca-api-spec.md

Python Monasca API Implementation

To install the python api implementation, git clone the source and run the following command:

$ sudo python setup.py install

If it installs successfully, you will need to make changes to the following two files to reflect your system settings, especially where kafka server is located:

/etc/monasca/api-config.ini
/etc/monasca/api-config.conf
/etc/monasca/api-logging.conf

Once the configuration files are modified to match your environment, you can start up the server by following the following instructions.

To start the server, run the following command:

Running the server in foreground mode
$ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini

Running the server as daemons
$ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini -D

To check if the code follows python coding style, run the following command from the root directory of this project

$ tox -e pep8

To run all the unit test cases, run the following command from the root directory of this project

$ tox -e py27

Start the Server for Apache

To start the server using Apache: create a modwsgi file, create a modwsgi configuration file, and enable the wsgi module in Apache.

The modwsgi configuration file may look something like this, and the site will need to be enabled:

Listen 8070

<VirtualHost *:8070>

    WSGIDaemonProcess monasca-api processes=4 threads=1 socket-timeout=120 user=mon-api group=monasca python-path=/usr/local/lib/python2.7/site-packages
    WSGIProcessGroup monasca-api
    WSGIApplicationGroup monasca-api
    WSGIScriptAlias / /usr/local/lib/python2.7/site-packages/monasca_api/api/wsgi/monasca_api.py

    WSGIPassAuthorization On

    LogLevel info
    ErrorLog /var/log/monasca-api/wsgi.log
    CustomLog /var/log/monasca-api/wsgi-access.log combined

    <Directory /usr/local/lib/python2.7/site-packages/monasca_api>
      Require all granted
    </Directory>

    SetEnv no-gzip 1

</VirtualHost>

The wsgi file may look something like this:

from monasca_api.api import server

application = server.get_wsgi_app(config_base_path='/etc/monasca')

Java Implementation

Details on usage can be found here

WARNING: The Java implementation of Monasca API is DEPRECATED and will be removed in future release.

License

Copyright (c) 2014 Hewlett-Packard Development Company, L.P.

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.