fides Quick Start Troubleshooting

Bug Description

Hi fides team,

I’m trying to get fides up and running locally for the very first time but am having some problems. I hope you can help. Basically:

• I get WARN messages about variables not being set during quick start. Can I ignore these safely?
• Why does the first quick start build take ~ 10 minutes (592 seconds in installation log attached below)? This is not quick. Is there some way of speeding this up?
• The quick start guide says to wait until the fides# prompt appears. It never appears.
• After nox -s dev is finished, how do I exit?

Steps to Reproduce

1. Clean your Docker env to simulate a first time user’s experience
   1. Stop all running containers docker stop $(docker ps -a -q)
   2. Remove all containers docker rm $(docker ps -a -q)
   3. Prune all images docker image prune -a
   4. Prune all volumes docker volume prune
   5. Prune build cache docker builder prune -a.
2. Folllow fides quick start instructions here
3. Try to reach the fides init part of Step 2 (I didn’t get past nox -s dev).

Expected behavior

• No WARN messages
• First-time quick start of ~ 3 minutes (this is the expected time stated in the docs)
• A fides# prompt (maybe I’m supposed to docker exec into a running container or something?)
• Guidance on how to exit / tear down quick start env.

Screenshots

I’m attaching the entire installation log here:

2022-10-12 daveqnet-alt fides quick start installation.log

The WARN messages were…

WARN[0000] The "VAULT_ADDR" variable is not set. Defaulting to a blank string.                                                                                                                                                                                                            
WARN[0000] The "VAULT_TOKEN" variable is not set. Defaulting to a blank string. 
WARN[0000] The "FIDES__CLI__ANALYTICS_ID" variable is not set. Defaulting to a blank string. 
WARN[0000] The "VAULT_NAMESPACE" variable is not set. Defaulting to a blank string. 
WARN[0000] The "FIDES__CLI__ANALYTICS_ID" variable is not set. Defaulting to a blank string. 

Environment

• Version: v1.9.2, I think? Not sure given recent repo unification efforts. See below for exact commit to main
• OS: See below
• Python Version: See below
• Docker Version: See below

~/projects/github/ethyca/fides main ❯ git log -1 | head -n 3
commit eb958dad3e313b6787199c4454c9493ac3595406
Author: Adam Sachs <[e-mail]>
Date:   Tue Oct 11 17:02:09 2022 -0400
~/projects/github/ethyca/fides main ❯ system_profiler SPSoftwareDataType SPHardwareDataType
Software:

    System Software Overview:

      System Version: macOS 12.6 (21G115)
      Kernel Version: Darwin 21.6.0
      <redacted>

Hardware:

    Hardware Overview:

      Model Name: MacBook Pro
      Model Identifier: MacBookPro17,1
      Chip: Apple M1
      Total Number of Cores: 8 (4 performance and 4 efficiency)
      Memory: 16 GB
      System Firmware Version: 7459.141.1
      OS Loader Version: 7459.141.1
      <redacted>

~/projects/github/ethyca/fides main ❯ python --version
Python 3.10.7
~/projects/github/ethyca/fides main ❯ nox --version
2022.8.7
~/projects/github/ethyca/fides main ❯ pipx --version
1.1.0
~/projects/github/ethyca/fides main ❯ docker --version
Docker version 20.10.17, build 100c701
~/projects/github/ethyca/fides main ❯ docker-compose --version
Docker Compose version v2.10.2

Additional context

This is obviously an issue raised by an alt of @daveqnet, but please treat it exactly the same as you would an issue raised by any non-Ethyca GitHub member

[daveqnet-alt]

Thank you for your help on this, @sanders41!

After a git pull the build time in a cleaned Docker env (no cache) shrank to 158 seconds, which is a HUGE improvement. 🎉

Using nox -s dev -- shell as you suggested also takes me to a fides# prompt. 🥳

Just on the env teardown, ctrl+c in the container itself doesn’t work…

