From 905e124b776a6f2a933ec94e5ff01dea7b38625a Mon Sep 17 00:00:00 2001 From: Shengjing Zhu Date: Thu, 6 Jan 2022 00:22:24 +0800 Subject: [PATCH] docs: fix agent proto file path Fixes: #3391 Signed-off-by: Shengjing Zhu --- docs/design/architecture/README.md | 4 ++-- src/agent/README.md | 4 ++-- src/tools/agent-ctl/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/design/architecture/README.md b/docs/design/architecture/README.md index 946b457fa7..0439592267 100644 --- a/docs/design/architecture/README.md +++ b/docs/design/architecture/README.md @@ -250,7 +250,7 @@ runtime cleans up the environment (which includes terminating the If the container manager requests the container be deleted, the [runtime](#runtime) will signal the agent by sending it a -`DestroySandbox` [ttRPC API](../../../src/agent/protocols/protos/agent.proto) request. +`DestroySandbox` [ttRPC API](../../../src/libs/protocols/protos/agent.proto) request. ## Guest assets @@ -291,7 +291,7 @@ for each VM created. The agent communicates with the other Kata components (primarily the [runtime](#runtime)) using a [`ttRPC`](https://github.com/containerd/ttrpc-rust) based -[protocol](../../../src/agent/protocols/protos). +[protocol](../../../src/libs/protocols/protos). > **Note:** > diff --git a/src/agent/README.md b/src/agent/README.md index 97b6acc071..fb181c03fd 100644 --- a/src/agent/README.md +++ b/src/agent/README.md @@ -60,7 +60,7 @@ $ make -C ${dir}/kata-containers/src/agent The Kata runtime communicates with the Kata agent using a ttRPC based API protocol. -This ttRPC API is defined by a set of [protocol buffers files](protocols/protos). +This ttRPC API is defined by a set of [protocol buffers files](../libs/protocols/protos). The protocol files are used to generate the bindings for the following components: | Component | Language | Generation method `[*]` | Tooling required | @@ -74,7 +74,7 @@ The protocol files are used to generate the bindings for the following component If you wish to change the API, these files must be regenerated. Although the rust code will be automatically generated by the -[build script](protocols/build.rs), +[build script](../libs/protocols/build.rs), the Golang code generation requires the external `protoc` command to be available in `$PATH`. diff --git a/src/tools/agent-ctl/README.md b/src/tools/agent-ctl/README.md index a351255cfa..7a8d88d23a 100644 --- a/src/tools/agent-ctl/README.md +++ b/src/tools/agent-ctl/README.md @@ -41,7 +41,7 @@ the agent protocol and the client and server implementations. | Description | File | Example RPC or function | Example summary | |-|-|-|-| -| Protocol buffers definition of the Kata Containers Agent API protocol | [`agent.proto`](../../agent/protocols/protos/agent.proto) | `CreateContainer` | API to create a Kata container. | +| Protocol buffers definition of the Kata Containers Agent API protocol | [`agent.proto`](../../libs/protocols/protos/agent.proto) | `CreateContainer` | API to create a Kata container. | | Agent Control (client) API calls | [`src/client.rs`](src/client.rs) | `agent_cmd_container_create()` | Agent Control tool function that calls the `CreateContainer` API. | | Agent (server) API implementations | [`rpc.rs`](../../agent/src/rpc.rs) | `create_container()` | Server function that implements the `CreateContainers` API. |