Documentation ¶
Index ¶
- Constants
- Variables
- type History
- type ManagedNamespace
- type Metadata
- type NS
- type Namespace
- type NamespaceIface
- type NamespaceMode
- type NamespaceOption
- type Sandbox
- func (s *Sandbox) AddContainer(c *oci.Container)
- func (s *Sandbox) AddHostnamePath(hostname string)
- func (s *Sandbox) AddIPs(ips []string)
- func (s *Sandbox) Annotations() map[string]string
- func (s *Sandbox) CgroupParent() string
- func (s *Sandbox) Containers() oci.ContainerStorer
- func (s *Sandbox) CreateManagedNamespaces(managedNamespaces []nsmgr.NSType, idMappings *idtools.IDMappings, ...) ([]*ManagedNamespace, error)
- func (s *Sandbox) CreateNamespacesWithFunc(managedNamespaces []nsmgr.NSType, idMappings *idtools.IDMappings, ...) (mns []*ManagedNamespace, retErr error)
- func (s *Sandbox) Created() bool
- func (s *Sandbox) CreatedAt() time.Time
- func (s *Sandbox) GetContainer(name string) *oci.Container
- func (s *Sandbox) HostNetwork() bool
- func (s *Sandbox) Hostname() string
- func (s *Sandbox) HostnamePath() string
- func (s *Sandbox) ID() string
- func (s *Sandbox) IPs() []string
- func (s *Sandbox) InfraContainer() *oci.Container
- func (s *Sandbox) IpcNsJoin(nspath string) error
- func (s *Sandbox) IpcNsPath() string
- func (s *Sandbox) KubeName() string
- func (s *Sandbox) Labels() fields.Set
- func (s *Sandbox) LogDir() string
- func (s *Sandbox) Metadata() *Metadata
- func (s *Sandbox) MountLabel() string
- func (s *Sandbox) Name() string
- func (s *Sandbox) Namespace() string
- func (s *Sandbox) NamespaceOptions() *NamespaceOption
- func (s *Sandbox) NamespacePaths() []*ManagedNamespace
- func (s *Sandbox) NeedsInfra(serverDropsInfra bool) bool
- func (s *Sandbox) NetNsJoin(nspath string) error
- func (s *Sandbox) NetNsPath() string
- func (s *Sandbox) NetworkStopped() bool
- func (s *Sandbox) PidNsPath() string
- func (s *Sandbox) PortMappings() []*hostport.PortMapping
- func (s *Sandbox) Privileged() bool
- func (s *Sandbox) ProcessLabel() string
- func (s *Sandbox) Ready(takeLock bool) bool
- func (s *Sandbox) RemoveContainer(c *oci.Container)
- func (s *Sandbox) RemoveInfraContainer()
- func (s *Sandbox) RemoveManagedNamespaces() error
- func (s *Sandbox) ResolvPath() string
- func (s *Sandbox) RestoreStopped()
- func (s *Sandbox) RuntimeHandler() string
- func (s *Sandbox) SeccompProfilePath() string
- func (s *Sandbox) SetCreated()
- func (s *Sandbox) SetInfraContainer(infraCtr *oci.Container) error
- func (s *Sandbox) SetNamespaceOptions(nsOpts *NamespaceOption)
- func (s *Sandbox) SetNetworkStopped(createFile bool) error
- func (s *Sandbox) SetSeccompProfilePath(pp string)
- func (s *Sandbox) SetStopped(createFile bool)
- func (s *Sandbox) ShmPath() string
- func (s *Sandbox) StopMutex() *sync.RWMutex
- func (s *Sandbox) Stopped() bool
- func (s *Sandbox) UnmountShm() error
- func (s *Sandbox) UserNsJoin(nspath string) error
- func (s *Sandbox) UserNsPath() string
- func (s *Sandbox) UsernsMode() string
- func (s *Sandbox) UtsNsJoin(nspath string) error
- func (s *Sandbox) UtsNsPath() string
- type StoreFilter
- type StoreReducer
- type Storer
Constants ¶
const DefaultShmSize = 64 * 1024 * 1024
DefaultShmSize is the default shm size
const DevShmPath = "/dev/shm"
DevShmPath is the default system wide shared memory path
Variables ¶
var ErrIDEmpty = errors.New("PodSandboxId should not be empty")
ErrIDEmpty is the error returned when the id of the sandbox is empty
Functions ¶
This section is empty.
Types ¶
type History ¶
type History []*Sandbox
History is a convenience type for storing a list of sandboxes, sorted by creation date in descendant order.
type ManagedNamespace ¶ added in v1.17.0
type ManagedNamespace struct {
// contains filtered or unexported fields
}
ManagedNamespace is a structure that holds all the necessary information a caller would need for a sandbox managed namespace Where NamespaceIface does hold similar information, ManagedNamespace exists to allow this library to not return data not necessarily in a NamespaceIface (for instance, when a namespace is not managed by CRI-O, but instead is based off of the infra pid)
func (*ManagedNamespace) Path ¶ added in v1.17.0
func (m *ManagedNamespace) Path() string
Type returns the namespace path
func (*ManagedNamespace) Type ¶ added in v1.17.0
func (m *ManagedNamespace) Type() nsmgr.NSType
Type returns the namespace type
type Metadata ¶ added in v1.20.0
type Metadata struct { // Pod name of the sandbox. Name string `json:"name,omitempty"` // Pod UID of the sandbox. UID string `json:"uid,omitempty"` // Pod namespace of the sandbox. Namespace string `json:"namespace,omitempty"` // Attempt number of creating the sandbox. Attempt uint32 `json:"attempt,omitempty"` }
type NS ¶ added in v1.17.0
NS is a wrapper for the containernetworking plugin's NetNS interface It exists because while NetNS is specifically called such, it is really a generic namespace, and can be used for other namespaces
type Namespace ¶ added in v1.17.0
Namespace handles data pertaining to a namespace
func (*Namespace) Initialize ¶ added in v1.17.0
func (n *Namespace) Initialize() NamespaceIface
Initialize does the necessary setup for a Namespace It does not do the bind mounting and nspinning
func (*Namespace) Initialized ¶ added in v1.17.0
Initialized returns true if the Namespace is already initialized
type NamespaceIface ¶ added in v1.17.0
type NamespaceIface interface { // Close closes this network namespace Close() error // Get returns the native Namespace Get() *Namespace // Initialize does the necessary setup Initialize() NamespaceIface // Initialized returns true if already initialized Initialized() bool // Remove ensures this network namespace handle is closed and removed Remove() error // Path returns the bind mount path of the namespace Path() string // Type returns the namespace type (net, ipc or uts) Type() nsmgr.NSType }
NamespaceIface provides a generic namespace interface
type NamespaceMode ¶ added in v1.20.0
type NamespaceMode int32
A NamespaceMode describes the intended namespace configuration for each of the namespaces (Network, PID, IPC) in NamespaceOption. Runtimes should map these modes as appropriate for the technology underlying the runtime.
const ( // A pod namespace is common to all containers in a pod. // For example, a container with a pid namespace of pod expects to view // all of the processes in all of the containers in the pod. NamespaceModePod NamespaceMode = 0 // A container namespace is restricted to a single container. // For example, a container with a pid namespace of container expects to // view only the processes in that container. NamespaceModeContainer NamespaceMode = 1 // A node namespace is the namespace of the Kubernetes node. // For example, a container with a pid namespace of node expects to view // all of the processes on the host running the kubelet. NamespaceModeNode NamespaceMode = 2 // NamespaceModeTarget targets the namespace of another container. When // this is specified, a target_id must be specified in NamespaceOption and // refer to a container previously created with NamespaceModeContainer. // This containers namespace will be made to match that of container // target_id. For example, a container with a pid namespace of // NamespaceModeTarget expects to view all of the processes that container // target_id can view. NamespaceModeTarget NamespaceMode = 3 )
type NamespaceOption ¶ added in v1.20.0
type NamespaceOption struct { // Network namespace for this container/sandbox. Network NamespaceMode `json:"network,omitempty"` // PID namespace for this container/sandbox. Pid NamespaceMode `json:"pid,omitempty"` // IPC namespace for this container/sandbox. Ipc NamespaceMode `json:"ipc,omitempty"` // Target Container ID for NamespaceModeTarget. This container must have // been previously created in the same pod. It is not possible to specify // different targets for each namespace. TargetID string `json:"target_id,omitempty"` }
type Sandbox ¶
type Sandbox struct {
// contains filtered or unexported fields
}
Sandbox contains data surrounding kubernetes sandboxes on the server
func New ¶
func New(id, namespace, name, kubeName, logDir string, labels, annotations map[string]string, processLabel, mountLabel string, metadata *Metadata, shmPath, cgroupParent string, privileged bool, runtimeHandler, resolvPath, hostname string, portMappings []*hostport.PortMapping, hostNetwork bool, createdAt time.Time, usernsMode string) (*Sandbox, error)
New creates and populates a new pod sandbox New sandboxes have no containers, no infra container, and no network namespaces associated with them An infra container must be attached before the sandbox is added to the state
func (*Sandbox) AddContainer ¶
AddContainer adds a container to the sandbox
func (*Sandbox) AddHostnamePath ¶
AddHostnamePath adds the hostname path to the sandbox
func (*Sandbox) Annotations ¶
Annotations returns a list of annotations for the sandbox
func (*Sandbox) CgroupParent ¶
CgroupParent returns the cgroup parent of the sandbox
func (*Sandbox) Containers ¶
func (s *Sandbox) Containers() oci.ContainerStorer
Containers returns the ContainerStorer that contains information on all of the containers in the sandbox
func (*Sandbox) CreateManagedNamespaces ¶ added in v1.17.0
func (s *Sandbox) CreateManagedNamespaces(managedNamespaces []nsmgr.NSType, idMappings *idtools.IDMappings, sysctls map[string]string, cfg *config.Config) ([]*ManagedNamespace, error)
CreateManagedNamespaces calls pinnsPath on all the managed namespaces for the sandbox. It returns a slice of ManagedNamespaces it created.
func (*Sandbox) CreateNamespacesWithFunc ¶ added in v1.17.0
func (s *Sandbox) CreateNamespacesWithFunc(managedNamespaces []nsmgr.NSType, idMappings *idtools.IDMappings, sysctls map[string]string, cfg *config.Config, pinFunc namespacePinner) (mns []*ManagedNamespace, retErr error)
CreateManagedNamespacesWithFunc is mainly added for testing purposes. There's no point in actually calling the pinns binary in unit tests, so this function allows the actual pin func to be abstracted out. Every other caller should use CreateManagedNamespaces
func (*Sandbox) GetContainer ¶
GetContainer retrieves a container from the sandbox
func (*Sandbox) HostNetwork ¶
HostNetwork returns whether the sandbox runs in the host network namespace
func (*Sandbox) HostnamePath ¶
HostnamePath retrieves the hostname path from a sandbox
func (*Sandbox) InfraContainer ¶
InfraContainer returns the infrastructure container for the sandbox
func (*Sandbox) IpcNsJoin ¶ added in v1.17.0
IpcNsJoin attempts to join the sandbox to an existing IPC namespace This will fail if the sandbox is already part of a IPC namespace
func (*Sandbox) IpcNsPath ¶ added in v1.17.0
IpcNsPath returns the path to the network namespace of the sandbox. If the sandbox uses the host namespace, the empty string is returned
func (*Sandbox) MountLabel ¶
MountLabel returns the mount label for the sandbox
func (*Sandbox) NamespaceOptions ¶
func (s *Sandbox) NamespaceOptions() *NamespaceOption
NamespaceOptions returns the namespace options for the sandbox
func (*Sandbox) NamespacePaths ¶ added in v1.17.0
func (s *Sandbox) NamespacePaths() []*ManagedNamespace
NamespacePaths returns all the paths of the namespaces of the sandbox. If a namespace is not managed by the sandbox, the namespace of the infra container will be returned. It returns a slice of ManagedNamespaces
func (*Sandbox) NeedsInfra ¶ added in v1.19.0
NeedsInfra is a function that returns whether the sandbox will need an infra container. If the server manages the namespace lifecycles, and the Pid option on the sandbox is node or container level, the infra container is not needed
func (*Sandbox) NetNsJoin ¶
NetNsJoin attempts to join the sandbox to an existing network namespace This will fail if the sandbox is already part of a network namespace
func (*Sandbox) NetNsPath ¶
NetNsPath returns the path to the network namespace of the sandbox. If the sandbox uses the host namespace, the empty string is returned
func (*Sandbox) NetworkStopped ¶ added in v1.16.3
NetworkStopped returns whether the network has been stopped
func (*Sandbox) PidNsPath ¶ added in v1.19.0
PidNsPath returns the path to the pid namespace of the sandbox. If the sandbox uses the host namespace, the empty string is returned.
func (*Sandbox) PortMappings ¶
func (s *Sandbox) PortMappings() []*hostport.PortMapping
PortMappings returns a list of port mappings between the host and the sandbox
func (*Sandbox) Privileged ¶
Privileged returns whether or not the containers in the sandbox are privileged containers
func (*Sandbox) ProcessLabel ¶
ProcessLabel returns the process label for the sandbox
func (*Sandbox) Ready ¶ added in v1.18.0
Ready returns whether the sandbox should be marked as ready to the kubelet if there is no infra container, it is always considered ready. `takeLock` should be set if we need to take the lock to get the infra container's state. If there is no infra container, it is never considered ready. If the infra container is spoofed, the pod is considered ready when it has been created, but not stopped.
func (*Sandbox) RemoveContainer ¶
RemoveContainer deletes a container from the sandbox
func (*Sandbox) RemoveInfraContainer ¶
func (s *Sandbox) RemoveInfraContainer()
RemoveInfraContainer removes the infrastructure container of a sandbox
func (*Sandbox) RemoveManagedNamespaces ¶ added in v1.17.0
RemoveManagedNamespaces cleans up after managing the namespaces. It removes all of the namespaces and the parent directory in which they lived.
func (*Sandbox) ResolvPath ¶
ResolvPath returns the resolv path for the sandbox
func (*Sandbox) RestoreStopped ¶ added in v1.16.3
func (s *Sandbox) RestoreStopped()
func (*Sandbox) RuntimeHandler ¶
RuntimeHandler returns the name of the runtime handler that should be picked from the list of runtimes. The name must match the key from the map of runtimes.
func (*Sandbox) SeccompProfilePath ¶
SeccompProfilePath returns the seccomp profile path
func (*Sandbox) SetCreated ¶
func (s *Sandbox) SetCreated()
SetCreated sets the created status of sandbox to true
func (*Sandbox) SetInfraContainer ¶
SetInfraContainer sets the infrastructure container of a sandbox Attempts to set the infrastructure container after one is already present will throw an error
func (*Sandbox) SetNamespaceOptions ¶
func (s *Sandbox) SetNamespaceOptions(nsOpts *NamespaceOption)
SetNamespaceOptions sets whether the pod is running using host network
func (*Sandbox) SetNetworkStopped ¶ added in v1.16.3
SetNetworkStopped sets the sandbox network state as stopped This should be set after a network stop operation succeeds, so we don't double stop the network if createFile is true, it creates a "network-stopped" file in the infra container's persistent dir this is used to track the network is stopped over reboots returns an error if an error occurred when creating the network-stopped file
func (*Sandbox) SetSeccompProfilePath ¶
SetSeccompProfilePath sets the seccomp profile path
func (*Sandbox) SetStopped ¶
SetStopped sets the sandbox state to stopped. This should be set after a stop operation succeeds so that subsequent stops can return fast. if createFile is true, it also creates a "stopped" file in the infra container's persistent dir this is used to track the sandbox is stopped over reboots
func (*Sandbox) UnmountShm ¶ added in v1.17.0
UnmountShm removes the shared memory mount for the sandbox and returns an error if any failure occurs.
func (*Sandbox) UserNsJoin ¶ added in v1.17.0
UserNsJoin attempts to join the sandbox to an existing User namespace This will fail if the sandbox is already part of a User namespace
func (*Sandbox) UserNsPath ¶
UserNsPath returns the path to the user namespace of the sandbox. If the sandbox uses the host namespace, the empty string is returned
func (*Sandbox) UsernsMode ¶ added in v1.20.0
UsernsMode returns the mode for setting the user namespace, if any.
type StoreFilter ¶
StoreFilter defines a function to filter sandboxes in the store.
type StoreReducer ¶
type StoreReducer func(*Sandbox)
StoreReducer defines a function to manipulate sandboxes in the store
type Storer ¶
type Storer interface { // Add appends a new sandbox to the store. Add(string, *Sandbox) // Get returns a sandbox from the store by the identifier it was stored with. Get(string) *Sandbox // Delete removes a sandbox from the store by the identifier it was stored with. Delete(string) // List returns a list of sandboxes from the store. List() []*Sandbox // Size returns the number of sandboxes in the store. Size() int // First returns the first sandbox found in the store by a given filter. First(StoreFilter) *Sandbox // ApplyAll calls the reducer function with every sandbox in the store. ApplyAll(StoreReducer) }
Storer defines an interface that any container store must implement.