494b940f14
In containerd 1.5.x, we introduced support for go modules by adding a go.mod file in the root directory. This go.mod lists all the things needed across the whole code base (with the exception of integration/client which has its own go.mod). So when projects that need to make calls to containerd API will pull in some code from containerd/containerd, the `go mod` commands will add all the things listed in the root go.mod to the projects go.mod file. This causes some problems as the list of things needed to make a simple API call is enormous. in effect, making a API call will pull everything that a typical server needs as well as the root go.mod is all encompassing. In general if we had smaller things folks could use, that will make it easier by reducing the number of things that will end up in a consumers go.mod file. Now coming to a specific problem, the root containerd go.mod has various k8s.io/* modules listed. Also kubernetes depends on containerd indirectly via both moby/moby (working with docker maintainers seperately) and via google/cadvisor. So when the kubernetes maintainers try to use latest 1.5.x containerd, they will see the kubernetes go.mod ending up depending on the older version of kubernetes! So if we can expose just the minimum things needed to make a client API call then projects like cadvisor can adopt that instead of pulling in the entire go.mod from containerd. Looking at the existing code in cadvisor the minimum things needed would be the api/ directory from containerd. Please see proof of concept here: github.com/google/cadvisor/pull/2908 To enable that, in this PR, we add a go.mod file in api/ directory. we split the Protobuild.yaml into two, one for just the things in api/ directory and the rest in the root directory. We adjust various targets to build things correctly using `protobuild` and also ensure that we end up with the same generated code as before as well. To ensure we better take care of the various go.mod/go.sum files, we update the existing `make vendor` and also add a new `make verify-vendor` that one can run locally as well in the CI. Ideally, we would have a `containerd/client` either as a standalone repo or within `containerd/containerd` as a separate go module. but we will start here to experiment with a standalone api go module first. Also there are various follow ups we can do, for example @thaJeztah has identified two tasks we could do after this PR lands: github.com/containerd/containerd/pull/5716#discussion_r668821396 Signed-off-by: Davanum Srinivas <davanum@gmail.com>
55 lines
2.2 KiB
TOML
55 lines
2.2 KiB
TOML
version = "unstable"
|
|
generator = "gogoctrd"
|
|
plugins = ["grpc", "fieldpath"]
|
|
|
|
# Control protoc include paths. Below are usually some good defaults, but feel
|
|
# free to try it without them if it works for your project.
|
|
[includes]
|
|
# Include paths that will be added before all others. Typically, you want to
|
|
# treat the root of the project as an include, but this may not be necessary.
|
|
before = []
|
|
|
|
# Paths that should be treated as include roots in relation to the vendor
|
|
# directory. These will be calculated with the vendor directory nearest the
|
|
# target package.
|
|
packages = ["github.com/gogo/protobuf", "github.com/gogo/googleapis"]
|
|
|
|
# Paths that will be added untouched to the end of the includes. We use
|
|
# `/usr/local/include` to pickup the common install location of protobuf.
|
|
# This is the default.
|
|
after = ["/usr/local/include"]
|
|
|
|
# This section maps protobuf imports to Go packages. These will become
|
|
# `-M` directives in the call to the go protobuf generator.
|
|
[packages]
|
|
"gogoproto/gogo.proto" = "github.com/gogo/protobuf/gogoproto"
|
|
"google/protobuf/any.proto" = "github.com/gogo/protobuf/types"
|
|
"google/protobuf/empty.proto" = "github.com/gogo/protobuf/types"
|
|
"google/protobuf/descriptor.proto" = "github.com/gogo/protobuf/protoc-gen-gogo/descriptor"
|
|
"google/protobuf/field_mask.proto" = "github.com/gogo/protobuf/types"
|
|
"google/protobuf/timestamp.proto" = "github.com/gogo/protobuf/types"
|
|
"google/protobuf/duration.proto" = "github.com/gogo/protobuf/types"
|
|
"google/rpc/status.proto" = "github.com/gogo/googleapis/google/rpc"
|
|
|
|
[[overrides]]
|
|
prefixes = ["github.com/containerd/containerd/api/events"]
|
|
plugins = ["fieldpath"] # disable grpc for this package
|
|
|
|
[[overrides]]
|
|
prefixes = ["github.com/containerd/containerd/api/services/ttrpc/events/v1"]
|
|
plugins = ["ttrpc", "fieldpath"]
|
|
|
|
[[overrides]]
|
|
# enable ttrpc and disable fieldpath and grpc for the shim
|
|
prefixes = ["github.com/containerd/containerd/runtime/v1/shim/v1", "github.com/containerd/containerd/runtime/v2/task"]
|
|
plugins = ["ttrpc"]
|
|
|
|
# Aggregrate the API descriptors to lock down API changes.
|
|
[[descriptors]]
|
|
prefix = "github.com/containerd/containerd/api"
|
|
target = "next.pb.txt"
|
|
ignore_files = [
|
|
"google/protobuf/descriptor.proto",
|
|
"gogoproto/gogo.proto"
|
|
]
|