Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.26 KB
Raw

Contributing

Issues

Add as much info, such as logs, versions and CR-definitions to the issue.

Pull-requests

Create PRs including tests. Make sure you run make manifests fmt vet prior to opening the PR as this will update any API-defintion changes and format/vet the code.

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation