Skip to content

Latest commit

 

History

History
158 lines (113 loc) · 5.13 KB

DEVELOPMENT.md

File metadata and controls

158 lines (113 loc) · 5.13 KB
Raw

Development

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.

Installing required dependencies

There are a number of dependencies required to be able to run the controller and its test suite locally:

The dependency libgit2 also needs to be installed to be able to run image-automation-controller or its test-suite locally (not in a container).

In case this dependency is not present on your system (at the expected version), the first invocation of a make target that requires the dependency will attempt to compile it locally to hack/libgit2. For this build to succeed ensure the following dependencies are present on your system:

Triggering a manual build of the dependency is possible as well by running make libgit2. To enforce the build, for example if your system dependencies match but are not linked in a compatible way, append LIBGIT2_FORCE=1 to the make command.

Follow the instructions below to install these dependencies to your system.

macOS

$ # Ensure libgit2 dependencies are available
$ brew install cmake [email protected] libssh2 pkg-config
$ LIBGIT2_FORCE=1 make libgit2

openssl and pkg-config

You may see this message when trying to run a build:

# pkg-config --cflags libgit2
Package openssl was not found in the pkg-config search path.
Perhaps you should add the directory containing `openssl.pc'
to the PKG_CONFIG_PATH environment variable
Package 'openssl', required by 'libgit2', not found
pkg-config: exit status 1

On some macOS systems brew will not link the pkg-config file for openssl into expected directory, because it clashes with a system-provided openssl. When installing it, or if you do

brew link [email protected]
Warning: Refusing to link macOS provided/shadowed software: [email protected]
If you need to have [email protected] first in your PATH, run:
  echo 'export PATH="/usr/local/opt/[email protected]/bin:$PATH"' >> ~/.profile

For compilers to find [email protected] you may need to set:
  export LDFLAGS="-L/usr/local/opt/[email protected]/lib"
  export CPPFLAGS="-I/usr/local/opt/[email protected]/include"

For pkg-config to find [email protected] you may need to set:
  export PKG_CONFIG_PATH="/usr/local/opt/[email protected]/lib/pkgconfig"

.. it tells you (in the last part of the message) how to add openssl to your PKG_CONFIG_PATH so it can be found.

Linux

$ # Ensure libgit2 dependencies are available
$ pacman -S cmake openssl libssh2
$ LIBGIT2_FORCE=1 make libgit2

Note: Example shown is for Arch Linux, but likewise procedure can be followed using any other package manager, e.g. apt.

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

  • controller-gen (v0.7.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.17

You can run the test suite by simply doing

make test

How to run the controller locally

Install the controller's CRDs on your test cluster:

make install

Note that image-automation-controller depends on source-controller to acquire its artifacts and image-reflector-controller to access container image metadata. Ensure that they are both running on your test cluster prior to running the image-automation-controller.

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/kustomize-controller
export TAG=latest

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

BUILD_ARGS=--push make docker-build

Note: make docker-build will build images for the amd64,arm64 and arm/v7 architectures.

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 image-automation-controller into the cluster that is configured in the local kubeconfig file (i.e. ~/.kube/config):

make deploy