+] Running 3/0
 ⠿ Container fides-fides-db-1  Running                                                                                                                                                                                                                                               0.0s
 ⠿ Container fides-redis-1     Running                                                                                                                                                                                                                                               0.0s
 ⠿ Container fides-worker-1    Running                                                                                                                                                                                                                                               0.0s
root@3ddb6ea288f3:/fides# ^C
root@3ddb6ea288f3:/fides#

but if I exit the container and then use ctrl+c it seems to work.

root@3ddb6ea288f3:/fides# exit
exit
nox > Command docker compose run --rm -e FIDES__CLI__ANALYTICS_ID -e ANALYTICS_OPT_OUT --user=root fides /bin/bash failed with exit code 130
nox > Session dev failed.
nox > Running session teardown
nox > Creating virtual environment (virtualenv) using python3.10 in .nox/teardown
nox > docker compose -f docker-compose.yml -f docker-compose.integration-tests.yml -f docker/docker-compose.integration-mariadb.yml -f docker/docker-compose.integration-mongodb.yml -f docker/docker-compose.integration-mysql.yml -f docker/docker-compose.integration-postgres.yml -f docker/docker-compose.integration-mssql.yml down --remove-orphans
WARN[0000] The "FIDES__CLI__ANALYTICS_ID" variable is not set. Defaulting to a blank string. 
WARN[0000] The "VAULT_ADDR" variable is not set. Defaulting to a blank string. 
WARN[0000] The "FIDES__CLI__ANALYTICS_ID" variable is not set. Defaulting to a blank string. 
WARN[0000] The "VAULT_NAMESPACE" variable is not set. Defaulting to a blank string. 
WARN[0000] The "VAULT_TOKEN" variable is not set. Defaulting to a blank string. 
[+] Running 5/5
 ⠿ Container fides-fides-1     Removed                                                                                                                                                                                                                                               1.6s
 ⠿ Container fides-fides-db-1  Removed                                                                                                                                                                                                                                               0.2s
 ⠿ Container fides-worker-1    Removed                                                                                                                                                                                                                                               2.2s
 ⠿ Container fides-redis-1     Removed                                                                                                                                                                                                                                               0.2s
 ⠿ Network fides_default       Removed                                                                                                                                                                                                                                               0.1s
Teardown complete
nox > Session teardown was successful.
nox > Ran multiple sessions:
nox > * dev: failed
nox > * teardown: success

Should I be concerned about the nox > * dev: failed message?

Also, the volumes created during the quick start persist - is this intended?

~/projects/github/ethyca/fides main ❯ docker ps -a                                                                                                                                                                                                                                 2m 58s
CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES
~/projects/github/ethyca/fides main ❯ docker image ls
REPOSITORY     TAG            IMAGE ID       CREATED         SIZE
ethyca/fides   local          752a2c5ef451   3 minutes ago   1.27GB
<none>         <none>         3fc3af312eca   3 minutes ago   1.27GB
postgres       12             bfb204038175   7 days ago      352MB
redis          6.2.5-alpine   2d113b08aca4   13 months ago   32.4MB
~/projects/github/ethyca/fides main ❯ docker volume ls  
DRIVER    VOLUME NAME
local     1ee8875cf7fe78fc454fa391878e39868642a206ef5289d26ffb6cc833b50822
local     ff258eb3117718b400dab2d36c09279b47cde34fdea14c849afc4666f0564f04
local     fides_postgres

[sanders41]

I get WARN messages about variables not being set during quick start. Can I ignore these safely?

Yes, you can safely ignore these. They are more info than warning, we might should change it to info.

Why does the first quick start build take ~ 10 minutes (592 seconds in installation log attached below)? This is not quick. Is there some way of speeding this up?

This is an issue with M1/M2 macs that was just fixed. If you pull the latest main you will get this update.

The quick start guide says to wait until the fides# prompt appears. It never appears.

The quick start command is missing an argument. It should be nox -s dev -- shell. I have opened an issue for this here. This is the biggest part of your issue with completing the quick start. If you have any more issues after nox -s dev -- shell feel free to follow-up with more questions.

After nox -s dev is finished, how do I exit?

Control + c will stop the container.