openstack/monasca-events-api
Code Issues Proposed changes
Monasca Events REST API
599 Commits 9 Branches 39 Tags 3.3 MiB
Python 76.6%
Shell 23.4%
f0736202d4
Go to file
Craig Bryant f0736202d4 Update API doc for Alarm Definitions 
Explain how Alarm Definitions work and how they generate Alarms with
examples

Updated Table of Contents which was way out of date

Change-Id: I23c5531b645a2262abef50828f435fb7b9499521
2014-11-05 12:45:44 -07:00
docs Update API doc for Alarm Definitions 2014-11-05 12:45:44 -07:00
etc Add alarm definition create resource 2014-10-31 09:45:01 -06:00
monasca Use properties in alarm expression parser 2014-11-03 11:03:52 -07:00
src Change alarm_id to alarm_definition_id in alarm_action table 2014-10-31 14:38:05 -06:00
.coveragerc initial python implementation 2014-09-15 13:18:10 -04:00
.gitignore initial python implementation 2014-09-15 13:18:10 -04:00
.gitreview Get initial build to work. 2014-07-15 15:35:50 -06:00
.testr.conf initial python implementation 2014-09-15 13:18:10 -04:00
babel.cfg initial python implementation 2014-09-15 13:18:10 -04:00
LICENSE Added license file 2014-05-01 16:22:11 -07:00
pom.xml Use new monasca-common package names 2014-10-14 13:00:17 -06:00
README.md Use new monasca-common package names 2014-10-14 13:00:17 -06:00
requirements.txt initial python implementation 2014-09-15 13:18:10 -04:00
setup.cfg Add alarm definition create resource 2014-10-31 09:45:01 -06:00
setup.py initial python implementation 2014-09-15 13:18:10 -04:00
test-requirements.txt initial python implementation 2014-09-15 13:18:10 -04:00
tox.ini initial python implementation 2014-09-15 13:18:10 -04:00

README.md

Overview

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

Build

Requires monasca-common from https://github.com/stackforge/monasca-common. Download and do mvn install.

mvn clean install

Usage

java -jar target/monasca-api.jar server config-file.yml

Design Overview

Architectural layers

Requests flow through the following architectural layers from top to bottom:

  • Resource
    • Serves as the entrypoint into the service.
    • Responsible for handling web service requests, and performing structural request validation.
  • Application
    • Responsible for providing application level implementations for specific use cases.
  • Domain
    • Contains the technology agnostic core domain model and domain service definitions.
    • Responsible for upholding invariants and defining state transitions.
  • Infrastructure
    • Contains technology specific implementations of domain services.

Documentation

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/monasca.ini
/etc/monasca/monasca.conf

Once the configurations 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/monasca.ini

Running the server as daemons
gunicorn -k eventlet --worker-connections=2000 --backlog=1000
         --paste /etc/monasca/monasca.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   (or -e py26, -e py33)

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.