Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: prepare for sumac cutoff #61

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 32 additions & 28 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ jobs:
deploy:
runs-on: ubuntu-latest
env:
SSH: ssh -o StrictHostKeyChecking=no -o TCPKeepAlive=yes -o ServerAliveInterval=150 -i ~/.ssh/demo.key ubuntu@redwood.demo.edly.io
VERSION: redwood
LMS_HOST: redwood.demo.edly.io
SSH: ssh -o StrictHostKeyChecking=no -o TCPKeepAlive=yes -o ServerAliveInterval=150 -i ~/.ssh/demo.key ubuntu@sumac.demo.edly.io
VERSION: sumac
LMS_HOST: sumac.demo.edly.io
TUTOR: ~/.local/bin/tutor
steps:
- name: Configure SSH
Expand All @@ -37,23 +37,23 @@ jobs:
- name: Install dependencies, tutor and plugins (from source)
# Pending:
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-cairn.git@$VERSION#egg=tutor-cairn
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-android.git@$VERSION#egg=tutor-android
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-credentials.git@$VERSION#egg=tutor-credentials
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-discovery.git@$VERSION#egg=tutor-discovery
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-ecommerce.git@$VERSION#egg=tutor-ecommerce
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-forum.git@$VERSION#egg=tutor-forum
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-jupyter.git@$VERSION#egg=tutor-jupyter
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-minio.git@$VERSION#egg=tutor-minio
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-notes.git@$VERSION#egg=tutor-notes
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-webui.git@$VERSION#egg=tutor-webui
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-xqueue.git@$VERSION#egg=tutor-xqueue
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/openedx/tutor-contrib-aspects.git@master#egg=tutor-contrib-aspects
# pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/eduNEXT/tutor-contrib-codejail.git@$VERSION#egg=tutor-contrib-codejail
run: |
$SSH "#! /bin/bash -e
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor.git@$VERSION#egg=tutor
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-mfe.git@$VERSION#egg=tutor-mfe
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-android.git@$VERSION#egg=tutor-android
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-credentials.git@$VERSION#egg=tutor-credentials
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-discovery.git@$VERSION#egg=tutor-discovery
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-ecommerce.git@$VERSION#egg=tutor-ecommerce
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-forum.git@$VERSION#egg=tutor-forum
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-indigo.git@$VERSION#egg=tutor-indigo
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-jupyter.git@$VERSION#egg=tutor-jupyter
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-minio.git@$VERSION#egg=tutor-minio
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-notes.git@$VERSION#egg=tutor-notes
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-webui.git@$VERSION#egg=tutor-webui
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/overhangio/tutor-xqueue.git@$VERSION#egg=tutor-xqueue
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/openedx/tutor-contrib-aspects.git@master#egg=tutor-contrib-aspects
pip install --user --upgrade --src=~/apps/openedx/src --editable git+https://github.com/eduNEXT/tutor-contrib-codejail.git@$VERSION#egg=tutor-contrib-codejail
"
# Backup
- name: Backup data
Expand Down Expand Up @@ -97,36 +97,40 @@ jobs:
"
# Configure
- name: Enable plugins
# missing plugins: cairn
run: $SSH "$TUTOR plugins enable android aspects credentials discovery ecommerce forum indigo jupyter mfe minio notes webui xqueue codejail"
# missing plugins: cairn android aspects credentials discovery ecommerce forum jupyter minio notes webui xqueue codejail
run: $SSH "$TUTOR plugins enable indigo mfe "
- name: Configure tutor settings
run: |
$SSH "#! /bin/bash -e
$TUTOR config save \
--set LMS_HOST=$LMS_HOST \
--set CMS_HOST=studio.$LMS_HOST \
--set ENABLE_HTTPS=true \
--set PLATFORM_NAME='Open edX Redwood Demo'
--set PLATFORM_NAME='Open edX Sumac Demo'
"
- name: Install extra xblocks/packages
run: |
$SSH "#! /bin/bash -e
$TUTOR config save --append 'OPENEDX_EXTRA_PIP_REQUIREMENTS=edx-event-routing-backends>=7.2.0,<8.0.0'
"
- name: Configure xqueue grader password
run: |
$SSH "$TUTOR config save --set XQUEUE_AUTH_PASSWORD=xqueuepassword"
- name: Configure Jupyter LTI Password
run: |
$SSH "$TUTOR config save --set JUPYTER_LTI_CLIENT_SECRET=jupyter-lti-password"
# TODO: uncomment when enabling tutor-xqueue
# - name: Configure xqueue grader password
# run: |
# $SSH "$TUTOR config save --set XQUEUE_AUTH_PASSWORD=xqueuepassword"
# TODO: uncomment when enabling tutor-jupyter
# - name: Configure Jupyter LTI Password
# run: |
# $SSH "$TUTOR config save --set JUPYTER_LTI_CLIENT_SECRET=jupyter-lti-password"
# Build
- name: Build Docker images
run: |
$SSH "#! /bin/bash -e
$TUTOR images build all
"
- name: Initialize codejail
run: $SSH "$TUTOR local do init --limit=codejail"
# TODO: uncomment when enabling tutor-contrib-codejail
# - name: Initialize codejail
# run: $SSH "$TUTOR local do init --limit=codejail"
- name: Launch
run: $SSH "$TUTOR local launch --non-interactive"
# Provision
Expand All @@ -138,8 +142,8 @@ jobs:
- name: "Provision: Create users"
run: |
$SSH "#! /bin/bash -e
$TUTOR local do createuser --staff --superuser --password=admin admin admin@overhang.io
$TUTOR local do createuser --password=student student student@overhang.io
$TUTOR local do createuser --staff --superuser --password=admin admin admin@edly.io
$TUTOR local do createuser --password=student student student@edly.io
"
# Unfortunately ecommerce user creation may not be automated because the admin
# user needs to login from the frontend first. We could use the ecommerce
Expand Down
46 changes: 22 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# Open edX release demo platform CD

