summaryrefslogtreecommitdiff
path: root/README.rst
blob: 8e6f11335e5424ad6e0b4cbd0d45aa09fb535c26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
Team and repository tags
========================

.. image:: https://governance.openstack.org/tc/badges/monasca-api.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

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/monasca-api.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:

.. code:: apache

       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:

.. code:: py


       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.

.. _layered architecture: https://en.wikipedia.org/wiki/Multilayered_architecture
.. _docs/monasca-api-spec.md: docs/monasca-api-spec.md
.. _here: /docs/java.md