README
¶
NAIS API reconcilers
This repository contains the reconcilers for the NAIS API.
The main purpose is to create team resources, permissions and maintain them.
Local development
nais/api is a dependency for this project. To run the reconciler locally, you need to have the nais/api project cloned and running. See the nais/api README for more information.
Given that a lot of the reconcilers are using external services, most of these requires authentication and access to these services. So ensure that you configure and provide a proper environment for the reconcilers to run. You may use the example configuration file to skip the boring process of figuring it out:
cp .env.example .env
To run the reconciler locally, you can use the following command:
make local
This will build the reconciler and run it locally. It sets an environment variable to communicate with the nais/api project running locally.
Run make test to run the tests.
Architecture
The project contains a set of reconcilers which are run on schedule or triggered by events. A manager is responsible for running the reconcilers and handling the errors.
The manager will listen for pubsub events and trigger the correct reconcilers when needed.
All state and data is stored in NAIS api, and the communication with the API is done through GRPC.
Directories