github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-29 12:14:48 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add VSOCK localhost example for agent-ctl

Browse Source 
Update the `agent-ctl` docs to show how to use a VSOCK local address
when running the agent and the tool in the same environment. This is an
alternative to using a Unix socket.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2022-04-28 12:45:36 +01:00
parent 86d348e065
commit 666aee54d2
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/tools/agent-ctl/README.md
View File

@ -211,10 +211,12 @@ $ sudo install -o root -g root -m 0755 ~/.cargo/bin/kata-agent-ctl /usr/local/bi
> **Warnings:**
>
> - This method is **only** for testing and development!
> - These methods are **only** for testing and development!
> - Only continue if you are using a non-critical system
> (such as a freshly installed VM environment).
#### Use a Unix abstract domain socket
1. Start the agent, specifying a local socket for it to communicate on:
```sh
@ -233,3 +235,31 @@ $ sudo install -o root -g root -m 0755 ~/.cargo/bin/kata-agent-ctl /usr/local/bi
>
> The `@` in the server address is required - it denotes an abstract
> socket which the agent requires (see `unix(7)`).
#### Use a VSOCK loopback socket
VSOCK supports a special CID value of `1` (known symbolically as
`VMADDR_CID_LOCAL`) which assumes that the VM is actually
the local environment. This is effectively a `localhost` or loopback
interface which does not require an actual VM to be
running.
1. Start the agent, specifying the local VSOCK socket for it to communicate on:
```sh
$ vsock_loopback_cid=1
$ agent_vsock_port=1024
$ sudo KATA_AGENT_SERVER_ADDR="vsock://${vsock_loopback_cid}:${agent_vsock_port}" target/x86_64-unknown-linux-musl/release/kata-agent
```
> **Note:** This example assumes an Intel x86-64 system.
1. Run the tool in the same environment:
```sh
$ vsock_loopback_cid=1
$ agent_vsock_port=1024
$ cargo run -- -l debug connect --server-address "vsock://${vsock_loopback_cid}:${agent_vsock_port}" --bundle-dir "$bundle_dir" -c Check -c GetGuestDetails
```