package kube

ocaml-kube

A native OCaml 5 client and controller runtime for Kubernetes®.

The current release is v0.1.2. The public API is usable, but may still evolve between minor releases while the project is in the 0.x series.

Highlights

• Typed clients for built-in resources and custom resources.
• Generated Kubernetes 1.34–1.37 API packages, plus discovery and dynamic APIs.
• Watches, reflectors, indexed caches, work queues, controllers, and leader election.
• Kubeconfig and in-cluster authentication, TLS, proxies, impersonation, and explicit cancellation.
• Pod logs, exec, attach, and port forwarding.
• CRD generation, admission and conversion webhooks, operator scaffolding, and a deterministic testkit.
• A batteries-included operator runner, declarative owned-child apply, conflict retries, standard status conditions, and compilation-checked common patterns.

Install

OCaml 5.1 or newer and OPAM are required. Install the released package with:

opam install kube

The OPAM package installs the kube libraries and the ocaml-kube scaffolding command.

Build from source

To build the development checkout with its tests and API documentation:

opam install . --deps-only --with-test --with-doc
opam exec -- dune build @all @install @doc @codegen-check
opam exec -- dune runtest

See Getting started for client setup, a typed request, and the local integration example.

Libraries

Documentation

Release history is in CHANGES.md. See CONTRIBUTING.md, SECURITY.md, and the release checklist for project processes.

Licensed under Apache-2.0.