Rename State's Root to Bundle

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
This commit is contained in:
Michael Crosby 2015-09-29 10:37:47 -07:00
parent d521b54a1e
commit 34def3a09c
2 changed files with 3 additions and 3 deletions

View File

@ -65,6 +65,6 @@ type State struct {
ID string `json:"id"`
// Pid is the process id for the container's main process.
Pid int `json:"pid"`
// Root is the path to the container's bundle directory.
Root string `json:"root"`
// BundlePath is the path to the container's bundle directory.
BundlePath string `json:"bundlePath"`
}

View File

@ -12,7 +12,7 @@ By providing a default location that container state is stored external applicat
* **`version`** (string) Version of the OCI specification used when creating the container.
* **`id`** (string) ID is the container's ID.
* **`pid`** (int) Pid is the ID of the main process within the container.
* **`root`** (string) Root is the path to the container's bundle directory.
* **`bundlePath`** (string) BundlePath is the path to the container's bundle directory.
The ID is provided in the state because hooks will be executed with the state as the payload.
This allows the hook to perform clean and teardown logic after the runtime destroys its own state.