runner.compose_generation

This file holds functions that generate docker-compose configuration files from templates, interpolating variables according to the derex project configuration.

They are invoked thanks to the @hookimpl call to the pluggy plugin system.

The functions have to be reachable under the common name ddc_project_options so a class is put in place to hold each of them.

Module Contents

runner.compose_generation.logger[source]
runner.compose_generation.DEREX_ETC_PATH[source]
runner.compose_generation.derex_path[source]
runner.compose_generation.WSGI_PY_PATH[source]
runner.compose_generation.DDC_SERVICES_YML_PATH[source]
runner.compose_generation.DDC_ADMIN_PATH[source]
runner.compose_generation.DDC_PROJECT_TEMPLATE_PATH[source]
class runner.compose_generation.BaseServices[source]
static ddc_services_options()[source]

See derex.runner.plugin_spec.ddc_services_options docstring.

class runner.compose_generation.BaseProject[source]
static ddc_project_options(project: Project)[source]

See derex.runner.plugin_spec.ddc_project_options docstring

class runner.compose_generation.LocalServices[source]
static ddc_services_options()[source]

See derex.runner.plugin_spec.ddc_services_options docstring.

class runner.compose_generation.LocalProject[source]
static ddc_project_options(project: Project)[source]

See derex.runner.plugin_spec.ddc_project_options docstring

class runner.compose_generation.LocalProjectRunmode[source]
static ddc_project_options(project: Project)[source]

See derex.runner.plugin_spec.ddc_project_options docstring

runner.compose_generation.generate_ddc_project_file(project: Project) → Path[source]

This function is called every time ddc-project is run. It assembles a docker-compose file from the given configuration. It should execute as fast as possible.

runner.compose_generation.generate_ddc_services_file() → str[source]

Generate the global docker-compose config file that will drive ddc-services and return its path.