Skip to main content

Backend

Headlamp's backend is written in Go and is in charge of redirecting the client requests to the right clusters, as well as to return any available plugins for the client to use.

The backend most basic and essential function is to read the cluster information from the given configuration, and set up proxies to the defined clusters as well as endpoints to them. This means that instead of having a set of endpoints related to the functionality available to the client, it simply redirects the requests to the defined proxies.

Building and running

The backend (Headlamp's server) can be quickly built using:

make backend

Once built, it can be run in development mode (insecure / don't use in production) using:

make run-backend

Lint

To lint the backend/ code.

make backend-lint

Format

To format the backend code.

make backend-format

Test

make backend-test