Skip to main content

Flux

@dataverket/fluxv2026.11.12.1· AGPL-3.0-only· 9d agoBEHAVIORSEXTENDSACCEPTED WARNINGS
01README

Flux for swamp: HelmReleases, Kustomizations and sources as three model types, read with kubectl and driven with the flux CLI; and a directory pushed as an OCI artifact for an OCIRepository to pull. A fork of @ginger_pappa/flux 2026.06.09.1 (MIT, copyright ginger_pappa) merged with the reset method this package used to add to it, so one package owns the types and nothing is pulled from another collective. helmrelease lists releases with chart, requested and applied versions, readiness and source, and reconciles, suspends and resumes one; kustomization does the same for Kustomizations with path, prune and the applied and attempted revisions; source lists GitRepository, HelmRepository and OCIRepository objects with URL, reference and artifact revision, skipping a kind whose CRD is not installed. get reads one HelmRelease in full, so a caller no longer parses the Ready message: every Helm history entry Flux keeps with revision number, status, chart and app version, deploy times, digests and test hook results; whether the last action was an install or an upgrade and whether it succeeded, taken from structured status fields and condition reasons; the failure counters; the attempted and the applied revision; and the Jobs labelled for the release with their hook types and results. A failed or never installed release is recorded, not thrown, and missing hook Jobs are a recorded fact. reset is the recovery action the base type lacked: a reconcile with --reset that clears a HelmRelease's failure counters so helm-controller tries again after RetriesExceeded, then reads the object back and records readiness, the newest Helm history status and both counters, so the outcome is a record and not a log line. Two live pre-flight checks confirm flux and kubectl can be run before anything starts, so a missing binary is a named refusal instead of a spawn error part-way through. push_artifact on the source type is the producer side of an OCIRepository: a directory pushed with flux push artifact, reproducibly, with the source and revision Flux shows on the object that pulls it, OCI annotations, and an optional metadata object written as release.json into a copy of the directory first, so the directory itself is untouched. The record holds the reference by digest and the digest flux printed, so what is signed, promoted or verified afterwards is the artifact as pushed. Changes from upstream: kubectl output that is not JSON is a named error; a HelmRelease declared through chartRef reports that as its source; the spec is read defensively; every kubectl resource is named by its full group; a name or namespace that is not a Kubernetes name is refused before a command runs; every flux and kubectl process has a time limit and is stopped when a run is cancelled; error text is one bounded line with credentials blanked. flux and kubectl are run by name from PATH and the model's namespace, kubeconfig and context are honoured, as upstream did.

02Behaviors3
@dataverket/flux/helmreleasev2026.11.12.1helmrelease.ts
fn list(namespace?: string)
List all HelmReleases with chart versions, ready status, and sync conditions
ArgumentTypeDescription
namespace?string
fn reconcile(name: string, namespace?: string)
Trigger an immediate reconciliation of a HelmRelease, optionally including its source
ArgumentTypeDescription
namestring
namespace?string
fn suspend(name: string, namespace?: string)
Suspend a HelmRelease to pause reconciliation
ArgumentTypeDescription
namestring
namespace?string
fn resume(name: string, namespace?: string)
Resume a previously suspended HelmRelease
ArgumentTypeDescription
namestring
namespace?string

Resources

helmrelease(infinite)— HelmRelease status including chart name, requested and applied versions, sync conditions, and source reference
@dataverket/flux/kustomizationv2026.11.12.1kustomization.ts
fn list(namespace?: string)
List all FluxCD Kustomizations with applied revisions, paths, and sync conditions
ArgumentTypeDescription
namespace?string
fn reconcile(name: string, namespace?: string)
Trigger an immediate reconciliation of a FluxCD Kustomization
ArgumentTypeDescription
namestring
namespace?string
fn suspend(name: string, namespace?: string)
Suspend a FluxCD Kustomization to pause reconciliation
ArgumentTypeDescription
namestring
namespace?string
fn resume(name: string, namespace?: string)
Resume a previously suspended FluxCD Kustomization
ArgumentTypeDescription
namestring
namespace?string

Resources

kustomization(infinite)— FluxCD Kustomization status including source reference, path, applied revision, and sync conditions
@dataverket/flux/sourcev2026.11.12.1source.ts
fn list(namespace?: string, kind?: enum)
List FluxCD sources (GitRepository, HelmRepository, OCIRepository) with artifact revisions and sync state
ArgumentTypeDescription
namespace?string
kind?enum

Resources

source(infinite)— FluxCD source status including URL, artifact revision, sync state, and conditions
03Extends3
@dataverket/flux/helmreleasereset.ts
fn reset(name: string, namespace?: string, withSource?: boolean)
Reconcile a HelmRelease with --reset: clears its failure counters so helm-controller retries a release stuck at RetriesExceeded. Waits for the attempt and records the result. When flux fails and helm-controller did not handle the reset, nothing is recorded and flux's error is thrown.
ArgumentTypeDescription
namestring
namespace?string
withSource?boolean

Resources

resetResult(infinite)— Outcome of a reconcile with --reset: readiness and failure counters afterwards.
@dataverket/flux/helmreleaseget.ts
fn get(name: string, namespace?: string)
Read one HelmRelease with its whole Helm history: revisions with status, chart and digests, test hook results, whether the last action was an install or an upgrade and how it ended, the failure counters, and the Jobs labelled for the release. Read-only; a release that failed is recorded, not thrown.
ArgumentTypeDescription
namestring
namespace?string

Resources

detail(infinite)— One HelmRelease in full: what list stores, every Helm history entry with its test hooks, the last attempted action and how it ended, the failure counters, and the Jobs labelled for the release.
@dataverket/flux/sourcepush_artifact.ts
fn push_artifact(path: string, target?: string, repository?: string, tag?: string, source: string, revision: string, metadata?: record, annotations?: array, insecureRegistry?: boolean)
Push a directory as an OCI artifact with flux push artifact, reproducibly, with release.json from metadata written into a copy first; records the reference and digest
ArgumentTypeDescription
pathstringThe directory to push, absolute or relative to the repository root
target?stringWhere to push, oci://<repository>:<tag>; or give repository and tag
repository?stringThe repository, <registry>/<path>, when target is not given
tag?stringThe tag, when target is not given
sourcestringThe source address Flux shows for the artifact, such as the Git URL; flux's --source
revisionstringThe source revision, <branch|tag>@sha1:<commit>; flux's --revision
metadata?recordWritten as release.json into a copy of the directory before the push; the directory itself is untouched
annotations?arrayOCI annotations on the artifact, key=value
insecureRegistry?booleanPush to a registry served over plain HTTP, flux's --insecure-registry

Resources

artifact(infinite)— One directory pushed as an OCI artifact: repository, tag, the digest flux printed, source and revision, annotations
04Previous Versions6
2026.11.10.1AGPL-3.0-only

updated labels

2026.10.29.1AGPL-3.0-only

Added 3 behaviors. updated labels

2026.10.27.1AGPL-3.0-only(was none)
2026.10.05.1

updated labels

2026.09.29.2
2026.09.29.1
05Stats
A
100 / 100
Downloads
44
Archive size
113.0 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned

07Platforms
08Labels