The freva-deployment software

The freva-deployment software is used to deploy Freva in different computing environments. The general strategy is to split the deployment into different steps, these are : - Deploy database service - Deploy a HashiCorp Vault service for storing and retrieving passwords and other sensitive data via docker (this step get automatically activated once the MariaDB service is set) - Deploy the DatabrowserAPI The databrowser API deployment consists of three parts:

• The actual databrowser rest API

• Apache solr search backend

• Mongodb to store search statistics

• Deploy command line interface and python library (freva)

• Deploy web front end (freva_web) The web front end deployment is sub divided into three parts:

  • Deployment of the django web application

  • Deployment of a redis instance acting as database cache

  • Deployment as a apache httpd service as a reverse proxy server for connections from the client to the django web application.

Note

The vault server is auto deployed once the database server is deployed. The vault centrally stores all passwords and other sensitive data.

• Installing freva-deployment
  • 1. Using pre-built binaries.
  • 2. Installation via pip.
  • 3. Using docker
  • Sub Commands after installation:
  • Installing docker/podman to the service servers
• Configuring and running the deployment
  • Running the deployment
  • Setting the python and git path
  • Setting up the deployment without root-privileges
  • Version checking
  • Using environment variables
  • Advanced: Adjusting the playbook
  • Known Issues:
• Usage of the text user interface
  • General usage
  • Core setup
  • Web ui setup
  • Freva rest setup
  • Database server setup
  • The run screen.
• Example deployment configuration
  • Typical deployment
  • Deployment with non-root privileges