Production Onedata Deployments

This repository contains configs and docker-compose files for deploying and maintaining production Onedata deployments. You can also find some examples (templates) to adjust to your needs and deploy your own instances.

Structure

• homepage - configs for deploying the homepage, which includes general info about Onedata, documentation and API reference

  • onedata.org (README) - currently the only one homepage deployment

• onezone - configs used in production Onezone instances (per domain), and some example templates from which the production configs were derived

  • onezone.onedata.org - (README) stable Onezone deployment used as a showcase for the Onedata system (referenced on the homepage)

  • demo.onedata.org - (README) Onezone deployment used for demo purposes and testing of bleeding edge releases

  • datahub.egi.eu - (README) Onezone deployment for EGI DataHub

  • demo.onedata.org - (README) Onezone deployment used for demo purposes and testing of bleeding edge releases

  • hub.crmdr.org - (README) Onezone deployment for COVID-19 medical database

  • examples - ready to use templates to set up you own instances, using the graphical wizard or batch mode

• oneprovider - configs used in production Oneprovider instances (per domain) and examples mostly intended for people who do not want to use the Onedatify wizard

• bin - useful scripts (see below)

• initial-vm-config - ansible scripts for vm setup - see the README.

• openfaas - ansible scripts and manual instructions for deploying OpenFaaS - see the README.

Useful scripts

Can be found in the bin directory.

onezone.sh

The onezone.sh is merely a wrapper for the docker-compose command that simplifies onepanel emergency passphrase management. The passphrase is stored in
data/secret/emergency-passphrase.txt (relative to given deployment). Before deploying, you can put there an emergency passphrase of your choice. Otherwise, it will be generated automatically. If installing using the graphical wizard, you will be prompted for the passphrase - provide the same as in the file.

If you wish, you can simply use docker-compose up -d, but be aware of the following:

• If you are installing using the graphical wizard, the emergency passphrase is not needed to be specified beforehand - you will be asked to set up one during installation
• If you are installing using the batch mode, you must provide an emergency passphrase in the EMERGENCY_PASSPHRASE env variable (which is referenced in docker-compose.yaml)
• If you are restarting the deployment, EMERGENCY_PASSPHRASE is not obligatory, but it will allow you to see more output from the service startup.

odbackup.sh

This script allows backing up of onedata services. It assumed in the script that the service is installed under the /opt/onedata filesystem, which is placed on a logical volume. The logical volume is needed as the backup uses LVM snapshots. The script writes the backups to an S3 bucket using s3cmd, which needs to be configured before running the script.

Usage: odbackup <hostname or ip> [hostname or ip ... ]