Skip to content

Commit

Permalink
doc: Add the sandbox apis of kata-api-design.md
Browse files Browse the repository at this point in the history
The doc package of kata design, just list part apis of the the sandbox
management apis. This commit add the other sandbox apis to the api
tables, the file kata-api-design.md

Fixes kata-containers#700

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
  • Loading branch information
DavidWang-YC committed Aug 27, 2020
1 parent 3a65791 commit ba91b73
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion design/kata-api-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ To fulfill the [Kata design requirements](kata-design-requirements.md), and base

|Name|Description|
|---|---|
|`CreateSandbox(SandboxConfig)`| Create and start a sandbox, and return the sandbox structure.|
|`CreateSandbox(SandboxConfig)`| Create and start a sandbox, create its containers and do not start them, return the sandbox structure.|
|`FetchSandbox(ID)`| Connect to an existing sandbox and return the sandbox structure.|
|`ListSandboxes()`| List all existing sandboxes with status. |
|`StatusSandbox(ID)`| Get the detailed status of a Sandbox. |
|`StartSandbox(ID)`| Start an existing sandbox and all its containers, return the sandbox structure. |
|`RunSandbox(SandboxConfig)`| Create and start a sandbox, and then create and start its containers, return the sandbox structure. |
|`StopSandbox(ID)`| Stop an existing sandbox and destroy all containers within the sandbox, return the sandbox structure. |
|`DeleteSandbox(ID)`| Stop an already created sandbox and then delete it, return the sandbox structure. |

### Sandbox Operation API

Expand Down

0 comments on commit ba91b73

Please # to comment.