containerd/api
Stephen J Day 50532f231a
api: use weak imports for plugin protobufs
Because of a side-effect import, we have the possibility of pulling in
several unnecessary packages that are used by the plugin and not at
runtime to implement protobuf structures. Setting these imports to
`weak` prevents this from happening, reducing the total import set,
reducing memory usage and binary size.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-11-16 20:18:15 -08:00
..
events api: use weak imports for plugin protobufs 2017-11-16 20:18:15 -08:00
services api: use weak imports for plugin protobufs 2017-11-16 20:18:15 -08:00
types api: use weak imports for plugin protobufs 2017-11-16 20:18:15 -08:00
next.pb.txt api: use weak imports for plugin protobufs 2017-11-16 20:18:15 -08:00
README.md Minor typo fix. 2017-08-10 06:23:21 +00:00

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.