⚠ This repo is read-only until the next major Open edX release. See you in Sumac! (Oct. 2024)

This repo holds the continuous deployment (CD) scripts to deploy the Open edX release demo platforms. As of May 9, 2024, it is used to deploy and configure a test instance of the Redwood release.
This repo holds the continuous deployment (CD) scripts to deploy the Open edX release demo platforms. As of October 23, 2024, it is used to deploy and configure a test instance of the Sumac release.

⚠ THIS REPO IS NOT FOR PUBLIC CONSUMPTION ⚠ It is only used to deploy and configure a test instance for the [Build/Test/Release working group](https://discuss.openedx.org/c/working-groups/build-test-release/30). Detected issues should be reported to the working group.

URLs:

- LMS: https://redwood.demo.edly.io
- Studio: https://studio.redwood.demo.edly.io
- LMS: https://sumac.demo.edly.io
- Studio: https://studio.sumac.demo.edly.io

You may log in with the following credentials:

- Student user:
- username: student
- email: student@overhang.io
- email: student@edly.io
- password: student
- Administrator user:
- username: admin
- email: admin@overhang.io
- email: admin@edly.io
- password: admin

The platform is reset weekly, every Monday at 2 am UTC.
Expand All @@ -28,26 +26,26 @@ The [deployment script](https://github.com/overhangio/openedx-release-demo/blob/

The following plugins are enabled on the demo platform:

- tutor-android ([PR](https://github.com/overhangio/tutor-android/pull/24) by @DawoudSheraz)
- The mobile apk can be downloaded from https://mobile.redwood.demo.edly.io/app.apk.
- ~~tutor-cairn ([PR](https://github.com/overhangio/tutor-cairn/pull/40) by @FahadKhalid210)~~
- tutor-contrib-aspects ([master branch](https://github.com/openedx/tutor-contrib-aspects/tree/master))
- tutor-android (TBA)
- ~~The mobile apk can be downloaded from https://mobile.sumac.demo.edly.io/app.apk.~~
- ~~tutor-cairn (TBA)~~
- tutor-contrib-aspects ([master branch](https://github.com/openedx/tutor-contrib-aspects/tree/master)) -- **To be enabled**
- aspects has been enabled in place of cairn for testing of certain Product features.
- tutor-contrib-codejail ([PR](https://github.com/eduNEXT/tutor-contrib-codejail/pull/54) by @MoisesGSalas)
- tutor-credentials ([PR](https://github.com/overhangio/tutor-credentials/pull/42) by @Faraz32123)
- tutor-discovery ([PR](https://github.com/overhangio/tutor-discovery/pull/74) by @Faraz32123)
- tutor-ecommerce ([PR](https://github.com/overhangio/tutor-ecommerce/pull/81) by @Faraz32123)
- tutor-forum ([PR](https://github.com/overhangio/tutor-forum/pull/36) by @DawoudSheraz)
- tutor-indigo ([PR](https://github.com/overhangio/tutor-indigo/pull/79) by @hinakhadim)
- tutor-mfe ([PR](https://github.com/overhangio/tutor-mfe/pull/207) by @hinakhadim)
- tutor-minio ([PR](https://github.com/overhangio/tutor-minio/pull/40) by @FahadKhalid210)
- tutor-notes ([PR](https://github.com/overhangio/tutor-notes/pull/37) by @jfavellar90)
- tutor-webui ([PR](https://github.com/overhangio/tutor-webui/pull/17) by @Abdul-Muqadim-Arbisoft)
- tutor-xqueue ([PR](https://github.com/overhangio/tutor-xqueue/pull/31) by @jfavellar90)
- tutor-jupyter ([PR](https://github.com/overhangio/tutor-jupyter/pull/8) by @Abdul-Muqadim-Arbisoft)
- tutor-contrib-codejail (TBA)
- tutor-credentials (TBA)
- tutor-discovery (TBA)
- tutor-ecommerce (TBA)
- tutor-forum (TBA)
- tutor-indigo ([PR](https://github.com/overhangio/tutor-indigo/pull/101) by @hinakhadim)
- tutor-mfe ([PR](https://github.com/overhangio/tutor-mfe/pull/227) by @hinakhadim and @DawoudSheraz)
- tutor-minio (TBA)
- tutor-notes (TBA)
- tutor-webui (TBA)
- tutor-xqueue (TBA)
- tutor-jupyter (TBA)
- LTI passport is `jupyterhub:openedx:jupyter-lti-password`.

If you are interested in upgrading these plugins to Redwood, please submit a PR by following the regular [plugin upgrade instructions](https://discuss.overhang.io/t/how-to-upgrade-a-tutor-plugin/1488).
If you are interested in upgrading these plugins to Sumac, please submit a PR by following the regular [plugin upgrade instructions](https://discuss.overhang.io/t/how-to-upgrade-a-tutor-plugin/1488).

## Testing

Expand Down