Skip to content

Commit

Permalink
Docs: Document proxy plugin diff support
Browse files Browse the repository at this point in the history
Document that differs can be proxy plugins now.

Signed-off-by: Danny Canter <[email protected]>
  • Loading branch information
dcantah committed Aug 19, 2023
1 parent 465c04c commit de4c338
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
currently supported types are `snapshot` and `content`.
currently supported types are `snapshot`, `content`, and `diff`.

```toml
version = 2
Expand All @@ -63,8 +63,7 @@ version = 2

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
[content store service](https://godoc.org/github.com/containerd/containerd/api/services/content/v1#ContentServer)
and [snapshotter service](https://godoc.org/github.com/containerd/containerd/api/services/snapshots/v1#SnapshotsServer).
[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).

The following example creates a snapshot plugin binary which can be used
with any implementation of
Expand Down

0 comments on commit de4c338

Please sign in to comment.