2019-06-03 22:44:12 +00:00
|
|
|
import os
|
|
|
|
|
2021-04-06 10:09:00 +00:00
|
|
|
from . import env, exceptions, fmt, plugins, serialize, utils
|
|
|
|
from .types import Config, cast_config
|
2019-06-03 22:44:12 +00:00
|
|
|
|
2021-11-23 08:25:09 +00:00
|
|
|
CONFIG_FILENAME = "config.yml"
|
|
|
|
|
2019-06-03 22:44:12 +00:00
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def load(root: str) -> Config:
|
2019-06-05 13:43:51 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Load full configuration.
|
|
|
|
|
|
|
|
This will raise an exception if there is no current configuration in the
|
|
|
|
project root. A warning will also be printed if the version from disk
|
|
|
|
differs from the package version.
|
2019-06-05 13:43:51 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
if not os.path.exists(config_path(root)):
|
|
|
|
raise exceptions.TutorError(
|
|
|
|
"Project root does not exist. Make sure to generate the initial "
|
|
|
|
"configuration with `tutor config save --interactive` or `tutor local "
|
|
|
|
"quickstart` prior to running other commands."
|
|
|
|
)
|
|
|
|
env.check_is_up_to_date(root)
|
|
|
|
return load_full(root)
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def load_minimal(root: str) -> Config:
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Load a minimal configuration composed of the user and the base config.
|
2019-12-24 16:22:12 +00:00
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
This configuration is not suitable for rendering templates, as it is incomplete.
|
|
|
|
"""
|
|
|
|
config = get_user(root)
|
|
|
|
update_with_base(config)
|
|
|
|
render_full(config)
|
2019-06-03 22:44:12 +00:00
|
|
|
return config
|
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def load_full(root: str) -> Config:
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Load a full configuration, with user, base and defaults.
|
2021-11-23 08:25:09 +00:00
|
|
|
|
|
|
|
Return:
|
|
|
|
current (dict): params currently saved in config.yml
|
|
|
|
defaults (dict): default values of params which might be missing from the
|
|
|
|
current config
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
config = get_user(root)
|
|
|
|
update_with_base(config)
|
|
|
|
update_with_defaults(config)
|
|
|
|
render_full(config)
|
|
|
|
return config
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def update_with_base(config: Config) -> None:
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Add base configuration to the config object.
|
|
|
|
|
|
|
|
Note that configuration entries are unrendered at this point.
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
base = get_base(config)
|
|
|
|
merge(config, base)
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def update_with_defaults(config: Config) -> None:
|
|
|
|
"""
|
|
|
|
Add default configuration to the config object.
|
2019-06-03 22:44:12 +00:00
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
Note that configuration entries are unrendered at this point.
|
|
|
|
"""
|
|
|
|
defaults = get_defaults(config)
|
|
|
|
merge(config, defaults)
|
2020-01-16 14:40:38 +00:00
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def update_with_env(config: Config) -> None:
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Override config values from environment variables.
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
overrides = {}
|
|
|
|
for k in config.keys():
|
2019-06-03 22:44:12 +00:00
|
|
|
env_var = "TUTOR_" + k
|
|
|
|
if env_var in os.environ:
|
2021-11-08 13:46:38 +00:00
|
|
|
overrides[k] = serialize.parse(os.environ[env_var])
|
|
|
|
config.update(overrides)
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def get_user(root: str) -> Config:
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Get the user configuration from the tutor root.
|
|
|
|
|
|
|
|
Overrides from environment variables are loaded as well.
|
2019-06-03 22:44:12 +00:00
|
|
|
"""
|
2021-10-18 09:43:40 +00:00
|
|
|
convert_json2yml(root)
|
2021-11-08 13:46:38 +00:00
|
|
|
path = config_path(root)
|
|
|
|
config = {}
|
|
|
|
if os.path.exists(path):
|
|
|
|
config = get_yaml_file(path)
|
|
|
|
upgrade_obsolete(config)
|
|
|
|
update_with_env(config)
|
|
|
|
return config
|
2019-06-03 22:44:12 +00:00
|
|
|
|
2019-06-05 17:57:30 +00:00
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
def get_base(config: Config) -> Config:
|
2019-06-05 13:43:51 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
Load the base configuration.
|
|
|
|
|
|
|
|
Entries in this configuration are unrendered.
|
2019-06-05 13:43:51 +00:00
|
|
|
"""
|
2021-11-08 13:46:38 +00:00
|
|
|
base = get_template("base.yml")
|
|
|
|
|
|
|
|
# Load base values from plugins
|
2020-01-14 12:32:45 +00:00
|
|
|
for plugin in plugins.iter_enabled(config):
|
2019-06-05 13:43:51 +00:00
|
|
|
# Add new config key/values
|
2020-01-14 12:32:45 +00:00
|
|
|
for key, value in plugin.config_add.items():
|
|
|
|
new_key = plugin.config_key(key)
|
2021-11-08 13:46:38 +00:00
|
|
|
base[new_key] = value
|
2019-06-05 13:43:51 +00:00
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
# Set existing config key/values
|
|
|
|
for key, value in plugin.config_set.items():
|
|
|
|
base[key] = value
|
|
|
|
|
|
|
|
return base
|
|
|
|
|
|
|
|
|
|
|
|
def get_defaults(config: Config) -> Config:
|
|
|
|
"""
|
|
|
|
Get default configuration, including from plugins.
|
|
|
|
|
|
|
|
Entries in this configuration are unrendered.
|
|
|
|
"""
|
|
|
|
defaults = get_template("defaults.yml")
|
|
|
|
|
|
|
|
for plugin in plugins.iter_enabled(config):
|
2020-09-18 10:39:22 +00:00
|
|
|
# Create new defaults
|
|
|
|
for key, value in plugin.config_defaults.items():
|
|
|
|
defaults[plugin.config_key(key)] = value
|
|
|
|
|
2021-11-08 13:46:38 +00:00
|
|
|
update_with_env(defaults)
|
|
|
|
return defaults
|
|
|
|
|
|
|
|
|
|
|
|
def get_template(filename: str) -> Config:
|
|
|
|
"""
|
|
|
|
Get one of the configuration templates.
|
|
|
|
|
|
|
|
Entries in this configuration are unrendered.
|
|
|
|
"""
|
|
|
|
config = serialize.load(env.read_template_file("config", filename))
|
|
|
|
return cast_config(config)
|
|
|
|
|
|
|
|
|
|
|
|
def get_yaml_file(path: str) -> Config:
|
|
|
|
"""
|
|
|
|
Load config from yaml file.
|
|
|
|
"""
|
|
|
|
with open(path) as f:
|
|
|
|
config = serialize.load(f.read())
|
|
|
|
return cast_config(config)
|
|
|
|
|
|
|
|
|
|
|
|
def merge(config: Config, base: Config) -> None:
|
|
|
|
"""
|
|
|
|
Merge base values with user configuration. Values are only added if not
|
|
|
|
already present.
|
|
|
|
|
|
|
|
Note that this function does not perform the rendering step of the
|
|
|
|
configuration entries.
|
|
|
|
"""
|
|
|
|
for key, value in base.items():
|
|
|
|
if key not in config:
|
|
|
|
config[key] = value
|
|
|
|
|
|
|
|
|
|
|
|
def render_full(config: Config) -> None:
|
|
|
|
"""
|
|
|
|
Fill and render an existing configuration with defaults.
|
|
|
|
|
|
|
|
It is generally necessary to apply this function before rendering templates,
|
|
|
|
otherwise configuration entries may not be rendered.
|
|
|
|
"""
|
|
|
|
for key, value in config.items():
|
|
|
|
config[key] = env.render_unknown(config, value)
|
2019-06-05 13:43:51 +00:00
|
|
|
|
2019-06-03 22:44:12 +00:00
|
|
|
|
2021-04-06 10:09:00 +00:00
|
|
|
def is_service_activated(config: Config, service: str) -> bool:
|
2021-02-25 08:09:14 +00:00
|
|
|
return config["RUN_" + service.upper()] is not False
|
Improve job running in local and k8s
Running jobs was previously done with "exec". This was because it
allowed us to avoid copying too much container specification information
from the docker-compose/deployments files to the jobs files. However,
this was limiting:
- In order to run a job, the corresponding container had to be running.
This was particularly painful in Kubernetes, where containers are
crashing as long as migrations are not correctly run.
- Containers in which we need to run jobs needed to be present in the
docker-compose/deployments files. This is unnecessary, for example when
mysql is disabled, or in the case of the certbot container.
Now, we create dedicated jobs files, both for local and k8s deployment.
This introduces a little redundancy, but not too much. Note that
dependent containers are not listed in the docker-compose.jobs.yml file,
so an actual platform is still supposed to be running when we launch the
jobs.
This also introduces a subtle change: now, jobs go through the container
entrypoint prior to running. This is probably a good thing, as it will
avoid forgetting about incorrect environment variables.
In k8s, we find ourselves interacting way too much with the kubectl
utility. Parsing output from the CLI is a pain. So we need to switch to
the native kubernetes client library.
2020-03-25 17:47:36 +00:00
|
|
|
|
|
|
|
|
2021-04-06 10:09:00 +00:00
|
|
|
def upgrade_obsolete(config: Config) -> None:
|
2019-06-03 22:44:12 +00:00
|
|
|
# Openedx-specific mysql passwords
|
|
|
|
if "MYSQL_PASSWORD" in config:
|
|
|
|
config["MYSQL_ROOT_PASSWORD"] = config["MYSQL_PASSWORD"]
|
|
|
|
config["OPENEDX_MYSQL_PASSWORD"] = config["MYSQL_PASSWORD"]
|
|
|
|
config.pop("MYSQL_PASSWORD")
|
|
|
|
if "MYSQL_DATABASE" in config:
|
|
|
|
config["OPENEDX_MYSQL_DATABASE"] = config.pop("MYSQL_DATABASE")
|
|
|
|
if "MYSQL_USERNAME" in config:
|
|
|
|
config["OPENEDX_MYSQL_USERNAME"] = config.pop("MYSQL_USERNAME")
|
2020-09-17 10:53:14 +00:00
|
|
|
if "RUN_NOTES" in config:
|
|
|
|
if config["RUN_NOTES"]:
|
2019-07-03 14:09:33 +00:00
|
|
|
plugins.enable(config, "notes")
|
2020-09-17 10:53:14 +00:00
|
|
|
config.pop("RUN_NOTES")
|
|
|
|
if "RUN_XQUEUE" in config:
|
|
|
|
if config["RUN_XQUEUE"]:
|
2019-07-02 20:16:44 +00:00
|
|
|
plugins.enable(config, "xqueue")
|
2020-09-17 10:53:14 +00:00
|
|
|
config.pop("RUN_XQUEUE")
|
2019-07-07 02:02:03 +00:00
|
|
|
if "SECRET_KEY" in config:
|
|
|
|
config["OPENEDX_SECRET_KEY"] = config.pop("SECRET_KEY")
|
2020-09-17 10:53:14 +00:00
|
|
|
# Replace WEB_PROXY by RUN_CADDY
|
|
|
|
if "WEB_PROXY" in config:
|
|
|
|
config["RUN_CADDY"] = not config.pop("WEB_PROXY")
|
|
|
|
# Rename ACTIVATE_HTTPS to ENABLE_HTTPS
|
|
|
|
if "ACTIVATE_HTTPS" in config:
|
|
|
|
config["ENABLE_HTTPS"] = config.pop("ACTIVATE_HTTPS")
|
|
|
|
# Replace RUN_* variables by RUN_*
|
|
|
|
for name in [
|
|
|
|
"ACTIVATE_LMS",
|
|
|
|
"ACTIVATE_CMS",
|
|
|
|
"ACTIVATE_ELASTICSEARCH",
|
|
|
|
"ACTIVATE_MONGODB",
|
|
|
|
"ACTIVATE_MYSQL",
|
|
|
|
"ACTIVATE_REDIS",
|
|
|
|
"ACTIVATE_SMTP",
|
|
|
|
]:
|
|
|
|
if name in config:
|
|
|
|
config[name.replace("ACTIVATE_", "RUN_")] = config.pop(name)
|
2021-10-14 10:47:23 +00:00
|
|
|
# Replace RUN_CADDY by ENABLE_WEB_PROXY
|
|
|
|
if "RUN_CADDY" in config:
|
|
|
|
config["ENABLE_WEB_PROXY"] = config.pop("RUN_CADDY")
|
|
|
|
# Replace RUN_CADDY by ENABLE_WEB_PROXY
|
|
|
|
if "NGINX_HTTP_PORT" in config:
|
|
|
|
config["CADDY_HTTP_PORT"] = config.pop("NGINX_HTTP_PORT")
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-02-25 08:09:14 +00:00
|
|
|
def convert_json2yml(root: str) -> None:
|
2019-06-05 13:43:51 +00:00
|
|
|
"""
|
|
|
|
Older versions of tutor used to have json config files.
|
|
|
|
"""
|
2019-06-03 22:44:12 +00:00
|
|
|
json_path = os.path.join(root, "config.json")
|
|
|
|
if not os.path.exists(json_path):
|
|
|
|
return
|
|
|
|
if os.path.exists(config_path(root)):
|
|
|
|
raise exceptions.TutorError(
|
2021-11-23 08:25:09 +00:00
|
|
|
f"Both config.json and {CONFIG_FILENAME} exist in {root}: only one of these files must exist to continue"
|
2019-06-03 22:44:12 +00:00
|
|
|
)
|
2021-11-08 13:46:38 +00:00
|
|
|
config = get_yaml_file(json_path)
|
2020-02-27 16:14:00 +00:00
|
|
|
save_config_file(root, config)
|
2019-06-03 22:44:12 +00:00
|
|
|
os.remove(json_path)
|
|
|
|
fmt.echo_info(
|
2021-11-23 08:25:09 +00:00
|
|
|
f"File config.json detected in {root} and converted to {CONFIG_FILENAME}"
|
2019-06-03 22:44:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
2021-04-06 10:09:00 +00:00
|
|
|
def save_config_file(root: str, config: Config) -> None:
|
2019-06-03 22:44:12 +00:00
|
|
|
path = config_path(root)
|
|
|
|
utils.ensure_file_directory_exists(path)
|
|
|
|
with open(path, "w") as of:
|
|
|
|
serialize.dump(config, of)
|
2021-11-23 08:25:09 +00:00
|
|
|
fmt.echo_info(f"Configuration saved to {path}")
|
2019-06-03 22:44:12 +00:00
|
|
|
|
|
|
|
|
2021-02-25 08:09:14 +00:00
|
|
|
def config_path(root: str) -> str:
|
2021-11-23 08:25:09 +00:00
|
|
|
return os.path.join(root, CONFIG_FILENAME)
|