Skip to content

docs: add OEP-45/decision-0003#807

Open
gabor-boros wants to merge 5 commits into
masterfrom
gabor/oep45-decision0003
Open

docs: add OEP-45/decision-0003#807
gabor-boros wants to merge 5 commits into
masterfrom
gabor/oep45-decision0003

Conversation

@gabor-boros

Copy link
Copy Markdown

This PR updates OEP-45 and adds a new, decision 0003 to give recommendation on large Open edX deployments.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jul 10, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @gabor-boros!

This repository is currently maintained by @sarina.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jul 13, 2026
gabor-boros and others added 5 commits July 20, 2026 12:36
Signed-off-by: Gabor Boros <gabor@opencraft.com>
Signed-off-by: Gabor Boros <gabor@opencraft.com>
Signed-off-by: Gabor Boros <gabor@opencraft.com>
Co-authored-by: Braden MacDonald <mail@bradenm.com>
Signed-off-by: Gabor Boros <gabor@opencraft.com>
@gabor-boros
gabor-boros force-pushed the gabor/oep45-decision0003 branch from d4a461f to 34c0297 Compare July 20, 2026 08:43
Decision
********

We recommend that all large Open edX deployments use the community-maintained Terraform modules and Helm chart described in decision 0002, existing solutions in the Open edX ecosystem (`GitHub Actions`_), provider-maintained open-source tooling (`Drydock`_ and `Picasso`_), and cloud-native, provider-agnostic deployment tools (`ArgoCD`_, and `Argo Workflows`_). We encourage providers to share any additional deployment code/tooling they use as open source repos or templates that other providers can use as a reference. If any particular template such as OpenCraft's `Launchpad`_ becomes adopted by multiple providers, it should be considered for adoption as a community standard, and this OEP should be updated to recommend its use.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In decision 2, the framing is:

For , the community maintains , and will make it compatible with

For Open edX operators who wish to deploy Open edX on Kubernetes, community-maintained Terraform modules and Helm Charts will be used to simplify the process of provisioning a Kubernetes cluster capable of loading one or more Open edX instances.

Building on top of the decision 0001, individual instances will be configured by Tutor and the Tutor plugin ecosystem

I like that framing better than to offer a straight up recommendation. Part of the appeal of OpenedX is the chameleon approach.

How do you feel about using something like:

A coalition of commercial providers maintains the Terraform modules and Helm chart described in decision 0002, as well as a growing ecosystem of open-source deployment tools. For operators deploying Open edX on Kubernetes, these resources (Drydock, Picasso, ArgoCD, Argo Workflows and GitHub Actions) provide flexible reference architectures.
We recognize that Open edX deployments vary widely in scale and infrastructure. Operators are free to blend these community tools with their own existing stack, and we encourage providers to share new deployment code, modules, or templates with the community.

Because Open edX intentionally supports diverse infrastructure needs, none of these tools are mandatory. Instead, the community focuses its efforts on ensuring these reference implementations and provider templates like OpenCraft's Launchpad, are maintained well enough to serve as reliable blueprints.


Consequences
************

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add an introductory session, that explains these consequences and recommendations apply to those that decide to take the joint path of harmony+tools(argo, drydock,...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

5 participants