Skip to content

CHANGELOG.md

Latest commit

 

History

History
916 lines (516 loc) · 27.6 KB

CHANGELOG.md

File metadata and controls

916 lines (516 loc) · 27.6 KB

CHANGELOG

Unreleased

See the fragment files in the changelog.d/ directory.

21.2.1 — 2026-05-28

Fixed

  • Properly mirror the LMS caddy block in the default catch-all block used by DRYDOCK_ENABLE_MULTITENANCY.

  • Avoid retriggering the CONFIG_LOADED action multiple times when redering the jobs templates.

21.2.0 — 2026-04-24

Changed

  • The prefix ingress- was removed from the ingress objects names. The suffix -tls was also removed from additional ingresses defined via DRYDOCK_INGRESS_EXTRA_HOSTS.

Warning

This rename will cause errors with the Ingress NGINX validation webhook due to two different ingress objects registering the same routes.

The old ingress objects must be deleted before applying the new changes. Either perform a manual delete or set DRYDOCK_INGRESS to false to delete all ingress objects in the next apply.

21.1.0 — 2026-04-17

Added

  • The new DRYDOCK_INGRESS_CLASS allows to configure the ingress class used by the Ingress and Issuers objects.

Removed

  • All support for debug pods via Ingress NGINX canary annotations has been removed. Users of this feature must re-implement it.

  • Several features that rely on specific ingress-nginx functionality have been removed:

    • The NGINX static cache ingress resources and related plugin settings.
    • The bypass Caddy configuration used to route traffic directly from the ingress-controller avoiding extra latency.

21.0.0 — 2026-01-28

Added

  • Support for the Ulmo release

20.2.0 — 2026-01-27

Fixed

  • Ensure that the utf8mb4 charset is used when connecting to MySQL.
  • Do not proxy SCORM assets directly through the LMS. This restores the previous behaviour for versions prior to v19.0.3 of openedx-scorm-xblock.

20.1.1 — 2025-12-04

Fixed

  • Adjust the drop-db command to properly handle replica set configuration if available. Remove the Notes user if the Notes plugin is enabled.
  • Avoid erroring when calling iter_mfes if the MFE plugin is not enabled. Useful for testing with the minimal dependencies.

v20.1.0 (2025-11-10)

Features

  • Add the ability to exclude init jobs

v20.0.0 (2025-07-02)

Features

  • Add support for the Teak release

v19.2.0 (2025-04-15)

Features

v19.1.0 (2025-04-14)

