namespaces

Documentation

Index

• type CgroupMode
  • func (n CgroupMode) Container() string
  • func (n CgroupMode) IsContainer() bool
  • func (n CgroupMode) IsDefaultValue() bool
  • func (n CgroupMode) IsHost() bool
  • func (n CgroupMode) IsNS() bool
  • func (n CgroupMode) IsPrivate() bool
  • func (n CgroupMode) NS() string
  • func (n CgroupMode) Valid() bool
• type IpcMode
  • func (n IpcMode) Container() string
  • func (n IpcMode) IsContainer() bool
  • func (n IpcMode) IsEmpty() bool
  • func (n IpcMode) IsHost() bool
  • func (n IpcMode) IsNone() bool
  • func (n IpcMode) IsPrivate() bool
  • func (n IpcMode) IsShareable() bool
  • func (n IpcMode) Valid() bool
• type KeepIDUserNsOptions
• type NetworkMode
  • func (n NetworkMode) Container() string
  • func (n NetworkMode) IsBridge() bool
  • func (n NetworkMode) IsContainer() bool
  • func (n NetworkMode) IsDefault() bool
  • func (n NetworkMode) IsHost() bool
  • func (n NetworkMode) IsNS() bool
  • func (n NetworkMode) IsNone() bool
  • func (n NetworkMode) IsPasta() bool
  • func (n NetworkMode) IsPod() bool
  • func (n NetworkMode) IsPrivate() bool
  • func (n NetworkMode) IsSlirp4netns() bool
  • func (n NetworkMode) IsUserDefined() bool
  • func (n NetworkMode) NS() string
  • func (n NetworkMode) UserDefined() string
• type PidMode
  • func (n PidMode) Container() string
  • func (n PidMode) IsContainer() bool
  • func (n PidMode) IsHost() bool
  • func (n PidMode) IsPrivate() bool
  • func (n PidMode) Valid() bool
• type UTSMode
  • func (n UTSMode) Container() string
  • func (n UTSMode) IsContainer() bool
  • func (n UTSMode) IsHost() bool
  • func (n UTSMode) IsPrivate() bool
  • func (n UTSMode) Valid() bool
• type UsernsMode
  • func (n UsernsMode) Container() string
  • func (n UsernsMode) GetKeepIDOptions() (*KeepIDUserNsOptions, error)
  • func (n UsernsMode) IsAuto() bool
  • func (n UsernsMode) IsContainer() bool
  • func (n UsernsMode) IsDefaultValue() bool
  • func (n UsernsMode) IsHost() bool
  • func (n UsernsMode) IsKeepID() bool
  • func (n UsernsMode) IsNS() bool
  • func (n UsernsMode) IsNoMap() bool
  • func (n UsernsMode) IsPrivate() bool
  • func (n UsernsMode) NS() string
  • func (n UsernsMode) Valid() bool

Types

type CgroupMode

type CgroupMode string

CgroupMode represents cgroup mode in the container.

func (CgroupMode) Container

func (n CgroupMode) Container() string

Container returns the name of the container whose cgroup namespace is going to be used.

func (CgroupMode) IsContainer

func (n CgroupMode) IsContainer() bool

IsContainer indicates whether the container uses a new cgroup namespace.

func (CgroupMode) IsDefaultValue

func (n CgroupMode) IsDefaultValue() bool

IsDefaultValue indicates whether the cgroup namespace has the default value.

func (CgroupMode) IsHost

func (n CgroupMode) IsHost() bool

IsHost indicates whether the container uses the host's cgroup.

func (CgroupMode) IsNS

func (n CgroupMode) IsNS() bool

IsNS indicates a cgroup namespace passed in by path (ns:<path>)

func (CgroupMode) IsPrivate

func (n CgroupMode) IsPrivate() bool

IsPrivate indicates whether the container uses the a private cgroup.

func (CgroupMode) NS

func (n CgroupMode) NS() string

NS gets the path associated with a ns:<path> cgroup ns

func (CgroupMode) Valid

func (n CgroupMode) Valid() bool

Valid indicates whether the Cgroup namespace is valid.

type IpcMode

type IpcMode string

IpcMode represents the container ipc stack.

func (IpcMode) Container

func (n IpcMode) Container() string

Container returns the name of the container ipc stack is going to be used.

func (IpcMode) IsContainer

func (n IpcMode) IsContainer() bool

IsContainer indicates whether the container uses another container's ipc namespace.

func (IpcMode) IsEmpty

func (n IpcMode) IsEmpty() bool

IsEmpty indicates whether container IpcMode is empty

func (IpcMode) IsHost

func (n IpcMode) IsHost() bool

IsHost indicates whether the container shares the host's ipc namespace.

func (IpcMode) IsNone

func (n IpcMode) IsNone() bool

IsNone indicates whether container IpcMode is set to "none".

func (IpcMode) IsPrivate

func (n IpcMode) IsPrivate() bool

IsPrivate indicates whether the container uses its own private ipc namespace which cannot be shared.

func (IpcMode) IsShareable

func (n IpcMode) IsShareable() bool

IsShareable indicates whether the container uses its own shareable ipc namespace which can be shared.

func (IpcMode) Valid

func (n IpcMode) Valid() bool

Valid indicates whether the ipc mode is valid.

type KeepIDUserNsOptions

type KeepIDUserNsOptions struct {
	// UID is the target uid in the user namespace.
	UID *uint32
	// GID is the target uid in the user namespace.
	GID *uint32
}

