update docs and comments

Signed-off-by: Allen Sun <shlallen1990@gmail.com>
This commit is contained in:
Allen Sun 2017-09-25 10:11:48 +08:00 committed by Allen Sun
parent 709d34f882
commit 4700968ff3
6 changed files with 6 additions and 6 deletions

View File

@ -19,7 +19,7 @@ is simply a directory on the filesystem.
![Architecture](architecture.png) ![Architecture](architecture.png)
Note that while these architectural ideas are important to understanding the Note that while these architectural ideas are important to understand the
system, code layout may not reflect the exact architecture. These ideas should system, code layout may not reflect the exact architecture. These ideas should
be used as a guide for placing functionality and behavior and understanding the be used as a guide for placing functionality and behavior and understanding the
thought behind the design. thought behind the design.

View File

@ -1,6 +1,6 @@
# Container Lifecycle # Container Lifecycle
While containerd is a daemon that provides API to manage multiple containers, the containers themselves are not tied to the lifecycle of containerd. Each container has a shim that acts as the direct parent for the container's processes as well has reporting the exit status and holding onto the STDIO of the container. This also allows containerd to crash and restore all functionality to containers. While containerd is a daemon that provides API to manage multiple containers, the containers themselves are not tied to the lifecycle of containerd. Each container has a shim that acts as the direct parent for the container's processes as well as reporting the exit status and holding onto the STDIO of the container. This also allows containerd to crash and restore all functionality to containers.
## containerd ## containerd

View File

@ -14,7 +14,7 @@ import (
"github.com/sirupsen/logrus" "github.com/sirupsen/logrus"
) )
// MakeRef returns a unique reference for the descriptor. This reference can be // MakeRefKey returns a unique reference for the descriptor. This reference can be
// used to lookup ongoing processes related to the descriptor. This function // used to lookup ongoing processes related to the descriptor. This function
// may look to the context to namespace the reference appropriately. // may look to the context to namespace the reference appropriately.
func MakeRefKey(ctx context.Context, desc ocispec.Descriptor) string { func MakeRefKey(ctx context.Context, desc ocispec.Descriptor) string {

View File

@ -19,7 +19,7 @@ const (
DefaultStateDir = "/run/containerd" DefaultStateDir = "/run/containerd"
// DefaultAddress is the default unix socket address // DefaultAddress is the default unix socket address
DefaultAddress = "/run/containerd/containerd.sock" DefaultAddress = "/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data // DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/run/containerd/debug.sock" DefaultDebugAddress = "/run/containerd/debug.sock"
) )

View File

@ -5,7 +5,7 @@ import "context"
const ( const (
// DefaultAddress is the default unix socket address // DefaultAddress is the default unix socket address
DefaultAddress = "/var/run/containerd/containerd.sock" DefaultAddress = "/var/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data // DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/var/run/containerd/debug.sock" DefaultDebugAddress = "/var/run/containerd/debug.sock"
) )

View File

@ -13,7 +13,7 @@ const (
DefaultStateDir = "/run/containerd" DefaultStateDir = "/run/containerd"
// DefaultAddress is the default unix socket address // DefaultAddress is the default unix socket address
DefaultAddress = "/run/containerd/containerd.sock" DefaultAddress = "/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data // DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/run/containerd/debug.sock" DefaultDebugAddress = "/run/containerd/debug.sock"
) )