containerd/api
Stephen J Day 09b5ca1072
api/events: split event types from events service
To avoid importing all of grpc when consuming events, the types of
events have been split in to a separate package. This should allow a
reduction in memory usage in cases where a package is consuming events
but not using the gprc service directly.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-11-16 15:20:46 -08:00
..
events api/events: split event types from events service 2017-11-16 15:20:46 -08:00
services api/events: split event types from events service 2017-11-16 15:20:46 -08:00
types api,linux,windows: update generated protobufs 2017-11-09 13:37:06 -08:00
next.pb.txt api/events: split event types from events service 2017-11-16 15:20:46 -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.