Commit d478a3d4 by Mark Hoeber

Product stack documentation

DOC-448
parent 007fde03
......@@ -12,6 +12,9 @@ May, 2014
* - Date
- Change
* - 06/07/2014
- Addition of the section :ref:`Installing the edX Production Stack`
* - 05/21/2014
- The initial release of this guide, with the sections :ref:`Installing the edX Developer Stack` and :ref:`Running the edX Developer Stack`.
- The initial release of this guide, with the sections :ref:`Installing the
edX Developer Stack` and :ref:`Running the edX Developer Stack`.
\ No newline at end of file
......@@ -34,6 +34,7 @@ Devstack:
For example, `nginx`_ and `gunicorn`_ are disabled in Devstack; Devstack uses
Django's runserver instead.
See the `Vagrant documentation`_ for more information.
********************
Components
......@@ -46,6 +47,7 @@ Devstack includes the following edX components:
* Discussion Forums
* Open Response Assessor (ORA)
Devstack also includes a demo edX course.
**************************
Knowledge Prerequisites
......@@ -114,7 +116,7 @@ Before beginning the installation, ensure that you have your local computer's ad
The first time you create the Devstack virtual machine, Vagrant downloads the
base box, which is about 4GB. If you destroy and recreate the virtual
machine, Vagrant re-uses the box it downloaded.
machine, Vagrant re-uses the box it downloaded. See `Vagrant's documentation on boxes`_ for more information.
#. When prompted, enter your local computer's administrator's password.
......
.. include:: ../links.rst
.. _Testing on the edX Developer Stack:
####################################
Testing on the edX Developer Stack
####################################
......@@ -16,4 +16,4 @@ Installing, Configuring, and Running the edX Platform
install_options
devstack/install_devstack
devstack/run_devstack
.. devstack/test_devstack
\ No newline at end of file
prodstack/install_prodstack
......@@ -31,21 +31,20 @@ configuration options. This wiki contains two pages with more information about
* `Developing on Devstack`_
**********
Fullstack
**********
*********************
edX Production Stack
*********************
The edX Production Stack, known as **Fullstack**, is a Vagrant instance designed
to set up all edX services on a single server in a production-like
configuration.
1
for deploying all edX services on a single server.
Fullstack is in the `edx configuration repository`_ on GitHub.
Fullstack information is planned for future versions of this guide.
You can see the `edx configuration repository wiki`_ for information from edX
and the Open edX community on Fullstack and other installation and configuration options.
This guide includes :ref:`Installing the edX Production Stack`.
See the `edx configuration repository wiki`_ for information from edX and the
Open edX community on Fullstack and other installation and configuration
options.
==================
Ubuntu 12.04 64
......
......@@ -9,4 +9,10 @@
.. _edx configuration repository: https://github.com/edx/configuration
.. _edx configuration repository wiki: https://github.com/edx/configuration/wiki
.. _Devstack wiki: https://github.com/edx/configuration/wiki/edX-Developer-Stack
.. _Developing on Devstack: https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack
\ No newline at end of file
.. _Developing on Devstack: https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack
.. _RabbitMQ: http://www.rabbitmq.com/
.. _Discern: http://code.edx.org/discern/
.. _Ease: https://github.com/edx/ease
.. _VirtualBox Guest Editions: http://www.virtualbox.org/manual/ch04.html
.. _Vagrant documentation: http://docs.vagrantup.com/v2/
.. _Vagrant's documentation on boxes: http://docs.vagrantup.com/v2/boxes.html
\ No newline at end of file
.. include:: ../links.rst
.. _Installing the edX Production Stack:
####################################
Installing the edX Production Stack
####################################
This chapter is intended for those who are installing and running the edX Production Stack.
See the following sections:
* `Overview`_
* `Components`_
* `Knowledge Prerequisites`_
* `Software Prerequisites`_
* `Install the edX Production Stack`_
**********
Overview
**********
The edX Production Stack, known as **Fullstack**, is a Vagrant instance designed
for deploying all edX services on a single server.
See the `Vagrant documentation`_ for more information.
********************
Components
********************
Fullstack includes the following edX components:
* The Learning Management System (LMS)
* edX Studio
* XQueue, the queuing server that uses `RabbitMQ`_ for external graders
* Discussion Forums
* Open Response Assessor (ORA)
* `Discern`_, the machine-learning-based automated textual classification API
service.
* `Ease`_, a library for the classification of textual content.
**************************
Knowledge Prerequisites
**************************
To use Fullstack, you should:
* Understand basic terminal usage. If you are using a Mac computer, see
`Introduction to the Mac OS X Command Line`_. If you are using a Windows
computer, see `Windows Command Line Reference`_.
* Understand Vagrant commands. See the `Vagrant Getting Started`_ guide for more
information.
**************************
Software Prerequisites
**************************
To install and run Fullstack, you must first install:
* `VirtualBox`_ 4.3.10 or higher
* `Vagrant`_ 1.5.3 or higher
* An NFS client, if your operating system does not include one. Fullstack uses
`VirtualBox Guest Editions`_ to share folders through NFS.
*********************************
Install the edX Production Stack
*********************************
To install Fullstack directly from the command line, follow the instructions
below.
Before beginning the installation, ensure that you have your local computer's administrator's password.
#. Ensure the ``nfsd`` client is running.
#. Create the ``fullstack`` directory and navigate to it in the command prompt.
.. code-block:: bash
mkdir fullstack
cd fullstack
#. Download the fullstack Vagrant file.
.. code-block:: bash
curl -L https://raw.githubusercontent.com/edx/configuration/master/vagrant/release/fullstack/Vagrantfile > Vagrantfile
#. Install the Vagrant hostsupdater plugin.
.. code-block:: bash
vagrant plugin install vagrant-hostsupdater
#. Create the Fullstack virtual machine.
.. code-block:: bash
vagrant up
The first time you create the Fullstack virtual machine, Vagrant downloads the
base box, which is about 4GB. If you destroy and recreate the virtual
machine, Vagrant re-uses the box it downloaded. See `Vagrant's documentation on boxes`_ for more information.
#. When prompted, enter your local computer's administrator's password.
Your password is needed so that NFS can be set up to allow users to access
code directories directly from your computer.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment