Large files are being stored with git-lfs.
The list of what it is tracking can be found in .gitattributes, currently terraform/.terraform.
To add to the tracked list, use
git lfs track <> where <> could be "*.someFileExtension", path/to/dir/** for an entire directory.
asdf is used to maintain consistent software tooling for this repo. See installation instructions here.
After cloning the repo, run asdf install to add any required software packages.
This repo uses pre-commit to preform static analysis, code linting/formatting and more.
After asdf has already been run to install pre-commit, run: pre-commit install.
If pre-commit hooks are not running (or are incomplete), try
pre-commit uninstallandpre-commit installto refresh.For pre-commit install errors; such as, no module named ‘_sqlite3’. Install db-sqlite3, see here
After pre-commit is installed, run pre-commit install --hook-type commit-msg to enable gitlint
In order to run terraform plan etc. in this project, you currently need to ask for the credentials file. This will be dealt with properly shortly.
After making changes to terraform code:
terraform validate to ensure the configuration is syntactically valid and internally consistent.terraform fmt to format the code (make sure to save the files it formatted after running this).terraform plan to view what will be changed.terraform apply to apply the changes to the cluster.terraform destroy to tear down the resources.Testing is handled using the Terratest framework. Test are written in Go. See terraform/modules/metabase_vm/metabase_vm_test.go for a first example. As the go test command does not have any actual go modules to compile, test files will need to be explicitly called.
Current tests include:
go test terraform/modules/metabase_vm/metabase_vm_test.go -v -timeout 10mImportant note!: These tests deploy and destroy actual working infrastructure, so when creating them ensure you don't conflict with production infrastructure. Also, there may be costs associated with the deploys!
A Metabase instance is spun up in a GCP Compute Engine VM for Pilot usage. Each instantiation of EED's metabase will have a new IP, so you will need to go into the GCP Console to acquire that IP. When logged in, you can go to the Compute Engine VM dashboard and look for an instance named "eed-metabase". You can copy the external IP and access on port :3000.