Skip to content
@cookiecutter-openedx

Cookiecutter Open edX

A community supported organization focused on providing reliable CI automation tools for Open edX™️ software deployed to Kubernetes with Tutor.

Welcome to Cookiecutter Open edX

discuss.openedx.org docs.tutor.overhang.io
Docker Kubernetes

Cookiecutter Open edX is a community maintained project for jumpstarting and managing production-ready installations of the Open edX:tm: online learning management system running at scale on Kubernetes cloud infrastructure.

How it works

Cookiecutter workflow

The cookiecutter project helps you to remain focused on the blue boxes by providing you with templated solutions for everything else.

To provide a consistent onboarding experience to new Cookiecutter users we also manage a few other repositories on which the automated build and deployment workflows depend. These include:

  • an Open edX Plugin that contains modifications that are needed when installing Open edX:tm: to Kubernetes.
  • a collection of tutor plugins that are needed when installing Open edX:tm: to Kubernetes.
  • a Github Action that automatically creates AWS Elastic Container Repositories for you if they're referenced in your workflow.
  • any repositories which we've forked on an interim basis in order to facilitate Kubernetes-specific customizations, the PR's of which are pending in their respective upstream repositories.

Additionally, we maintain the following repositories that include working code samples and best practices for customizing and extending the feature set of Open edX installations:

  • an example Open edX plugin that includes working, maintained code samples illustrating how to accomplish various programming and integration tasks.
  • an example Open edX custom theme that provides scaffolding to help you get started with cusomizing the appearance of your Open edX:tm: platform

And finally, if you use Wordpress as your marketing site then we also maintain the following projects:

Our commitment to the Open edX community

We want to make it easier and more economical for small educational institutions, non-profits and ed-tech companies to leverage Open edX:tm: software. A single technology enthusiast should be able to maintain an Open edX:tm: platform on a part-time basis. Typical platforms should incur less than $500 usd in monthly cloud infrastructure costs.

Our mission and philosophy

Online learners are accustomed to performant, reliable and safe user experiences across the Internet, and they expect the same from your platform. But infrastructure and systems management are complex, constantly evolving matters that are hard to do well, and they don't provide any meaningful differentation for your project. Compounding matters, installing and configuring Open edX:tm: software is notoriously complex; even more so if you need to run your platform at scale. Lastly, keeping packaged software and infrastructure properly maintained is hard work. Cloud infrastructure providers evolve and the back end services they offer undergo routine updates. Open edX:tm: releases new features. New security threats surface on a regular basis.

We believe that these are problems best solved by the Open edX community and that Cookiecutter Open edX's templated infrastructure-as-code strategy is the best way to facilitate this.

History

The Cookiecutter Open edX project was originally conceived in 2021 by project members working on the Government Communications eLearning project for the UK Cabinet Office which they generously open-sourced. The principal project maintainer is Lawrence McDaniel, a full stack developer and Open edX community blogger.

The Government Communications eLearning platform was one of the first Docker-based Open edX:tm: platforms to launch at scale on Kubernetes-based cloud infrastructure. The devops team from this project brought a wealth of knowledge about cloud infrastructure, Kubernetes, CI/CD and infrastructure-as-code. Their efforts led to a robust set of integrated Terraform modules and fully automated CI solutions for building and deploying Open edX:tm: to Kubernetes. Moreover, they codified their extensive knowledge of CI and Kuberenetes best practices, maximizing the potential of these evolving technologies. In early 2022 this codebase was refactored into a more generalized collection of Jinja templating tools now known as "Cookiecutter Open edX" that is more suitable for community use and provides easy onboarding. Since then, the scope and feature set of Cookiecutter Open edX has grown considerably.

Get involved

Contributors are welcome! Contact me here: lawrencemcdaniel.com if you're interested in becoming a contributor to this project.

Open edX Github Actions

Don't forget to take a look at our cousin organization Open edX Github Actions where we manage a collection of several dozen Github Actions components that are used to create our automated Build and Deploy workflows.

Pinned Loading

  1. cookiecutter-openedx-devops cookiecutter-openedx-devops Public

    Open edX Tutor on Kubernetes implemented with Terraform

    HCL 42 17

  2. openedx-plugin-example openedx-plugin-example Public

    Python-Django scaffolding for common use cases

    Python 15 7

  3. openedx-theme-example openedx-theme-example Public

    2 6

  4. tutor-contrib-k8s-deploy-tasks tutor-contrib-k8s-deploy-tasks Public

    tutor plugin to manage deployment tasks that are exclusively (or mostly) specific to Kubernetes deployments.

    Python 5

Repositories

Showing 10 of 13 repositories
  • cookiecutter-openedx-devops Public

    Open edX Tutor on Kubernetes implemented with Terraform

    cookiecutter-openedx/cookiecutter-openedx-devops’s past year of commit activity
    HCL 42 AGPL-3.0 17 3 0 Updated Dec 11, 2024
  • tutor-contrib-k8s-deploy-tasks Public

    tutor plugin to manage deployment tasks that are exclusively (or mostly) specific to Kubernetes deployments.

    cookiecutter-openedx/tutor-contrib-k8s-deploy-tasks’s past year of commit activity
    Python 0 AGPL-3.0 5 0 3 Updated Nov 19, 2024
  • aws-ecr-create Public

    Github Action to create an AWS Elastic Container Registry repository

    cookiecutter-openedx/aws-ecr-create’s past year of commit activity
    Shell 1 AGPL-3.0 0 0 1 Updated May 16, 2024
  • openedx-plugin-example Public

    Python-Django scaffolding for common use cases

    cookiecutter-openedx/openedx-plugin-example’s past year of commit activity
    Python 15 AGPL-3.0 7 1 0 Updated May 12, 2024
  • django-memberpress-client Public

    a Django plugin that implements a Wordpress memberpress REST API client

    cookiecutter-openedx/django-memberpress-client’s past year of commit activity
    Python 0 MIT 2 0 0 Updated Apr 26, 2024
  • edx-oauth2-wordpress-backend Public

    An OAuth backend for the WP OAuth Plugin installed in stepwisemath.ai

    cookiecutter-openedx/edx-oauth2-wordpress-backend’s past year of commit activity
    Python 1 MIT 1 1 0 Updated Feb 1, 2024
  • cookiecutter-openedx-plugin Public

    An open edx plugin that implements customizations for deployment to Kubernetes

    cookiecutter-openedx/cookiecutter-openedx-plugin’s past year of commit activity
    Python 2 AGPL-3.0 0 0 0 Updated Apr 28, 2023
  • .github Public
    cookiecutter-openedx/.github’s past year of commit activity
    0 0 0 0 Updated Apr 10, 2023
  • tutor-contrib-s3 Public Forked from hastexo/tutor-contrib-s3

    This is a beta Tutor plugin. Use with care.

    cookiecutter-openedx/tutor-contrib-s3’s past year of commit activity
    Python 0 AGPL-3.0 32 0 0 Updated Mar 24, 2023
  • edx-ora2 Public Forked from openedx/edx-ora2

    Open Response Assessment Suite

    cookiecutter-openedx/edx-ora2’s past year of commit activity
    Python 0 AGPL-3.0 199 0 0 Updated Mar 16, 2023

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…