Skip to content

Latest commit

 

History

History
139 lines (98 loc) · 3.55 KB

DEVELOPMENT.md

File metadata and controls

139 lines (98 loc) · 3.55 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 the controller and its test suite locally:

In addition to the above, the following dependencies are also used by some of the make targets:

  • controller-gen (v0.12.0)
  • gen-crd-api-reference-docs (v0.3.0)
  • setup-envtest (latest)

If any of the above dependencies are not present on your system, the first invocation of a make target that requires them will install them.

How to run the test suite

Prerequisites:

  • Go >= 1.23

You can run the test suite by simply doing

make test

Additional test configuration

By setting the GO_TEST_ARGS environment variable you can pass additional flags to go test:

make test GO_TEST_ARGS="-v -run=TestReadIgnoreFile/with_domain"

How to run the controller locally

Install the controller's CRDs on your test cluster:

make install

Run the controller locally:

make run

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 IMG=registry-path/source-controller
export TAG=latest # optional

Build the container image, tagging it as $(IMG):$(TAG):

make docker-build

Push the image into the repository:

make docker-push

Alternatively, the three steps above can be done in a single line:

IMG=registry-path/source-controller TAG=latest BUILD_ARGS=--push \
    make docker-build

For an extensive list of BUILD_ARGS, refer to the docker buildx build options documentation.

Note: make docker-build will build images for all supported architecture by default. Limit this to a specific architecture for faster builds:

IMG=registry-path/source-controller TAG=latest BUILD_ARGS=--push BUILD_PLATFORMS=amd64 \
    make docker-build

If you get the following error when building the docker container:

Multiple platforms feature is currently not supported for docker driver.
Please switch to a different driver (eg. "docker buildx create --use")

you may need to create and switch to a new builder that supports multiple platforms:

docker buildx create --use

Deploying into a cluster

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

make deploy

Debugging controller with VSCode

Create a .vscode/launch.json file:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch Package",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceFolder}/main.go",
            "args": ["--storage-adv-addr=:0", "--storage-path=${workspaceFolder}/bin/data"]
        }
    ]
}

Start debugging by either clicking Run > Start Debugging or using the relevant shortcut.