Skip to content
Status and compatibility

Status and compatibility

kslate is pre-1.0. This page says what that means for each piece you depend on, so you can decide what to build against now.

Where each piece stands

PieceState
Error bodiesSTALE, STALE_PREMISE and HELD are normative, field names included. Changing one changes the HTTP API page in the same pull request.
The six operationsget, put, append, claim, checkpoint and query, the same over HTTP/JSON, gRPC and MCP.
The SharedContext CRDkslate.dev/v1alpha1. The shape can change before 1.0. helm upgrade does not update the CRD. You apply it.
The Helm chartChart 0.9.0, app version 0.9.0, installed from a checkout of the repository. Not published to a registry.
Container imagesNone published. You build kslate and kslate-reconciler yourself.
The Python clientVersion 0.9.0 in client/python. Not on PyPI. Install from a checkout.
The Go clientclient/go, import path kslate.dev/kslate/client/go. The path does not serve module metadata yet, so you add a replace.
The gRPC APIkslate.v1.KslateService, defined in proto/kslate/v1/kslate.proto.
The database schemaNumbered migrations compiled into the binary and applied when it starts. See Upgrade.
ReleasesNo release is tagged yet. Release notes come from the merged pull requests at release time.
FixesBefore 1.0, only the latest release gets fixes.

What may change

The error bodies and the six operations are the contract. These may change in a release before 1.0:

  • the CRD shape
  • the client APIs
  • the CLI flags
  • the chart values
  • the metric names

The release notes say what changed. Read them before you upgrade.

Where to look

  • Honest limits for what is designed but not built, and what kslate does not check.
  • Upgrade for moving a running install to a new build.