Releases
Each OpenKCM service and library is released on its own, from its own GitHub repository. This page tells you where to find the releases, the release notes and the deployable artifacts of every component.
Versioning
- Every repository follows semantic versioning. Versions below 1.0 can change in incompatible ways between minor releases, so read the release notes before you upgrade.
- Most repositories create their releases from conventional commits, so each release lists its features, fixes and breaking changes. The release notes are on the GitHub release page, and most repositories also keep a
CHANGELOG.md. - The services do not share a version number. Upgrade them one at a time and check the release notes of each.
CMK
| Component | What it contains | Releases |
|---|---|---|
| CMK service | API server, tenant manager, event reconciler, task scheduler and worker, database migrator, cmkctl | cmk |
| CMK UI | Web console | cmk-ui |
| Registry | Registry of tenants and systems | registry |
| ExtAuthZ | Request authentication and authorization at the gateway | extauthz |
| Session Manager | Browser sign-in and sessions | session-manager |
| CMK-2-Krypton Bridge | Connection from CMK to Krypton | cmk-krypton-bridge |
| Checker | Health of the cluster and versions of the services, over HTTP | checker |
| Keystore plugins | AWS KMS and other keystore integrations | keystore-plugins |
| Identity management plugins | SCIM directory integration | identity-management-plugins |
Krypton
| Component | What it contains | Releases |
|---|---|---|
| Krypton | Root server, agents and command-line client | krypton |
Libraries
These libraries are used by the services. You need them only if you build your own integration or plugin.
| Library | Purpose | Releases |
|---|---|---|
| plugin-sdk | Build keystore and identity management plugins | plugin-sdk |
| orbital | Jobs and tasks between services over AMQP | orbital |
| api-sdk | gRPC API definitions shared between services | api-sdk |
| common-sdk | Configuration, logging, audit and authentication helpers | common-sdk |
Artifacts
Every service is published as a container image and a Helm chart in the GitHub Container Registry. The charts are OCI artifacts: install them directly from the registry, without helm repo add.
| Service | Helm chart | Container image |
|---|---|---|
| CMK | oci://ghcr.io/openkcm/charts/cmk | ghcr.io/openkcm/cimages/mk/cmk-full-plugins |
| CMK UI | oci://ghcr.io/openkcm/charts/cmk-ui | ghcr.io/openkcm/images/cmk-ui |
| Registry | oci://ghcr.io/openkcm/charts/registry | ghcr.io/openkcm/images/registry |
| ExtAuthZ | oci://ghcr.io/openkcm/charts/extauthz | ghcr.io/openkcm/images/extauthz |
| Session Manager | oci://ghcr.io/openkcm/charts/session-manager | ghcr.io/openkcm/images/session-manager |
| Checker | oci://ghcr.io/openkcm/charts/checker | ghcr.io/openkcm/images/checker |
| Krypton root server and agent | oci://ghcr.io/openkcm/charts/krypton-root | ghcr.io/openkcm/images/krypton/root, ghcr.io/openkcm/images/krypton/agent |
| CMK-2-Krypton Bridge | oci://ghcr.io/openkcm/charts/cmkkryptonbridge | ghcr.io/openkcm/images/cmk-krypton-bridge |
Show the latest version of a chart, and the service version it deploys by default (appVersion), with:
bash
helm show chart oci://ghcr.io/openkcm/charts/cmk- Chart and service versions. Each chart deploys, by default, the service version it was released with: the image tag defaults to the chart's
appVersion. Pin the chart version with--version; setimage.tagorimage.digestonly to deploy another service version. - Chart documentation. Each chart's
README.mdlists the resources it creates and its upgrade notes, and itsvalues.yamldocuments every value, including every setting of the service, with examples. Both are in thecharts/directory of the service repository. - Plugins are not deployed on their own: the CMK image
cmk-full-pluginscontains the binaries of the plugin imagesghcr.io/openkcm/images/keystore-pluginsandghcr.io/openkcm/images/identity-management-plugins. - Krypton is in pre-production. The
krypton-rootchart deploys the root server; see Install the root node. - The CMK-2-Krypton Bridge is in early development; see its current state.
Use explicit chart versions, and image tags or digests, rather than latest.