Merge pull request #2818 from edx/derf/hackathon_documentation_updates

hackathon documentation updates

README.md

@@ -6,6 +6,8 @@ The goal of the edx/configuration project is to provide a simple, but
 flexible, way for anyone to stand up an instance of Open edX that is
 fully configured and ready-to-go.
 
+Before getting started, please look at the [Open EdX Deployment options](https://open.edx.org/deployment-options), to see which method for deploying OpenEdX is right for you.
+
 Building the platform takes place in two phases:
 
 * Infrastructure provisioning
@@ -17,6 +19,9 @@ and are free to use one, but not the other.  The provisioning phase
 stands-up the required resources and tags them with role identifiers
 so that the configuration tool can come in and complete the job.
 
+__Note__: The Cloudformation templates used for infrastructure provisioning 
+are no longer maintained. We are working to move to a more modern and flexible tool.
+
 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
@@ -28,11 +33,9 @@ The configuration phase is managed by [Ansible](http://ansible.com/).
 We have provided a number of playbooks that will configure each of
 the edX services.
 
-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.
-
+__Important__: 
+The 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 instruction please see the [Open edX Operations](https://openedx.atlassian.net/wiki/display/OpenOPS/Open+edX+Operations+Home) page.
+For more information including installation instruction please see the [OpenEdX Wiki](https://openedx.atlassian.net/wiki/display/OpenOPS/Open+edX+Operations+Home).
 
 For info on any large recent changes please see the [change log](https://github.com/edx/configuration/blob/master/CHANGELOG.md).

playbooks/sample_vars/server_vars.yml

+---
+
+#EDXAPP_PREVIEW_LMS_BASE: preview-${deploy_host}
+#EDXAPP_LMS_BASE: ${deploy_host}
+#EDXAPP_CMS_BASE: studio-${deploy_host}
+#EDXAPP_SITE_NAME: ${deploy_host}
+#CERTS_DOWNLOAD_URL: "http://${deploy_host}:18090"
+#CERTS_VERIFY_URL: "http://${deploy_host}:18090"
+#edx_internal: True
+#COMMON_USER_INFO:
+#  - name: ${github_username}
+#    github: true
+#    type: admin
+#USER_CMD_PROMPT: '[$name_tag] '
+#COMMON_ENABLE_NEWRELIC_APP: $enable_newrelic
+#COMMON_ENABLE_DATADOG: $enable_datadog
+#FORUM_NEW_RELIC_ENABLE: $enable_newrelic
+#ENABLE_PERFORMANCE_COURSE: $performance_course
+#ENABLE_DEMO_TEST_COURSE: $demo_test_course
+#ENABLE_EDX_DEMO_COURSE: $edx_demo_course
+#EDXAPP_NEWRELIC_LMS_APPNAME: sandbox-${dns_name}-edxapp-lms
+#EDXAPP_NEWRELIC_CMS_APPNAME: sandbox-${dns_name}-edxapp-cms
+#EDXAPP_NEWRELIC_WORKERS_APPNAME: sandbox-${dns_name}-edxapp-workers
+#XQUEUE_NEWRELIC_APPNAME: sandbox-${dns_name}-xqueue
+#FORUM_NEW_RELIC_APP_NAME: sandbox-${dns_name}-forums
+#SANDBOX_USERNAME: $github_username
+#EDXAPP_ECOMMERCE_PUBLIC_URL_ROOT: "https://ecommerce-${deploy_host}"
+#EDXAPP_ECOMMERCE_API_URL: "https://ecommerce-${deploy_host}/api/v2"
+#
+#ECOMMERCE_ECOMMERCE_URL_ROOT: "https://ecommerce-${deploy_host}"
+#ECOMMERCE_LMS_URL_ROOT: "https://${deploy_host}"
+#ECOMMERCE_SOCIAL_AUTH_REDIRECT_IS_HTTPS: true
+#
+#PROGRAMS_LMS_URL_ROOT: "https://${deploy_host}"
+#PROGRAMS_URL_ROOT: "https://programs-${deploy_host}"
+#PROGRAMS_SOCIAL_AUTH_REDIRECT_IS_HTTPS: true
+#
+#CREDENTIALS_LMS_URL_ROOT: "https://${deploy_host}"
+#CREDENTIALS_URL_ROOT: "https://credentials-${deploy_host}"
+#CREDENTIALS_SOCIAL_AUTH_REDIRECT_IS_HTTPS: true
+#COURSE_DISCOVERY_ECOMMERCE_API_URL: "https://ecommerce-${deploy_host}/api/v2"
+#
+#DISCOVERY_OAUTH_URL_ROOT: "https://${deploy_host}"
+#DISCOVERY_URL_ROOT: "https://discovery-${deploy_host}"
+#DISCOVERY_SOCIAL_AUTH_REDIRECT_IS_HTTPS: true
+
+## These flags are used to toggle role installation
+## in the plays that install each server cluster
+#COMMON_NEWRELIC_LICENSE: ''
+#COMMON_AWS_SYNC: True
+#NEWRELIC_LICENSE_KEY: ''
+#NEWRELIC_LOGWATCH: []
+  #  - logwatch-cms-errors.j2
+  #  - logwatch-lms-errors.j2
+#COMMON_ENABLE_NEWRELIC: True
+
+## Datadog Settings
+#datadog_api_key: ""
+#COMMON_DATADOG_API_KEY: ""
+#DATADOG_API_KEY: ""
+
+## NGINX settings:
+#NGINX_ENABLE_SSL: True
+#NGINX_SSL_CERTIFICATE: '/path/to/ssl.crt"
+#NGINX_SSL_KEY: '/path/to/ssl.key'
+#NGINX_SERVER_ERROR_IMG: https://files.edx.org/images-public/edx-sad-small.png
+#EDXAPP_XBLOCK_FS_STORAGE_BUCKET: 'your-xblock-storage-bucket'
+#EDXAPP_XBLOCK_FS_STORAGE_PREFIX: 'sandbox-edx/'
+#EDXAPP_LMS_SSL_NGINX_PORT: 443
+#EDXAPP_CMS_SSL_NGINX_PORT: 443
+#EDXAPP_LMS_NGINX_PORT: 80
+#EDXAPP_LMS_PREVIEW_NGINX_PORT: 80
+#EDXAPP_CMS_NGINX_PORT: 80
+#EDXAPP_WORKERS:
+#  lms: 2
+#  cms: 2
+#XSERVER_GRADER_DIR: "/edx/var/xserver/data/content-mit-600x~2012_Fall"
+#XSERVER_GRADER_SOURCE: "git@github.com:/MITx/6.00x.git"
+#CERTS_BUCKET: "verify-test.example.org"
+#migrate_db: "yes"
+#openid_workaround: True
+#rabbitmq_ip: "127.0.0.1"
+#rabbitmq_refresh: True
+#COMMON_HOSTNAME: edx-server
+#COMMON_DEPLOYMENT: edx
+#COMMON_ENVIRONMENT: sandbox
+#ora_gunicorn_workers: 1
+#AS_WORKERS: 1
+#ANALYTICS_WORKERS: 1
+#ANALYTICS_API_GUNICORN_WORKERS: 1
+#XQUEUE_WORKERS_PER_QUEUE: 2
+## Settings for Grade downloads
+#EDXAPP_GRADE_STORAGE_TYPE: 's3'
+#EDXAPP_GRADE_BUCKET: 'your-grade-bucket'
+#EDXAPP_GRADE_ROOT_PATH: 'sandbox'
+#EDXAPP_SEGMENT_IO: 'true'
+#EDXAPP_SEGMENT_IO_LMS: 'true'
+#EDXAPP_SEGMENT_IO_KEY: 'your segment.io key'
+#EDXAPP_SEGMENT_IO_LMS_KEY: 'your segment.io key'
+#EDXAPP_YOUTUBE_API_KEY: "Your Youtube API Key"
+#
+#EDXAPP_FEATURES:
+#  AUTH_USE_OPENID_PROVIDER: true
+#  CERTIFICATES_ENABLED: true
+#  ENABLE_DISCUSSION_SERVICE: true
+#  ENABLE_DISCUSSION_HOME_PANEL: true
+#  ENABLE_INSTRUCTOR_ANALYTICS: false
+#  SUBDOMAIN_BRANDING: false
+#  SUBDOMAIN_COURSE_LISTINGS: false
+#  PREVIEW_LMS_BASE: "{{ EDXAPP_PREVIEW_LMS_BASE }}"
+#  ENABLE_S3_GRADE_DOWNLOADS: true
+#  USE_CUSTOM_THEME: "{{ edxapp_use_custom_theme }}"
+#  ENABLE_MKTG_SITE: "{{ EDXAPP_ENABLE_MKTG_SITE }}"
+#  AUTOMATIC_AUTH_FOR_TESTING: "{{ EDXAPP_ENABLE_AUTO_AUTH }}"
+#  ENABLE_THIRD_PARTY_AUTH: "{{ EDXAPP_ENABLE_THIRD_PARTY_AUTH }}"
+#  AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING: true
+#  ENABLE_PAYMENT_FAKE: true
+#  ENABLE_VIDEO_UPLOAD_PIPELINE: true
+#  SEPARATE_VERIFICATION_FROM_PAYMENT: true
+#  ENABLE_COMBINED_LOGIN_REGISTRATION: true
+#  ENABLE_CORS_HEADERS: true
+#  ENABLE_MOBILE_REST_API: true
+#  ENABLE_OAUTH2_PROVIDER: true
+#  LICENSING: true
+#  CERTIFICATES_HTML_VIEW: true
+#
+#EDXAPP_CORS_ORIGIN_WHITELIST:
+#  - "example.org"
+#  - "www.example.org"
+#  - "{{ ECOMMERCE_ECOMMERCE_URL_ROOT }}"
+#
+#EDXAPP_VIDEO_UPLOAD_PIPELINE:
+#  BUCKET: "your-video-bucket"
+#  ROOT_PATH: "edx-video-upload-pipeline/unprocessed"
+#
+#EDXAPP_CC_PROCESSOR_NAME: "CyberSource2"
+#EDXAPP_CC_PROCESSOR:
+#  CyberSource2:
+#    PURCHASE_ENDPOINT: "/shoppingcart/payment_fake/"
+#    SECRET_KEY: ""
+#    ACCESS_KEY: ""
+#    PROFILE_ID: ""
+#
+#EDXAPP_PROFILE_IMAGE_BACKEND:
+#  class: storages.backends.s3boto.S3BotoStorage
+#  options:
+#    location: /{{ ansible_ec2_public_ipv4 }}
+#    bucket: your-profile-image-bucket
+#    custom_domain: yourcloudfrontdomain.cloudfront.net
+#    headers:
+#      Cache-Control: max-age-{{ EDXAPP_PROFILE_IMAGE_MAX_AGE }}
+#EDXAPP_PROFILE_IMAGE_SECRET_KEY: "SECRET KEY HERE"
+#
+##TODO: remove once ansible_provision.sh stops sucking or is burned to the ground
+#EDXAPP_PROFILE_IMAGE_MAX_AGE: 31536000
+#
+## send logs to s3
+#AWS_S3_LOGS: true
+#AWS_S3_LOGS_NOTIFY_EMAIL: devops+logs@example.com
+#AWS_S3_LOGS_FROM_EMAIL: devops@example.com
+#EDX_ANSIBLE_DUMP_VARS: true
+#configuration_version: release
+#CERTS_AWS_KEY: 'AWS SECRET KEY HERE'
+#CERTS_AWS_ID: 'AWS KEY ID HERE'
+#CERTS_REPO: "git@github.com:/edx/certificates"
+#XSERVER_GIT_IDENTITY: |
+#  -----BEGIN RSA PRIVATE KEY-----
+#    ssh private key here
+#  -----END RSA PRIVATE KEY-----
+#CERTS_GIT_IDENTITY: "{{ XSERVER_GIT_IDENTITY }}"
+#EDXAPP_INSTALL_PRIVATE_REQUIREMENTS: true
+#EDXAPP_USE_GIT_IDENTITY: true
+#_local_git_identity: |
+#  -----BEGIN RSA PRIVATE KEY-----
+#    ssh private key here
+#  -----END RSA PRIVATE KEY-----
+#
+#EDXAPP_GIT_IDENTITY: "{{ _local_git_identity }}"
+#
+################################################################
+##
+##  Analytics API Settings
+##
+#ANALYTICS_API_PIP_EXTRA_ARGS: "--use-wheel --no-index --find-links=http://edx-wheelhouse.s3-website-us-east-1.amazonaws.com/Ubuntu/precise/Python-2.7"
+#ANALYTICS_API_GIT_IDENTITY: "{{ _local_git_identity }}"
+#
+#TESTCOURSES_EXPORTS:
+#  - github_url: "https://github.com/edx/demo-performance-course.git"
+#    install: "{{ ENABLE_PERFORMANCE_COURSE }}"
+#    course_id: "course-v1:DemoX+PERF101+course"
+#  - github_url: "https://github.com/edx/demo-test-course.git"
+#    install: "{{ ENABLE_DEMO_TEST_COURSE }}"
+#    course_id: "course-v1:edX+Test101+course"
+#  - github_url: "https://github.com/edx/edx-demo-course.git"
+#    install: "{{ ENABLE_EDX_DEMO_COURSE }}"
+#    course_id: "course-v1:edX+DemoX+Demo_Course"
+#    
+#EDXAPP_FILE_UPLOAD_STORAGE_BUCKET_NAME: edxuploads-sandbox
+#EDXAPP_AWS_STORAGE_BUCKET_NAME: edxuploads-sandbox
+#
+#EDXAPP_SESSION_COOKIE_SECURE: true
+#
+## Celery Flower configuration
+## By default, we now turn on Google OAuth2 configuration
+## This disables that on sandboxes so you can use flower to manage your
+## local celery processes.
+#FLOWER_AUTH_REGEX: ""
+#
+################################################################
+##
+##  LOCUST Settings
+##
+#LOCUST_GIT_IDENTITY: "{{ _local_git_identity }}"
+

util/install/sandbox.sh

@@ -49,7 +49,7 @@ if [ -n "$OPENEDX_RELEASE" ]; then
     -e forum_version=$OPENEDX_RELEASE \
     -e xqueue_version=$OPENEDX_RELEASE \
     -e configuration_version=$OPENEDX_RELEASE \
-  "
+  $EXTRA_VARS"
   CONFIG_VER=$OPENEDX_RELEASE
 else
   CONFIG_VER="master"