From 2a4ae9896271e72d8aeee88b2dd0041a8e1f7ead Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Mon, 29 Aug 2022 22:36:04 +0200 Subject: [PATCH] docs: add section for local builds (#4445) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: add section for dev tools Signed-off-by: Charles-Edouard Brétéché * docs: add section for local builds Signed-off-by: Charles-Edouard Brétéché * typo Signed-off-by: Charles-Edouard Brétéché Signed-off-by: Charles-Edouard Brétéché --- DEVELOPMENT.md | 48 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d1991fcb50..fcc8da7f9c 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -6,6 +6,7 @@ It contains instructions to build, run, and test Kyverno. - [Tools](#tools) - [Building and publishing an image locally](#building-and-publishing-an-image-locally) +- [Building local binaries](#building-local-binaries) ## Tools @@ -16,17 +17,56 @@ We use `make` to simplify installing the tools we use. Tools will be installed in the `.tools` folder when possible, this allows keeping installed tools local to the Kyverno repository. The `.tools` folder is ignored by `git` and binaries should not be committed. -You can install tools by running: -``` +> **Note**: If you don't install tools, they will be downloaded/installed as necessary when running `make` targets. + +You can manually install tools by running: +```console make install-tools ``` To remove installed tools, run: -``` +```console make clean-tools ``` -> **Note**: If you don't install tools, they will be downloaded/installed as necessary when running `make` targets. +## Building local binaries + +The Kyverno repository contains code for three different binaries: +- [`kyvernopre`](#building-kyvernopre-locally): + Binary to update/cleanup existing resources in clusters. This is typically run as an init container before Kyverno controller starts. +- [`kyverno`](#building-kyverno-locally): + The Kyverno controller binary. +- [`cli`](#building-cli-locally): + The Kyverno command line interface. + +> **Note**: You can build all binaries at once by running `make build-all`. + +### Building kyvernopre locally + +To build `kyvernopre` binary on your local system, run: +```console +make build-kyvernopre +``` + +The binary should be created at `./cmd/initContainer/kyvernopre`. + +### Building kyverno locally + +To build `kyverno` binary on your local system, run: +```console +make build-kyverno +``` + +The binary should be created at `./cmd/kyverno/kyverno`. + +### Building cli locally + +To build `cli` binary on your local system, run: +```console +make build-cli +``` + +The binary should be created at `./cmd/cli/kubectl-kyverno/kubectl-kyverno`. ## Building and publishing an image locally