lpm0073 / edx.scripts

Covers 80% of the admin tasks you'll ever need to perform on your Open edX installation

edx.scripts

This repository contains fully documented and parameterized bash scripts that are intended to help you fill in the blanks on basic Open edX system administration and devops tasks. You'll find complete how-to guides for each of these scripts on my personal blog. More specifically, you might want refer to this troubleshooting guide in the event of any problems.

Scripts Included

Backup Open edX to AWS S3

edx.backup.sh. Use this script to create a complete backup of your Open edX installation saved to AWS S3. Backs up all MySQL and MongoDB databases and archives these into a single compressed tarball. The script also works with a properly-configured AWS S3 bucket and AWS Command Line Interface (CLI) to permanently archive your backup.

Compile Open edX Static Assets

edx.compile-assets.sh. In many cases, modifications to the Open edX user interface require recompiling assets so that your changes appear in the production environment. This script initiates the asset compilation process, which takes around 10 minutes to complete. Your Open edX platform will be unavailable during the compilation process.

Compile Open edX Language Files

edx.compile-language.sh. If you administer a non-English platform then any changes that you make to the language translation files require a recompilation of the language pack. This script initiates the recompilation process.

Open edX Native Installation

edx.platform-install.sh. These are the complete set of commands necessary to raise a new Open edX Native installation on a fresh build of Ubuntu 20.04.

Open edX Database Migrations

edx.platform-migrations.sh. Initiates database migrations, a Django-specific deployment process whereby updates to database table, field and relationships are deduced by programmatically analyzing django/python objects. This process is almost always taken care of for you via the Ansible Playbooks. You'd need to run this script if, for example, an automated platform upgrade script stalled.

Restart Open edX Platform

edx.platform-restart.sh. Restarts your Open edX platform without having to completely reboot the server.

Stop Open edX Platform

edx.platform-stop.sh. Stops all Open edX services.

Upgrade Open edX Platform

edx.platform-upgrade.sh. Backs up your current Open edX codebase and then reinstalls the latest executable code from the master branch of the edx Github repository.

edx.scripts's Issues

database enabling and anisble fail

when i run wget https://raw.githubusercontent.com/edx/configuration/$OPENEDX_RELEASE/util/install/native.sh -O - | bash > install.out
following error comes after some processing

TASK [mongo_3_2 : Enable/start disable transparent huge pages service (http://docs.mongodb.org/manual/tutorial/transparent-huge-pages/)] *****
fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": "Unable to start service disable-transparent-hugepages: Job for disable-transparent-hugepages.service failed because the control process exited with error code. See "systemctl status disable-transparent-hugepages.service" and "journalctl -xe" for details.\n"}
to retry, use: --limit @/var/tmp/configuration/playbooks/openedx_native.retry

PLAY RECAP ***********************************************************************************************************************************
localhost : ok=68 changed=9 unreachable=0 failed=1

INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Copying nginx configs for [u'certs', u'cms', u'lms', u'forum', u'xqueue'] ------ 12.62s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Copy the templates to their respestive destination [1] -------------------------- 9.96s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Gathering Facts ----------------------------------------------------------------- 8.22s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Define server configuration file and common nginx configuration ----------------- 5.08s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Create NGINX server templates --------------------------------------------------- 5.04s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: pip install virtualenv [1] ------------------------------------------------------ 4.98s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Set up nginx error log rotation ------------------------------------------------- 3.96s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: restart mysql ------------------------------------------------------------------- 3.55s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Add apt key --------------------------------------------------------------------- 3.06s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing: Update apt-get ------------------------------------------------------------------ 2.96s
INFO:/var/tmp/configuration/playbooks/callback_plugins/task_timing:
Playbook Configure instance(s) finished: 2019-10-15 06:01:15.492339, 253 total tasks. 0:02:10.846155 elapsed.

========================================
Ansible failed!

If you need help, see https://open.edx.org/getting-help .
When asking for help, please provide as much information as you can.
These might be helpful:
Your log file is at logs/install-20191015-055843.log
Your environment:

Installation finished at 2019-10-15 06:01:15

Open edX Native installation

When bootstrapping the system, it is better to run the cmd with sudo -H bash

wget https://raw.githubusercontent.com/edx/configuration/$OPENEDX_RELEASE/util/install/ansible-bootstrap.sh -O - | sudo -H bash