API Documentation

jhelm’s library artifacts publish versioned Javadoc to javadoc.io, which serves it automatically from Maven Central — no build or hosting required. The links below track the 1.2.1 release.

1. Javadoc per artifact

Artifact Javadoc

jhelm-core — chart model, rendering engine, action layer, repositories

browse

jhelm-gotemplate-helm — Helm template functions

browse

jhelm-kube — Kubernetes install / upgrade / rollback / uninstall

browse

jhelm-rest — REST API and controllers

browse

jhelm-mcp — MCP server tools

browse

jhelm-plugin — WASM plugin runtime

browse

jhelm-rest-starter and jhelm-mcp-starter are dependency-only starters — they pull in and auto-configure jhelm-rest / jhelm-mcp and carry no code of their own, so their API is the Javadoc of jhelm-rest / jhelm-mcp above. The jhelm-cli application and the sample modules are not published to Maven Central.

2. Key public types

Core engine and model (jhelm-core)

  • Engine — renders a chart to Kubernetes manifests

  • Chart — the in-memory chart model

  • ChartLoader — loads a chart from a directory or archive

  • RepoManager — chart repositories and pulls

  • KubeService — the cluster-operations SPI

Action layer (jhelm-core, package org.alexmond.jhelm.core.action)

  • InstallAction, with the sibling UpgradeAction, UninstallAction, RollbackAction, ListAction, StatusAction, HistoryAction, GetAction, and TemplateAction in the same package.

Helm template functions (jhelm-gotemplate-helm)

  • HelmFunctions — the Helm function provider. The Go template engine itself is the external gotmpl4j library, which publishes its own Javadoc.

Spring Boot auto-configuration entry points