diff --git a/README.md b/README.md index 73a28f8..6ce3797 100644 --- a/README.md +++ b/README.md @@ -194,13 +194,22 @@ Workspace Name "compatibility": [ { "version": "1.16.x", - "image": "kasmweb/vs-code:1.16-rolling", - "uncompressed_size_mb": 2428 + "image": "kasmweb/vs-code:1.16", + "uncompressed_size_mb": 2428, + "available_tags": [ + "develop", + "1.16.0" + ] + }, { "version": "1.17.x", - "image": "kasmweb/vs-code:1.17-rolling", - "uncompressed_size_mb": 2528 + "image": "kasmweb/vs-code:1.17", + "uncompressed_size_mb": 2528, + "available_tags": [ + "develop", + "1.17.0" + ] } ] } @@ -248,7 +257,9 @@ Kasm Workspaces will automatically pull the version of the schema that it unders 1.17.x changed the schema from 1.0 to 1.1, the main changes to this are the compatibility changes from a simple array to an array of objects, this allows us to tie the image used and the image size to the kasm version. In addition the top level name is removed as is top level uncompessed_size_mb as these are now available in the compatibility matrix (name is called image). -Finally change references to 1.0 to 1.1 in `build_all_branches.sh` and `site/next.config.js` + +## Channels +Schema 1.1 added the concept of channels. Each registry can specify the channels they support, these are defined by the tags an image has. For example you might have develop, 1.17.0 and 1.17.0-rolling-daily. When the registry json is built it loops through all the workspaces and generates a list of all the possible "Channels" (tags) that are listed in compatibility.available_tags. Available tags is an optional list, if you don't include it on any of the workspaces then your registry will work as before without presenting the end user with a channels option. You shouldn't mix and match though, if you add available tags to 1 workspace, you should add available tags to all workspaces.