containerd

History

Akihiro Suda a2472c0b5a transfer: add OCI descriptors to Progress structure The index media type and the digest are now shown in `ctr images pull --local=false` Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>		2024-01-11 23:56:13 +09:00
..
events	Update go module to github.com/containerd/containerd/v2	2023-10-29 20:52:21 -07:00
runtime	Update go module to github.com/containerd/containerd/v2	2023-10-29 20:52:21 -07:00
services	api: introduce sync_fs to diff.ApplyRequest	2023-12-12 10:18:39 +08:00
types	transfer: add OCI descriptors to Progress structure	2024-01-11 23:56:13 +09:00
1.0.pb.txt	Remove the executable bit for api/*.txt files	2020-02-19 16:32:52 +07:00
1.1.pb.txt	Remove the executable bit for api/*.txt files	2020-02-19 16:32:52 +07:00
1.2.pb.txt	Remove the executable bit for api/*.txt files	2020-02-19 16:32:52 +07:00
doc.go	Introduce a new go module - containerd/api for use in standalone clients	2021-07-27 07:34:59 -04:00
next.pb.txt	transfer: add OCI descriptors to Progress structure	2024-01-11 23:56:13 +09:00
Protobuild.toml	Cleanup protobuild config	2023-03-22 13:28:41 +08:00
README.md	Minor typo fix.	2017-08-10 06:23:21 +00:00

README.md

This directory contains the GRPC API definitions for containerd.

All defined services and messages have been aggregated into *.pb.txt descriptors files in this directory. Definitions present here are considered frozen after the release.

At release time, the current next.pb.txt file will be moved into place to freeze the API changes for the minor version. For example, when 1.0.0 is released, next.pb.txt should be moved to 1.0.txt. Notice that we leave off the patch number, since the API will be completely locked down for a given patch series.

We may find that by default, protobuf descriptors are too noisy to lock down API changes. In that case, we may filter out certain fields in the descriptors, possibly regenerating for old versions.

This process is similar to the process used to ensure backwards compatibility in Go.