github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
01dfb110c4
containerd/api
History
Kazuyoshi Kato 01dfb110c4 Add go_package on all proto files 
Seems it is no longer optional after migratring off from
gogo/protobuf (see #6564).

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2022-04-20 17:29:15 +00:00
..
events Remove all gogoproto extensions 2022-04-20 07:23:28 +00:00
runtime Keep shim API backward compatible 2022-04-19 18:46:02 -07:00
services Remove all gogoproto extensions 2022-04-20 07:23:28 +00:00
types Add go_package on all proto files 2022-04-20 17:29:15 +00: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 Add go_package on all proto files 2022-04-20 17:29:15 +00:00
Protobuild.toml Move runtime v2 proto 2022-04-19 17:59:33 -07: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.