Use monasca-log-api.conf for doc, devstack and docker
api-log.conf is the deprecated path for the configuration file. The new path is /etc/monasca/monasca-log-api.conf . So use this new path in devstack, documentation and docker. Change-Id: I2208b7e27d3dbec38290ffb8ba66bc64a5129744 Story: 2004831 Task: 29024
This commit is contained in:
Thomas Bechtold
parent
d8f53e80c8
commit
5c2ebbed54
@ -1,5 +1,5 @@
|
||||
[DEFAULT]
|
||||
output_file = etc/monasca/log-api.conf.sample
|
||||
output_file = etc/monasca/monasca-log-api.conf.sample
|
||||
wrap_width = 79
|
||||
format = ini
|
||||
summarize = True
|
||||
|
||||
@ -44,7 +44,7 @@ MONASCA_LOG_API_LOG_DIR=${MONASCA_LOG_API_LOG_DIR:-/var/log/monasca}
|
||||
MONASCA_LOG_API_CACHE_DIR=${MONASCA_LOG_API_CACHE_DIR:-/var/cache/monasca-log-api}
|
||||
MONASCA_LOG_API_WSGI_DIR=${MONASCA_LOG_API_WSGI_DIR:-/var/www/monasca-log-api}
|
||||
|
||||
MONASCA_LOG_API_CONF=${MONASCA_LOG_API_CONF:-$MONASCA_LOG_API_CONF_DIR/log-api.conf}
|
||||
MONASCA_LOG_API_CONF=${MONASCA_LOG_API_CONF:-$MONASCA_LOG_API_CONF_DIR/monasca-log-api.conf}
|
||||
MONASCA_LOG_API_PASTE=${MONASCA_LOG_API_PASTE:-$MONASCA_LOG_API_CONF_DIR/log-api-paste.ini}
|
||||
MONASCA_LOG_API_LOGGING_CONF=${MONASCA_LOG_API_LOGGING_CONF:-$MONASCA_LOG_API_CONF_DIR/log-api-logging.conf}
|
||||
MONASCA_LOG_API_UWSGI_CONF=${MONASCA_LOG_API_UWSGI_CONF:-$MONASCA_LOG_API_CONF_DIR/log-api-uwsgi.ini}
|
||||
|
||||
@ -200,13 +200,13 @@ function configure_monasca_log_api_core {
|
||||
|
||||
$MONASCA_LOG_API_BIN_DIR/oslo-config-generator \
|
||||
--config-file $MONASCA_LOG_API_DIR/config-generator/monasca-log-api.conf \
|
||||
--output-file /tmp/log-api.conf
|
||||
--output-file /tmp/monasca-log-api.conf
|
||||
|
||||
install -m 600 /tmp/log-api.conf $MONASCA_LOG_API_CONF && rm -rf /tmp/log-api.conf
|
||||
install -m 600 /tmp/monasca-log-api.conf $MONASCA_LOG_API_CONF && rm -rf /tmp/monasca-log-api.conf
|
||||
install -m 600 $MONASCA_LOG_API_DIR/etc/monasca/log-api-paste.ini $MONASCA_LOG_API_PASTE
|
||||
install -m 600 $MONASCA_LOG_API_DIR/etc/monasca/log-api-logging.conf $MONASCA_LOG_API_LOGGING_CONF
|
||||
|
||||
# configure log-api.conf
|
||||
# configure monasca-log-api.conf
|
||||
iniset "$MONASCA_LOG_API_CONF" DEFAULT log_config_append $MONASCA_LOG_API_LOGGING_CONF
|
||||
iniset "$MONASCA_LOG_API_CONF" service region $REGION_NAME
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ author = u'OpenStack Foundation'
|
||||
|
||||
# sample config
|
||||
config_generator_config_file = [
|
||||
('config-generator/monasca-log-api.conf', '_static/log-api')
|
||||
('config-generator/monasca-log-api.conf', '_static/monasca-log-api')
|
||||
|
||||
]
|
||||
policy_generator_config_file = [
|
||||
|
||||
@ -29,7 +29,7 @@ It prevents from unauthorized access and provides the isolation
|
||||
needed for multi-tenancy.
|
||||
|
||||
The configuration for ``keystonemiddleware`` should either be provided in
|
||||
``log-api.conf`` or in a file in one of the configuration directories.
|
||||
``monasca-log-api.conf`` or in a file in one of the configuration directories.
|
||||
For more details about configuration options, check
|
||||
`here <https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitecture.html#configuration>`_.
|
||||
|
||||
@ -44,7 +44,7 @@ Proper configuration should include:
|
||||
* ``max_message_size`` - maximum message size that can be posted a topic
|
||||
|
||||
The configuration for ``log_publisher`` should either be provided in
|
||||
``log-api.conf`` or in a file in one of the configuration directories.
|
||||
``monasca-log-api.conf`` or in a file in one of the configuration directories.
|
||||
|
||||
Configuring Healthcheck
|
||||
-----------------------
|
||||
@ -57,7 +57,7 @@ availability of the API. Configuration of healthcheck includes:
|
||||
* ``kafka_topics`` - list of topics that existence is verified by healthcheck
|
||||
|
||||
The configuration for ``kafka_healthcheck`` should either be provided in
|
||||
``log-api.conf`` or in a file in one of the configuration directories.
|
||||
``monasca-log-api.conf`` or in a file in one of the configuration directories.
|
||||
|
||||
Configuring Monitoring
|
||||
----------------------
|
||||
@ -77,7 +77,7 @@ There are several options you may want to tweak if necessary:
|
||||
metrics for this monasca-log-api instance
|
||||
|
||||
The configuration for ``monitoring`` should either be provided in
|
||||
``log-api.conf`` or in a file in one of the configuration directories.
|
||||
``monasca-log-api.conf`` or in a file in one of the configuration directories.
|
||||
|
||||
Configuring RBAC
|
||||
----------------
|
||||
@ -97,7 +97,7 @@ be configured as follows:
|
||||
on behalf of another project (tenant)
|
||||
|
||||
The configuration for ``roles_middleware`` can be provided either in
|
||||
``log-api.conf`` or in a file in one of the configuration directories.
|
||||
``monasca-log-api.conf`` or in a file in one of the configuration directories.
|
||||
|
||||
Configuring Logging
|
||||
-------------------
|
||||
@ -132,8 +132,8 @@ based on your deployment:
|
||||
of 100MBs)
|
||||
|
||||
The configuration of ``logging`` should be presented inside
|
||||
``log-api-logging.conf`` file and referenced from ``log-api.conf`` using
|
||||
``log_config_append`` option.
|
||||
``log-api-logging.conf`` file and referenced from ``monasca-log-api.conf``
|
||||
using ``log_config_append`` option.
|
||||
|
||||
If you want to know more about possible ways to save monasca-log-api logs,
|
||||
feel free to visit:
|
||||
|
||||
@ -6,8 +6,8 @@ Configuration files
|
||||
|
||||
Overview of monasca-log-api's configuration files.
|
||||
|
||||
log-api.conf
|
||||
------------
|
||||
monasca-log-api.conf
|
||||
--------------------
|
||||
|
||||
This is the main configuration file of monasca-log-api.
|
||||
It can be located in several places. During startup,
|
||||
@ -23,23 +23,23 @@ In this case, monasca-log-api searches the configuration files
|
||||
in the following directories:
|
||||
|
||||
* ``~/.monasca/monasca.conf.d/``
|
||||
* ``~/.monasca/log-api.conf.d/``
|
||||
* ``~/.monasca/monasca-log-api.conf.d/``
|
||||
* ``~/monasca.conf.d/``
|
||||
* ``~/log-api.conf.d/``
|
||||
* ``~/monasca-log-api.conf.d/``
|
||||
* ``/etc/monasca/monasca.conf.d/``
|
||||
* ``/etc/monasca/log-api.conf.d/``
|
||||
* ``/etc/monasca/monasca-log-api.conf.d/``
|
||||
* ``/etc/monasca.conf.d/``
|
||||
* ``/etc/log-api.conf.d/``
|
||||
* ``/etc/monasca-log-api.conf.d/``
|
||||
|
||||
Regardless of the location, the name of the main configuration file
|
||||
should always be ``log-api.conf``. For files located
|
||||
should always be ``monasca-log-api.conf``. For files located
|
||||
in ``.conf.d`` directories, the name is irrelevant, but it should
|
||||
indicate the file content.
|
||||
|
||||
For example, when guring keystone communication. The
|
||||
`keystonemiddleware <https://docs.openstack.org/keystonemiddleware/latest/>`_
|
||||
configuration would be, therefore, located in, for example,
|
||||
``/etc/log-api.conf.d/keystonemiddleware.conf``
|
||||
``/etc/monasca-log-api.conf.d/keystonemiddleware.conf``
|
||||
|
||||
A sample of this configuration file is also available
|
||||
:ref:`here <sample-configuration-api>`
|
||||
@ -48,7 +48,7 @@ log-api-logging.conf
|
||||
--------------------
|
||||
|
||||
This file contains the logging setup for monasca-log-api. It should be
|
||||
referenced from ``log-api.conf`` using, for example,
|
||||
referenced from ``monasca-log-api.conf`` using, for example,
|
||||
the following code snippet::
|
||||
|
||||
[DEFAULT]
|
||||
@ -87,7 +87,7 @@ log-api.policy.yaml
|
||||
-------------------
|
||||
|
||||
This is the configuration file for policies to access the services.
|
||||
the path of the file can be defined in ``log-api.conf``::
|
||||
the path of the file can be defined in ``monasca-log-api.conf``::
|
||||
|
||||
[oslo_policy]
|
||||
policy_file = log-api.policy.yaml
|
||||
|
||||
@ -15,10 +15,10 @@ of code in the monasca-log-api repository.
|
||||
Sample Configuration For Application
|
||||
------------------------------------
|
||||
|
||||
This sample configuration can also be viewed in `log-api.conf.sample
|
||||
<../_static/log-api.conf.sample>`_.
|
||||
This sample configuration can also be viewed in `monasca-log-api.conf.sample
|
||||
<../_static/monasca-log-api.conf.sample>`_.
|
||||
|
||||
.. literalinclude:: ../_static/log-api.conf.sample
|
||||
.. literalinclude:: ../_static/monasca-log-api.conf.sample
|
||||
|
||||
.. _sample-configuration-logging:
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ ENV \
|
||||
STAY_ALIVE_ON_FAILURE="false"
|
||||
|
||||
# Copy all neccessary files to proper locations.
|
||||
COPY log-api* /etc/monasca/
|
||||
COPY log-api* monasca-log-api* /etc/monasca/
|
||||
|
||||
# Run here all additionals steps your service need post installation.
|
||||
# Stay with only one `RUN` and use `&& \` for next steps to don't create
|
||||
|
||||
@ -72,7 +72,7 @@ STAY_ALIVE_ON_FAILURE false
|
||||
|
||||
Provide configuration templates
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
* log-api.conf.j2
|
||||
* monasca-log-api.conf.j2
|
||||
* log-api-gunicorn.conf.j2
|
||||
* log-api-logging.conf.j2
|
||||
* log-api.paste.ini.j2
|
||||
|
||||
@ -25,7 +25,7 @@ python3 /kafka_wait_for_topics.py
|
||||
# Template all config files before start, it will use env variables.
|
||||
# Read usage examples: https://pypi.org/project/Templer/
|
||||
echo "Start script: creating config files from templates"
|
||||
templer -v -f /etc/monasca/log-api.conf.j2 /etc/monasca/log-api.conf
|
||||
templer -v -f /etc/monasca/monasca-log-api.conf.j2 /etc/monasca/monasca-log-api.conf
|
||||
templer -v -f /etc/monasca/log-api-gunicorn.conf.j2 /etc/monasca/log-api-gunicorn.conf
|
||||
templer -v -f /etc/monasca/log-api-logging.conf.j2 /etc/monasca/log-api-logging.conf
|
||||
templer -v -f /etc/monasca/log-api-paste.ini.j2 /etc/monasca/log-api-paste.ini
|
||||
|
||||
Loading…
Reference in New Issue
Block a user