k8s_deploy_tasks plugin for `Tutor <https://docs.tutor.overhang.io>`__
===================================================================================
tutor plugin to manage deployment tasks that are exclusively (or mostly) specific to Kubernetes deployments.
- *oauth misconfiguration*. tutor relies on an environment variable `ENABLE_HTTPS` to determine the protocol of the production oauth client for applications that rely on the LMS oauth service. For Kubernetes installations however, this value needs to be set to `false` which results in ./manage.py lms create_dot_application misconfiguring the oauth client for some, but not all, of these oauth clients. This plugin reconfigures the oauth clients of cms, discovery, ecommerce and credentials to use `https` protocol for redirect URI.
- *Nutmeg upgrade and initializataion tasks* There are a few manage.py tasks that need to run for platforms that are upgrading to Nutmeg or newer from Maple or older. This plugin runs those tasks for you. For more information see `Open edX Nutmeg Release <https://edx.readthedocs.io/projects/open-edx-release-notes/en/latest/nutmeg.html>`_
- *Missing user profile records*. User accounts created with manage.py lack a corresponding auth_userprofile record, which causes a 500 exception during login for that account. Adds a blank record in cases where a record is missing.
- *MFE misconfiguration*. tutor-mfe relies on the value of ENABLE_HTTPS when generating the dict MFE_CONFIG, which in the case of k8s deployments will result in the browser blocking content due to "Mixed content". This plugin overrides the results of tutor-mfe openedx-lms-production-settings, replacing protocol produced by logic relying on ENABLE_HTTPS (assumed to result in 'http') with the hard-coded value 'https'.
- *Xblock storage configuration*. creates this `custom storage configuration <./tutork8s_deploy_tasks/patches/openedx-common-settings>`_ designed to leverage this `custom kubernetes ExternalService <https://github.com/lpm0073/cookiecutter-openedx-devops/blob/main/%7B%7Bcookiecutter.github_repo_name%7D%7D/terraform/environments/modules/kubernetes_ingress_clb/manifests/proxy-service.yml.tpl>`_ and `ingress <https://github.com/lpm0073/cookiecutter-openedx-devops/blob/main/%7B%7Bcookiecutter.github_repo_name%7D%7D/terraform/environments/modules/kubernetes_ingress_clb/manifests/ingress-scorm-proxy-service.yml.tpl>`_ created by Cookiecutter for supporting AWS S3 storage for Xblocks.
Installation
------------
::
pip install tutor-contrib-k8s-deploy-tasks
Usage
-----
::
tutor plugins enable k8s_deploy_tasks
License
-------
This software is licensed under the terms of the AGPLv3.
Raw data
{
"_id": null,
"home_page": "https://github.com/cookiecutter-openedx/tutor-contrib-k8s-deploy-tasks",
"name": "tutor-contrib-k8s-deploy-tasks",
"maintainer": "Lawrence McDaniel",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "lpm0073@gmail.com",
"keywords": null,
"author": "Lawrence McDaniel",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fd/4e/7bc9b1a0f2d91f547b8715e13afddaa61498f19c6d9e578514183cfd93b6/tutor_contrib_k8s_deploy_tasks-18.0.2.tar.gz",
"platform": null,
"description": "k8s_deploy_tasks plugin for `Tutor <https://docs.tutor.overhang.io>`__\n===================================================================================\n\ntutor plugin to manage deployment tasks that are exclusively (or mostly) specific to Kubernetes deployments.\n\n\n- *oauth misconfiguration*. tutor relies on an environment variable `ENABLE_HTTPS` to determine the protocol of the production oauth client for applications that rely on the LMS oauth service. For Kubernetes installations however, this value needs to be set to `false` which results in ./manage.py lms create_dot_application misconfiguring the oauth client for some, but not all, of these oauth clients. This plugin reconfigures the oauth clients of cms, discovery, ecommerce and credentials to use `https` protocol for redirect URI.\n- *Nutmeg upgrade and initializataion tasks* There are a few manage.py tasks that need to run for platforms that are upgrading to Nutmeg or newer from Maple or older. This plugin runs those tasks for you. For more information see `Open edX Nutmeg Release <https://edx.readthedocs.io/projects/open-edx-release-notes/en/latest/nutmeg.html>`_\n- *Missing user profile records*. User accounts created with manage.py lack a corresponding auth_userprofile record, which causes a 500 exception during login for that account. Adds a blank record in cases where a record is missing.\n- *MFE misconfiguration*. tutor-mfe relies on the value of ENABLE_HTTPS when generating the dict MFE_CONFIG, which in the case of k8s deployments will result in the browser blocking content due to \"Mixed content\". This plugin overrides the results of tutor-mfe openedx-lms-production-settings, replacing protocol produced by logic relying on ENABLE_HTTPS (assumed to result in 'http') with the hard-coded value 'https'.\n- *Xblock storage configuration*. creates this `custom storage configuration <./tutork8s_deploy_tasks/patches/openedx-common-settings>`_ designed to leverage this `custom kubernetes ExternalService <https://github.com/lpm0073/cookiecutter-openedx-devops/blob/main/%7B%7Bcookiecutter.github_repo_name%7D%7D/terraform/environments/modules/kubernetes_ingress_clb/manifests/proxy-service.yml.tpl>`_ and `ingress <https://github.com/lpm0073/cookiecutter-openedx-devops/blob/main/%7B%7Bcookiecutter.github_repo_name%7D%7D/terraform/environments/modules/kubernetes_ingress_clb/manifests/ingress-scorm-proxy-service.yml.tpl>`_ created by Cookiecutter for supporting AWS S3 storage for Xblocks.\n\nInstallation\n------------\n\n::\n\n pip install tutor-contrib-k8s-deploy-tasks\n\nUsage\n-----\n\n::\n\n tutor plugins enable k8s_deploy_tasks\n\n\nLicense\n-------\n\nThis software is licensed under the terms of the AGPLv3.\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "A Tutor plugin to manage deployment tasks that are exclusively (or mostly) specific to Kubernetes deployments",
"version": "18.0.2",
"project_urls": {
"Code": "https://github.com/cookiecutter-openedx/tutor-contrib-k8s-deploy-tasks",
"Community": "https://github.com/cookiecutter-openedx",
"Homepage": "https://github.com/cookiecutter-openedx/tutor-contrib-k8s-deploy-tasks",
"Issue tracker": "https://github.com/cookiecutter-openedx/tutor-contrib-k8s-deploy-tasks/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce893bd1d68305284cbae090deedf1fe1daf9d01e4bfe69abc939ca1779c067e",
"md5": "405dfcd5206a510b252f82a03d0bfd0a",
"sha256": "f8d3811ac3a72f7ec2008f4a679da6f2aec990637ac9f4e01ea28a16b7c27c19"
},
"downloads": -1,
"filename": "tutor_contrib_k8s_deploy_tasks-18.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "405dfcd5206a510b252f82a03d0bfd0a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 24486,
"upload_time": "2024-11-19T13:26:30",
"upload_time_iso_8601": "2024-11-19T13:26:30.788164Z",
"url": "https://files.pythonhosted.org/packages/ce/89/3bd1d68305284cbae090deedf1fe1daf9d01e4bfe69abc939ca1779c067e/tutor_contrib_k8s_deploy_tasks-18.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fd4e7bc9b1a0f2d91f547b8715e13afddaa61498f19c6d9e578514183cfd93b6",
"md5": "0c98020aea285147f7e0a0aaa15f7ea2",
"sha256": "812421555444339df6fc53435bac94ba765f7ec3b2f71fb21ec10e84010ff032"
},
"downloads": -1,
"filename": "tutor_contrib_k8s_deploy_tasks-18.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0c98020aea285147f7e0a0aaa15f7ea2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21611,
"upload_time": "2024-11-19T13:26:32",
"upload_time_iso_8601": "2024-11-19T13:26:32.059075Z",
"url": "https://files.pythonhosted.org/packages/fd/4e/7bc9b1a0f2d91f547b8715e13afddaa61498f19c6d9e578514183cfd93b6/tutor_contrib_k8s_deploy_tasks-18.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 13:26:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cookiecutter-openedx",
"github_project": "tutor-contrib-k8s-deploy-tasks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tutor-contrib-k8s-deploy-tasks"
}
JSON
