mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-18 23:04:20 +01:00
8a1949546c
Add a low-level agent control tool that can manipulate the agent via ttRPC. Fixes: #222. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
# Agent Control tool
|
|
|
|
* [Overview](#overview)
|
|
* [Audience and environment](#audience-and-environment)
|
|
* [Full details](#full-details)
|
|
|
|
## Overview
|
|
|
|
The Kata Containers agent control tool (`kata-agent-ctl`) is a low-level test
|
|
tool. It allows basic interaction with the Kata Containers agent,
|
|
`kata-agent`, that runs inside the virtual machine.
|
|
|
|
Unlike the Kata Runtime, which only ever makes sequences of correctly ordered
|
|
and valid agent API calls, this tool allows users to make arbitrary agent API
|
|
calls and to control their parameters.
|
|
|
|
## Audience and environment
|
|
|
|
> **Warning:**
|
|
>
|
|
> This tool is for *advanced* users familiar with the low-level agent API calls.
|
|
> Further, it is designed to be run on test and development systems **only**: since
|
|
> the tool can make arbitrary API calls, it is possible to easily confuse
|
|
> irrevocably other parts of the system or even kill a running container or
|
|
> sandbox.
|
|
|
|
## Full details
|
|
|
|
For a usage statement, run:
|
|
|
|
```sh
|
|
$ cargo run -- --help
|
|
```
|
|
|
|
To see some examples, run:
|
|
|
|
```sh
|
|
$ cargo run -- examples
|
|
```
|