summaryrefslogtreecommitdiff
path: root/README.rst
blob: 90d516d7249d42ed7771e748801d0710cb143874 (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
========================
Team and repository tags
========================

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

.. Change things from this point on

OpenStack Monasca-Log-Api
=========================

OpenStack Monasca-Log-Api provides RESTful Api to collect logs
from the OpenStack cloud.

OpenStack Monasca-Log-Api is distributed under the terms of the Apache
License, Version 2.0. The full terms and conditions of this
license are detailed in the LICENSE file.

Api
---

To learn how to use Monasca-Log-Api, consult the documentation
available online at:

* `Api Guide <https://developer.openstack.org/api-guide/monitoring-log-api/>`_
* `Api Ref <https://developer.openstack.org/api-ref/monitoring-log-api/>`_

For more information on OpenStack Apis, SDKs and CLIs,
please see:

* `OpenStack Application Development <https://www.openstack.org/appdev/>`_
* `OpenStack Developer Documentation <https://developer.openstack.org/>`_

Developers
----------

For information on how to contribute to Monasca-Log-Api, please see the
contents of the CONTRIBUTING.rst.

Any new code must follow the development guidelines detailed
in the HACKING.rst file, and pass all unit tests as well as linters.

Further developer focused documentation is available at:

* `Monasca-Log-Api <https://docs.openstack.org/monasca-log-api/latest/>`_

Operators
---------

To learn how to deploy and configure OpenStack Monasca-Log-Api, consult the
documentation available online at:

* `Installation <https://docs.openstack.org/monasca-log-api/latest/install/>`_
* `Configuration <https://docs.openstack.org/monasca-log-api/latest/configuration/>`_

Bug tracking
------------

In the unfortunate event that bugs are discovered, they should
be reported to the appropriate bug tracker. If you obtained
the software from a 3rd party operating system vendor, it is
often wise to use their own bug tracker for reporting problems.
In all other cases use the master OpenStack bug tracker,
available at:

* `Storyboard <https://storyboard.openstack.org/#!/project/869>`_