christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2025-01-27 06:58:24 +00:00
Code Issues Releases Activity
tutor/CHANGELOG.md

393 lines
16 KiB
Markdown
Raw Normal View History

Add Changelog
2018-09-15 12:14:55 +02:00
# Changelog
Replace `databases` command by `init`. Since initialisation does not only refer to database migrations, it makes more sense to rename this command.
2019-06-05 19:28:06 +02:00
Note: Breaking changes between versions are indicated by "💥".
Add scorm xblock to the openedx docker image
2020-04-25 14:20:13 +02:00
## Unreleased
Remove ingress/issuer from default k8s deployment There are too many different ways to deploy an Ingress resource and to generate SSL/TLS certificates: it's too much responsibility to make that decision for the end user.
2020-04-25 22:32:57 +02:00
- 💥[Improvement] Do not deploy an ingress or SSL/TLS certificate issuer ressource by default in Kubernetes
Fix tls certificate generation in k8s The "Certificate" objects are no longer required. As a consequence, the "k8s-ingress-certificates" has become useless and should be removed from plugins.
2020-03-27 13:54:47 +01:00
- [Improvement] Fix tls certificate generation in k8s
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 18:47:36 +01:00
- [Improvement] Radically change the way jobs are run: we no longer "exec", but instead run a dedicated container.
Upgrade cert-manager installation in k8s Note that the spec has changed for v1alpha2.
2020-03-26 11:33:06 +01:00
- [Improvement] Upgrade k8s certificate issuer to cert-manager.io/v1alpha2
Add scorm xblock to the openedx docker image
2020-04-25 14:20:13 +02:00
- [Feature] Add SCORM XBlock to default openedx docker image
v3.11.12 (2020-04-16) - [Feature] Make it easy to add custom translation strings to the openedx Docker image - [Improvement] Make it possible to rely on a different npm registry for faster image building
2020-04-16 19:31:36 +02:00
## v3.11.12 (2020-04-16)
Make it possible to pull nodejs packages from custom npm registry During an incident at npmjs.org it was extremely difficult to pull nodejs packages -- so we made it possible to pull from a custom registry, deployed for instance with Verdaccio (https://verdaccio.org/).
2020-04-16 19:22:12 +02:00
Make it easy to add custom translation strings to edx-platform Users can now add custom translation strings to a locale folder at build time, very much in the same way as custom themes or requirements. This is quite convenient, although is does require quite a bit of time to rebuild the docker images.
2020-04-16 19:26:49 +02:00
- [Feature] Make it easy to add custom translation strings to the openedx Docker image
Make it possible to pull nodejs packages from custom npm registry During an incident at npmjs.org it was extremely difficult to pull nodejs packages -- so we made it possible to pull from a custom registry, deployed for instance with Verdaccio (https://verdaccio.org/).
2020-04-16 19:22:12 +02:00
- [Improvement] Make it possible to rely on a different npm registry for faster image building
v3.11.11 (2020-04-15) - [Bugfix] Make sure all emails (including "password reset") are properly saved to a local file in development mode (#315) - [Improvement] Add `openedx-development-settings` patch to patch the LMS and the CMS simultaneously in development - [Bugfix] Fix missing celery tasks in the CMS
2020-04-15 23:53:05 +02:00
## v3.11.11 (2020-04-15)
Fix missing celery tasks in the CMS This should spare us quite a few error messages in the CMS worker.
2020-04-14 19:49:18 +02:00
Make sure all emails are stored to a tmp file in development In development, emails sent from edx-platform were using the "file_email" channel from edx-ace ("edX's automated communication engine"). This channel was failing because it tries to write to a file located in the /edx folder, which does not exist in tutor containers. To fix this, we configure edx-ace to rely on the django email backend, which itself is configured to send emails to a file in development. It turns out that this backend was also configured to store emails in a file located in the /edx folder, so we had to add the standard EMAIL_FILE_PATH django setting to our development settings. It was easier to reconfigure the django file email backend than the edx-ace file_email channel because the output path of the latter cannot be modified by a setting. Note that this causes all emails to be stored in local files instead of being sent to actual recipients. This is the default behaviour in Open edX, and indeed in most default django apps (in development). This is a good thing! If, for some reason, developers would like to try out email sending during development, they should modify the EMAIL_BACKEND setting and set it to 'django.core.mail.backends.smtp.EmailBackend'. This is quite easy to achieve with the help of a plugin: name: sendemailsindev version: 0.1.0 patches: openedx-development-settings: | # actually send emails in dev EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend" Close #315
2020-04-15 23:38:31 +02:00
- [Bugfix] Make sure all emails (including "password reset") are properly saved to a local file in development mode (#315)
Add `openedx-development-settings` patch
2020-04-15 23:50:56 +02:00
- [Improvement] Add `openedx-development-settings` patch to patch the LMS and the CMS simultaneously in development
Fix missing celery tasks in the CMS This should spare us quite a few error messages in the CMS worker.
2020-04-14 19:49:18 +02:00
- [Bugfix] Fix missing celery tasks in the CMS
v3.11.10 (2020-04-14) - [Bugfix] Fix updates to the course structure in the LMS (#302)
2020-04-14 19:24:27 +02:00
## v3.11.10 (2020-04-14)
Fix updates to the course structure in the LMS When we were changing unit titles in the CMS, the changes were taking a long time to be reflected in the LMS. That's because the cache key that corresponds to the course structure was not being updated. It was the responsibility of an asynchronous LMS celery worker to update this cache entry. However, this was impossible in most cases because tasks triggered in the CMS were only processed by CMS workers. That is, unless we are using a custom celery router: https://celery.readthedocs.io/en/latest/userguide/routing.html#routers This is what edx-platform does in the devstack: certain CMS tasks are forwarded both to CMS and to LMS workers. This is achieved by defining the ALTERNATE_WORKER_QUEUES="lms" django setting in the CMS. Adding this setting to Tutor solves the problem in production. However, in development mode Open edX runs without workers (`CELERY_ALWAYS_EAGER=True`). This means that the course structure will not be automatically updated when running `tutor dev` commands, which is a shame. The alternative is to define the "block_structure.invalidate_cache_on_publish" waffle switch. This can be done from the UI (in /admin/waffle/switch/add/) or by running: tutor dev run lms ./manage.py lms waffle_switch block_structure.invalidate_cache_on_publish on --create However, this flag seems to slow down access to the LMS for the first user who tries to access the course after it has been updated. Close #302
2020-04-14 18:27:36 +02:00
v3.11.10 (2020-04-14) - [Bugfix] Fix updates to the course structure in the LMS (#302)
2020-04-14 19:24:27 +02:00
- [Bugfix] Fix updates to the course structure in the LMS (#302)
Fix updates to the course structure in the LMS When we were changing unit titles in the CMS, the changes were taking a long time to be reflected in the LMS. That's because the cache key that corresponds to the course structure was not being updated. It was the responsibility of an asynchronous LMS celery worker to update this cache entry. However, this was impossible in most cases because tasks triggered in the CMS were only processed by CMS workers. That is, unless we are using a custom celery router: https://celery.readthedocs.io/en/latest/userguide/routing.html#routers This is what edx-platform does in the devstack: certain CMS tasks are forwarded both to CMS and to LMS workers. This is achieved by defining the ALTERNATE_WORKER_QUEUES="lms" django setting in the CMS. Adding this setting to Tutor solves the problem in production. However, in development mode Open edX runs without workers (`CELERY_ALWAYS_EAGER=True`). This means that the course structure will not be automatically updated when running `tutor dev` commands, which is a shame. The alternative is to define the "block_structure.invalidate_cache_on_publish" waffle switch. This can be done from the UI (in /admin/waffle/switch/add/) or by running: tutor dev run lms ./manage.py lms waffle_switch block_structure.invalidate_cache_on_publish on --create However, this flag seems to slow down access to the LMS for the first user who tries to access the course after it has been updated. Close #302
2020-04-14 18:27:36 +02:00
v3.11.9 (2020-04-07) - [Bugfix] Fix Android app build for domain names that include a dash ("-")
2020-04-07 15:06:21 +02:00
## v3.11.9 (2020-04-07)
Fix Android app build for domain names that include a dash See https://discuss.overhang.io/t/build-android-app-command-error/405/30 Android package names should be composed of alphanumeric or underscore characters only (https://developer.android.com/studio/build/application-id.html)
2020-04-07 15:04:34 +02:00
- [Bugfix] Fix Android app build for domain names that include a dash ("-")
v3.11.8 (2020-04-06) - [Feature] Add `encrypt` template filter to conveniently add htpasswd-based authentication to nginx - [Bugfix] Fix "missing tty" during init in cron jobs
2020-04-06 10:40:28 +02:00
## v3.11.8 (2020-04-06)
Fix "missing tty" during init in cron jobs
2020-04-02 12:36:43 +02:00
Add `encrypt` template filter This is convenient for htpasswd-based authentication to nginx, for instance.
2020-04-04 18:22:15 +02:00
- [Feature] Add `encrypt` template filter to conveniently add htpasswd-based authentication to nginx
Fix "missing tty" during init in cron jobs
2020-04-02 12:36:43 +02:00
- [Bugfix] Fix "missing tty" during init in cron jobs
v3.11.7 (2020-04-01) - [Bugfix] Fix missing js translations - [Bugfix] Fix tls certificate generation in cron jobs
2020-04-01 20:23:16 +02:00
## v3.11.7 (2020-04-01)
Fix tls certificate generation in cron jobs tls renewal and generation was failing in cron jobs because of "The input device is not a TTY" errors. This is because the "-it" docker option does not work when a tty is not available.
2020-03-27 09:59:11 +01:00
Add missing js translations to openedx Client-side translations are stored in "djangojs.js" files. Supposedly, these files were properly compiled prior to the Ironwood release -- but this is not the case, so we need to re-generate them. Also, we need to re-generate the djangojs.js files for the custom, downloaded locales. The assets collection settings are also fixed to take into account the separate locale folder. This step needs to happen prior to static assets collection, as the djangojs files are collected to the staticfiles/ folder. See these conversations: https://discuss.overhang.io/t/localization-not-works-perfect/363 https://discuss.openedx.org/t/localization-not-work-for-js-files/1671
2020-04-01 20:05:06 +02:00
- [Bugfix] Fix missing js translations
Fix tls certificate generation in cron jobs tls renewal and generation was failing in cron jobs because of "The input device is not a TTY" errors. This is because the "-it" docker option does not work when a tty is not available.
2020-03-27 09:59:11 +01:00
- [Bugfix] Fix tls certificate generation in cron jobs
v3.11.6 (2020-03-13) - [Bugfix] Fix "Unable to resolve dependency" error during forum initialisation - [Feature] Add `settheme` command to easily assign a theme to a domain name - [Improvement] Modify nginx access logs to include request scheme and server name (plugin developers should use the "tutor" log format) - [Bugfix] Fix DNS resolution of restarted service - [Feature] Restart multiple services with `local restart` - [Feature] Make it possible to easily reload openedx gunicorn process with `tutor local exec lms reload-gunicorn`` - [Improvement] Rename lms/cms_worker to lms/cms-worker in local deployment - [Improvement] Add the management plugin to the rabbitmq container - [Improvement] Make it possible to run an Elasticsearch service on https
2020-03-13 19:09:26 +01:00
## v3.11.6 (2020-03-13)
Make it possible to run an Elasticsearch service on https This is useful when running elasticsearch from 3rd-party vendors.
2020-03-09 13:18:02 +01:00
Fix "Unable to resolve dependency" error during forum init When running "bundle exec rake search:initialize" in the forum, we were getting the following error: /openedx/ruby/lib/ruby/site_ruby/2.4.0/rubygems/resolver.rb:235:in `search_for': Unable to resolve dependency: user requested 'did_you_mean (= 1.1.0)' (Gem::UnsatisfiableDependencyError) It happens this error suddently happened because rubygems-update was not pinned to a specific version. v3.0.4 was working and v3.1.2 was not. As it happens, we don't need rubygems-update, so we simply get rid of it entirely.
2020-03-13 18:38:10 +01:00
- [Bugfix] Fix "Unable to resolve dependency" error during forum initialisation
Add "settheme" command This makes it much easier to switch to a new theme.
2020-03-13 12:09:48 +01:00
- [Feature] Add `settheme` command to easily assign a theme to a domain name
Add scheme and server name to access logs To do so, we had to create a new log_format. Plugin developers are strongly encouraged to start using this log format by adding the `access_log /var/log/nginx/access.log tutor;` directive to their extra nginx configurations. In order to load this log format early, the `tutor.conf` config file had to be renamed to something early in the alphabet... (hence starting by an underscore) Older users would face an error on nginx reload, so older "tutor.conf" files are automatically removed on config save.
2020-03-12 11:59:50 +01:00
- [Improvement] Modify nginx access logs to include request scheme and server name (plugin developers should use the "tutor" log format)
Fix nginx DNS resolution of restarted services Previously, a common error when restarting e.g: the lms or the cms was that nginx redirected to the wrong container. For instance: access studio.localhost tutor local restart lms cms access studio.localhost In the second call to studio.localhost, we were frequently trying to access the LMS, which resulted in a 400 error. We solve this issue by setting a TTL of 10s on the nginx proxy name resolution. More docs: http://nginx.org/en/docs/http/ngx_http_core_module.html#resolver
2020-03-12 09:53:18 +01:00
- [Bugfix] Fix DNS resolution of restarted service
Allow multiple services in "local restart" command
2020-03-12 09:52:22 +01:00
- [Feature] Restart multiple services with `local restart`
Changelog typo
2020-03-25 17:10:07 +01:00
- [Feature] Make it possible to easily reload openedx gunicorn process with `tutor local exec lms reload-gunicorn`
Rename worker containers from x_worker to x-worker This is more coherent with k8s.
2020-03-10 10:05:53 +01:00
- [Improvement] Rename lms/cms_worker to lms/cms-worker in local deployment
Add the management plugin to the rabbitmq container The management plugin exposes an http API that makes it possible to monitor rabbitmq. By default, we do not expose the management dashboard. As a consequence, the API is only usable by other internal containers.
2020-03-09 13:19:20 +01:00
- [Improvement] Add the management plugin to the rabbitmq container
Make it possible to run an Elasticsearch service on https This is useful when running elasticsearch from 3rd-party vendors.
2020-03-09 13:18:02 +01:00
- [Improvement] Make it possible to run an Elasticsearch service on https
v3.11.5 (2020-02-27) - [Improvement] Switch edx-platform from open-release/ironwood.2 tag to the open-release/ironwood.master branch - [Security] Upgrade django to 1.11.28 - [Improvement] Make it possible to configure the elasticsearch heap size - [Bugfix] Fix broken elasticsearch environment variables - [Improvement] Restore more recent Android app version (#289).
2020-02-27 17:53:24 +01:00
## v3.11.5 (2020-02-27)
Restore more recent Android app tagged release A prior change used the ironwood.1 tag to build the Android app in an attempt to solve #289. Turns out that this change was unnecessary. So here we revert to a more recent release of the Android app. Instead of building from the master branch (which might create suprises) we build from a fixed release tag. The source repo and version are customisable via build arguments.
2020-02-25 17:16:09 +01:00
Switch edx-platform from ironwood.2 to ironwood.master There are too many patches on top of ironwood.2, and it's not practical to pull them all one by one. We still want to build on top of a specific version, and not a branch, so we use a dirty hack to guarantee that the docker image is properly rebuilt by CI when we change it.
2020-02-27 17:22:55 +01:00
- [Improvement] Switch edx-platform from open-release/ironwood.2 tag to the open-release/ironwood.master branch
Security upgrade django 1.11.27 -> 1.11.28
2020-02-27 17:13:42 +01:00
- [Security] Upgrade django to 1.11.28
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 11:47:43 +01:00
- [Improvement] Make it possible to configure the elasticsearch heap size
- [Bugfix] Fix broken elasticsearch environment variables
Restore more recent Android app tagged release A prior change used the ironwood.1 tag to build the Android app in an attempt to solve #289. Turns out that this change was unnecessary. So here we revert to a more recent release of the Android app. Instead of building from the master branch (which might create suprises) we build from a fixed release tag. The source repo and version are customisable via build arguments.
2020-02-25 17:16:09 +01:00
- [Improvement] Restore more recent Android app version (#289).
v3.11.4 (2020-02-16) - [Bugfix] Fix auth problem in Android app (#289)
2020-02-16 15:59:56 +01:00
## v3.11.4 (2020-02-16)
Downgrade android build version to ironwood.1 The android master branch was failing because of authentication errors. Close #289
2020-02-16 15:57:56 +01:00
- [Bugfix] Fix auth problem in Android app (#289)
v3.11.3 (2020-01-21) - [Bugfix] Fix incorrectly parsed empty strings for `config save --set ...=...` commands
2020-01-21 17:10:54 +01:00
## 3.11.3 (2020-01-21)
Fix incorrectly parsed empty strings in `config save --set ...=...` When running `config save --set KEY=""`, KEY was incorrectly interpreted as null.
2020-01-21 17:09:58 +01:00
- [Bugfix] Fix incorrectly parsed empty strings for `config save --set ...=...` commands
v3.11.2 (2020-01-17) - [Bugfix] Make sure `docker-compose.override.yml` are loaded in dev and local contexts
2020-01-17 12:12:47 +01:00
## 3.11.2 (2020-01-17)
Fix loading of docker-compose.override files Override files are not automatically loaded when running with `-f`, so we need to specify them manually.
2020-01-17 09:41:54 +01:00
- [Bugfix] Make sure `docker-compose.override.yml` are loaded in dev and local contexts
v3.11.1 (2020-01-16) - [Feature] Add `config render` command
2020-01-16 23:49:44 +01:00
## 3.11.1 (2020-01-16)
Add `config render` command This is going to be useful for using custom themes with user-defined variables.
2020-01-16 15:40:38 +01:00
- [Feature] Add `config render` command
v3.11.0 (2020-01-14) - [Feature] Add support for simple, YAML-based plugins - 💥[Improvement] The output of `plugins list` now includes plugin version numbers
2020-01-14 17:35:11 +01:00
## 3.11.0 (2020-01-14)
Refactor plugin internals This is for supporting json-based plugins. The great thing about this change is that it allows us to easily print plugin version numbers in `plugins list`.
2020-01-14 13:32:45 +01:00
Add support for simple, yaml-based plugins Those plugins are stored as yaml files in ~/.local/share/tutor-plugins and follow the same specifications as entrypoint plugins.
2020-01-14 15:42:20 +01:00
- [Feature] Add support for simple, YAML-based plugins
- 💥[Improvement] The output of `plugins list` now includes plugin version numbers
Refactor plugin internals This is for supporting json-based plugins. The great thing about this change is that it allows us to easily print plugin version numbers in `plugins list`.
2020-01-14 13:32:45 +01:00
3.10.1 (2020-01-13) - [Improvement] Explicitely point to docker.io images, when necessary, for [podman](https://podman.io/) compatibility.
2020-01-13 14:41:08 +01:00
## 3.10.1 (2020-01-13)
Add support for simple, yaml-based plugins Those plugins are stored as yaml files in ~/.local/share/tutor-plugins and follow the same specifications as entrypoint plugins.
2020-01-14 15:42:20 +01:00
- [Improvement] Explicitely point to docker.io images, when necessary, for [podman](https://podman.io/) compatibility
3.10.1 (2020-01-13) - [Improvement] Explicitely point to docker.io images, when necessary, for [podman](https://podman.io/) compatibility.
2020-01-13 14:41:08 +01:00
v3.10.0 - [Bugfix] Fix oauth authentication in dev mode - [Improvement] Upgrade to the 3.7 docker-compose syntax - [Improvement] The `dev runserver` command can now be run for just any service - 💥[Feature] `dev run/exec` commands now support generic options which are passed to docker-compose. Consequently, defining the `TUTOR_EDX_PLATFORM_PATH` environment variable no longer works. Instead, users are encouraged to explicitely pass the `-v` option, define a command alias or create a `docker-compose.override.yml` file.
2020-01-10 16:24:14 +01:00
## 3.10.0 (2020-01-10)
More feature-complete dev/local docker-compose commands By de-duplicating the code between dev.py and local.py, we are able to support more docker-compose run/up/stop options passed from tutor. To do so, we had to disable some features, such as automatically mounting the edx-platform repo when the TUTOR_EDX_PLATFORM_PATH environment variable was defined.
2020-01-08 19:38:13 +01:00
Fix oauth authentication in dev mode This was causing issues with the discovery service in development mode.
2020-01-10 13:14:55 +01:00
- [Bugfix] Fix oauth authentication in dev mode
Upgrade to v3.7 for docker-compose service definition We were encountering issues when overriding service definitions with "x-...". These were solved by upgrading docker-compose and switching to 3.7 service definition. As a consequence, the minimum supported docker version is 18.06.0, as specified by https://docs.docker.com/compose/compose-file/#compose-and-docker-compatibility-matrix
2020-01-10 10:55:08 +01:00
- [Improvement] Upgrade to the 3.7 docker-compose syntax
Make it possible to run `dev runserver` for any service
2020-01-08 22:26:14 +01:00
- [Improvement] The `dev runserver` command can now be run for just any service
Clarify changelog regarding docker-compose.override file
2020-01-10 16:07:35 +01:00
- 💥[Feature] `dev run/exec` commands now support generic options which are passed to docker-compose. Consequently, defining the `TUTOR_EDX_PLATFORM_PATH` environment variable no longer works. Instead, users are encouraged to explicitely pass the `-v` option, define a command alias or create a `docker-compose.override.yml` file.
More feature-complete dev/local docker-compose commands By de-duplicating the code between dev.py and local.py, we are able to support more docker-compose run/up/stop options passed from tutor. To do so, we had to disable some features, such as automatically mounting the edx-platform repo when the TUTOR_EDX_PLATFORM_PATH environment variable was defined.
2020-01-08 19:38:13 +01:00
v3.9.1 - [Improvement] Make it possible to override the project name in development mode - [Bugfix] Fix user switching in development mode - [Bugfix] Fix "k8s quickstart" crash
2020-01-08 20:09:33 +01:00
## 3.9.1 (2020-01-08)
Fix crash on "k8s quickstart" This was due to the recent context refactoring. See https://discuss.overhang.io/t/error-with-kubernetes-deployment/240
2020-01-08 20:07:25 +01:00
Add missing info from changelog
2020-01-08 20:08:50 +01:00
- [Improvement] Make it possible to override the project name in development mode
- [Bugfix] Fix user switching in development mode
Fix crash on "k8s quickstart" This was due to the recent context refactoring. See https://discuss.overhang.io/t/error-with-kubernetes-deployment/240
2020-01-08 20:07:25 +01:00
- [Bugfix] Fix "k8s quickstart" crash
v3.9.0 - [Security] Apply django 1.11.21 -> 1.11.27 security patches - [Bugfix] Fix running dev image with `sudo` - [Improvement] Add `cms/lms-env-features` patches (#276) - [Feature] Add plugin subcommands - 💥[Improvement] Move ``-r/--root`` option to parent command level - [Bugfix] Fix course about page visibility - [Improvement] Print gunicorn access logs in the console - 💥[Improvement] Get rid of the `indexcourses` and `portainer` command (#269)
2019-12-21 16:54:57 +01:00
## 3.9.0 (2019-12-21)
Get rid of the `indexcourses` command This command adds a burden on the `local` and `k8s` command. It does not make sense to provide this command out of the box, and not other administration commands. Instead, we should better document how to run regular `manage.py` commands from tutor. Close #269.
2019-12-05 11:45:09 +01:00
Apply django 1.11.21 -> 1.11.27 security patches
2019-12-21 15:18:29 +01:00
- [Security] Apply django 1.11.21 -> 1.11.27 security patches
Fix running dev openedx image with sudo When running with `sudo`, the USERID image ARG is 0. The docker entrypoint needed to take this case into account. See: https://discuss.overhang.io/t/openedx-is-not-the-name-of-a-known-user/224/5
2019-12-16 09:33:02 +01:00
- [Bugfix] Fix running dev image with `sudo`
Add `cms/lms-env-features` patches Close #276
2019-12-13 10:07:28 +01:00
- [Improvement] Add `cms/lms-env-features` patches (#276)
Make it possible to run plugin subcommands
2019-12-12 17:23:46 +01:00
- [Feature] Add plugin subcommands
- 💥[Improvement] Move ``-r/--root`` option to parent command level
Fix course about page visibility "Course visibility In Catalog" advanced CMS setting was being ignored because the default the COURSE_CATALOG_VISIBILITY_PERMISSION and COURSE_ABOUT_VISIBILITY_PERMISSION settings were incorrectly set to the legacy default, which "see_exists". See https://discuss.overhang.io/t/catalog-visibility-in-tutor-deployed-open-edx/214
2019-12-09 10:18:54 +01:00
- [Bugfix] Fix course about page visibility
Print gunicorn access logs in the console See docs: https://docs.gunicorn.org/en/stable/settings.html#accesslog
2019-12-05 12:41:00 +01:00
- [Improvement] Print gunicorn access logs in the console
Get rid of the `local portainer` command It makes more sense to document this command instead of adding it to the `local` commands. If need be, in the future we should be able to re-add it as a plugin.
2019-12-05 11:54:44 +01:00
- 💥[Improvement] Get rid of the `indexcourses` and `portainer` command (#269)
Get rid of the `indexcourses` command This command adds a burden on the `local` and `k8s` command. It does not make sense to provide this command out of the box, and not other administration commands. Instead, we should better document how to run regular `manage.py` commands from tutor. Close #269.
2019-12-05 11:45:09 +01:00
v3.8.0 - [Improvement] Add `k8s-deployments-nginx-volume-mounts` patch - [Bugfix] Fix running forum locally when both elasticsearch and mongodb are not activated (#266) - [Bugfix] Fix MongoDb url in forum when running separate service (#267) - 💥[Improvement] Better `dev` commands, with dedicated development docker image. One of the consequences is that the `dev watchthemes` command is replaced by `dev run lms watchthemes`. - [Improvement] `images` commands now accept multiple `image` arguments
2019-11-22 13:01:42 +01:00
## 3.8.0 (2019-11-22)
Better `dev` environment The `dev` commands now rely on a different openedx-dev docker image. This gives us multiple improvements: - no more chown in base image - faster chown in development - mounted requirements volume in development - fix static assets issues - bundled ipdb/vim/... packages, which are convenient for development Close #235
2019-10-22 16:13:50 +02:00
Add k8s-deployments-nginx-volume-mounts plugin patch This is for mounting discovery/ecommerce static asset folders in nginx.
2019-11-22 11:54:49 +01:00
- [Improvement] Add `k8s-deployments-nginx-volume-mounts` patch
Fix forum depends_on when data services are disabled When both mongodb and elasticsearch were not activated, there was a syntax error in the local docker-compose.yml file. Close #266
2019-11-22 09:20:17 +01:00
- [Bugfix] Fix running forum locally when both elasticsearch and mongodb are not activated (#266)
Fix Mongodb url in forum when running separate service MONGOHQ_URL was not properly set when MONGODB_HOST/PORT was customised. That's because the environment variable was being defined in the Dockerfile, and not at runtime. Close #267
2019-11-22 08:41:47 +01:00
- [Bugfix] Fix MongoDb url in forum when running separate service (#267)
Better `dev` environment The `dev` commands now rely on a different openedx-dev docker image. This gives us multiple improvements: - no more chown in base image - faster chown in development - mounted requirements volume in development - fix static assets issues - bundled ipdb/vim/... packages, which are convenient for development Close #235
2019-10-22 16:13:50 +02:00
- 💥[Improvement] Better `dev` commands, with dedicated development docker image. One of the consequences is that the `dev watchthemes` command is replaced by `dev run lms watchthemes`.
- [Improvement] `images` commands now accept multiple `image` arguments
v3.7.4 (2019-10-19) - [Bugfix] Fix missing requirements file in pypi package (#261) - [Improvement] Add missing cms/lms production/development setting patches - [Improvement] Allow SigV4 authentication for video upload to S3 - [Bugfix] Fix cms development settings
2019-10-19 19:13:57 +02:00
## 3.7.4 (2019-10-19)
Support SigV4 authentication for video upload
2019-10-18 17:37:30 +02:00
Fix missing requirements file in pypi package Close #261.
2019-10-19 18:28:29 +02:00
- [Bugfix] Fix missing requirements file in pypi package (#261)
Add missing cms/lms production/development setting patches
2019-10-18 18:01:12 +02:00
- [Improvement] Add missing cms/lms production/development setting patches
Support SigV4 authentication for video upload
2019-10-18 17:37:30 +02:00
- [Improvement] Allow SigV4 authentication for video upload to S3
- [Bugfix] Fix cms development settings
## 3.7.3 (2019-10-17)
Upgrade openedx locales to Ironwood
2019-10-09 15:50:32 +02:00
- [Improvement] Upgrade openedx locales to Ironwood
v3.7.2 (2019-10-09) - [Improvement] Properly set studio title (#246) - [Improvement] Enable Mysql strict mode
2019-10-09 12:18:37 +02:00
## 3.7.2 (2019-10-09)
Get rid of mysql strict trans mode warnings Here, we adopt the same behaviour as edX.org. See the following links for documentation: https://docs.djangoproject.com/en/1.11/ref/databases/#mysql-sql-mode https://dev.mysql.com/doc/refman/en/sql-mode.html#sql-mode-strict
2019-10-07 16:33:28 +02:00
Properly set studio title This title is visible in the browser title bar and the main page of the CMS. Close #246.
2019-10-09 12:04:15 +02:00
- [Improvement] Properly set studio title (#246)
Get rid of mysql strict trans mode warnings Here, we adopt the same behaviour as edX.org. See the following links for documentation: https://docs.djangoproject.com/en/1.11/ref/databases/#mysql-sql-mode https://dev.mysql.com/doc/refman/en/sql-mode.html#sql-mode-strict
2019-10-07 16:33:28 +02:00
- [Improvement] Enable Mysql strict mode
v3.7.1 - [Feature] Introduce tutor docker image - [Feature] Introduce `local hook` command for plugin development. - [Bugfix] Persist `private.txt` file between two runs of `config save`. (#247) - [Improvement] Added configuration values to limit the number of gunicorn workers for the LMS and CMS.
2019-10-07 14:27:12 +02:00
## 3.7.1 (2019-10-06)
Added config values for #gunicorn workers
2019-09-19 15:39:18 +02:00
Add tutor docker image (experimental)
2019-10-04 12:01:26 +02:00
- [Feature] Introduce tutor docker image
Introduce `local hook` command
2019-10-04 11:43:26 +02:00
- [Feature] Introduce `local hook` command for plugin development.
Persist private.txt between two runs of "config save" Close #247.
2019-09-23 11:32:10 +02:00
- [Bugfix] Persist `private.txt` file between two runs of `config save`. (#247)
Added config values for #gunicorn workers
2019-09-19 15:39:18 +02:00
- [Improvement] Added configuration values to limit the number of gunicorn workers for the LMS and CMS.
v3.7.0 (2019-09-03) - 💥[Improvement] Get rid of mysql-client container - [Improvement] Add "local-docker-compose-lms/cms-dependencies" plugin patches - [Improvement] Use "exec" instead of "run" to initialise local platform
2019-09-03 11:11:52 +02:00
## 3.7.0 (2019-09-03)
Switch from "run" to "exec" for local initialisation We ran into an issue when trying to run migrations when the MinIO plugin is activated. As seen in issues #243 and #244, the certificates.0003_data__default_modes migration requires access to MinIO. To do so, the MinIO host must be reached. That means that SSL certificates must be in place (if https is enabled) and that the nginx server must be booted. However, it does not make sense to require that the minio container depends on the nginx container. So, in effect, we need a fully working platform to run migrations. In a sense, this is better as it harmonises the init task with k8s: in k8s, init was already run with exec. Next step is to get rid of these ugly mysql-client/minio-client containers that must be up at all times. It would be much simpler to just exec the commands inside the mysql/minio containers.
2019-09-03 09:29:38 +02:00
Get rid of mysql-client container This has an impact on plugin hooks. Plugin hooks that needed to run inside mysql-client now need to run inside mysql container. This simplifies the deployment, as we no longer have an empty mysql-client container sitting around. When mysql is not enabled (ACTIVATE_MYSQL=False) the mysql container is simply a mysql client.
2019-09-03 10:36:10 +02:00
- 💥[Improvement] Get rid of mysql-client container
Add lms/cms dependency patches This makes it possible to declare that the lms/cms depend on minio.
2019-09-03 09:35:55 +02:00
- [Improvement] Add "local-docker-compose-lms/cms-dependencies" plugin patches
Switch from "run" to "exec" for local initialisation We ran into an issue when trying to run migrations when the MinIO plugin is activated. As seen in issues #243 and #244, the certificates.0003_data__default_modes migration requires access to MinIO. To do so, the MinIO host must be reached. That means that SSL certificates must be in place (if https is enabled) and that the nginx server must be booted. However, it does not make sense to require that the minio container depends on the nginx container. So, in effect, we need a fully working platform to run migrations. In a sense, this is better as it harmonises the init task with k8s: in k8s, init was already run with exec. Next step is to get rid of these ugly mysql-client/minio-client containers that must be up at all times. It would be much simpler to just exec the commands inside the mysql/minio containers.
2019-09-03 09:29:38 +02:00
- [Improvement] Use "exec" instead of "run" to initialise local platform
v3.6.3 (2019-08-31) - [Security] Fix CustomTagModule mako template injection - [Improvement] Move all plugins outside of the tutor repo - [Bugfix/Improvement] Add all plugins (with data) into binary bundle (#242)
2019-08-31 12:15:08 +02:00
## 3.6.3 (2019-08-31)
Add all plugins (with data) to binary bundle All existing plugins are added to the binary bundle, in their latest version, so that users don't need to pip install tutor. Also, the tutor MANIFEST.in file was removed to simplify the management of package data. Close #242.
2019-08-20 17:01:34 +02:00
Fix CustomTagModule mako template injection See announcement: https://groups.google.com/forum/#!topic/openedx-ops/aVHomKimstU
2019-08-31 12:13:19 +02:00
- [Security] Fix CustomTagModule mako template injection
Move plugins to dedicated repositories minio, notes and xqueue plugins are moved to tutor-* github repos.
2019-08-21 18:32:39 +02:00
- [Improvement] Move all plugins outside of the tutor repo
Add all plugins (with data) to binary bundle All existing plugins are added to the binary bundle, in their latest version, so that users don't need to pip install tutor. Also, the tutor MANIFEST.in file was removed to simplify the management of package data. Close #242.
2019-08-20 17:01:34 +02:00
- [Bugfix/Improvement] Add all plugins (with data) into binary bundle (#242)
v3.6.2 (2019-08-07) - [Bugfix] Fix missing templates in bundled plugins - [Bugfix] Enable html certificate view
2019-08-07 13:31:35 +02:00
## 3.6.2 (2019-08-07)
Enable HTML certificates by default See this discussion https://discuss.overhang.io/t/how-to-generate-a-certificate-for-students/100/3
2019-07-31 13:11:22 +02:00
Fix missing `templates` folder in pypi plugins This was causing a `TemplateNotFound` error. For instance: https://discuss.overhang.io/t/error-trying-to-enable-xqueue-plugin/110
2019-08-07 12:55:03 +02:00
- [Bugfix] Fix missing templates in bundled plugins
Enable HTML certificates by default See this discussion https://discuss.overhang.io/t/how-to-generate-a-certificate-for-students/100/3
2019-07-31 13:11:22 +02:00
- [Bugfix] Enable html certificate view
Clarify release date of v3.6.1 in changelog
2019-07-28 11:46:15 +02:00
## 3.6.1 (2019-07-27)
Release 0.1.0 of tutor-minio
2019-07-26 23:19:40 +02:00
- [Bugfix] Fix missing patches from minio plugin (thanks @Wejie!)
v3.6.0 (2019-07-11) - [Feature] Modify ``createuser`` commands to define a password from the command line - [Improvement] Better yaml value parsing from command line - [Feature] Add `dev exec` command - [Bugfix] Fix incorrect notes settings definition - [Improvement] Make it possible to start/stop/reboot a selection of services - [Improvement] Add `local/k8s reboot` commands - [Improvement] Add `-U/--unset` option to `config save` - [Bugfix] Fix insecure static asset loading when web proxy is enabled - [Improvement] Rename `SECRET_KEY` configuration parameter to `OPENEDX_SECRET_KEY` - [Improvement] Add support for SSL and TLS in external SMTP server (#231) - [Bugfix] Fix missing video transcripts in LMS (#229) - [Improvement] Make it possible to enable/disable multiple plugins at once - [Improvement] Add a few local and k8s patches for plugins
2019-07-11 14:26:27 +08:00
## 3.6.0 (2019-07-11)
Add 'local-docker-compose-nginx-volumes' patch
2019-07-07 06:29:33 +08:00
Define a password from the CLI on user creation Add a `-p/--password` option to `createuser` commands.
2019-07-11 11:55:12 +08:00
- [Feature] Modify ``createuser`` commands to define a password from the command line
Improve command line yaml value deserialization
2019-07-10 15:00:44 +08:00
- [Improvement] Better yaml value parsing from command line
Add `dev exec` command for debugging apps in dev mode
2019-07-09 17:57:00 +08:00
- [Feature] Add `dev exec` command
Fix incorrect notes settings definition
2019-07-09 12:21:22 +08:00
- [Bugfix] Fix incorrect notes settings definition
Make it possible to start/stop/reboot a selection of services
2019-07-09 12:20:06 +08:00
- [Improvement] Make it possible to start/stop/reboot a selection of services
Minor changelog formatting
2019-07-09 17:57:28 +08:00
- [Improvement] Add `local/k8s reboot` commands
- [Improvement] Add `-U/--unset` option to `config save`
Fix insecure asset loading with web proxy enabled This issue is well described in this post: https://discuss.overhang.io/t/reverse-proxy-and-mixed-content-issue/86 When WEB_PROXY=True and ACTIVATE_HTTPS=True the containerized nginx sets an incorrect value for X-Forwarded-Proto.
2019-07-07 17:14:31 +08:00
- [Bugfix] Fix insecure static asset loading when web proxy is enabled
Minor changelog formatting
2019-07-09 17:57:28 +08:00
- [Improvement] Rename `SECRET_KEY` configuration parameter to `OPENEDX_SECRET_KEY`
Add support for SMTP SSL, in addition to TLS Note that SSL and TLS are incompatible. Close #231.
2019-07-08 06:24:35 +08:00
- [Improvement] Add support for SSL and TLS in external SMTP server (#231)
Fix missing video transcripts in LMS Video transcripts uploaded in the CMS were not visible in the LMS. This was a symptom caused by the fact that the LMS and the CMS do not share the same MEDIA_ROOT. We initially thought that data uploaded in the CMS (such as transcripts) was stored in a shared data service, such as mongodb. It is, in fact, not. This makes it even more important to run an object storage service like minio for distributed services. Close #229
2019-07-07 08:52:47 +08:00
- [Bugfix] Fix missing video transcripts in LMS (#229)
Enable/Disable multiple plugins in one command
2019-07-07 08:21:14 +08:00
- [Improvement] Make it possible to enable/disable multiple plugins at once
Add nginx volumes patch for k8s
2019-07-10 16:39:58 +08:00
- [Improvement] Add a few local and k8s patches for plugins
Add 'local-docker-compose-nginx-volumes' patch
2019-07-07 06:29:33 +08:00
v3.5.3 (2019-07-05) - [Bugfix] Add pre-init hook for correct initialisation of minio
2019-07-05 14:21:15 +08:00
## 3.5.3 (2019-07-05)
Add pre-init hook The 0003 migration from the certificates app of the LMS requires that the S3-like platform is correctly setup during initialisation. To solve this issue, we introduce a pre-init hook that is run prior to the LMS migrations.
2019-07-05 14:19:23 +08:00
- [Bugfix] Add pre-init hook for correct initialisation of minio
v3.5.2 (2019-07-05) - [Security] Apply certificate XSS security patch
2019-07-05 06:29:28 +08:00
## 3.5.2 (2019-07-05)
Apply XSS certificate vulnerability patch https://github.com/edx/edx-platform/pull/20904 https://groups.google.com/forum/#!msg/openedx-ops/fi2WVlD0iNo/hFZrAnLpCAAJ
2019-07-05 06:27:28 +08:00
- [Security] Apply certificate XSS security patch
v3.5.1 (2019-07-04) - [Feature] Make it possible for plugins to patch the build templates - [Improvement] Move Xqueue and Student notes to a dedicated plugin
2019-07-04 22:56:38 +08:00
## 3.5.1 (2019-07-04)
Move Xqueue to a dedicated plugin This gives us the opportunity to develop new hooks: build-image and remote-image.
2019-07-02 22:16:44 +02:00
Make it possible to patch build templates Thus, build templates are no longer copied, but rendered.
2019-07-04 16:45:15 +08:00
- [Feature] Make it possible for plugins to patch the build templates
Migrate notes to a dedicated plugin
2019-07-03 22:09:33 +08:00
- [Improvement] Move Xqueue and Student notes to a dedicated plugin
Move Xqueue to a dedicated plugin This gives us the opportunity to develop new hooks: build-image and remote-image.
2019-07-02 22:16:44 +02:00
v3.4.3 (2019-06-24) - [Bugfix] Fix missing password values from generated configuration
2019-06-24 12:37:19 +02:00
## 3.4.3 (2019-06-24)
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 12:36:19 +02:00
- [Bugfix] Fix missing password values from generated configuration
v3.4.2 (2019-06-23) - [Bugfix] Fix incorrect settings during lms/cms init (#224)
2019-06-23 15:50:00 +02:00
## 3.4.2 (2019-06-23)
Fix incorrect settings during lms/cms init During init, the DJANGO_SETTINGS_MODULE environment variable was undefined, as the entrypoint is overridden. Close #224.
2019-06-23 15:47:30 +02:00
- [Bugfix] Fix incorrect settings during lms/cms init (#224)
v3.4.1 (2019-06-23) - [Bugfix] Fix install from pypi - [Improvement] Get rid of kubernetes python package dependency
2019-06-23 13:26:13 +02:00
## 3.4.1 (2019-06-23)
Get rid of kubernetes requirement from pypi package v3.4.0 package from pypi was still installing the kubernetes requirement, although is wasn't required anymore.
2019-06-23 13:08:30 +02:00
Fix install from pypi After installing from pypi, install was broken with "ModuleNotFoundError: No module named 'tutor.command".
2019-06-23 13:23:27 +02:00
- [Bugfix] Fix install from pypi
Get rid of kubernetes requirement from pypi package v3.4.0 package from pypi was still installing the kubernetes requirement, although is wasn't required anymore.
2019-06-23 13:08:30 +02:00
- [Improvement] Get rid of kubernetes python package dependency
v3.4.0 (2019-06-17) - [Feature] Creation of a plugin system - [Feature] Kubernetes support out of beta - [Improvement] Switch to pinned image tags for easier upgrades - 💥[Improvement] Remove the `-y/--yes` option: `tutor config save` is now non-interactive by default. Use `-i/--interactive` to force interactive mode. - 💥[Improvement] Replace the `databases` command by `init`. - [Improvement] Upgrade to ironwood.2 - [Improvement] Add `-y/--yes` option to `local quickstart` for non-interactive quickstart - [Improvement] Persist LMS/CMS logs to disk by default (with collaboration from @silviot 💪) - [Bugfix] Fix installing a locally cloned requirement repository - [Improvement] Add `--no-cache` option to `images build` - [Improvement] Make it possible to configure the notes service hostname - [Improvement] Better, more robust MySQL initialisation
2019-06-17 20:08:10 +02:00
## 3.4.0 (2019-06-17)
Replace `databases` command by `init`. Since initialisation does not only refer to database migrations, it makes more sense to rename this command.
2019-06-05 19:28:06 +02:00
v3.4.0 (2019-06-17) - [Feature] Creation of a plugin system - [Feature] Kubernetes support out of beta - [Improvement] Switch to pinned image tags for easier upgrades - 💥[Improvement] Remove the `-y/--yes` option: `tutor config save` is now non-interactive by default. Use `-i/--interactive` to force interactive mode. - 💥[Improvement] Replace the `databases` command by `init`. - [Improvement] Upgrade to ironwood.2 - [Improvement] Add `-y/--yes` option to `local quickstart` for non-interactive quickstart - [Improvement] Persist LMS/CMS logs to disk by default (with collaboration from @silviot 💪) - [Bugfix] Fix installing a locally cloned requirement repository - [Improvement] Add `--no-cache` option to `images build` - [Improvement] Make it possible to configure the notes service hostname - [Improvement] Better, more robust MySQL initialisation
2019-06-17 20:08:10 +02:00
- [Feature] Creation of a plugin system
- [Feature] Kubernetes support out of beta
Pin docker image tags to tutor versions Having an identical "ironwood" tag for all releases is not practical, in particular for breaking changes. Thus, docker images are now pinned to the tutor version that they were build with.
2019-06-17 20:00:30 +02:00
- [Improvement] Switch to pinned image tags for easier upgrades
Make configuration silent (non-interactive) by default Thus, we remove the -y/--yes options, which were kind of unintuitive, and we add instead `-i/--interactive`. The quickstart commands remain interactive by default, but can be silenced with `-I/--non-interactive`.
2019-06-05 19:45:22 +02:00
- 💥[Improvement] Remove the `-y/--yes` option: `tutor config save` is now non-interactive by default. Use `-i/--interactive` to force interactive mode.
Replace `databases` command by `init`. Since initialisation does not only refer to database migrations, it makes more sense to rename this command.
2019-06-05 19:28:06 +02:00
- 💥[Improvement] Replace the `databases` command by `init`.
Upgrade from ironwood.1 to ironwood.2 Because https://github.com/edx/edx-platform/pull/20325/ was merged in ironwood.2, we no longer need this patch.
2019-06-07 08:50:43 +02:00
- [Improvement] Upgrade to ironwood.2
Add `-y/--yes` option to `local quickstart`
2019-05-26 16:57:25 +02:00
- [Improvement] Add `-y/--yes` option to `local quickstart` for non-interactive quickstart
Improve lms/cms logging - deduplicate stdout logs - don't persist celery logs - persist logs to all.log by default
2019-05-05 13:53:04 +02:00
- [Improvement] Persist LMS/CMS logs to disk by default (with collaboration from @silviot 💪)
Fix installing a locally cloned requirement repository When running `pip install -r /path/to/x.txt`, relative paths listed in x.txt are supposed to be relative to the current folder, and not the x.txt folder. This results in an error during `pip install`: ./xblock-poll/ should either be a path to a local project or a VCS url beginning with svn+, git+, hg+, or bzr+ This error was first reported here: https://discuss.overhang.io/t/installing-custom-xblock/61
2019-05-22 19:27:49 +02:00
- [Bugfix] Fix installing a locally cloned requirement repository
Add `--no-cache` option to `images build`
2019-05-22 19:17:54 +02:00
- [Improvement] Add `--no-cache` option to `images build`
Make it possible to configure the notes service hostname This is important, in particular in development.
2019-05-15 10:51:54 +02:00
- [Improvement] Make it possible to configure the notes service hostname
Replace `databases` command by `init`. Since initialisation does not only refer to database migrations, it makes more sense to rename this command.
2019-06-05 19:28:06 +02:00
- [Improvement] Better, more robust MySQL initialisation
Make it possible to configure the notes service hostname This is important, in particular in development.
2019-05-15 10:51:54 +02:00
v3.3.10 (2019-05-15) - [Bugfix] Fix boolean configuration choices
2019-05-15 10:33:29 +02:00
## 3.3.10 (2019-05-15)
Fix boolean configuration choices Since the ask_bool refactoring, boolean choices were no longer taken into account during interactive configuration.
2019-05-15 10:19:51 +02:00
- [Bugfix] Fix boolean configuration choices
v3.3.9 (2019-05-13) - [Improvement] Add `local exec` command for running commands inside existing containers - [Bugfix] Fix triple display of courses in LMS search (upstream patch,
2019-05-13 17:27:41 +02:00
## 3.3.9 (2019-05-13)
Add `local exec` command
2019-05-05 12:22:14 +02:00
- [Improvement] Add `local exec` command for running commands inside existing containers
Fix triple course display in LMS search dashboard Apply upstream patch from https://github.com/edx/edx-platform/pull/20325/ Close #189.
2019-04-29 19:41:05 +02:00
- [Bugfix] Fix triple display of courses in LMS search (upstream patch, #189)
Less gunicorn workers for less RAM usage Settings the number of workers for the LMS and the CMS to 2*|CPU|+1 results in 4*|CPU]+2 gunicorn workers, which is too much for a laptop to cope with. Close #207
2019-04-28 09:34:02 +02:00
## 3.3.8 (2019-04-28)
- [Bugfix] Reduce the number of gunicorn workers to address RAM usage (#207)
v3.3.7 (2019-04-28) - [Bugfix] Fix "Timeout after 20s" on running migrations
2019-04-28 08:31:06 +02:00
## 3.3.7 (2019-04-28)
- [Bugfix] Fix "Timeout after 20s" on running migrations
v3.3.6 (2019-04-27) - [Bugfix] Fix KeyError on first quickstart - [Improvement] De-duplication of prod/dev settings. Thanks @silviot! 😺
2019-04-27 10:49:45 +02:00
## 3.3.6 (2019-04-27)
- [Bugfix] Fix KeyError on first quickstart
- [Improvement] De-duplication of prod/dev settings. Thanks @silviot! 😺
Fix changelog version typos
2019-04-25 21:57:44 +02:00
## 3.3.5 (2019-04-22)
Allow uppercase "Y" and "N" as answers to boolean questions
2019-04-09 13:38:56 -07:00
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 20:15:50 +01:00
- [Feature] Pluggable LMS/CMS/forum
Crash on env overwrite in non-interactive mode We took the opportunity to replace the custom ask_bool code by click.confirm, which just simpler.
2019-04-20 00:02:47 +02:00
- [Improvement] Safer environment overwrite. Thanks @silviot! 👐
Fix security issue with jinja2 requirement https://nvd.nist.gov/vuln/detail/CVE-2019-10906 To fix this issue, all requirements were simply upgraded to the latest version.
2019-04-17 08:02:51 +02:00
- [Security] Fix Jinja2 vulnerability
Improve cold start time by moving kubernetes import "import kubernetes" takes a long time. Moving this import improves "tutor --version" from 0.8s to 0.3s.
2019-04-09 18:28:19 -07:00
- [Improvement] Improve CLI cold start performance
Allow uppercase "Y" and "N" as answers to boolean questions
2019-04-09 13:38:56 -07:00
- [Improvement] Allow uppercase "Y" and "N" as answers to boolean questions
Fix changelog version typos
2019-04-25 21:57:44 +02:00
## 3.3.4 (2019-04-09)
Fix (again) login from studio when https is activated Login from studio with https was broken by the fix for localhost login. Close #193.
2019-04-09 11:11:32 -07:00
Rename `--silent` option to `-y/--yes`
2019-04-09 11:17:19 -07:00
- [Improvement] Rename `--silent` option to `-y/--yes`
Fix (again) login from studio when https is activated Login from studio with https was broken by the fix for localhost login. Close #193.
2019-04-09 11:11:32 -07:00
- [Bugfix] Fix (again) login from studio when https is activated (#193)
Fix changelog version typos
2019-04-25 21:57:44 +02:00
## 3.3.3 (2019-03-29)
Fix `pip install tutor-openedx` Installing from pip was broken because, for some reason, the templates/apps/xqueue/settings/ folder contained a __pycache__ folder with compiled *.pyc files. Rendering the binary files was failing miserably.
2019-03-29 06:24:59 -07:00
- [Bugfix] Fix `pip install tutor-openedx`
Fix changelog version typos
2019-04-25 21:57:44 +02:00
## 3.3.2 (2019-03-27)
Fix missing configuration parameters for android environment
2019-03-27 07:34:38 -07:00
v3.3.3 (2019-03-29) - [Bugfix] Fix `pip install tutor-openedx`
2019-03-29 06:36:19 -07:00
- [Bugfix] Fix login from localhost
Fix missing configuration parameters for android environment
2019-03-27 07:34:38 -07:00
- [Bugfix] Fix Android app image build
v3.3.1 - [Improvement] Improve assets building for development - [Improvement] Support CMS login when the CMS is not a subdomain of the LMS
2019-03-25 07:43:15 -07:00
## 3.3.1 (2019-03-25)
Add missing CMS config (just in case) I don't think this affects the CMS behaviour, but SESSION_COOKIE_DOMAIN is used by the CMS, so rather be safe than sorry.
2019-03-23 16:07:50 -07:00
use `update_assets` instead of the custom `openedx-assets` script Now that the correct webpack settings are loaded by the `update_assets` command in Ironwood, we can stop relying on the `openedx-assets` script. Actually, we could probably remove it.
2019-03-25 07:41:17 -07:00
- [Improvement] Improve assets building for development
Add missing CMS config (just in case) I don't think this affects the CMS behaviour, but SESSION_COOKIE_DOMAIN is used by the CMS, so rather be safe than sorry.
2019-03-23 16:07:50 -07:00
- [Improvement] Support CMS login when the CMS is not a subdomain of the LMS
v3.3.0 - [Feature] Upgrade from Hawthorn to Ironwood
2019-03-22 23:39:50 +01:00
## 3.3.0 (2019-03-22)
- [Feature] Upgrade from Hawthorn to Ironwood
v3.2.2 - [Feature] Multiple platforms on a single server \o/ - [Feature] Easily configure web proxy on the host - [Bugfix] Fix `images pull all` command which failed on "all" image - [Improvement] Add configurable mongodb, SMTP and rabbitmq authentication - [Improvement] Harmonize mysql username/password configuration parameters - [Feature] Configurable and pluggable data storage backends (#114)
2019-03-21 19:11:03 +01:00
## 3.2.2 (2019-03-21)
Pluggable SMTP service This is part of #114
2019-03-20 18:45:09 +01:00
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 19:06:08 +01:00
- [Feature] Multiple platforms on a single server \o/
Easily configurable web proxy A web proxy is a web server on the host that will forward request to the tutor web server. We support Apache2 and Nginx.
2019-03-21 17:38:01 +01:00
- [Feature] Easily configure web proxy on the host
Fix incorrect vendor image pulling
2019-03-21 14:08:47 +01:00
- [Bugfix] Fix `images pull all` command which failed on "all" image
Configurable mongodb username/password/port
2019-03-20 19:18:46 +01:00
- [Improvement] Add configurable mongodb, SMTP and rabbitmq authentication
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 18:45:20 +01:00
- [Improvement] Harmonize mysql username/password configuration parameters
Pluggable SMTP service This is part of #114
2019-03-20 18:45:09 +01:00
- [Feature] Configurable and pluggable data storage backends (#114)
v3.2.1 - [Feature] Enable grade downloads by default (#143) - [Improvement] Remove orphan containers on `local start`
2019-03-19 01:04:45 +01:00
## 3.2.1 (2019-03-19)
Remove orphan containers on `local start`
2019-03-18 23:03:45 +01:00
Enable grade download by default It was tricky to define correct settings: the "localfs" default storage backend was causing incorrect urls of the form "/media/<id>/<name>.csv". Close #143
2019-02-07 09:34:54 +01:00
- [Feature] Enable grade downloads by default (#143)
Remove orphan containers on `local start`
2019-03-18 23:03:45 +01:00
- [Improvement] Remove orphan containers on `local start`
v3.2.0 - [Improvement] `images pull` now also pulls vendor images - [Feature] Add convenient `config printvalue` command - [Feature] Customize docker registry - [Feature] Load configuration parameters from the system environment - [Improvement] Automatic environment re-generation after re-configuration - [Improvement] Error and interrupt handling in UI and web UI - [Bugfix] Fix missing webui env directory
2019-03-18 22:43:02 +01:00
## 3.2.0 (2019-03-18)
Fix missing webui env directory
2019-03-10 18:02:20 +01:00
Pull vendor images from the command line Vendor docker image versions are no longer hardcoded in environment files.
2019-03-18 22:39:35 +01:00
- [Improvement] `images pull` now also pulls vendor images
Add convenient "config printvalue" command
2019-03-18 22:38:13 +01:00
- [Feature] Add convenient `config printvalue` command
Easily customise the docker registry As a consequence, `images` commands lose the `--namespace/--version` arguments, which were confusing anyway.
2019-03-18 21:53:18 +01:00
- [Feature] Customize docker registry
Load configuration values from environment Configuration values can be loaded from the system environment by adding a "TUTOR_" prefix. Environment values supersede values from the user configuration file, so that we can set values from the command line with "KEY=VAL tutor config save --silent" even when KEY is already present in the user configuration file.
2019-03-18 21:19:03 +01:00
- [Feature] Load configuration parameters from the system environment
Simplify environment generation Environment is no longer generated separately for each target, but only once the configuration is saved. Note that the environment is automatically updated during re-configuration, based on a "version" file stored in the environment.
2019-03-18 17:26:37 +01:00
- [Improvement] Automatic environment re-generation after re-configuration
Handle command errors and ctrl+d commands in UI
2019-03-16 12:20:28 +01:00
- [Improvement] Error and interrupt handling in UI and web UI
Fix missing webui env directory
2019-03-10 18:02:20 +01:00
- [Bugfix] Fix missing webui env directory
v3.1.0 - [Improvement] Install python requirements in virtual env in docker image - [Bugfix] Add missing volume for theme development - [Improvement] Rename "config [non]interactive" command to "config save [--silent]" - [Improvement] More explicit logging during environment generation - [Improvement] Configurable docker images (#122) - [Bugfix] Fix "android pullimage" command - [Improvement] Do not upgrade images as part of quickstart - [Bugfix] Fix USERID setup in development mode and various dev-related docs (#177)
2019-03-09 17:53:34 +01:00
## 3.1.0 (2019-03-09)
Add `runserver stop` command
2019-02-13 17:25:17 +01:00
Install python requirements in venv in docker image Installing the requirements in a virtualenv is necessary to run "pip install ..." commands in development mode, when the USERID is != 0.
2019-03-09 17:51:25 +01:00
- [Improvement] Install python requirements in virtual env in docker image
Add missing volume for theme development The documentation instructions could not be working, as the theme folder was not being mounted in the dev container.
2019-03-09 15:39:33 +01:00
- [Bugfix] Add missing volume for theme development
Rename "config [non]interactive" command to "config save [--silent]"
2019-03-06 17:49:15 +01:00
- [Improvement] Rename "config [non]interactive" command to "config save [--silent]"
More explicit env generation logging
2019-03-06 17:59:55 +01:00
- [Improvement] More explicit logging during environment generation
Configurable docker images Docker images for each service can now be configured one by one. Close #122.
2019-03-06 17:21:47 +01:00
- [Improvement] Configurable docker images (#122)
Fix "android pullimage" command
2019-03-06 16:43:20 +01:00
- [Bugfix] Fix "android pullimage" command
- [Improvement] Do not upgrade images as part of quickstart
Fix USERID setting in development mode USERID environment variable was no longer passed to docker image in development mode. We take the opportunity to improve the documentation regarding the dev environment. Close #177.
2019-03-09 11:16:12 +01:00
- [Bugfix] Fix USERID setup in development mode and various dev-related docs (#177)
v3.0.6 - [Bugfix] Fix import/export of demo course (#175)
2019-02-26 20:54:22 +01:00
## 3.0.6 (2019-02-26)
- [Bugfix] Fix import/export of demo course (#175)
v3.0.5 - [Feature] Add cloud deployment script - [Improvement] Run `images pull` command - [Improvement] Run `indexcourses` on importing demo course - [Improvement] Add `runserver stop` command
2019-02-14 08:39:11 +01:00
## 3.0.5 (2019-02-14)
Make tutor ready for the AWS cloud
2019-02-13 23:44:42 +01:00
- [Feature] Add cloud deployment script
- [Improvement] Run `images pull` command
- [Improvement] Run `indexcourses` on importing demo course
- [Improvement] Add `runserver stop` command
Add `runserver stop` command
2019-02-13 17:25:17 +01:00
v3.0.4 - [Minor] Minimum required `click` version is 7.0 (#171) - [Bugfix] Fix `runserver` dev command (#172) - [Minor] Fix non-https link to documentation in pypi - [Minor] Fix `createuser` documentation
2019-02-13 17:15:18 +01:00
## 3.0.4 (2019-02-13)
Fix http link to docs in pypi
2019-02-12 17:43:01 +01:00
Minimum required click version is 7.0 Close #171
2019-02-13 17:14:10 +01:00
- [Minor] Minimum required `click` version is 7.0 (#171)
Fix `runserver` dev command Close #172
2019-02-13 17:09:07 +01:00
- [Bugfix] Fix `runserver` dev command (#172)
Fix http link to docs in pypi
2019-02-12 17:43:01 +01:00
- [Minor] Fix non-https link to documentation in pypi
- [Minor] Fix `createuser` documentation
v3.0.3 - [Bugfix] Add missing template data to pypi package - [Bugfix] Fix quickstart on Kubernetes (#164) - [Improvement] Add datatases task to Kubernetes quickstart (#167)
2019-02-12 09:21:31 +01:00
## 3.0.3 (2019-02-12)
Fix missing templates in pypi install Close #165.
2019-02-12 09:09:44 +01:00
- [Bugfix] Add missing template data to pypi package
Fix k8s quickstart Close #164
2019-02-12 09:11:38 +01:00
- [Bugfix] Fix quickstart on Kubernetes (#164)
Run databases task on k8s quickstart Close #167
2019-02-12 09:17:18 +01:00
- [Improvement] Add datatases task to Kubernetes quickstart (#167)
Fix missing templates in pypi install Close #165.
2019-02-12 09:09:44 +01:00
v3.0.2 - [Bugfix] Fix import paths -- 🚀 thanks @silviot! - [Improvement] Properly set docker project name in mysql logs -- 🦊 thanks again @silviot!
2019-02-12 08:36:22 +01:00
## 3.0.2 (2019-02-12)
Fix settings import paths
2019-02-12 08:26:50 +01:00
- [Bugfix] Fix import paths -- 🚀 thanks @silviot!
v3.0.2 - [Bugfix] Fix import paths -- 🚀 thanks @silviot! - [Improvement] Properly set docker project name in mysql logs -- 🦊 thanks again @silviot!
2019-02-12 08:36:22 +01:00
- [Bugfix] Properly set docker project name in mysql logs -- 🦊 thanks again @silviot!
Fix settings import paths
2019-02-12 08:26:50 +01:00
v3.0.2 - [Bugfix] Fix import paths -- 🚀 thanks @silviot! - [Improvement] Properly set docker project name in mysql logs -- 🦊 thanks again @silviot!
2019-02-12 08:36:22 +01:00
## 3.0.1 (2019-02-11)
Better CI
2019-02-10 21:02:30 +01:00
Replace `databases` command by `init`. Since initialisation does not only refer to database migrations, it makes more sense to rename this command.
2019-06-05 19:28:06 +02:00
- [Bugfix] fix mysql initialisation (#159, #160)
Better CI
2019-02-10 21:02:30 +01:00
- [Improvement] Better handling of continuous integration
- [Bugfix] fix `tutor --version` (#156)
- [Improvement] Absolute settings imports -- 📯 thanks @tonytan4ever!
v3.0.2 - [Bugfix] Fix import paths -- 🚀 thanks @silviot! - [Improvement] Properly set docker project name in mysql logs -- 🦊 thanks again @silviot!
2019-02-12 08:36:22 +01:00
## 3.0.0 (2019-02-09)
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 21:25:04 +01:00
- [Improvement] Complete rewrite of Tutor: switch from a make-based project to a single binary which runs all commands.
- [Feature] An web user interface can be created with `tutor webui start`
- [Bugfix] Add missing elasticsearch to Kubernetes deployment (#147)
- [Improvement] Upload `tutor-openedx` to pypi
## Older changes
Fix download of user-uploaded media Nginx volumes for downloading user-uploaded files has been accidentally removed at some point. Close #139
2019-01-26 15:51:00 -03:00
- 2019-01-27 [Bugfix] Fix video transcript/srt upload and download of user-uploaded files. Thanks @dannielariola!
Make it easy for users to override production settings Close #131.
2019-01-20 09:23:43 +01:00
- 2019-01-20 [Improvement] Make it easy to load custom settings for the local production install
Upgrade to Ironwood Here, we upgrade all images from Ironwood to Hawthorn, except for the locales, which we did not generate yet.
2019-01-19 15:42:39 +01:00
- 2019-01-19 [Improvement] Upgrade to Ironwood
Switch license to AGPL
2019-01-16 17:22:53 +01:00
- 2019-01-16 [Improvement] Switch license from MIT to AGPL
Fix xqueue consumer command This should address issue #109.
2019-01-04 10:21:16 +01:00
- 2019-01-04 [Bugfix] Fix xqueue consumer command
Upgrade node to 5.5.1 in openedx image
2018-12-26 00:08:06 +01:00
- 2018-12-26 [Improvement] Upgrade nodejs to 5.5.1
Package static assets inside the openedx image This allows us to deploy much faster: all we have to do is to copy the assets from the container to the shared volume. We also changed the way themes are managed: similarly to static assets, they are now packaged inside the docker image.
2018-12-07 19:30:30 +01:00
- 2018-12-07 [Improvement] Bundle theme and production static assets in the openedx docker image
Migrate github repo to overhangio organization
2019-06-23 19:56:15 +02:00
- 2018-12-02 [Feature] Download extra locales from [openedx-i18n](https://github.com/openedx/openedx-i18n/) to the Open edX Docker image
Easily change openedx docker image Just add the OPENEDX_DOCKER_IMAGE variable to the .env file.
2018-11-28 20:18:10 +01:00
- 2018-11-28 [Feature] Easily change openedx docker image
Enable customized themes This makes assets collection faster because we no longer compile assets from the themes bundled with edx-platform. Close #88
2018-11-28 19:57:17 +01:00
- 2018-11-28 [Feature] Enable comprehensive theming!
Get rid of datadog
2018-11-28 19:22:25 +01:00
- 2018-11-28 [Improvement] Get rid of datadog
Upgrade docker images to ubuntu 18.04 All images (except the openedx image, which requires ubuntu 16.04) are upgraded.
2018-11-28 19:00:48 +01:00
- 2018-11-28 [Improvement] Upgrade docker images to ubuntu 18.04 for android, forum, notes, xqueue
Interactively change default platform language
2018-11-28 18:27:52 +01:00
- 2018-11-28 [Feature] Make it possible to define default platform language interactively
Document how to run forked edx-platform
2018-11-26 12:07:58 +01:00
- 2018-11-26 [Improvement] Make it easier to run a forked version of edx-platform
Local filesystem storage for ORA2 uploads By default, open response assessment files are sent to S3. Here, we store uploaded files with the "filesystem" backend instead. To do so, we must install a forked version of ora2 that fixes a couple issues. Note that the "django" backend is not very usable, as file extensions are lost on upload. Close #97
2018-11-20 11:24:52 +01:00
- 2018-11-25 [Feature] Use local filesystem for open assessment file upload
Accelerate container bootstrapping We don't need to run "chmod" on openedx files outside of development mode. So, there is no need to set the USERID environment variable in most cases. This should considerably accelerate pretty much all commands that involve the openedx container. For discussion consult PR #98.
2018-11-23 13:44:47 +01:00
- 2018-11-23 [Improvement] Faster container bootstrapping without "chmod", as suggested by @silviot
Remove persistent data in openedx containers VOLUME statements in a container make the data persist in this folder. There is no need to do so, so we just remove the statements.
2018-11-20 16:47:08 +01:00
- 2018-11-20 [Bugfix] Fix cross-platform theme assets generation
More simple nginx port mapping Added the possibility to easily change the ports that nginx listens to. This is useful, for instance when Apache or Nginx already runs on the host. With this change, it is no longer necessary to edit the docker-compose file to modify these ports. To deploy with alternate ports, add a `.env` file with the following contents: ``` OPENEDX_NGINX_PORT=8080 OPENEDX_NGINX_TLSPORT=8443 ```
2018-11-13 08:48:33 -08:00
- 2018-11-17 [Improvement] Custom nginx port mapping. :crossed_swords: @frob @frohro
Add "restart-openedx" make command Close #91
2018-11-13 11:27:00 -08:00
- 2018-11-17 [Improvement] Add "make restart-openedx" command. :+1: @frob
- 2018-11-13 [Improvement] Facilitate install of extra XBlocks. Thanks @frob!
Make sure rabbitmq restarts on failures Rabbitmq was not configured to restart on failures. It does not explain why rabbitmq crashes (with exit code 255, see issue #80), but this should be sufficient as a quick fix.
2018-10-30 09:33:11 +01:00
- 2018-10-30 [Bugfix] Fix rabbitmq restart policy
Accelerate Android app build App building is accelerated by pre-installing packages in docker image.
2018-10-03 15:44:02 +02:00
- 2018-10-03 [Improvement/Bugfix] Fix and accelerate Android application build
Upgrade to hawthorn.2
2018-10-02 08:36:29 +02:00
- 2018-10-02 [Improvement] Bump Open edX version to hawthorn.2
Fix broken celery tasks in CMS Duplicate "environment" statement in the docker-compose.yml was causing the first one to be forgotten. Hence, the cms celery worker was running with LMS settings. Close #72
2018-09-30 19:17:22 +02:00
- 2018-09-30 [Bugfix] Fix CMS celery worker, including export tasks
Make feature flags interactive Feature flags are now asked to the user interactively, as part of the configuration step. This makes defining feature flags much more simple.
2018-09-30 14:27:24 +02:00
- 2018-09-30 [Improvement] Simplify boolean feature flags definition
Add logging commands
2018-09-29 18:01:08 +02:00
- 2018-09-29 [Improvement] Add logging commands
Add a self-documenting Make help Picked from https://github.com/openfun/fun-platform, which itself picked it from https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html Running `make help` or simply `make` now produces a beautiful colored help.
2018-09-29 17:08:39 +02:00
- 2018-09-29 [Improvement] Add self-documented help with "make help"
Add portainer as an optional feature
2018-09-29 15:09:19 +02:00
- 2018-09-29 [Feature] Add [Portainer](https://portainer.io) as an optional web UI to administer docker containers
Add optional Student Notes service With notes, students can annotate sections of the courseware.
2018-09-15 15:19:57 +02:00
- 2018-09-15 [Feature] Add student notes as an optional feature
Simplify configurator Template files are now directly loaded in the configurator container, so that it is possible to run the configurator container directly, outside of this project.
2018-09-15 16:19:35 +02:00
- 2018-09-15 [Feature] Add templates to configurator container, which can now be run separately
Rename up & daemon make commands The new commands are "run" and "daemonize". Older commands are preserved, although they are undocumented.
2018-09-15 12:20:35 +02:00
- 2018-09-15 [Improvement] Rename "up" and "daemon" commands to "run" and "daemonize"
Add Changelog
2018-09-15 12:14:55 +02:00
- 2018-09-15 [Feature] Activate course search and discovery
- 2018-09-15 [Bugfix] Deduplicate console logs from lms/cms
- 2018-09-05 [Improvement] Use a single email address for all inbound email
- 2018-09-04 [Bugfix] Get make commands to work with 'sudo'
- 2018-09-02 [Bugfix] Get HTTPS to work for CMS. Thanks @flytreeleft!
- 2018-08-28 [Bugfix] Fix certbot image updating
- 2018-08-27 [Improvement] Add development requirements to openedx image
- 2018-08-27 [Bugfix] Upgrade mongodb
- 2018-08-19 [Improvement] Make Xqueue an optional feature
- 2018-08-16 [Feature] Add HTTPS support
Copy Permalink