NAIS API

NAIS API is the main entrypoint when interacting with the API of the NAIS platform.

Local development

asdf install # Install required dependencies
docker compose up -d
make setup-local # Setup local environment (seeds database and creates pubsub topic)
make local

For local development you need to set the WITH_FAKE_CLIENTS environment variable to true (as set by make local), and you will also need to set the X-User-Email header to [email protected] if you want to act as a regular user, or [email protected] if you need an admin user.

Development practices

Check practices used in this project here: docs/practices.md

Graph-API

We have defined a set of practices for the Graph-API in the docs/graphql_practices.md file.

Fake clients

We have a set of fake clients, and stubs, that can be used for local development. One of the clients is a fake Kubernetes client that read data from data/k8s. You can read more about how the fake clients works in the data/k8s/README.md file.

Architecture

graph TD
  API --> Postgres[(psql)]
  Service[NAIS Service] --> |GRPC|API
  Clients[External Clients] --> |GraphQL|API
  API -.-> PubSub{PubSub}

  subgraph ext [External data]
    API --> K8s([Kubernetes])
    API --> Prom([Prometheus])
    API --> GA([Google Admin])
    API --> BQ([BigQuery])
  end

Loading

Component	Description
API	This service
Postgres	The postgres database storing state from this application
NAIS Service	Services by NAIS that requires special communication with API. E.g. Reconcilers and Deploy
External Clients	External clients that communicates with the API. E.g. Browsers and NADA
Kubernetes	The Kubernetes clusters of the tenant
PubSub	The PubSub topic used for communication between the API and the NAIS Service
Prometheus	We collect historic data from the tenants prometheus
Google Admin	We use the Google Admin API to manage a list of users
BigQuery	We collect historic cost data from BigQuery