Skip to content

Latest commit

 

History

History
172 lines (113 loc) · 4.72 KB

DEVELOPMENT.md

File metadata and controls

172 lines (113 loc) · 4.72 KB
Raw

Development

We follow the Flux development best practices.

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

Developer Certificate of Origin

By submitting any contributions to this repository as an individual or on behalf of a corporation, you agree to the Developer Certificate of Origin.

Code Reviews

Although you are a contributor with the write access to this repository, please do not merge PRs by yourself. Please ask the project's maintainers to merge them for you after reviews.

Protobuf Setup

TF-controller requires a specific version of Protobuf compiler and its Go plugins.

  • Protoc: version 3.19.4
  • Go plugin: go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.27.1
  • Go plugin: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

These can be installed by running make tools.

How to run the test suite

Prerequisites:

  • go = 1.20.x
  • kubebuilder = 3.6.x
  • controller-gen = 0.15.x
  • kustomize = 4.x
  • kubectl >= 1.21

You can run the unit tests by simply doing

make test

If you get an error stating "etcd" not found then run:

make install-envtest

and then retry make test

GRPC

Any changes to the runner.pb.go file will require you to regenerate the necessary proto files.

To do so, first run:

make protoc-gen-go-grpc

to install the library and then:

make gen-grpc

to update the the generated runner.pg.go data.

How to run the controller locally

Prerequisites:

  • go
  • kind
  • kubectl
  • tilt
  • docker
  • flux

Start the KinD cluster with a local registry and install flux:

./tools/reboot.sh

Build the containers and run them in the KinD cluster:

# GITHUB_TOKEN is used by the branch planner and requires read access to the targeted repository.
# If you do not intend to use the branch planner, then you can set it to a random non-empty string. 
export GITHUB_TOKEN=<token>
tilt up

Tilt will automatically detect code changes which will retrigger a build and redeploy.

How to install the controller

Building the container image

Set the name of the container image to be created from the source code. This will be used when building, pushing and referring to the image on YAML files:

export MANAGER_IMG=registry-path/tf-controller

Build the container image, tagging it as $MANAGER_IMG:latest:

make docker-build

Push the image into the repository:

make docker-push

Note: make docker-build will build an image for the amd64 architecture.

Deploying into a cluster

Deploy tf-controller into the cluster that is configured in the local kubeconfig file (i.e. ~/.kube/config):

make deploy

Running the above will also deploy source-controller and its CRDs to the cluster.

Debug

sudo dlv --listen=:2345 --headless=true --api-version=2 attach $(pgrep tf-controller)

Communications

For realtime communications we use Slack: To join the conversation, simply join the Weave Users Slack workspace and use the #tf-controller channel.

To discuss ideas and specifications we use Github Discussions.

Acceptance policy

These things will make a PR more likely to be accepted:

  • a well-described requirement
  • tests for new code
  • tests for old code!
  • new code and tests follow the conventions in old code and tests
  • a good commit message (see below)
  • all code must abide Go Code Review Comments
  • names should abide What's in a name
  • code must build on both Linux and Darwin, via plain go build
  • code should have appropriate test coverage and tests should be written to work with go test

In general, we will merge a PR once one maintainer has endorsed it. For substantial changes, more people may become involved, and you might get asked to resubmit the PR or divide the changes into more than one PR.

Format of the Commit Message

We prefer the following rules for good commit messages:

  • Limit the subject to 50 characters and write as the continuation of the sentence "If applied, this commit will ..."
  • Explain what and why in the body, if more than a trivial change; wrap it at 72 characters.

The following article has some more helpful advice on documenting your work.