KeepIDUserNsOptions defines how to keepIDmatically create a user namespace.

type NetworkMode

type NetworkMode string

NetworkMode represents the container network stack.

func (NetworkMode) Container

func (n NetworkMode) Container() string

Container is the id of the container which network this container is connected to.

func (NetworkMode) IsBridge

func (n NetworkMode) IsBridge() bool

IsBridge indicates whether container uses the bridge network stack

func (NetworkMode) IsContainer

func (n NetworkMode) IsContainer() bool

IsContainer indicates whether container uses a container network stack.

func (NetworkMode) IsDefault

func (n NetworkMode) IsDefault() bool

IsDefault indicates whether container uses the default network stack.

func (NetworkMode) IsHost

func (n NetworkMode) IsHost() bool

IsHost indicates whether the container uses the host's network stack.

func (NetworkMode) IsNS

func (n NetworkMode) IsNS() bool

IsNS indicates a network namespace passed in by path (ns:<path>)

func (NetworkMode) IsNone

func (n NetworkMode) IsNone() bool

IsNone indicates whether container isn't using a network stack.

func (NetworkMode) IsPasta

func (n NetworkMode) IsPasta() bool

IsPasta indicates if we are running a rootless network stack using pasta

func (NetworkMode) IsPod

func (n NetworkMode) IsPod() bool

IsPod returns whether the network refers to pod networking

func (NetworkMode) IsPrivate

func (n NetworkMode) IsPrivate() bool

IsPrivate indicates whether container uses its private network stack.

func (NetworkMode) IsSlirp4netns

func (n NetworkMode) IsSlirp4netns() bool

IsSlirp4netns indicates if we are running a rootless network stack

func (NetworkMode) IsUserDefined

func (n NetworkMode) IsUserDefined() bool

IsUserDefined indicates user-created network

func (NetworkMode) NS

func (n NetworkMode) NS() string

NS gets the path associated with a ns:<path> network ns

func (NetworkMode) UserDefined

func (n NetworkMode) UserDefined() string

UserDefined indicates user-created network

type PidMode

type PidMode string

PidMode represents the pid namespace of the container.

func (PidMode) Container

func (n PidMode) Container() string

Container returns the name of the container whose pid namespace is going to be used.

func (PidMode) IsContainer

func (n PidMode) IsContainer() bool

IsContainer indicates whether the container uses a container's pid namespace.

func (PidMode) IsHost

func (n PidMode) IsHost() bool

IsHost indicates whether the container uses the host's pid namespace.

func (PidMode) IsPrivate

func (n PidMode) IsPrivate() bool

IsPrivate indicates whether the container uses its own new pid namespace.

func (PidMode) Valid

func (n PidMode) Valid() bool

Valid indicates whether the pid namespace is valid.

type UTSMode

type UTSMode string

UTSMode represents the UTS namespace of the container.

func (UTSMode) Container

func (n UTSMode) Container() string

Container returns the name of the container whose uts namespace is going to be used.

func (UTSMode) IsContainer

func (n UTSMode) IsContainer() bool

IsContainer indicates whether the container uses a container's UTS namespace.

func (UTSMode) IsHost

func (n UTSMode) IsHost() bool

IsHost indicates whether the container uses the host's UTS namespace.

func (UTSMode) IsPrivate

func (n UTSMode) IsPrivate() bool

IsPrivate indicates whether the container uses its private UTS namespace.

func (UTSMode) Valid

func (n UTSMode) Valid() bool

Valid indicates whether the UTS namespace is valid.

type UsernsMode

type UsernsMode string

UsernsMode represents userns mode in the container.

func (UsernsMode) Container

func (n UsernsMode) Container() string

Container is the id of the container which network this container is connected to.

func (UsernsMode) GetKeepIDOptions

func (n UsernsMode) GetKeepIDOptions() (*KeepIDUserNsOptions, error)

GetKeepIDOptions returns a KeepIDUserNsOptions with the settings to keepIDmatically set up a user namespace.

func (UsernsMode) IsAuto

func (n UsernsMode) IsAuto() bool

IsAuto indicates whether container uses the "auto" userns mode.

func (UsernsMode) IsContainer

func (n UsernsMode) IsContainer() bool

IsContainer indicates whether container uses a container userns.

func (UsernsMode) IsDefaultValue

func (n UsernsMode) IsDefaultValue() bool

IsDefaultValue indicates whether the user namespace has the default value.

func (UsernsMode) IsHost

func (n UsernsMode) IsHost() bool

IsHost indicates whether the container uses the host's userns.

func (UsernsMode) IsKeepID

func (n UsernsMode) IsKeepID() bool

IsKeepID indicates whether container uses a mapping where the (uid, gid) on the host is kept inside of the namespace.

func (UsernsMode) IsNS

func (n UsernsMode) IsNS() bool

IsNS indicates a userns namespace passed in by path (ns:<path>)

func (UsernsMode) IsNoMap

func (n UsernsMode) IsNoMap() bool

IsNoMap indicates whether container uses a mapping where the (uid, gid) on the host is not present in the namespace.

func (UsernsMode) IsPrivate

func (n UsernsMode) IsPrivate() bool

IsPrivate indicates whether the container uses the a private userns.

func (UsernsMode) NS

func (n UsernsMode) NS() string

NS gets the path associated with a ns:<path> userns ns

func (UsernsMode) Valid

func (n UsernsMode) Valid() bool

Valid indicates whether the userns is valid.