Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.48 KB

DEVELOPMENT.md

File metadata and controls

55 lines (38 loc) · 1.48 KB
Raw

Development

Note: Please take a look at https://fluxcd.io/contributing/flux/ to find out about how to contribute to Flux and how to interact with the Flux Development team.

Installing required dependencies

There are a number of dependencies required to be able to run image-reflector-controller and its test-suite locally.

How to run the test suite

Prerequisites:

  • go >= 1.16
  • kustomize >= 3.1

You can run them by simply doing

make test

Note: Since this will also trigger generating some files such as manifests, it is advised to run this prior to committing your changes, especially when making API changes.

Please refer to the Makefile to see all make targets and what they do.

How to install the controller

You can install the CRDs and the controller by simply doing

# Install CRDs into a cluster
make install
# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
make deploy

How to run the controller locally

You can run the controller on your host by

make run

How to generate and update CRDs API reference documentation

If you made any changes to CRDs API, you can update CRDs API reference doc by

make api-docs