containerd/api
Brian Goff 2123855eeb Add build tag to omit grpc
This is needed so we can build the runc shim without grpc as a
transative dependency.
With this change the runc shim binary went from 14MB to 11MB.
The RSS from an idle shim went from about 17MB to 14MB (back around
where it was in in 1.7).

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2024-10-02 01:50:48 +00:00
..
events Make api a Go sub-module 2024-05-02 11:03:00 -07:00
releases Prepare release notes for api/v1.8.0 2024-05-03 16:51:50 -07:00
runtime Add build tag to omit grpc 2024-10-02 01:50:48 +00:00
services Add build tag to omit grpc 2024-10-02 01:50:48 +00:00
types Make api a Go sub-module 2024-05-02 11:03:00 -07: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
go.mod api: update github.com/containerd/ttrpc v1.2.5 2024-06-20 16:53:50 +02:00
go.sum api: update github.com/containerd/ttrpc v1.2.5 2024-06-20 16:53:50 +02:00
next.pb.txt sandbox: add update api for controller 2024-06-14 02:31:51 +00:00
Protobuild.toml Update protobuild to build ttrpc services 2024-02-21 14:22:25 -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.