Skip to content

edx/configuration

 
 

Repository files navigation

Configuration Management

Description

A collection of configuration scripts using Ansible for deploying edx.org. This is not meant for general Open edX deployment and use. View the Open EdX Installation options page for recommended deployment options.

For info on any large recent changes please see the change log.

What is in this Repo?

  • playbooks: This directory contains ansible playbooks that can be used to configure individual services in the openedx platform. See Open EdX Installation options before trying to use any of the scripts in this directory.
  • docker: This directory contains dockerfiles that can be used to test that playbooks execute cleanly. See Makefiles for Documentation on how to run these containers.
  • requirements : inputs for pip-compile Update files in this directory and then run make upgrade to update requirements.txt
  • tests: scripts used by travis-ci to test changes to this repo
  • util: one-off scripts or tools used to perform certain functions related to openedx management.
  • vagrant: vagrant tooling for testing changes to this repo.

Roadmap

This repository is in sustained status. The goal is to deprecate this codebase and move the deployment code into the repos with the application code.

With the adoption of containerized application platforms like Kubernetes, the tools in this repository are complex and inappropriate for building small single purpose containers.

At edx.org, we are focusing on deployment of applications using Terraform and Kubernetes. We hope to provide open source tooling for this soon.

Contributing

  • Bugfixes: If you would like to contribute a bugfix to this codebase, please open a pull request. A bot will automatically walk your contribution through the Open Source Contribution process.

About

A collection of edx configuration scripts and utilities that edx.org uses to deploy openedx.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jinja 40.7%
  • Python 38.5%
  • Shell 14.9%
  • Dockerfile 4.5%
  • Groovy 0.6%
  • Makefile 0.6%
  • Other 0.2%