"Fossies" - the Fresh Open Source Software Archive

Member "monasca-api-4.0.0/PKG-INFO" (13 May 2020, 5870 Bytes) of package /linux/misc/openstack/monasca-api-4.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "PKG-INFO": 3.1.0_vs_4.0.0.

    1 Metadata-Version: 2.1
    2 Name: monasca-api
    3 Version: 4.0.0
    4 Summary: OpenStack Monitoring as a Service
    5 Home-page: https://docs.openstack.org/monasca-api/latest/
    6 Author: OpenStack
    7 Author-email: openstack-discuss@lists.openstack.org
    8 License: UNKNOWN
    9 Description: Team and repository tags
   10         ========================
   11         
   12         .. image:: https://governance.openstack.org/tc/badges/monasca-api.svg
   13             :target: https://governance.openstack.org/tc/reference/tags/index.html
   14         
   15         .. Change things from this point on
   16         
   17         Overview
   18         ========
   19         
   20         ``monasca-api`` is a RESTful API server that is designed with a `layered
   21         architecture`_.
   22         
   23         Documentation
   24         -------------
   25         
   26         The full API Specification can be found in `docs/monasca-api-spec.md`_
   27         
   28         Python Monasca API Implementation
   29         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   30         
   31         To install the python api implementation, git clone the source and run
   32         the following command:
   33         
   34         ::
   35         
   36            $ sudo python setup.py install
   37         
   38         If it installs successfully, you will need to make changes to the
   39         following two files to reflect your system settings, especially where
   40         kafka server is located:
   41         
   42         ::
   43         
   44            /etc/monasca/api-config.ini
   45            /etc/monasca/monasca-api.conf
   46            /etc/monasca/api-logging.conf
   47         
   48         Once the configuration files are modified to match your environment, you
   49         can start up the server by following the following instructions.
   50         
   51         To start the server, run the following command:
   52         
   53         ::
   54         
   55            Running the server in foreground mode
   56            $ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini
   57         
   58            Running the server as daemons
   59            $ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini -D
   60         
   61         To check if the code follows python coding style, run the following
   62         command from the root directory of this project
   63         
   64         ::
   65         
   66            $ tox -e pep8
   67         
   68         To run all the unit test cases, run the following command from the root
   69         directory of this project
   70         
   71         ::
   72         
   73            $ tox -e py36
   74         
   75         Start the Server - for Apache
   76         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   77         
   78         To start the server using Apache: create a modwsgi file, create a
   79         modwsgi configuration file, and enable the wsgi module in Apache.
   80         
   81         The modwsgi configuration file may look something like this, and the
   82         site will need to be enabled:
   83         
   84         .. code:: apache
   85         
   86                Listen 8070
   87         
   88                <VirtualHost *:8070>
   89         
   90                    WSGIDaemonProcess monasca-api processes=4 threads=1 socket-timeout=120 user=mon-api group=monasca python-path=/usr/local/lib/python2.7/site-packages
   91                    WSGIProcessGroup monasca-api
   92                    WSGIApplicationGroup monasca-api
   93                    WSGIScriptAlias / /usr/local/lib/python2.7/site-packages/monasca_api/api/wsgi/monasca_api.py
   94         
   95                    WSGIPassAuthorization On
   96         
   97                    LogLevel info
   98                    ErrorLog /var/log/monasca-api/wsgi.log
   99                    CustomLog /var/log/monasca-api/wsgi-access.log combined
  100         
  101                    <Directory /usr/local/lib/python2.7/site-packages/monasca_api>
  102                      Require all granted
  103                    </Directory>
  104         
  105                    SetEnv no-gzip 1
  106         
  107                </VirtualHost>
  108         
  109         The wsgi file may look something like this:
  110         
  111         .. code:: py
  112         
  113         
  114                from monasca_api.api import server
  115         
  116                application = server.get_wsgi_app(config_base_path='/etc/monasca')
  117         
  118         Java Implementation
  119         ~~~~~~~~~~~~~~~~~~~
  120         
  121         Details on usage can be found `here`_
  122         
  123         WARNING: The Java implementation of Monasca API is DEPRECATED and will
  124         be removed in future release.
  125         
  126         License
  127         =======
  128         
  129         Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
  130         
  131         Licensed under the Apache License, Version 2.0 (the "License"); you may
  132         not use this file except in compliance with the License. You may obtain
  133         a copy of the License at
  134         
  135         ::
  136         
  137            http://www.apache.org/licenses/LICENSE-2.0
  138         
  139         Unless required by applicable law or agreed to in writing, software
  140         distributed under the License is distributed on an "AS IS" BASIS,
  141         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  142         See the License for the specific language governing permissions and
  143         limitations under the License.
  144         
  145         .. _layered architecture: https://en.wikipedia.org/wiki/Multilayered_architecture
  146         .. _docs/monasca-api-spec.md: docs/monasca-api-spec.md
  147         .. _here: /docs/java.md
  148         
  149         
  150 Platform: UNKNOWN
  151 Classifier: Environment :: OpenStack
  152 Classifier: Intended Audience :: Information Technology
  153 Classifier: Intended Audience :: System Administrators
  154 Classifier: License :: OSI Approved :: Apache Software License
  155 Classifier: Operating System :: POSIX :: Linux
  156 Classifier: Programming Language :: Python
  157 Classifier: Programming Language :: Python :: Implementation :: CPython
  158 Classifier: Programming Language :: Python :: 3 :: Only
  159 Classifier: Programming Language :: Python :: 3.6
  160 Classifier: Programming Language :: Python :: 3.7
  161 Requires-Python: >=3.6
  162 Provides-Extra: influxdb
  163 Provides-Extra: cassandra
  164 Provides-Extra: test