Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00
Code Issues Packages Projects Releases Wiki Activity
81f79d943a
constellation/rfc/cli-api.md
Moritz Sanft c3347f2eb5
rfc: specify cli version api (#1175) 
* add cli compatibility api rfc

* fix typos

* rewording
2023-02-17 10:32:48 +01:00

1.3 KiB
Raw Blame History

CLI compatibility information

The CLI API provides information about the compatibility of the Constellation CLI and other components of the Constellation ecosystem such as Kubernetes versions.

CLI API Endpoints

The build pipeline produces artifacts for compatibility information that are uploaded to S3 and can be accessed via HTTP. The artifacts are organized in a directory structure that allows to look up the compatibility for a given Constellation version.

The following HTTP endpoints are available:

CLI information artifact

The CLI compatibility information artifact is a JSON file that maps the image name consisting of ref, stream and version to the corresponding CLI version and it's compatibility information:

/constellation/v1/ref/<REF>/stream/<STREAM>/<VERSION>/cli/info.json

{
  "version": "<VERSION>",
  "ref": "<REF>",
  "stream": "<STREAM>",
  "kubernetes": ["v1.1.23", "v1.1.24", "v1.1.25"]
}

This shows that the Constellation CLI version <VERSION> is compatible with Kubernetes versions v1.1.23, v1.1.24 and v1.1.25.