"Fossies" - the Fresh Open Source Software Archive 
Source code changes of the file "doc/source/configuration/files.rst" between
monasca-log-api-2.7.0.tar.gz and monasca-log-api-2.9.0.tar.gz
About: OpenStack Monasca Log API is a RESTful API server acting as gateway for logs collected from log-agents. The "Stein" series (maintained release).
| files.rst (monasca-log-api-2.7.0) | : | files.rst (monasca-log-api-2.9.0) | ||
|---|---|---|---|---|
| .. _configuration-files: | .. _configuration-files: | |||
| ------------------- | ------------------- | |||
| Configuration files | Configuration files | |||
| ------------------- | ------------------- | |||
| Overview of monasca-log-api's 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. | This is the main configuration file of monasca-log-api. | |||
| It can be located in several places. During startup, | It can be located in several places. During startup, | |||
| monasca-log-api searches for it in the following directories: | monasca-log-api searches for it in the following directories: | |||
| * ``~/.monasca`` | * ``~/.monasca`` | |||
| * ``~/`` | * ``~/`` | |||
| * ``/etc/monasca`` | * ``/etc/monasca`` | |||
| * ``/etc`` | * ``/etc`` | |||
| Alternatively, you can roll with a multi-file-based configuration model. | Alternatively, you can roll with a multi-file-based configuration model. | |||
| In this case, monasca-log-api searches the configuration files | In this case, monasca-log-api searches the configuration files | |||
| in the following directories: | in the following directories: | |||
| * ``~/.monasca/monasca.conf.d/`` | * ``~/.monasca/monasca.conf.d/`` | |||
| * ``~/.monasca/log-api.conf.d/`` | * ``~/.monasca/monasca-log-api.conf.d/`` | |||
| * ``~/monasca.conf.d/`` | * ``~/monasca.conf.d/`` | |||
| * ``~/log-api.conf.d/`` | * ``~/monasca-log-api.conf.d/`` | |||
| * ``/etc/monasca/monasca.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/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 | 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 | in ``.conf.d`` directories, the name is irrelevant, but it should | |||
| indicate the file content. | indicate the file content. | |||
| For example, when guring keystone communication. The | For example, when guring keystone communication. The | |||
| `keystonemiddleware <https://docs.openstack.org/keystonemiddleware/latest/>`_ | `keystonemiddleware <https://docs.openstack.org/keystonemiddleware/latest/>`_ | |||
| configuration would be, therefore, located in, for example, | 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 | A sample of this configuration file is also available | |||
| :ref:`here <sample-configuration-api>` | :ref:`here <sample-configuration-api>` | |||
| log-api-logging.conf | log-api-logging.conf | |||
| -------------------- | -------------------- | |||
| This file contains the logging setup for monasca-log-api. It should be | 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:: | the following code snippet:: | |||
| [DEFAULT] | [DEFAULT] | |||
| log_config_append = /etc/monasca/log-api-logging.conf | log_config_append = /etc/monasca/log-api-logging.conf | |||
| A sample of this configuration file is also available | A sample of this configuration file is also available | |||
| :ref:`here <sample-configuration-logging>` | :ref:`here <sample-configuration-logging>` | |||
| log-api-paste.ini | log-api-paste.ini | |||
| ----------------- | ----------------- | |||
| skipping to change at line 90 | skipping to change at line 90 | |||
| [filter:debug] | [filter:debug] | |||
| paste.filter_factory = oslo_middleware.debug:Debug.factory | paste.filter_factory = oslo_middleware.debug:Debug.factory | |||
| This particular filter might be useful for examining the | This particular filter might be useful for examining the | |||
| WSGI environment during troubleshooting or local development. | WSGI environment during troubleshooting or local development. | |||
| log-api.policy.yaml | log-api.policy.yaml | |||
| ------------------- | ------------------- | |||
| This is the configuration file for policies to access the services. | 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] | [oslo_policy] | |||
| policy_file = log-api.policy.yaml | policy_file = log-api.policy.yaml | |||
| More information about policy file configuration can be found at | More information about policy file configuration can be found at | |||
| `oslo.policy <https://docs.openstack.org/oslo.policy/latest/admin/policy-yaml-fi le.html>`_ | `oslo.policy <https://docs.openstack.org/oslo.policy/latest/admin/policy-yaml-fi le.html>`_ | |||
| A sample of this configuration file is also available | A sample of this configuration file is also available | |||
| :ref:`here <sample-configuration-policy>` | :ref:`here <sample-configuration-policy>` | |||
| End of changes. 9 change blocks. | ||||
| 9 lines changed or deleted | 10 lines changed or added | |||