Skip to content

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 ​

ComponentWhat it containsReleases
CMK serviceAPI server, tenant manager, event reconciler, task scheduler and worker, database migrator, cmkctlcmk
CMK UIWeb consolecmk-ui
RegistryRegistry of tenants and systemsregistry
ExtAuthZRequest authentication and authorization at the gatewayextauthz
Session ManagerBrowser sign-in and sessionssession-manager
CMK-2-Krypton BridgeConnection from CMK to Kryptoncmk-krypton-bridge
CheckerHealth of the cluster and versions of the services, over HTTPchecker
Keystore pluginsAWS KMS and other keystore integrationskeystore-plugins
Identity management pluginsSCIM directory integrationidentity-management-plugins

Krypton ​

ComponentWhat it containsReleases
KryptonRoot server, agents and command-line clientkrypton

Libraries ​

These libraries are used by the services. You need them only if you build your own integration or plugin.

LibraryPurposeReleases
plugin-sdkBuild keystore and identity management pluginsplugin-sdk
orbitalJobs and tasks between services over AMQPorbital
api-sdkgRPC API definitions shared between servicesapi-sdk
common-sdkConfiguration, logging, audit and authentication helperscommon-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.

ServiceHelm chartContainer image
CMKoci://ghcr.io/openkcm/charts/cmkghcr.io/openkcm/cimages/mk/cmk-full-plugins
CMK UIoci://ghcr.io/openkcm/charts/cmk-uighcr.io/openkcm/images/cmk-ui
Registryoci://ghcr.io/openkcm/charts/registryghcr.io/openkcm/images/registry
ExtAuthZoci://ghcr.io/openkcm/charts/extauthzghcr.io/openkcm/images/extauthz
Session Manageroci://ghcr.io/openkcm/charts/session-managerghcr.io/openkcm/images/session-manager
Checkeroci://ghcr.io/openkcm/charts/checkerghcr.io/openkcm/images/checker
Krypton root server and agentoci://ghcr.io/openkcm/charts/krypton-rootghcr.io/openkcm/images/krypton/root, ghcr.io/openkcm/images/krypton/agent
CMK-2-Krypton Bridgeoci://ghcr.io/openkcm/charts/cmkkryptonbridgeghcr.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; set image.tag or image.digest only to deploy another service version.
  • Chart documentation. Each chart's README.md lists the resources it creates and its upgrade notes, and its values.yaml documents every value, including every setting of the service, with examples. Both are in the charts/ directory of the service repository.
  • Plugins are not deployed on their own: the CMK image cmk-full-plugins contains the binaries of the plugin images ghcr.io/openkcm/images/keystore-plugins and ghcr.io/openkcm/images/identity-management-plugins.
  • Krypton is in pre-production. The krypton-root chart 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.

See also ​

EU and German government funding logos

Funded by the European Union – NextGenerationEU.

The views and opinions expressed are solely those of the author(s) and do not necessarily reflect the views of the European Union or the European Commission. Neither the European Union nor the European Commission can be held responsible for them.