The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- func ContainerNetNSPath(ctx context.Context, c containerd.Container) (string, error)
- func ContainerStateDirPath(ns, dataStore, id string) (string, error)
- func ContainerStatus(ctx context.Context, c containerd.Container) (containerd.Status, error)
- func CopyFiles(ctx context.Context, client *containerd.Client, container containerd.Container, ...) error
- func GenerateSharingPIDOpts(ctx context.Context, targetCon containerd.Container) ([]oci.SpecOpts, error)
- func NetworkOptionsFromSpec(spec *specs.Spec) (types.NetworkOptions, error)
- func Pause(ctx context.Context, client *containerd.Client, id string) error
- func PrintHostPort(ctx context.Context, writer io.Writer, container containerd.Container, ...) error
- func ReconfigNetContainer(ctx context.Context, c containerd.Container, client *containerd.Client, ...) error
- func ReconfigPIDContainer(ctx context.Context, c containerd.Container, client *containerd.Client, ...) error
- func Start(ctx context.Context, container containerd.Container, flagA bool, ...) (err error)
- func Stop(ctx context.Context, container containerd.Container, timeout *time.Duration) (err error)
- func Unpause(ctx context.Context, client *containerd.Client, id string) error
- func UpdateErrorLabel(ctx context.Context, container containerd.Container, err error) error
- func UpdateExplicitlyStoppedLabel(ctx context.Context, container containerd.Container, explicitlyStopped bool) error
- func UpdateStatusLabel(ctx context.Context, container containerd.Container, ...) error
- func WithBindMountHostProcfs(_ context.Context, _ oci.Client, _ *containers.Container, s *oci.Spec) error
- type ContainerVolume
- type NetworkOptionsManager
Constants ¶
const (
UtsNamespaceHost = "host"
)
Variables ¶
This section is empty.
Functions ¶
func ContainerNetNSPath ¶ added in v1.2.0
ContainerNetNSPath returns the netns path of a container.
func ContainerStateDirPath ¶ added in v1.3.0
ContainerStateDirPath returns the path to the Nerdctl-managed state directory for the container with the given ID.
func ContainerStatus ¶ added in v1.2.0
func ContainerStatus(ctx context.Context, c containerd.Container) (containerd.Status, error)
ContainerStatus returns the container's status from its task.
func CopyFiles ¶ added in v1.2.1
func CopyFiles(ctx context.Context, client *containerd.Client, container containerd.Container, container2host bool, dst, src string, snapshotter string, followSymlink bool) error
CopyFiles implements `nerdctl cp`. See https://docs.docker.com/engine/reference/commandline/cp/ for the specification.
func GenerateSharingPIDOpts ¶ added in v1.2.0
func GenerateSharingPIDOpts(ctx context.Context, targetCon containerd.Container) ([]oci.SpecOpts, error)
GenerateSharingPIDOpts returns the oci.SpecOpts that shares the host linux namespace from `targetCon` If `targetCon` doesn't have a `PIDNamespace`, a new one is generated from its `Pid`.
func NetworkOptionsFromSpec ¶ added in v1.3.0
func NetworkOptionsFromSpec(spec *specs.Spec) (types.NetworkOptions, error)
NetworkOptionsFromSpec Returns the NetworkOptions used in a container's creation from its spec.Annotations.
func PrintHostPort ¶
func PrintHostPort(ctx context.Context, writer io.Writer, container containerd.Container, containerPort int, proto string) error
PrintHostPort writes to `writer` the public (HostIP:HostPort) of a given `containerPort/protocol` in a container. if `containerPort < 0`, it writes all public ports of the container.
func ReconfigNetContainer ¶ added in v1.2.0
func ReconfigNetContainer(ctx context.Context, c containerd.Container, client *containerd.Client, lab map[string]string) error
ReconfigNetContainer reconfigures the container's network namespace path.
func ReconfigPIDContainer ¶ added in v1.2.0
func ReconfigPIDContainer(ctx context.Context, c containerd.Container, client *containerd.Client, lab map[string]string) error
ReconfigPIDContainer reconfigures the container's spec options for sharing PID namespace.
func Start ¶ added in v1.2.0
func Start(ctx context.Context, container containerd.Container, flagA bool, client *containerd.Client, detachKeys string) (err error)
Start starts `container` with `attach` flag. If `attach` is true, it will attach to the container's stdio.
func Stop ¶ added in v1.2.0
Stop stops `container` by sending SIGTERM. If the container is not stopped after `timeout`, it sends a SIGKILL.
func UpdateErrorLabel ¶ added in v1.3.0
UpdateErrorLabel updates the "nerdctl/error" label of the container according to the container error.
func UpdateExplicitlyStoppedLabel ¶ added in v1.2.0
func UpdateExplicitlyStoppedLabel(ctx context.Context, container containerd.Container, explicitlyStopped bool) error
UpdateExplicitlyStoppedLabel updates the "containerd.io/restart.explicitly-stopped" label of the container according to the value of explicitlyStopped.
func UpdateStatusLabel ¶ added in v1.5.0
func UpdateStatusLabel(ctx context.Context, container containerd.Container, status containerd.ProcessStatus) error
UpdateStatusLabel updates the "containerd.io/restart.status" label of the container according to the value of restart desired status.
func WithBindMountHostProcfs ¶ added in v1.2.0
func WithBindMountHostProcfs(_ context.Context, _ oci.Client, _ *containers.Container, s *oci.Spec) error
WithBindMountHostProcfs replaces procfs mount with rbind. Required for --pid=host on rootless.
https://github.com/moby/moby/pull/41893/files https://github.com/containers/podman/blob/v3.0.0-rc1/pkg/specgen/generate/oci.go#L248-L257
Types ¶
type ContainerVolume ¶ added in v1.5.0
type ContainerVolume struct {
Type string
Name string
Source string
Destination string
Mode string
RW bool
Propagation string
}
ContainerVolume is a struct representing a volume in a container.
func GetContainerVolumes ¶ added in v1.5.0
func GetContainerVolumes(containerLabels map[string]string) []*ContainerVolume
GetContainerVolumes is a function that returns a slice of containerVolume pointers. It accepts a map of container labels as input, where key is the label name and value is its associated value. The function iterates over the predefined volume labels (AnonymousVolumes and Mounts) and for each, it checks if the labels exists in the provided container labels. If yes, it decodes the label value from JSON format and appends the volumes to the result. In case of error during decoding, it logs the error and continues to the next label.
type NetworkOptionsManager ¶ added in v1.3.0
type NetworkOptionsManager interface {
// NetworkOptions Returns a copy of the internal types.NetworkOptions.
NetworkOptions() types.NetworkOptions
// VerifyNetworkOptions Verifies that the internal network settings are correct.
VerifyNetworkOptions(context.Context) error
// SetupNetworking Performs setup actions required for the container with the given ID.
SetupNetworking(context.Context, string) error
// CleanupNetworking Performs any required cleanup actions for the given container.
// Should only be called to revert any setup steps performed in SetupNetworking.
CleanupNetworking(context.Context, containerd.Container) error
// InternalNetworkingOptionLabels Returns the set of NetworkingOptions which should be set as labels on the container.
//
// These options can potentially differ from the actual networking options
// that the NetworkOptionsManager was initially instantiated with.
// E.g: in container networking mode, the label will be normalized to an ID:
// `--net=container:myContainer` => `--net=container:<ID of myContainer>`.
InternalNetworkingOptionLabels(context.Context) (types.NetworkOptions, error)
// ContainerNetworkingOpts Returns a slice of `oci.SpecOpts` and `containerd.NewContainerOpts` which represent
// the network specs which need to be applied to the container with the given ID.
ContainerNetworkingOpts(context.Context, string) ([]oci.SpecOpts, []containerd.NewContainerOpts, error)
}
NetworkOptionsManager types.NetworkOptionsManager is an interface for reading/setting networking options for containers based on the provided command flags.
func NewNetworkingOptionsManager ¶ added in v1.3.0
func NewNetworkingOptionsManager(globalOptions types.GlobalCommandOptions, netOpts types.NetworkOptions, client *containerd.Client) (NetworkOptionsManager, error)
NewNetworkingOptionsManager Returns a types.NetworkOptionsManager based on the provided command's flags.
Source Files