Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openedx/configuration

A collection of edx configuration scripts and utilities that edx.org uses to deploy openedx.
https://github.com/openedx/configuration

ansible docker python

Last synced: 2 months ago
JSON representation

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

Awesome Lists containing this project

README 

        
Configuration Management

########################



DEPRECATION WARNING

*******************



This repository is Deprecated and is planned to be archived after the Redwood

Cut (Late April 2024). See https://github.com/openedx/public-engineering/issues/51

for more details and up-to-date information.



Description

***********



This repository is a collection of tools and scripts that edx.org uses to deploy

openedx. The purpose of this repository is to share portions of our toolchain

with the community. This repository is *not* the best way to get started running

openedx. For that, please look at `Open EdX Installation options`_, which contains

links to the recommended paths for new installations.



**Important**: The Open edX configuration scripts need to be run as root on

your servers and will make changes to service configurations including, but not

limited to, sshd, dhclient, sudo, apparmor and syslogd. Our scripts are made

available as we use them and they implement our best practices. We strongly

recommend that you review everything that these scripts will do before running

them against your servers. We also recommend against running them against

servers that are hosting other applications. No warranty is expressed or

implied.



For more information including installation instructions please see the `OpenEdX

Wiki`_.



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 `__.



.. _Open EdX Installation options: https://open.edx.org/installation-options

.. _Ansible: http://ansible.com/

.. _OpenEdX Wiki: https://openedx.atlassian.net/wiki/display/OpenOPS/Open+edX+Operations+Home

.. _change log: https://github.com/openedx/configuration/blob/master/CHANGELOG.md