Features

  • Create patch for registry credentials (#154, e6d8948)

  • feat: create patch for registry credentials

  • feat: include json transform

  • feat: change secret render

  • fix: correct files

  • docs: update readmd

  • fix: include extra workloads

  • fix: change patch for cronjob and remove kind

  • docs: update readme.md

Co-authored-by: Moisés González moises.gonzalez@edunext.co

  • fix: remove deamonset and statefulsets

v19.0.1 (2025-01-31)

Bug Fixes

  • Configure custom forum DBs credentials (#153, 68b06f5)

The tutor-forum plugin hardcodes the value of the name of the forum database in the Django settings, dropping the previous FORUM_MONGODB_DATABASE setting (https://github.com/overhangio/tutor-forum/blob/5d3d2dd7d1ea3c9a311ac5619eb5931a111ba363/tutorforum/plugin.py#L29).

We reintroduce the FORUM_MONGODB_DATABASE setting and ensure the mongodb user has permissions over the Forum Database.

In order to be able to override the hardcoded value we lower the priority level of the Drydock patches, guaranteeing that they are going to be applied after all the installed plugins.

v19.0.0 (2024-12-18)

Features

Empty commit to trigger a major version bump

v18.2.8 (2024-10-16)

Bug Fixes

  • Adding replicaset info to mongosh connection command. Adding mongodb port variable (#145, 8855736)

  • Include the MongoDB port in the mongosh command (useful when running MongoDB in a different port)

    • Include the replica set info in the mongosh command. It could be the case you aren't connected to a replica set primary but to a secondary one. If the replica set name is not specified, the mongosh command will fail since it is not possible to write to a secondary

v18.2.7 (2024-10-15)

Bug Fixes

  • newrelic: Use the new location of uwsgi.ini in the launch command (#144, 67fb1fc)

The location of the uwsgi.ini file was changed in tutor==18.1.3 so we have to update the command run by the container. Additionally we remove an unused variable that was lingering.

v18.2.6 (2024-09-24)

Bug Fixes

  • scorm: Use request host for scorm custom domain (#141, 55a5153)

v18.2.5 (2024-09-19)

Bug Fixes

v18.2.4 (2024-09-11)

Bug Fixes

  • fix: add readiness probe for lms/cms

  • fix: add affinity to spread lms/cms to multiple nodes

  • chore: remove readiness probe

  • fix: reduce startup probe period seconds

  • fix: gracefully kill uwsgi workers

  • fix: disable local file loggers

  • fix: disable logging

  • fix: reduce max unavailable to 0

  • fix: add liveness probe for cms and lms

  • fix: fail early on tracking logger removal

  • chore: remove rolling update options

  • fix: restore preStop hook

  • fix: use right host for cms livenessProbe

  • fix: use lms/cms host only

  • chore: restore prestopHook

v18.2.3 (2024-08-13)

Bug Fixes

v18.2.2 (2024-08-12)

Bug Fixes

  • Add uwsgi tweaks for closed connection (#126, a8cbf65)

fix: add readiness probe for lms

chore: remove startup probe and increase timeout of readiness probe

chore: restore startup probe

v18.2.1 (2024-08-06)

Bug Fixes

v18.2.0 (2024-07-15)

Features

  • Add aspects deployments to post init deployments (#123, 762c356)

v18.1.1 (2024-07-05)

Bug Fixes

  • S3_host for alternative S3-compatible services (#120, 08d2ef3)
  • fix: when using SCORM, S3_HOST must be used for alternative S3-compatible services

v18.1.0 (2024-07-02)

Bug Fixes

  • Remove unnecesary annotations from the hpa sync wave (#117, 18c99e3)

The HPA sync-wave patch includes annotations to indicate argocd in which order should the HPA resources be applied in relation to the other resources. The argocd.argoproj.io/hook: Sync and argocd.argoproj.io/hook-delete-policy: HookSucceeded annotations are used for ephemeral resources (like jobs) and should not be used for the HPA resources.

Features

fix: address PR suggestions

build: correct port and path for mfe tests

v18.0.0 (2024-07-02)

Features

BREAKING CHANGE: version 18

Breaking Changes

  • Version 18

v17.3.5 (2024-06-12)

Bug Fixes

  • Replace deprecated bucket argument for recommended bucket_name (#107, f21d338)

The S3Boto3Storage backend no longer accepts the argument bucket. Use bucket_name or the setting AWS_STORAGE_BUCKET_NAME instead: jschneier/django-storages#636

v17.3.4 (2024-05-27)

Bug Fixes

  • fix: solve error check k8s workflow

  • fix: define specific kubeconform version and include action on push

  • fix: extract and set kubernetes version from kubectl

v17.3.3 (2024-05-22)

v17.3.2 (2024-04-26)

Bug Fixes

  • Verify minio host is defined on scorm proxy (#96, 503ab92)

  • fix: verify minio host is defined on scorm proxy

  • chore: refactor scorm template

v17.3.1 (2024-04-26)

Bug Fixes

  • Enable scorm proxy if s3 plugin is installed (#92, c1ee060)

docs: add documentation for ingress lm extra hosts

v17.3.0 (2024-04-18)

Bug Fixes

  • Run the jobs scripts with '-e' to exit on error (#74, cb8bcb2)

Features

v17.2.0 (2024-02-27)

Features

  • Iterate over added mfes to add its paths (#72, d61991b)

v17.1.1 (2024-02-23)

Bug Fixes

  • Notes annotations throw job skip from argocd sync (#69, d965aa7)

v17.1.0 (2024-01-30)

Features

  • feat: add poddisruptionbudget patches

  • test: update pdb

  • test: include pdbs in patches

  • test: using kustomization

  • test: include in resources

  • fix: include conditional for mfe and forum

  • fix: correct endlines

  • feat: pdb value parametrizable

  • fix: delete undefined variable

  • fix: drydock variable names

  • fix: change comparison operator and pdb path

v17.0.0 (2024-01-19)

Features

BREAKING CHANGE: Support to tutor v17

Breaking Changes

  • Support to tutor v17

v16.2.2 (2024-01-18)

Bug Fixes

v16.2.1 (2024-01-18)

Bug Fixes

  • Add missing drydock custom certs secret (#64, 7812911)

(cherry picked from commit ed8b57a0600913ea77de02bd995f6adc134f1446)

v16.2.0 (2024-01-17)

Features

  • Add mysql init job patch and fix command on mongo init job (#63, d838e22)

v16.1.0 (2024-01-10)

Features

  • Add a job to initialize mongodb users (#60, c19ae63)

Include an initialization job similar to the MySQL one that creates a mongodb user with the necessary permissions. To simplify things a bit we use the same user for edxapp and forum and remove the need for the forum-overrides patch.

v16.0.1 (2024-01-09)

Bug Fixes

  • Add manifests file to allow install drydock non editable (#59, b150a41)

v16.0.0 (2023-12-19)

Features

BREAKING CHANGE: Drops support to python 3.7

Breaking Changes

  • Drops support to python 3.7

v15.5.1 (2023-12-18)

Bug Fixes

  • Issue at first run with lms and cms deployments (#56, e1b5636)

  • Remove pat from release workflow (#55, acb59ad)

v15.5.0 (2023-11-29)

Features

  • Support docker operations for image in drydock backups (#53, 07d0371)

  • feat: support docker operations for image in drydock backups

  • fix: update image variable in defaults and jobs template

  • fix: update .gitignore

  • fix: using BACKUP_VARIABLE

  • fix: update readme

  • fix: update gitignore for /build/ folder

v15.4.0 (2023-11-23)

Features

  • Mongo DB backups proper implementation (#52, 16d27ea)

  • fix: update variables names and jumplines

  • fix: duplicate key

  • fix: include custom_storage_endpoint in aws block

  • fix: newlines control

  • fix: args for command

  • fix: environment azure variables

  • fix: include bucket path in all options

  • fix: delete databases variable

  • fix: update .sh

  • fix: update default shipyard-utils image

v15.3.0 (2023-11-16)

Features

  • feat: install azcopy

  • feat: add new variables and conditionals for storage services

  • fix: include custom storage endpoint inside s3 conditional

  • feat: add variables and azcopy command

  • fix: update variable names

  • fix: storage system names

  • fix: default s3 value

  • fix: error in readme

  • update backup system variable name

  • fix: azure-blob conditional

v15.2.0 (2023-11-07)

Features

  • Split ingress per host, add patch to add lms extra hosts (#50, 0401123)

v15.1.0 (2023-11-01)

Bug Fixes

  • Removing inexistent folder from github actions release flow (81f3a06)

  • Using Github PAT to bypass main branch protection (ad40e6a)

Features

  • Replacing Kustomize JSON patches with strategic merge patches. (65a4b70)

v15.0.0 (2023-10-09)

Features

v0.7.3 (2023-08-08)

Bug Fixes

  • Set the correct path to use pvc volume (#45, 6f9189c)

v0.7.2 (2023-07-14)

Bug Fixes

  • Conditional error when tutor version is up to 15.0.0 (#44, 8360e3f)

v0.7.1 (2023-07-10)

Bug Fixes

  • Drydock fails in older versions to tutor palm (#43, c3c5e0a)

v0.7.0 (2023-07-07)

Features

v0.6.1 (2023-05-12)

Bug Fixes

  • Mysqldump faild due mysql version (#41, 62d0839)

v0.6.0 (2023-04-05)

Features

Co-authored-by: Cristhian Garcia cristhian.garcia@edunext.co

Co-authored-by: Jhony Avella jhony.avella@edunext.co

v0.5.1 (2023-03-20)

Bug Fixes

  • Rendering NewRelic overrides properly in tutor14 Drydock templates (#38, 423bac3)

v0.5.0 (2023-02-28)

Bug Fixes

  • Cms_sso_user, cms debug pods and whitespace triming (#37, fb36c65)

  • fix: standarize whitespace triming

  • fix: define DJANGO_SETTINGS_MODULE for the cms debug pods

  • fix: use the DRYDOCK_CMS_SSO_USER variable on the init jobs

Features

  • Add templates with tutor15 support. (#35, 1e85e46)

  • update forum job according to the k8s-jobs patch from tutor-forum. - use simplified hooks API introduced in tutor V15.3.0. - fix getting incompatible yaml files. - use DRYDOCK_CMS_SSO_USER variable instead of hard coded value.

v0.4.1 (2022-12-07)

Features

  • Add configuration for container interactivity (#29, fbc4489)

v0.4.0 (2022-12-01)

Bug Fixes

  • Add missing patch in V14 templates (#27, bda221b)

  • Use the right target for the forum hpa (#26, 49df7d4)

Features

  • Add templates for debugging purposes (#25, 2cc049d)

This PR adds k8s templates for debug pods, i.e pods running with non-production setup (root user, container entrypoint/command changed, ...), which allow developers to debug services like LMS/CMS in a production-like environment.

v0.3.4 (2022-11-09)

Features

  • Adding patch to enable multipurpose jobs in an OpenedX installation V14 (#23, 75e35a1)

v0.3.3 (2022-11-09)

Features

  • Adding patch to enable multipurpose jobs in an OpenedX installation (#22, 44d336d)

v0.3.2 (2022-11-01)

Bug Fixes

  • Add missing labels for notes jobs (#21, 0428575)

v0.3.1 (2022-10-21)

Features

  • Refactor hpa with latest practices (#19, 3009617)

v0.3.0 (2022-10-18)

Features

  • Add templates with tutor14 support (#18, cc392bb)

  • Make manifests template root configurable through reference (#17, 0382752)

v0.2.0 (2022-10-13)

Bug Fixes

  • Go back to production ingress (#11, 3be0bd2)

  • Use the correct init command for forum and add missing annotations (#12, 9306d54)

Features

This PR adds a list of jobs for the most used services. This list can be configured using a variable defined in the config.yml with optional services such as minio or forum; required services like LMS are not removable. We configured this behavior using waves from argoCD.

  • Add extra-jobs for extra tasks during initialization (#14, bdfa07b)

  • Add toggleable certificates (#13, c021df9)

  • Removing MySQL jobs when MySQL running outside the cluster (#15, fca2272)

  • feat: removing MySQL jobs when MySQL service is running outside the cluster

  • feat: adding labels to drydock jobs to better identify those from MySQL we want to skip

  • Starting Forum pod in wave 4 to prevent issues before running the Forum job. (#16, 33d8c4a)

Starting HPA resources in wave 5 to make sure deployments already exist

v0.1.0 (2022-08-16)

Bug Fixes

  • Setting a default value for DRYDOCK_NEWRELIC_CONFIG variable (a67dbf1)

Features

  • Add a basic manifest repository implementation (#1, 1f8208b)

The BaseManfests builder will render a standard Tutor environment based on the templates used in version 13.3.1 of Tutor and use it as a base of Kustomization application with additional resources as overlays.

The TutorExtendedConfig will return the Tutor configuration values of the current TUTOR_ROOT and will use the default values of the template set (defined in a file defaults.yml) as a fallback.

  • Add kustomize based extensions to the base manifests (#3, 2b93163)

  • Add newrelic manifests for tutor13 installation (#6, 8990e08)

  • Add support for custom certificates (809ae3e)

  • Adding a better explanation at the readme (95d1490)

  • Adding readme (86f1c66)

  • Cleaning the manifest output a bit (aa19367)

  • Connecting with tutor (76dec19)

  • Laying the groundwork for the architecture (bd6129c)

  • Making all the classes be defined by the reference file (138307a)

  • Making reference support options (7b69f2c)

  • Making tutor_v13 volume sizes configurable (6bbebca)

  • Moving the tutor renderer to the actual implementing class (e2a6119)

  • Render global environment for prometheus outside tutor-env (#5, f114243)

  • Stating the purpose and context for this project (2ba3280)