Commit 6bf25817 authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Documentation for config.py.

parent 6f4f3160
# Modules
## Dependencies
## nomad.config
```eval_rst
.. automodule:: nomad.config
:members:
```
## nomad.dependencies
```eval_rst
.. automodule:: nomad.dependencies
```
## Files
## nomad.files
```eval_rst
.. automodule:: nomad.files
```
## Processing
## nomad.processing
```eval_rst
.. automodule:: nomad.processing
```
......@@ -12,13 +12,27 @@
# See the License for the specific language governing permissions and
# limitations under the License.
"""
This module is used to store all configuration values. It makes use of
*namedtuples* to create key sensitive configuration objects.
"""
from collections import namedtuple
S3Config = namedtuple('S3', ['uploads_bucket', 'repository_bucket', 'archive_bucket'])
""" API independent configuration for the object storage. """
RabitMQConfig = namedtuple('RabbitMQ', ['host', 'port', 'user', 'password'])
""" Used to configure the RabbitMQ used by celery as a task backend. """
MinioConfig = namedtuple('Minio', ['host', 'port', 'accesskey', 'secret'])
""" Used to configure the minio object storage API. """
FSConfig = namedtuple('FSConfig', ['tmp'])
""" Used to configure file stystem access. """
LogstashConfig = namedtuple('LogstashConfig', ['enabled', 'host', 'tcp_port'])
""" Used to configure and enable/disable the ELK based centralized logging. """
s3 = S3Config(
uploads_bucket='uploads',
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment