api

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2023 License: Apache-2.0, Apache-2.0 Imports: 0 Imported by: 0

README

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package events has protobuf types for various events that are used in containerd.
Package events has protobuf types for various events that are used in containerd.
services
events/v1
Package events defines the event pushing and subscription service.
Package events defines the event pushing and subscription service.
ttrpc/events/v1
Package events defines the ttrpc event service.
Package events defines the ttrpc event service.
version/v1
Package version defines the version service.
Package version defines the version service.
task
Package task defines the task service.
Package task defines the task service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL