Skip to content

Install

This page covers the practical commands for running kleym, deploying it, testing it, and previewing the documentation site locally.

Prerequisites

  • Go 1.25+
  • Docker
  • kubectl
  • Access to a Kubernetes cluster
  • kind for make test-e2e

The repository bootstraps local tool binaries under bin/ through make targets, so you do not need to install controller-gen, kustomize, setup-envtest, or golangci-lint globally.

Run Locally

Run the controller against your current kubeconfig:

make run

Build the manager binary:

make build

Deploy

Install the CRD into the current cluster:

make install

Deploy the controller image:

make deploy IMG=<registry>/kleym:<tag>

Render the consolidated installer manifest:

make build-installer

Test

Run controller and API tests:

make test

Run lint:

make lint

Run Kind-backed end-to-end coverage:

make test-e2e

Use the smallest command set that proves the change. See contributing for the repository validation expectations.

Preview Docs

Serve the MkDocs site with the pinned container image:

make docs-serve

Build the static site locally:

make docs-build

Override the port if you need something other than 8000:

make docs-serve DOCS_PORT=8080

If you prefer a local Python workflow instead of the containerized one, requirements-docs.txt still pins the MkDocs dependencies for that path.