christianlight/tutor
7
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-06-02 14:20:47 +00:00
Code Issues Releases Activity
ceddc11c29
tutor/tutor/templates/config.yml

79 lines
2.5 KiB
YAML
Raw Normal View History

Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147.
2019-01-22 20:25:04 +00:00
---
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
# These configuration values must be stored in the user's config.yml.
MYSQL_ROOT_PASSWORD: "{{ 8|random_string }}"
OPENEDX_MYSQL_PASSWORD: "{{ 8|random_string }}"
Rename SECRET_KEY to OPENEDX_SECRET_KEY
2019-07-07 02:02:03 +00:00
OPENEDX_SECRET_KEY: "{{ 24|random_string }}"
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
ID: "{{ 24|random_string }}"
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 10:36:19 +00:00
# This must be defined early
LMS_HOST: "www.myopenedx.com"
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
# The following are default values
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
RUN_CADDY: true
RUN_LMS: true
RUN_CMS: true
RUN_FORUM: true
RUN_ELASTICSEARCH: true
ENABLE_HTTPS: false
RUN_MONGODB: true
RUN_MYSQL: true
RUN_REDIS: true
RUN_SMTP: true
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 10:36:19 +00:00
CMS_HOST: "studio.{{ LMS_HOST }}"
CONTACT_EMAIL: "contact@{{ LMS_HOST }}"
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
OPENEDX_AWS_ACCESS_KEY: ""
OPENEDX_AWS_SECRET_ACCESS_KEY: ""
Make it possible to override dev project name
2020-01-08 13:36:51 +00:00
DEV_PROJECT_NAME: "tutor_dev"
Tutor docker images should point to docker.io, too
2020-01-10 16:22:01 +00:00
DOCKER_REGISTRY: "docker.io/"
Make it possible to override the docker registry for individual services Previously, it was not possible to override the docker registry for just one or a few services. Setting the DOCKER_REGISTRY configuration parameter would apply to all images. This was inconvenient. To resolve this, we include the docker registry value in the DOCKER_IMAGE_* configuration parameters. This allows users to override the docker registry individually by defining the DOCKER_IMAGE_SERVICENAME configuration parameter. See https://discuss.overhang.io/t/kubernetes-ci-cd-pipeline/765/3
2020-07-21 07:13:00 +00:00
DOCKER_IMAGE_OPENEDX: "{{ DOCKER_REGISTRY }}overhangio/openedx:{{ TUTOR_VERSION }}"
DOCKER_IMAGE_OPENEDX_DEV: "{{ DOCKER_REGISTRY }}overhangio/openedx-dev:{{ TUTOR_VERSION }}"
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
DOCKER_IMAGE_CADDY: "{{ DOCKER_REGISTRY }}caddy:2.3.0"
Make it possible to override the docker registry for individual services Previously, it was not possible to override the docker registry for just one or a few services. Setting the DOCKER_REGISTRY configuration parameter would apply to all images. This was inconvenient. To resolve this, we include the docker registry value in the DOCKER_IMAGE_* configuration parameters. This allows users to override the docker registry individually by defining the DOCKER_IMAGE_SERVICENAME configuration parameter. See https://discuss.overhang.io/t/kubernetes-ci-cd-pipeline/765/3
2020-07-21 07:13:00 +00:00
DOCKER_IMAGE_FORUM: "{{ DOCKER_REGISTRY }}overhangio/openedx-forum:{{ TUTOR_VERSION }}"
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
DOCKER_IMAGE_MONGODB: "{{ DOCKER_REGISTRY }}mongo:4.0.23"
DOCKER_IMAGE_MYSQL: "{{ DOCKER_REGISTRY }}mysql:5.7.33"
DOCKER_IMAGE_ELASTICSEARCH: "{{ DOCKER_REGISTRY }}elasticsearch:7.8.1"
DOCKER_IMAGE_NGINX: "{{ DOCKER_REGISTRY }}nginx:1.19.9"
DOCKER_IMAGE_REDIS: "{{ DOCKER_REGISTRY }}redis:6.2.1"
Make it possible to override the docker registry for individual services Previously, it was not possible to override the docker registry for just one or a few services. Setting the DOCKER_REGISTRY configuration parameter would apply to all images. This was inconvenient. To resolve this, we include the docker registry value in the DOCKER_IMAGE_* configuration parameters. This allows users to override the docker registry individually by defining the DOCKER_IMAGE_SERVICENAME configuration parameter. See https://discuss.overhang.io/t/kubernetes-ci-cd-pipeline/765/3
2020-07-21 07:13:00 +00:00
DOCKER_IMAGE_SMTP: "{{ DOCKER_REGISTRY }}namshi/smtp:latest"
Easily launch multiple platforms on a single server By using a web proxy on the host, it's now extremely easy to launch multiple platforms on a single server.
2019-03-21 18:06:08 +00:00
LOCAL_PROJECT_NAME: "tutor_local"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
ELASTICSEARCH_HOST: "elasticsearch"
ELASTICSEARCH_PORT: 9200
Rename *_PROTOCOL to *_SCHEME
2020-03-12 08:37:22 +00:00
ELASTICSEARCH_SCHEME: "http"
Fix broken elasticsearch configuration Because we are running a version of elasticsearch older than Methusalem, the docker environment variables were not properly taken into account. For instance, the cluster name and "mlockall" settings were incorrect, as we could see by running: $ tutor local run lms curl elasticsearch:9200 | grep cluster_name ... "cluster_name" : "elasticsearch", $ tutor local run lms curl elasticsearch:9200/_nodes/process?pretty | grep mlock ... "mlockall" : false See https://discuss.overhang.io/t/elastic-container-is-not-being-removed/312/3 for discussion. This fix also introduces a new tutor configuration setting to adjust the elasticsearch heap size.
2020-02-26 10:47:43 +00:00
ELASTICSEARCH_HEAP_SIZE: 1g
Pluggable lms/cms/forum LMS, CMS and forum can now be independently (de)activated. This will be useful to deploy Tutor on multiple servers.
2019-03-22 19:15:50 +00:00
FORUM_HOST: "forum"
More explicit JWT configuration values
2019-07-08 06:00:20 +00:00
JWT_COMMON_AUDIENCE: "openedx"
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
JWT_COMMON_ISSUER: "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/oauth2"
More explicit JWT configuration values
2019-07-08 06:00:20 +00:00
JWT_COMMON_SECRET_KEY: "{{ OPENEDX_SECRET_KEY }}"
v10.0.0 Upgrade to Juniper (2020-06-15) Here, we upgrade the Open edX platform from Ironwood to Juniper. This upgrade does not come with many feature changes, but there are many technical improvements under the hood: - Upgrade from Python 2.7 to 3.5 - Upgrade from Mongodb v3.2 to v3.6 - Upgrade Ruby to 2.5.7 We took the opportunity to completely rething the way locally running platforms should be accessed for testing purposes. It is no longer possible to access a running platform from http://localhost and http://studio.localhost. Instead, users should access http://local.overhang.io and https://studio.local.overhang.io. This drastically simplifies internal communication between Docker containers. To upgrade, users should simply run: tutor local quickstart For Kubernetes platform, the upgrade process is outlined when running: tutor k8s upgrade --from=ironwood
2019-12-24 16:22:12 +00:00
JWT_RSA_PRIVATE_KEY: "{{ 2048|rsa_private_key }}"
Towards a stable Kubernetes integration Missing features: - https certificates - xqueue - lms/cms workers Moreover, we scalability issues due to the uploaded file storage in the lms/cms. To address this issue we need to develop the MinIO plugin so that it becomes compatible with Open edX. Close #126 #179 #187
2019-05-09 07:51:06 +00:00
K8S_NAMESPACE: "openedx"
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
LANGUAGE_CODE: "en"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
MONGODB_HOST: "mongodb"
MONGODB_DATABASE: "openedx"
Configurable mongodb username/password/port
2019-03-20 18:18:46 +00:00
MONGODB_PORT: 27017
MONGODB_USERNAME: ""
MONGODB_PASSWORD: ""
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
OPENEDX_CACHE_REDIS_DB: 1
OPENEDX_CELERY_REDIS_DB: 0
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
OPENEDX_CMS_UWSGI_WORKERS: 2
OPENEDX_LMS_UWSGI_WORKERS: 2
Harmonize mysql usernames and passwords We were using the same password both for the root and the openedx user. This used to be fine, but alas it is so no longer.
2019-03-20 17:45:20 +00:00
OPENEDX_MYSQL_DATABASE: "openedx"
v10.0.0 Upgrade to Juniper (2020-06-15) Here, we upgrade the Open edX platform from Ironwood to Juniper. This upgrade does not come with many feature changes, but there are many technical improvements under the hood: - Upgrade from Python 2.7 to 3.5 - Upgrade from Mongodb v3.2 to v3.6 - Upgrade Ruby to 2.5.7 We took the opportunity to completely rething the way locally running platforms should be accessed for testing purposes. It is no longer possible to access a running platform from http://localhost and http://studio.localhost. Instead, users should access http://local.overhang.io and https://studio.local.overhang.io. This drastically simplifies internal communication between Docker containers. To upgrade, users should simply run: tutor local quickstart For Kubernetes platform, the upgrade process is outlined when running: tutor k8s upgrade --from=ironwood
2019-12-24 16:22:12 +00:00
OPENEDX_CSMH_MYSQL_DATABASE: "{{ OPENEDX_MYSQL_DATABASE }}_csmh"
Harmonize mysql usernames and passwords We were using the same password both for the root and the openedx user. This used to be fine, but alas it is so no longer.
2019-03-20 17:45:20 +00:00
OPENEDX_MYSQL_USERNAME: "openedx"
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
OPENEDX_COMMON_VERSION: "open-release/lilac.1"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
MYSQL_HOST: "mysql"
MYSQL_PORT: 3306
Make the mysql root username a configuration parameter This allows users who connect to an external database to customise the root username. Indeed, quite often the "root" username is reserved. Close #328
2020-06-01 15:11:10 +00:00
MYSQL_ROOT_USERNAME: "root"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
NGINX_HTTP_PORT: 80
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
PLATFORM_NAME: "My Open edX"
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
PLUGINS: []
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
REDIS_HOST: "redis"
REDIS_PORT: 6379
REDIS_USERNAME: ""
REDIS_PASSWORD: ""
Pluggable SMTP service This is part of #114
2019-03-20 17:45:09 +00:00
SMTP_HOST: "smtp"
SMTP_PORT: 25
Configurable SMTP server authentication We can now define non-empty username/password for sending email.
2019-03-20 17:52:57 +00:00
SMTP_USERNAME: ""
SMTP_PASSWORD: ""
Add support for external SMTP server with TLS Note that this setting will not work with the default namshi smtp server shipped with tutor. Close #231.
2019-07-07 01:06:35 +00:00
SMTP_USE_TLS: false
Add support for SMTP SSL, in addition to TLS Note that SSL and TLS are incompatible. Close #231.
2019-07-07 22:24:35 +00:00
SMTP_USE_SSL: false
Copy Permalink