Skip to content

Commit

Permalink
Merge branch 'containerd:main' into pull-branch
Browse files Browse the repository at this point in the history
  • Loading branch information
zzzzzzzzzy9 authored May 30, 2024
2 parents c1e0b79 + e69120e commit b71ce98
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion crates/logging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Shim v2 runtime supports pluggable logging binaries via stdio URIs.
This crate implement `logging::run` to easy custom logger implementations in Rust.

[containerd Documentation](https://github.com/containerd/containerd/tree/master/runtime/v2#logging)
[containerd Documentation](https://github.com/containerd/containerd/tree/master/core/runtime/v2#logging)

## Example

Expand Down
4 changes: 2 additions & 2 deletions crates/shim-protos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ This crate is mainly expected to be useful to interact with containerd's shim ru
Runtime v2 introduces a first class shim API for runtime authors to integrate with containerd.
The shim API is minimal and scoped to the execution lifecycle of a container.

To learn how containerd's shim v2 runtime works in details, please refer to the [documentation](https://github.com/containerd/containerd/blob/main/runtime/v2/README.md).
To learn how containerd's shim v2 runtime works in details, please refer to the [documentation](https://github.com/containerd/containerd/blob/main/core/runtime/v2/README.md).

## Design
The `containerd-shim-protos` crate provides [Protobuf](https://github.com/protocolbuffers/protobuf.git) message
and [TTRPC](https://github.com/containerd/ttrpc.git) service definitions for the
[Containerd shim v2](https://github.com/containerd/containerd/blob/main/runtime/v2/task/shim.proto) protocol.
[Containerd shim v2](https://github.com/containerd/containerd/blob/main/api/runtime/task/v2/shim.proto) protocol.

The message and service definitions are auto-generated from protobuf source files under `vendor/`
by using [ttrpc-codegen](https://github.com/containerd/ttrpc-rust/tree/master/ttrpc-codegen). So please do not
Expand Down
2 changes: 1 addition & 1 deletion crates/shim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This crate simplifies shim v2 runtime development for containerd. It handles com
as command line parsing, setting up shim's TTRPC server, logging, events, etc.

Clients are expected to implement [Shim] and [Task] traits with task handling routines.
This generally replicates same API as in Go [version](https://github.com/containerd/containerd/blob/main/runtime/v2/example/cmd/main.go).
This generally replicates same API as in Go [version](https://github.com/containerd/containerd/blob/main/core/runtime/v2/example/cmd/main.go).

Once implemented, shim's bootstrap code is as easy as:
```text
Expand Down
2 changes: 1 addition & 1 deletion crates/snapshots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ $ ctr i pull --snapshotter custom docker.io/library/hello-world:latest
## Getting started

Snapshotters are required to implement `Snapshotter` trait (which is very similar to containerd's
[Snapshotter](https://github.com/containerd/containerd/blob/main/snapshots/snapshotter.go) interface).
[Snapshotter](https://github.com/containerd/containerd/blob/main/core/snapshots/snapshotter.go) interface).

```rust,ignore
use std::collections::HashMap;
Expand Down

0 comments on commit b71ce98

Please sign in to comment.