Bifröst

Bifröst is a portal for managing Frontend Platform resources. In Norse mythology, Bifröst is a bridge that connects Midgard, the realm of humans, with Asgard, the realm of the gods. At NAV Bifröst is a bridge that connects developers with the resources they need to build and run their frontend applications.

Features

[x] Manage Unleash Instances

Pre-requisites

Google Clooud Service Account

Bifröst needs a Google Cloud service account with the following roles:

Cloud SQL Admin

Google Cloud Resources

Bifröst needs the following Google Cloud resources:

A Google Cloud PostgreSQL instance for Unleash databases

Kubernetes Resources

Bifröst needs the following Kubernetes resources:

Configuration

Bifröst is configured using environment variables. The following variables are required:

Google Configuration

Variable	Description
`BIFROST_GOOGLE_PROJECT_ID`	The Google Cloud project ID
`BIFROST_GOOGLE_PROJECT_NUMBER`	The Google Cloud project number
`BIFROST_GOOGLE_IAP_BACKEND_SERVICE_ID`	The Google Cloud IAP backend service ID

IAP Backend Service ID

To find the required IAP Eackend Service ID you can do one of two ways:

Using the gcloud cli using the OAuth client ID for the IAP:

gcloud compute backend-services list \
  --filter "iap.oauth2ClientId=<CLIENT_ID>" \
  --format "value(id)"

Using the Google Cloud Console:

Go to the Identity-Aware Proxy page
Find the correct load balancer in the list
Click the Get JWT audience code from the list
Copy the last number in the string which is the Backend Service ID

Unleash Configuration**

Variable	Description
`BIFROST_UNLEASH_INSTANCE_NAMESPACE`	The Kubernetes namespace where Unleash instances are deployed
`BIFROST_UNLEASH_INSTANCE_SERVICE_ACCOUNT`	The Kubernetes service account used by Unleash instances
`BIFROST_UNLEASH_SQL_INSTANCE_ID`	The SQL instance ID for Unleash databases
`BIFROST_UNLEASH_SQL_INSTANCE_REGION`	The SQL instance region for Unleash databases
`BIFROST_UNLEASH_SQL_INSTANCE_ADDRESS`	The SQL instance address for Unleash databases
`BIFROST_UNLEASH_INSTANCE_WEB_INGRESS_HOST`	The ingress host for Unleash instances Web UI
`BIFROST_UNLEASH_INSTANCE_WEB_INGRESS_CLASS`	The ingress class for Unleash instances Web UI
`BIFROST_UNLEASH_INSTANCE_API_INGRESS_HOST`	The ingress host for Unleash instances API
`BIFROST_UNLEASH_INSTANCE_API_INGRESS_CLASS`	The ingress class for Unleash instances API

Local development

Prerequisite

Google Cloud Service Account
Local Kubernetes Cluster

With you local Kubernetes cluster apply the required custom resource definitions:

kubectl apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/gke-fqdnnetworkpolicies-golang/main/config/crd/bases/networking.gke.io_fqdnnetworkpolicies.yaml
kubectl apply -f https://raw.githubusercontent.com/nais/unleasherator/main/config/crd/bases/unleash.nais.io_unleashes.yaml

Environment variables

The following environment variables needs to be set in addition to the configuration variables above:

Variable	Value	Description
`BIFROST_SERVER_HOST`	`127.0.0.1`	The host for the Bifröst server
`GOOGLE_APPLICATION_CREDENTIALS`		Google Cloud service account credentials
`KUBECONFIG`		Path to Kubernetes configuration file

Start the server

make start

License

MIT

nais / bifrost

readme