Firecloud in a Box

Firecloud in a Box (FiaB)

With some caveats, it is possible to run the Terra UI against FiaB.

1. Make sure you're on the Broad VPN (vpn.broadinstitute.org) as some of the links below are behind the Broad firewall.

2. Create a FiaB host if you don't already have one.

   1. To check, visit https://console.cloud.google.com/compute/instances?project=broad-dsde-dev and filter by your slack username. This will also tell you whether or not it's running.

   2. To create one, visit https://fc-jenkins.dsp-techops.broadinstitute.org/view/FIAB/job/fiab-host-create/build, enter your slack username for the USERNAME parameter, and click Build. When the host is ready, you will receive a slack message with the hostname, IP address, and a snippet of text to add to your /etc/hosts file.

   3. To start an existing one, visit https://fc-jenkins.dsp-techops.broadinstitute.org/view/FIAB/job/fiab-host-restart/build and enter your FiaB hostname for the FIAB_HOST parameter, and click Build. When the host is ready, you will receive a slack message with the IP address and a snippet of text to add to your /etc/hosts file. Make sure you replace any existing /etc/hosts entry with the new one.

3. Start FiaB.

   1. Visit https://fc-jenkins.dsp-techops.broadinstitute.org/view/FIAB/job/fiab-start/build, enter your FiaB hostname for the HOST_NAME parameter, and click Build. This will give you a bleeding edge FiaB build.

   2. You can specify other versions to deploy such as staging.

   3. After clicking Build, you'll have to keep track of startup progress yourself; no slack message will be sent. Startup takes 10-15 minutes.

   4. Replace the contents of public/config.json with config/fiab.json.

Notes:

• The FiaB hosts incur cost while running, even if FiaB is stopped. You will receive daily slack reminders about running hosts. Please shut down hosts you're not using. The slack messages have helpful links for this.

  • Tip: Make sure you stop FiaB before shutting down the host

• The only pre-populated data is a set of registered test users. See The Testerson Family and the Order of the QA for a list of users. The password can be retrieved using:

    vault read secret/dsde/firecloud/dev/common/users
  

  You can also register any account that you would usually register in FireCloud dev.

• You will need to create a billing project and any workspaces you need for testing.

• You can access FireCloud at https://firecloud-fiab.dsde-dev.broadinstitute.org:22443/

• Calhoun doesn't run inside a fiab, and dev points to dev Sam for auth purposes, so that wouldn't work as expected. (Thanks to Brett for pointing this out)