Make Targets¶

The provider repository, cluster-api-provider-terraform, drives its build, checks, test environment and releases with make. Every tool is a pinned version that make installs into hack/tools/bin on first use, so you need only Go, make, and for some targets podman, python3, git or jq. make with no target, and make help, print the targets with their one-line descriptions, grouped as they are here.

For how the targets fit into a contribution, see Contributing.

The everyday loop¶

For most changes, run this before you push:

make lint test verify

After you change api/v1alpha1 or a controller’s kubebuilder markers, run make generate manifests first. make fmt formats Go code before you lint it.

To try a change against a real cluster, run make testenv-up once, then make testenv-reload after each change. See Test environment.

Variables¶

Set a variable on the command line, as in make docker-build IMG=<image>. Unless the table says otherwise, a variable only affects the targets named in its row.

An empty value takes the default in the table.

General¶

Development¶

Test¶

See Testing for what the tests cover, the coverage floors, and how to run one package or one test.

Test environment¶

The testenv-* targets manage a kind cluster on podman (or docker) with cert-manager, Cluster API and CAPTF built from your working tree. Use it to try a change against a real API server, without a cloud. Each target runs one operation of the e2e-tagged package test/env/lifecycle, with the pinned clusterctl and kustomize. Everything for a cluster <name> lands in bin/testenv/<name>/: its kubeconfig, an env.sh that exports KUBECONFIG, a state.json and the diagnostics bundles.

make testenv-up
source bin/testenv/captf-test-dev/env.sh
kubectl get pods -A
make testenv-reload
make testenv-down

Only cluster names that start with captf-test- are accepted, and the targets never read ~/.kube/config. testenv-up refuses an existing cluster unless CAPTF_TESTENV_REUSE=1 is set. For example, to run a cluster with one worker node next to the default one:

make testenv-up TESTENV_NAME=captf-test-pool TESTENV_WORKERS=1

End-to-end¶

The e2e-* targets run the opt-in e2e suites under test/e2e/. They need podman or docker. make test never compiles them, and CI does not run them. See Testing.

Build¶

make run points the manager at $(RUNNER_IMAGE), which is $(IMG) by default. Build the image first when a Job needs a runner you changed:

make docker-build IMG=<image>
make run RUNNER_IMAGE=<image> ARGS="<flags>"

• <image> is an image reference the cluster can pull, for example localhost/captf:dev on a cluster that shares your image store.
• <flags> are extra manager flags. Leave out ARGS if you have none.

Verify¶

make verify runs every check below. Each one also runs alone, which is faster when only one has failed. Several need python3, git or podman.

verify does not run cover-check, which needs the profiles test-cover writes. CI runs the two as separate steps.

Release¶

These targets build and publish a release. They need a clean tree with HEAD tagged $(VERSION). A tag never moves, so a bad release candidate gets a new one. Releasing has the full procedure. Publishing is for maintainers.

Tools¶

Cleanup¶