DevOps Working Group

This is where the Open edX DevOps working group gathers to work on all matters related to the technical operations of an Open edX platform, both in development and in production.

The DevOps working group is an umbrella for multiple, more specific projects. See the full list below.

Useful links

• Communication:
  • The Open edX forum DevOps working group category, which is the primary communication channel for this working group. Members are encouraged to subscribe to the notifications for this category ("Watch first post").
  • We also use Slack for quick one-off Q&A: see the #wg-devops channel (if you're not already on the Open edX Slack get an invitation here). Slack is great for talking to individual people, but most in-depth conversations should happen on the forum or on repository tickets.
• Issue management: we use this project board
• General information and Confluence workspaces:
  • DevOps working group workspace (we try to use it as little as possible and keep most of the information in the forum or in this GitHub project)
  • List of all Open edX working groups

Projects

Build/Test/Release working group

• General information: Build/Test/Release workspace
• Communication: Build/Test/Release working group forum category and #wg-build-test-release Slack channel.
• Issue management: project board

Developer Experience working group

• General information: Developer Experience workspace
• Communication: Developer Experience working group forum category and #wg-developer-experience Slack channel.
• Issue management: Developer Experience working group

Large Instances working group

• General information: Large Instances workspace
• Communication: bi-weekly meeting, DevOps forum category, #wg-devops Slack channel.
• Issue management: Large Instances working group

This group leads the Harmony Kubernetes project, used to deploy Open edX via Helm & Tutor: https://github.com/openedx/openedx-k8s-harmony

Tutor

Tutor is the default community distribution to run Open edX, both as a development environment and a production platform, using either docker-compose or Kubernetes. The Tutor code base is split into Tutor core and the official plugins.

• Tutor core source code: https://github.com/overhangio/tutor/
• Documentation
• Project board
• Tutor-related questions are tagged with "tutor" on the forum: https://discuss.openedx.org/tag/tutor
• Become a Tutor maintainer

Contributing

How to join the working group?

We're glad you want to help :) Working group membership is fluid, which means that if you help the group then you are considered a member. All members are strongly encouraged to join the conversation (see the links above). You can reply to an existing topic or write a new topic where you introduce yourself and describe how you would like to help. Welcome!

How to report an issue?

Would you like to report a devops-related issue? First, check whether the issue was already reported elsewhere:

• Search the Open edX forum.
• Search the existing issues in this project and the relevant child projects (see links above).

If your issue was already reported, feel free to join the conversation! If your issue is new, then you are strongly encouraged to discuss it in the forum first. You should strive to describe your issue as thoroughly as possible:

• Nobody likes one-line issues! As a rule of thumb, you should expect that other contributors will not put in more work to resolve your issue than you did in describing it.
• Include a precise description of the context in which the error is occurring: what command are you running? What is the url of the page that is crashing?
• Describe the problem precisely: include any error log, stacktrace and browser screenshots. As far as possible, use copy-pasted text instead of screenshots for errors.
• What version of Open edX/Tutor are you running? Are any plugins enabled?
• If relevant, post your OS and browser versions.
• Add your forum topic to the "working groups -> DevOps" forum subcategory such that other members of the group receive a notification.

If you are positive that the issue is relevant for many Open edX users, then you can open a GitHub issue. The same recommendations above apply.

How to get started fixing issues?

Awesome! Have a look at the following issues:

• DevOps "good first issues"
• Build/Test/Release bugs
• Developer Experience "good first issues"
• Large Instances "good first issues"
• Tutor "good first issues" (check the "Backlog" column) Also, read the Open edX Contributing Guidelines document.

We're happy to have you on board :)