container

package
v28.5.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 8, 2025 License: Apache-2.0 Imports: 70 Imported by: 275

Documentation

Index

Constants

View Source 
const (
	PullImageAlways  = "always"
	PullImageMissing = "missing" // Default (matches previous behavior)
	PullImageNever   = "never"
)

Pull constants

Variables

This section is empty.

Functions

func DiffFormatWrite deprecated 

func DiffFormatWrite(fmtCtx formatter.Context, changes []container.FilesystemChange) error

DiffFormatWrite writes formatted diff using the Context

Deprecated: this function was only used internally and will be removed in the next release.

func ForwardAllSignals 

func ForwardAllSignals(ctx context.Context, apiClient client.ContainerAPIClient, cid string, sigc <-chan os.Signal)

ForwardAllSignals forwards signals to the container

The channel you pass in must already be setup to receive any signals you want to forward.

func MonitorTtySize 

func MonitorTtySize(ctx context.Context, cli command.Cli, id string, isExec bool) error

MonitorTtySize updates the container tty size when the terminal tty changes size

func NewAttachCommand deprecated 

func NewAttachCommand(dockerCLI command.Cli) *cobra.Command

NewAttachCommand creates a new cobra.Command for `docker attach`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewCommitCommand deprecated 

func NewCommitCommand(dockerCLI command.Cli) *cobra.Command

NewCommitCommand creates a new cobra.Command for `docker commit`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewContainerCommand deprecated 

func NewContainerCommand(dockerCLI command.Cli) *cobra.Command

NewContainerCommand returns a cobra command for `container` subcommands

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewCopyCommand deprecated 

func NewCopyCommand(dockerCLI command.Cli) *cobra.Command

NewCopyCommand creates a new `docker cp` command

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewCreateCommand deprecated 

func NewCreateCommand(dockerCLI command.Cli) *cobra.Command

NewCreateCommand creates a new cobra.Command for `docker create`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewDiffCommand deprecated 

func NewDiffCommand(dockerCLI command.Cli) *cobra.Command

NewDiffCommand creates a new cobra.Command for `docker diff`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewDiffFormat deprecated 

func NewDiffFormat(source string) formatter.Format

NewDiffFormat returns a format for use with a diff Context

Deprecated: this function was only used internally and will be removed in the next release.

func NewExecCommand deprecated 

func NewExecCommand(dockerCLI command.Cli) *cobra.Command

NewExecCommand creates a new cobra.Command for `docker exec`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewExportCommand deprecated 

func NewExportCommand(dockerCLI command.Cli) *cobra.Command

NewExportCommand creates a new `docker export` command

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewKillCommand deprecated 

func NewKillCommand(dockerCLI command.Cli) *cobra.Command

NewKillCommand creates a new cobra.Command for `docker kill`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewLogsCommand deprecated 

func NewLogsCommand(dockerCLI command.Cli) *cobra.Command

NewLogsCommand creates a new cobra.Command for `docker logs`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewPauseCommand deprecated 

func NewPauseCommand(dockerCLI command.Cli) *cobra.Command

NewPauseCommand creates a new cobra.Command for `docker pause`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewPortCommand deprecated 

func NewPortCommand(dockerCli command.Cli) *cobra.Command

NewPortCommand creates a new cobra.Command for `docker port`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewPruneCommand deprecated 

func NewPruneCommand(dockerCLI command.Cli) *cobra.Command

NewPruneCommand returns a new cobra prune command for containers

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewPsCommand deprecated 

func NewPsCommand(dockerCLI command.Cli) *cobra.Command

NewPsCommand creates a new cobra.Command for `docker ps`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewRenameCommand deprecated 

func NewRenameCommand(dockerCLI command.Cli) *cobra.Command

NewRenameCommand creates a new cobra.Command for `docker rename`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewRestartCommand deprecated 

func NewRestartCommand(dockerCLI command.Cli) *cobra.Command

NewRestartCommand creates a new cobra.Command for `docker restart`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewRmCommand deprecated 

func NewRmCommand(dockerCLI command.Cli) *cobra.Command

NewRmCommand creates a new cobra.Command for `docker rm`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewRunCommand deprecated 

func NewRunCommand(dockerCLI command.Cli) *cobra.Command

NewRunCommand create a new `docker run` command

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewStartCommand deprecated 

func NewStartCommand(dockerCli command.Cli) *cobra.Command

NewStartCommand creates a new cobra.Command for `docker start`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewStatsCommand deprecated 

func NewStatsCommand(dockerCLI command.Cli) *cobra.Command

NewStatsCommand creates a new cobra.Command for "docker stats".

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewStatsFormat 

func NewStatsFormat(source, osType string) formatter.Format

NewStatsFormat returns a format for rendering an CStatsContext

func NewStopCommand deprecated 

func NewStopCommand(dockerCLI command.Cli) *cobra.Command

NewStopCommand creates a new cobra.Command for `docker stop`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewTopCommand deprecated 

func NewTopCommand(dockerCLI command.Cli) *cobra.Command

NewTopCommand creates a new cobra.Command for `docker top`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewUnpauseCommand deprecated 

func NewUnpauseCommand(dockerCli command.Cli) *cobra.Command

