Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-05-02 14:26:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

rfc: add numeric ids to existing RFCs (#2638)

Browse source 
* rfc: add numeric ids to existing RFCs
This commit is contained in:
Markus Rudy 2023-11-23 17:53:38 +01:00 • committed by GitHub
parent 0564e4ebb4
commit d3b542d781
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 28 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

32
rfc/010-cli-api.md Normal file
View file

@ -0,0 +1,32 @@
# RFC 010: 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:
- `GET /constellation/v1/ref/<REF>/stream/<STREAM>/<VERSION>/cli/`
- [`info.json` returns the CLI compatibility information artifact for the given Constellation version.](#cli-lookup-table)
## 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
```
```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`.