docs: update the sandbox operation API table #728
Conversation
There was a problem hiding this comment.
Thanks @YchauWang. Not strictly required, but you could add a second commit that sorts this table by Name.
lgtm
Sync the api from the runtime codes to the documentation. Remove sandbox.Pause() and sandbox.Resume() apis and add some missing methods in this table. And sort this table by Feature and Name. Fixes: kata-containers#727 Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
YchauWang
force-pushed
the
update-docs
branch
from
05b213b to
b19b543
Compare
| |`sandbox.Release()`| Release a sandbox data structure, close connections to the agent, and quit any goroutines associated with the sandbox. Mostly used for daemon restart.| | ||
| |`sandbox.Start()`| Start a a sandbox and the containers making the sandbox.| | ||
| |`sandbox.Status()`| Get the status of the sandbox and containers.| | ||
| |`sandbox.Stop()`| Stop a sandbox and Destroy the containers in the sandbox..| |
There was a problem hiding this comment.
Nit: lowercase "destroy" (otherwise suggests it's a method name)
There was a problem hiding this comment.
In doing reviews like this, you realize how stupid the Go convention of capitalizing public methods really is. It's really pointlessly painful to find the exports in a file from an editor. Even guru does not help. Any good suggestion there?
There was a problem hiding this comment.
Added #729 about missing documentation for types.
There was a problem hiding this comment.
@c3d - I tend to either use a crazy grep regex, but also have a golang program that uses ast + parse packages to list functions (it "works" but doesn't list the receiver for methods yet 😢)
amshinde
added
the
needs-forward-port
|
@YchauWang Can you port this change to the Kata 2.0 repository as well : https://github.com/kata-containers/kata-containers/blob/2.0-dev/docs/design/kata-api-design.md? |
|
@amshinde OK! I try to push a PR for 2.0. And 2.0 with shimV2, I am thinking about how to make some change for the 2.0-dev. |
Sync the api from the runtime codes to the documentation. Remove
sandbox.Pause() and sandbox.Resume() apis and add some missing methods
in this table.
Fixes: #727
Signed-off-by: Ychau Wang wangyongchao.bj@inspur.com