File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change @@ -278,6 +278,36 @@ and new fields on messages may be added if they are optional.
278
278
to the API by having a diff that the CI can run. These files are not intended to be
279
279
consumed or used by clients.
280
280
281
+ As of containerd 2.0, the API version diverges from the main containerd version.
282
+ While containerd 2.0 is a _ major_ version jump for containerd, the API will remain
283
+ on 1.x to remain backwards compatible with prior releases and existing clients.
284
+ The 2.0 release adds the API to a separate Go module which can remain as the
285
+ ` github.com/containerd/containerd/api ` Go package and imported separately from the
286
+ rest of containerd.
287
+
288
+ The API minor version will continue to be incremented for each major and minor
289
+ version release of containerd. However, the API is tagged directly out of the
290
+ main branch with the minor version incrementing earlier in the next release cycle
291
+ rather than at the end. This means that after the containerd 2.0 release, the next
292
+ API change is tagged as ` api/v1.9.0 ` prior to any containerd 2.1 release. The
293
+ latest API version should be backported to all supported versions and patch
294
+ releases for prior API versions should be avoided if possible.
295
+
296
+
297
+ | Containerd Version | API Version at Release |
298
+ | --------------------| ------------------------|
299
+ | v1.0 | 1.0 |
300
+ | v1.1 | 1.1 |
301
+ | v1.2 | 1.2 |
302
+ | v1.3 | 1.3 |
303
+ | v1.4 | 1.4 |
304
+ | v1.5 | 1.5 |
305
+ | v1.6 | 1.6 |
306
+ | v1.7 | 1.7 |
307
+ | v2.0 | 1.8 |
308
+ | next | 1.9 |
309
+
310
+
281
311
### Metrics API
282
312
283
313
The metrics API that outputs prometheus style metrics will be versioned independently,
You can’t perform that action at this time.
0 commit comments