README.md 1.62 KB
Newer Older
jarv committed
1
# Configuration Management
2 3 4 5 6 7

## Introduction

**This project is currently in alpha**

The goal of the edx/configuration project is to provide a simple, but
8 9
flexible, way for anyone to stand up an instance of Open edX that is
fully configured and ready-to-go.
10

11
Building the platform takes place in two phases:
12

13
* Infrastructure provisioning
14 15 16 17
* Service configuration

As much as possible, we have tried to keep a clean distinction between
provisioning and configuration.  You are not obliged to use our tools
18
and are free to use one, but not the other.  The provisioning phase
19 20 21 22 23 24 25 26 27 28
stands-up the required resources and tags them with role identifiers
so that the configuration tool can come in and complete the job.

The reference platform is provisioned using an Amazon
[CloudFormation](http://aws.amazon.com/cloudformation/) template.
When the stack has been fully created you will have a new AWS Virtual
Private Cloud with hosts for the core edX services.  This template
will build quite a number of AWS resources that cost money, so please
consider this before you start.

dhpollack committed
29
The configuration phase is managed by [Ansible](http://ansible.com/).
30
We have provided a number of playbooks that will configure each of
31
the edX services.
32 33 34 35 36

This project is a re-write of the current edX provisioning and
configuration tools, we will be migrating features to this project
over time, so expect frequent changes.

37

38
For more information including installation instruction please see the [Configuration Wiki](https://github.com/edx/configuration/wiki).
39 40

For info on any large recent changes please see the [change log](https://github.com/edx/configuration/blob/master/CHANGELOG.md).