Github Action to build a Docker image of the Tutor plugin "Backup & Restore", and upload to an AWS Elastic Container Registry repository.
The "Backup & Restore" plugin is authored by hastexo: https://github.com/hastexo/tutor-contrib-backup.
This is an experimental plugin for Tutor that provides backup and restore functionality for MySQL, MongoDB, and Caddy services in both local and Kubernetes Tutor deployments.
In Kubernetes, the plugin runs the backup job as a CronJob by default. You can also run the backup job from the command line. In both cases the backup tar file is stored in an S3 bucket. Then, in a new Kubernetes deployment, you can use the restore command to restore your Open edX environment. You can even schedule the restore as a CronJob to periodically download the latest backup and restore your environment. This can, for example, be useful if you want to maintain a standby site for disaster recovery purposes.
name: Example workflow
on: workflow_dispatch
jobs:
build:
runs-on: ubuntu-latest
steps:
# required antecedent
- uses: actions/checkout
# required antecedent
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials
with:
aws-access-key-id: ${{ secrets.THE_NAME_OF_YOUR_AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.THE_NAME_OF_YOUR_AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-2
# install and configure tutor and kubectl
- name: Configure Github workflow environment
uses: openedx-actions/tutor-k8s-init@v1
# This action.
# Note that both inputs are optional.
# - aws-ecr-repo: default value is openedx_backup
# - hastexo-backup-release: default is latest stable
- name: Build the image and upload to AWS ECR
uses: openedx-actions/tutor-plugin-build-backup@v0
with:
aws-ecr-repo: openedx_backup
hastexo-backup-release: 'v0.0.6'Pull requests are welcome! Please note that this repository uses semantic release for automated processessing of commits and pull requests, and package publication for new releases. Please note the following about your commit message:
- pull requests can be approved and merged by any two authorized core committers
- only the 'next' branch can be merged to main. Thus, your Pull Request should be created from the 'next' branch
- we use Angular commit message format. See below
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
| Branch | Description |
|---|---|
| main | commits are prohibited. Only accepts automated merges via Github Actions |
| next | this is the branch that I (Lawrence) primarly use for normal code maintenance |
| next-major | special use, in the unlikely event that we ever bump beyond version 1.x.x |
| beta | if you're working on something large then merge here before doing anything in 'next' |
| alph | if you're doing some really big then start here |
An example:
git commit -m "fix: fix bug in the yadda yadda step"Your commit message should be prefixed with one of the following:
| Prefix | Description |
|---|---|
| build | changes that affect the build system or external dependencies (example - scopes: gulp, broccoli, npm) |
| ci | changes to our CI configuration files and scripts (examples: Github Actions, CircleCi, SauceLabs) |
| docs | documentation only changes |
| feat | a new feature |
| fix | a bug fix |
| perf | a code change that improves performance |
| refactor | a code change that neither fixes a bug nor adds a feature |
| test | adding missing tests or correcting existing tests |
More generally, less is more: don't use two words where one will suffice. Simple words are better than fancy words.
