wearewondrous / platformsh-backup-s3-action

platformsh-backup-s3-action

What it does

Given a Drupal 8+ project deployed on platform.sh, this GitHub-action backups the database, public files, private files and a snapshot of the code to an AWS bucket. Instead of using the platform sh server resources, GitHub resources are leveraged. This may be required for projects with large data dumps. Thus, you'll be able to restore the project from the four compressed files.

With the required aws_s3_bucket you define the parent folder. The current repository name will be used as a default folder. Backups are folders named by the current datetime (in ISO 8601 date format) containing the compressed files. An example folder structure see below:

<aws_s3_bucket>/
├─ <repository_name>/
│  ├─ datetime/
│  │  ├─ repository_name--branch--datetime--database.sql.gz
│  │  ├─ repository_name--branch--datetime--private-files.zip
│  │  ├─ repository_name--branch--datetime--public-files.zip
│  │  ├─ repository_name--branch--datetime--source-code.zip
│  ├─ .../

With the days_to_backup (defaults to 30) you can limit the amount of folders in aws S3. Set it to 0 to disable this limitation and store all backups made. Note: If no private folder is present, this file will be empty.

Setup

Create a workflow yml file and use the example below to configure the project.

$ touch .github/workflows/sync-backups.yml

Add the following

name: Sync Backups
on:
  workflow_dispatch:                          # optional, trigger the backup via the GitHub actions UI
  schedule:
    - cron: '0 1 * * *'
jobs:
  upload-backup:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: wearewondrous/platformsh-backup-s3-action@v1
        with:
          gh_user: 'github-username'          # required, GitHub user related with the Access Token
          platformsh_project: 'abcdefghijkl'  # required, Platform.sh project ID
          aws_s3_bucket: 'my-backup-bucket'   # required, AWS S3 bucket name
        env:
          PLATFORMSH_CLI_TOKEN: ${{ secrets.PLATFORMSH_CLI_TOKEN }}   # required
          GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}             # required
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}         # required
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} # required
          AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}       # required

See action.yml for more optional parameters.

Make sure to have all the required INPUT variables and add GitHub secrets set.

PLATFORMSH_CLI_TOKEN
GH_ACCESS_TOKEN
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_DEFAULT_REGION

AWS S3 IAM permissions

To allow the script to push content to the S3 storage, make sure to configure a user with the required access rights to the bucket and target folder. See iam-policies.json for a sample. Replace <my-backup-bucket> with

Background knowledge

GitHub Scheduled workflows run on the latest commit on the default or base branch. If you set e.g. the dev-branch as default for pull requests, the cron will run with the GITHUB_REF_NAME set to dev. Thus, we provide the optional variable TARGET_BRANCH (defaults to master for platform.sh).

Optional but nice: set workflow_dispatch on the action, to trigger the backup by hand.

Credits

Made with ♥️ by WONDROUS, Switzerland