Skip to content

README.md

Latest commit

 

History

History
58 lines (41 loc) · 2.32 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.32 KB

Scripts for deploying Onezone @ demo.onedata.org

Prerequisites

Prepare a host with the following:

  • git
  • docker
  • docker-compose
  • python + pyyaml
  • hostname set to demo.onedata.org
  • static DNS NS records pointing at the host IP for subdomain demo.onedata.org, e.g.: 
    demo.onedata.org.      120  IN  NS  ns1.demo.onedata.org
ns1.demo.onedata.org.  120  IN  A   149.156.182.28
    Onezone will handle the requests for the domain using the build-in DNS server, which enables subdomain delegation for subject Oneproviders (you can find out more here).

First deployment

  1. Place your auth.config in data/secret/auth.config - see OpenID & SAML for more
  2. Run ./onezone.sh start (see onezone.sh)
  3. The installation should happen automatically (batch mode) and might take a while (consult container logs for indication whether the installation was finished)
  4. Visit https://demo.onedata.org and log in using the credentials admin:EMERGENCY_PASSPHRASE (can be found in data/secret/emergency-passphrase.txt)

Maintaining the deployment

The Onezone docker is configured to restart automatically.

You can use the onezone.sh script to easily start / stop the deployment and for some convenient commands allowing to exec to the container or view the logs.

Regularly back-up the persistence directory: data/persistence. The script odbackup.sh can be used to backup the service. See the top-level ../../README.md for usage instructions.

To upgrade, stop the deployment (./onezone.sh stop), bump the onezone image version in docker-compose.yaml and start the deployment (./onezone.sh start). Make sure to back-up the persistence directory beforehand.

If you modify anything (e.g. onezone image), please commit the changes rather than make them only locally on the host.

More

Please refer to the documentation.
⚡