Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add various instructions on development documentation #191

Closed
wants to merge 18 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
> 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.
* [Install Go](https://golang.org/doc/install)
* [Install Kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/)
* [Install Docker](https://docs.docker.com/engine/install/)
* [Install Kubebuilder](https://book.kubebuilder.io/quick-start.html)
tomhuang12 marked this conversation as resolved.
Show resolved Hide resolved

## How to run the test suite

Prerequisites:
Expand All @@ -16,3 +23,30 @@ You can run the unit tests by simply doing
```bash
make test
tomhuang12 marked this conversation as resolved.
Show resolved Hide resolved
```

## How to install the controller

You can install the CRDs and the controller by simply doing

```bash
# 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

```bash
make run
```

## How to generate and update CRDs API reference documentation

You can update CRDs API reference doc by

```bash
make gen-crd-api-reference-docs
tomhuang12 marked this conversation as resolved.
Show resolved Hide resolved
```
tomhuang12 marked this conversation as resolved.
Show resolved Hide resolved