NewUnpauseCommand creates a new cobra.Command for `docker unpause`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewUpdateCommand deprecated 

func NewUpdateCommand(dockerCLI command.Cli) *cobra.Command

NewUpdateCommand creates a new cobra.Command for `docker update`

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewWaitCommand deprecated 

func NewWaitCommand(dockerCLI command.Cli) *cobra.Command

NewWaitCommand creates a new cobra.Command for `docker wait`

Deprecated: Do not import commands directly. They will be removed in a future release.

func RunAttach 

func RunAttach(ctx context.Context, dockerCLI command.Cli, containerID string, opts *AttachOptions) error

RunAttach executes an `attach` command

func RunExec 

func RunExec(ctx context.Context, dockerCLI command.Cli, containerIDorName string, options ExecOptions) error

RunExec executes an `exec` command

func RunPrune 

func RunPrune(ctx context.Context, dockerCli command.Cli, _ bool, filter opts.FilterOpt) (uint64, string, error)

RunPrune calls the Container Prune API This returns the amount of space reclaimed and a detailed output string

func RunStart 

func RunStart(ctx context.Context, dockerCli command.Cli, opts *StartOptions) error

RunStart executes a `start` command

func RunStats 

func RunStats(ctx context.Context, dockerCLI command.Cli, options *StatsOptions) error

RunStats displays a live stream of resource usage statistics for one or more containers. This shows real-time information on CPU usage, memory usage, and network I/O.

Types

type AttachOptions 

type AttachOptions struct {
	NoStdin    bool
	Proxy      bool
	DetachKeys string
}

AttachOptions group options for `attach` command

type ExecOptions 

type ExecOptions struct {
	DetachKeys  string
	Interactive bool
	TTY         bool
	Detach      bool
	User        string
	Privileged  bool
	Env         opts.ListOpts
	Workdir     string
	Command     []string
	EnvFile     opts.ListOpts
}

ExecOptions group options for `exec` command

func NewExecOptions 

func NewExecOptions() ExecOptions

NewExecOptions creates a new ExecOptions

type StartOptions 

type StartOptions struct {
	Attach        bool
	OpenStdin     bool
	DetachKeys    string
	Checkpoint    string
	CheckpointDir string

	Containers []string
}

StartOptions group options for `start` command

type Stats 

type Stats struct {
	StatsEntry
	// contains filtered or unexported fields
}

Stats represents an entity to store containers statistics synchronously

func NewStats 

func NewStats(container string) *Stats

NewStats returns a new Stats entity and sets in it the given name

func (*Stats) GetError 

func (cs *Stats) GetError() error

GetError returns the container statistics error. This is used to determine whether the statistics are valid or not

func (*Stats) GetStatistics 

func (cs *Stats) GetStatistics() StatsEntry

GetStatistics returns container statistics with other meta data such as the container name

func (*Stats) SetError 

func (cs *Stats) SetError(err error)

SetError sets container statistics error

func (*Stats) SetErrorAndReset 

func (cs *Stats) SetErrorAndReset(err error)

SetErrorAndReset zeroes all the container statistics and store the error. It is used when receiving time out error during statistics collecting to reduce lock overhead

func (*Stats) SetStatistics 

func (cs *Stats) SetStatistics(s StatsEntry)

SetStatistics set the container statistics

type StatsEntry 

type StatsEntry struct {
	Container        string
	Name             string
	ID               string
	CPUPercentage    float64
	Memory           float64 // On Windows this is the private working set
	MemoryLimit      float64 // Not used on Windows
	MemoryPercentage float64 // Not used on Windows
	NetworkRx        float64
	NetworkTx        float64
	BlockRead        float64
	BlockWrite       float64
	PidsCurrent      uint64 // Not used on Windows
	IsInvalid        bool
}

StatsEntry represents the statistics data collected from a container

type StatsOptions 

type StatsOptions struct {
	// All allows including both running and stopped containers. The default
	// is to only include running containers.
	All bool

	// NoStream disables streaming stats. If enabled, stats are collected once,
	// and the result is printed.
	NoStream bool

	// NoTrunc disables truncating the output. The default is to truncate
	// output such as container-IDs.
	NoTrunc bool

	// Format is a custom template to use for presenting the stats.
	// Refer to [flagsHelper.FormatHelp] for accepted formats.
	Format string

	// Containers is the list of container names or IDs to include in the stats.
	// If empty, all containers are included. It is mutually exclusive with the
	// Filters option, and an error is produced if both are set.
	Containers []string

	// Filters provides optional filters to filter the list of containers and their
	// associated container-events to include in the stats if no list of containers
	// is set. If no filter is provided, all containers are included. Filters and
	// Containers are currently mutually exclusive, and setting both options
	// produces an error.
	//
	// These filters are used both to collect the initial list of containers and
	// to refresh the list of containers based on container-events, accepted
	// filters are limited to the intersection of filters accepted by "events"
	// and "container list".
	//
	// Currently only "label" / "label=value" filters are accepted. Additional
	// filter options may be added in future (within the constraints described
	// above), but may require daemon-side validation as the list of accepted
	// filters can differ between daemon- and API versions.
	Filters *filters.Args
}

StatsOptions defines options for RunStats.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.