Blame docs/apps/duffy/Configuration.md

fd40ec
An example configuration can be found here - https://github.com/CentOS/duffy/blob/dev/etc/duffy-example-config.yaml
fd40ec
fd40ec
# `app` section
fd40ec
fd40ec
This section has all the configuration settings for the `duffy` application.
fd40ec
fd40ec
## Key/value pairs
fd40ec
fd40ec
1. `loglevel` - Set the default loglevel for the `duffy` application.
fd40ec
2. `host` - Set the default host address for the `duffy` application to listen to.
fd40ec
3. `port` - Set the default port number for the `duffy` application to listen to.
fd40ec
4. `logging` - Set the global logging configuration for the parts of the `duffy` application.
fd40ec
fd40ec
# `metaclient` section
fd40ec
fd40ec
This section has all the configuration settings for the `duffy` metaclient application.
fd40ec
fd40ec
## Key/value pairs
fd40ec
fd40ec
1. `loglevel` - Set the default loglevel for the `duffy` metaclient application.
fd40ec
2. `host` - Set the default host address for the `duffy` metaclient application to listen to.
fd40ec
3. `port` - Set the default port number for the `duffy` metaclient application to listen to.
fd40ec
4. `dest` - Set the destination address and port number for the deployed `duffy` application.
fd40ec
5. `usermap` - Set the mapping of UUIDs with legacy `duffy` usernames.
fd40ec
6. `poolmap` - Set the mapping of poolname and hardware configuration (`version` and `arch`).
fd40ec
fd40ec
# `tasks` section
fd40ec
fd40ec
This section has all the configuration settings required for the `duffy` worker backend.
fd40ec
fd40ec
## Key/value pairs
fd40ec
1. `celery` - Configure the Celery backend.
fd40ec
   1. `broker_url` - Set the address to a reachable Redis store.
fd40ec
   2. `result_backend` - Set the address to a reachable Redis store.
fd40ec
   3. `worker_redirect_stdouts_level` - Set the loglevel for worker redirect operations.
fd40ec
2. `locking` - Configure the Celery backend.
fd40ec
   1. `url` - Set the address to a reachable Redis store.
fd40ec
3. `periodic` - Configure recurring operations.
fd40ec
   1. `fill-pools` - Configure checking for new devices for the pools.
fd40ec
      1. `interval` - Set the interval in seconds for the period.
fd40ec
   1. `expire-sessions` - Configure checking for provisioned nodes reaching expiry.
fd40ec
      1. `interval` - Set the interval in seconds for the period.
fd40ec
fd40ec
# `database` section
fd40ec
fd40ec
This section has all the configuration settings required for the `duffy` database.
fd40ec
fd40ec
## Key/value pairs
fd40ec
1. `sqlalchemy` - Configure SQLAlchemy settings.
fd40ec
   1. `sync_url` - Set the reachable database location for synchronous database operations.
fd40ec
   2. `async_url` - Set the reachable database location for asynchronous database operations.
fd40ec
fd40ec
# `misc` section
fd40ec
fd40ec
This section has all the configuration settings required for the session allowed time.
fd40ec
fd40ec
## Key/value pairs
fd40ec
1. `session-lifetime` - Set the allowed time for a normal session.
fd40ec
2. `session-lifetime-max` - Set the allowed time for an extended session.
fd40ec
fd40ec
# `nodepools` section
fd40ec
fd40ec
This section has all the configuration settings required for describing node pools.
fd40ec
fd40ec
## Key/value pairs
fd40ec
1. `abstract` - Set the Ansible paths and settings for physical and virtual nodes.
fd40ec
2. `concrete` - Set the settings for physical and virtual nodes by extending configs.