kubepkg

module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2026 License: Apache-2.0

README

kubepkg

A package layer for people who build platforms and distributions on Kubernetes: versioned packages made from ordinary Helm charts, requirements on packages and capabilities, conflicts, CRD ownership, a plan before every change, and whole-package rollback where it is declared safe.

kubepkg works alongside Helm, werf, Flux and Argo CD rather than replacing them.

It runs in any Kubernetes cluster and can be embedded in a platform through configuration, without code changes.

Status: stable; the API is v1 and changes only in compatible ways.

kubepkg moved to the kuberoot-dev organization in 1.2.0. The Go module is now github.com/kuberoot-dev/kubepkg; releases up to 1.1.0 stay available under github.com/tym83/kubepkg. The operator image and the chart are published under ghcr.io/kuberoot-dev, the example repository's index is at https://kuberoot-dev.github.io/kubepkg-recipes/index.yaml, and the documentation at the address below. Old git and web links to GitHub redirect.

Documentation: https://kuberoot-dev.github.io/kubepkg/, starting with the quickstart.

Licensed under the Apache License 2.0.

Directories

Path Synopsis
api
v1
Package v1 contains the kubepkg API.
Package v1 contains the kubepkg API.
v1alpha1
Package v1alpha1 contains the first kubepkg API.
Package v1alpha1 contains the first kubepkg API.
v1beta1
Package v1beta1 contains the kubepkg API.
Package v1beta1 contains the kubepkg API.
cmd
kubepkg command
Command kubepkg is the kubepkg CLI.
Command kubepkg is the kubepkg CLI.
kubepkg-operator command
Command kubepkg-operator runs the kubepkg operator with its standard options.
Command kubepkg-operator runs the kubepkg operator with its standard options.
hack
gendocs command
Command gendocs writes the CLI and API reference pages from the commands and the CRDs themselves, so they cannot drift from the code.
Command gendocs writes the CLI and API reference pages from the commands and the CRDs themselves, so they cannot drift from the code.
pkg
admission
Package admission keeps pods in package namespaces on the images their packages pin: a tag a package pins becomes that tag at its digest, and in enforce mode an image no installed package vouches for is refused.
Package admission keeps pods in package namespaces on the images their packages pin: a tag a package pins becomes that tag at its digest, and in enforce mode an image no installed package vouches for is refused.
backend
Package backend defines how a package component reaches the cluster.
Package backend defines how a package component reaches the cluster.
backend/argo
Package argo is the backend that installs through Argo CD: one Application per component, pointing at the component's published chart, synced automatically.
Package argo is the backend that installs through Argo CD: one Application per component, pointing at the component's published chart, synced automatically.
backend/flux
Package flux is the backend that installs through Flux: for every component it writes the chart's source (an OCIRepository for charts in a registry, a HelmRepository otherwise) and a HelmRelease, and lets source-controller and helm-controller do the rest.
Package flux is the backend that installs through Flux: for every component it writes the chart's source (an OCIRepository for charts in a registry, a HelmRepository otherwise) and a HelmRelease, and lets source-controller and helm-controller do the rest.
backend/helm
Package helm is the backend that installs charts with the Helm SDK inside the operator.
Package helm is the backend that installs charts with the Helm SDK inside the operator.
backend/werf
Package werf is the backend that installs through Nelm, the deployment engine of werf: the operator prepares charts as for the helm backend and runs nelm for each component.
Package werf is the backend that installs through Nelm, the deployment engine of werf: the operator prepares charts as for the helm backend and runs nelm for each component.
build
Package build turns recipes into installable packages.
Package build turns recipes into installable packages.
bundle
Package bundle carries packages into clusters that cannot reach the places they were published: a bundle holds the signed repository files, the charts, package trees and images of the chosen packages, and is checked against the repository's signatures again before anything from it is copied into a mirror registry.
Package bundle carries packages into clusters that cannot reach the places they were published: a bundle holds the signed repository files, the charts, package trees and images of the chosen packages, and is checked against the repository's signatures again before anything from it is copied into a mirror registry.
cli
Package cli holds the kubepkg commands.
Package cli holds the kubepkg commands.
controller
Package controller reconciles Packages into package revisions.
Package controller reconciles Packages into package revisions.
images
Package images finds the container images manifests run, normalises their references and pins them by digest.
Package images finds the container images manifests run, normalises their references and pins them by digest.
operator
Package operator assembles the kubepkg operator.
Package operator assembles the kubepkg operator.
repo
Package repo builds and reads package repository indexes.
Package repo builds and reads package repository indexes.
resolve
Package resolve decides which package versions to install and whether a package's requirements and conflicts are satisfied.
Package resolve decides which package versions to install and whether a package's requirements and conflicts are satisfied.
sbom
Package sbom describes packages as CycloneDX software bills of materials: what each package is, which charts and container images it installs, pinned by digest, and which packages it requires.
Package sbom describes packages as CycloneDX software bills of materials: what each package is, which charts and container images it installs, pinned by digest, and which packages it requires.
source
Package source fetches package trees and composes charts from them.
Package source fetches package trees and composes charts from them.
version
Package version holds the kubepkg version, set at build time:
Package version holds the kubepkg version, set at build time:

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL