github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge pull request #8991 from dcantah/remote-differ-docs

Browse Source 
Docs: Document proxy plugins diff support
This commit is contained in:
Derek McGowan 2023-08-21 09:27:56 -07:00 committed by GitHub
commit df1ddc46b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/PLUGINS.md
View File

@ -48,7 +48,7 @@ Update the containerd config file, which by default is at
`/etc/containerd/config.toml`. Add a `[proxy_plugins]` section along with a `/etc/containerd/config.toml`. Add a `[proxy_plugins]` section along with a
section for your given plugin `[proxy_plugins.myplugin]`. The `address` must section for your given plugin `[proxy_plugins.myplugin]`. The `address` must
refer to a local socket file which the containerd process has access to. The refer to a local socket file which the containerd process has access to. The
currently supported types are `snapshot` and `content`. currently supported types are `snapshot`, `content`, and `diff`.
```toml ```toml
version = 2 version = 2
@ -63,8 +63,7 @@ version = 2
Implementing a proxy plugin is as easy as implementing the gRPC API for a Implementing a proxy plugin is as easy as implementing the gRPC API for a
service. For implementing a proxy plugin in Go, look at the go doc for service. For implementing a proxy plugin in Go, look at the go doc for
[content store service](https://godoc.org/github.com/containerd/containerd/api/services/content/v1#ContentServer) [content store service](https://godoc.org/github.com/containerd/containerd/api/services/content/v1#ContentServer), [snapshotter service](https://godoc.org/github.com/containerd/containerd/api/services/snapshots/v1#SnapshotsServer), and [diff service](https://pkg.go.dev/github.com/containerd/containerd/api/services/diff/v1#DiffServer).
and [snapshotter service](https://godoc.org/github.com/containerd/containerd/api/services/snapshots/v1#SnapshotsServer).
The following example creates a snapshot plugin binary which can be used The following example creates a snapshot plugin binary which can be used
with any implementation of with any implementation of