Documentation
¶
Index ¶
- Constants
- func FilterIdFn(id []string) func(Identifier) bool
- func FilterIdOrNameFn(id []string) func(IdOrNamed) bool
- func FilterNameFn(name []string) func(Named) bool
- func FilterNamesFn(name []string) func(Names) bool
- func NewStringSet(elem ...string) *stringSet
- type AttachOptions
- type BoolReport
- type CheckpointOptions
- type CheckpointReport
- type CommitOptions
- type CommitReport
- type Container
- type ContainerCleanupOptions
- type ContainerCleanupReport
- type ContainerCreateReport
- type ContainerEngine
- type ContainerExportOptions
- type ContainerFilter
- type ContainerInitOptions
- type ContainerInitReport
- type ContainerInspectReport
- type ContainerListOptions
- type ContainerLogsOptions
- type ContainerMountOptions
- type ContainerMountReport
- type ContainerRunOptions
- type ContainerRunReport
- type ContainerStartOptions
- type ContainerStartReport
- type ContainerUnmountOptions
- type ContainerUnmountReport
- type DiffOptions
- type DiffReport
- type EngineMode
- type ExecOptions
- type HealthCheckOptions
- type IdOrNameResponse
- type IdOrNamed
- type IdOrNames
- type Identifier
- type Image
- type ImageData
- type ImageDeleteOptions
- type ImageDeleteReport
- type ImageEngine
- type ImageFilter
- type ImageHistoryLayer
- type ImageHistoryOptions
- type ImageHistoryReport
- type ImageImportOptions
- type ImageImportReport
- type ImageInspectReport
- type ImageListOptions
- type ImageLoadOptions
- type ImageLoadReport
- type ImagePruneOptions
- type ImagePruneReport
- type ImagePullOptions
- type ImagePullReport
- type ImagePushOptions
- type ImageSaveOptions
- type ImageSearchOptions
- type ImageSearchReport
- type ImageSummary
- type ImageTagOptions
- type ImageUntagOptions
- type InspectOptions
- type KillOptions
- type KillReport
- type ListContainer
- type ListContainerNamespaces
- type ListPodContainer
- type ListPodsReport
- type Named
- type Names
- type NetOptions
- type PauseUnPauseOptions
- type PauseUnpauseReport
- type PodCreateOptions
- type PodCreateReport
- type PodDeleteReport
- type PodInspectOptions
- type PodInspectReport
- type PodKillOptions
- type PodKillReport
- type PodPSOptions
- type PodPauseOptions
- type PodPauseReport
- type PodPruneOptions
- type PodPruneReport
- type PodRestartOptions
- type PodRestartReport
- type PodRmOptions
- type PodRmReport
- type PodStartOptions
- type PodStartReport
- type PodStopOptions
- type PodStopReport
- type PodTopOptions
- type PodUnpauseReport
- type PodmanConfig
- func (c PodmanConfig) DefaultCgroupNS() string
- func (c PodmanConfig) DefaultDNSOptions() []string
- func (c PodmanConfig) DefaultDNSSearches() []string
- func (c PodmanConfig) DefaultDNSServers() []string
- func (c PodmanConfig) DefaultDetachKeys() string
- func (c PodmanConfig) DefaultDevices() []string
- func (c PodmanConfig) DefaultEnv() []string
- func (c PodmanConfig) DefaultIPCNS() string
- func (c PodmanConfig) DefaultInitPath() string
- func (c PodmanConfig) DefaultNetNS() string
- func (c PodmanConfig) DefaultPidNS() string
- func (c PodmanConfig) DefaultPidsDescription() string
- func (c PodmanConfig) DefaultPidsLimit() int64
- func (c PodmanConfig) DefaultSecurityOptions() []string
- func (c PodmanConfig) DefaultShmSize() string
- func (c PodmanConfig) DefaultSysctls() []string
- func (c PodmanConfig) DefaultUTSNS() string
- func (c PodmanConfig) DefaultUlimits() []string
- func (c PodmanConfig) DefaultUserNS() string
- func (c PodmanConfig) DefaultVolumes() []string
- type PodunpauseOptions
- type PsSortedCreateTime
- type Report
- type RestartOptions
- type RestartReport
- type RestoreOptions
- type RestoreReport
- type RmOptions
- type RmReport
- type ServiceOptions
- type SortContainers
- type SortCreateTime
- type SortListContainers
- type StopOptions
- type StopReport
- type StringSliceReport
- type TopOptions
- type Volume
- type VolumeConfigResponse
- type VolumeCreateOptions
- type VolumeDeleteOptions
- type VolumeDeleteReport
- type VolumeFilter
- type VolumeInspectOptions
- type VolumeInspectReport
- type VolumeListOptions
- type VolumeListReport
- type VolumePruneOptions
- type VolumePruneReport
- type VolumeRmOptions
- type VolumeRmReport
- type WaitOptions
- type WaitReport
Constants ¶
const ( ABIMode = EngineMode("abi") TunnelMode = EngineMode("tunnel") )
Variables ¶
This section is empty.
Functions ¶
func FilterIdFn ¶
func FilterIdFn(id []string) func(Identifier) bool
func FilterIdOrNameFn ¶
func FilterNameFn ¶
func FilterNamesFn ¶
func NewStringSet ¶ added in v1.9.0
func NewStringSet(elem ...string) *stringSet
Types ¶
type AttachOptions ¶ added in v1.9.0
type AttachOptions struct {
DetachKeys string
Latest bool
NoStdin bool
SigProxy bool
Stdin *os.File
Stdout *os.File
Stderr *os.File
}
AttachOptions describes the cli and other values needed to perform an attach
type BoolReport ¶ added in v1.9.0
type BoolReport struct {
Value bool
}
type CheckpointOptions ¶ added in v1.9.0
type CheckpointReport ¶ added in v1.9.0
type CommitOptions ¶ added in v1.9.0
type CommitReport ¶ added in v1.9.0
type CommitReport struct {
Id string
}
type ContainerCleanupOptions ¶ added in v1.9.0
ContainerCleanupOptions are the CLI values for the cleanup command
type ContainerCleanupReport ¶ added in v1.9.0
ContainerCleanupReport describes the response from a container cleanup
type ContainerCreateReport ¶ added in v1.9.0
type ContainerCreateReport struct {
Id string
}
type ContainerEngine ¶
type ContainerEngine interface {
Config(ctx context.Context) (*config.Config, error)
ContainerAttach(ctx context.Context, nameOrId string, options AttachOptions) error
ContainerCheckpoint(ctx context.Context, namesOrIds []string, options CheckpointOptions) ([]*CheckpointReport, error)
ContainerCleanup(ctx context.Context, namesOrIds []string, options ContainerCleanupOptions) ([]*ContainerCleanupReport, error)
ContainerCommit(ctx context.Context, nameOrId string, options CommitOptions) (*CommitReport, error)
ContainerCreate(ctx context.Context, s *specgen.SpecGenerator) (*ContainerCreateReport, error)
ContainerDiff(ctx context.Context, nameOrId string, options DiffOptions) (*DiffReport, error)
ContainerExec(ctx context.Context, nameOrId string, options ExecOptions) (int, error)
ContainerExists(ctx context.Context, nameOrId string) (*BoolReport, error)
ContainerExport(ctx context.Context, nameOrId string, options ContainerExportOptions) error
ContainerInit(ctx context.Context, namesOrIds []string, options ContainerInitOptions) ([]*ContainerInitReport, error)
ContainerInspect(ctx context.Context, namesOrIds []string, options InspectOptions) ([]*ContainerInspectReport, error)
ContainerKill(ctx context.Context, namesOrIds []string, options KillOptions) ([]*KillReport, error)
ContainerList(ctx context.Context, options ContainerListOptions) ([]ListContainer, error)
ContainerMount(ctx context.Context, nameOrIds []string, options ContainerMountOptions) ([]*ContainerMountReport, error)
ContainerPause(ctx context.Context, namesOrIds []string, options PauseUnPauseOptions) ([]*PauseUnpauseReport, error)
ContainerLogs(ctx context.Context, containers []string, options ContainerLogsOptions) error
ContainerRestart(ctx context.Context, namesOrIds []string, options RestartOptions) ([]*RestartReport, error)
ContainerRestore(ctx context.Context, namesOrIds []string, options RestoreOptions) ([]*RestoreReport, error)
ContainerRm(ctx context.Context, namesOrIds []string, options RmOptions) ([]*RmReport, error)
ContainerRun(ctx context.Context, opts ContainerRunOptions) (*ContainerRunReport, error)
ContainerStart(ctx context.Context, namesOrIds []string, options ContainerStartOptions) ([]*ContainerStartReport, error)
ContainerStop(ctx context.Context, namesOrIds []string, options StopOptions) ([]*StopReport, error)
ContainerTop(ctx context.Context, options TopOptions) (*StringSliceReport, error)
ContainerUnmount(ctx context.Context, nameOrIds []string, options ContainerUnmountOptions) ([]*ContainerUnmountReport, error)
ContainerUnpause(ctx context.Context, namesOrIds []string, options PauseUnPauseOptions) ([]*PauseUnpauseReport, error)
ContainerWait(ctx context.Context, namesOrIds []string, options WaitOptions) ([]WaitReport, error)
HealthCheckRun(ctx context.Context, nameOrId string, options HealthCheckOptions) (*define.HealthCheckResults, error)
Info(ctx context.Context) (*define.Info, error)
PodCreate(ctx context.Context, opts PodCreateOptions) (*PodCreateReport, error)
PodExists(ctx context.Context, nameOrId string) (*BoolReport, error)
PodInspect(ctx context.Context, options PodInspectOptions) (*PodInspectReport, error)
PodKill(ctx context.Context, namesOrIds []string, options PodKillOptions) ([]*PodKillReport, error)
PodPause(ctx context.Context, namesOrIds []string, options PodPauseOptions) ([]*PodPauseReport, error)
PodPs(ctx context.Context, options PodPSOptions) ([]*ListPodsReport, error)
PodRestart(ctx context.Context, namesOrIds []string, options PodRestartOptions) ([]*PodRestartReport, error)
PodRm(ctx context.Context, namesOrIds []string, options PodRmOptions) ([]*PodRmReport, error)
PodStart(ctx context.Context, namesOrIds []string, options PodStartOptions) ([]*PodStartReport, error)
PodStop(ctx context.Context, namesOrIds []string, options PodStopOptions) ([]*PodStopReport, error)
PodTop(ctx context.Context, options PodTopOptions) (*StringSliceReport, error)
PodUnpause(ctx context.Context, namesOrIds []string, options PodunpauseOptions) ([]*PodUnpauseReport, error)
RestService(ctx context.Context, opts ServiceOptions) error
VarlinkService(ctx context.Context, opts ServiceOptions) error
VolumeCreate(ctx context.Context, opts VolumeCreateOptions) (*IdOrNameResponse, error)
VolumeInspect(ctx context.Context, namesOrIds []string, opts VolumeInspectOptions) ([]*VolumeInspectReport, error)
VolumeList(ctx context.Context, opts VolumeListOptions) ([]*VolumeListReport, error)
VolumePrune(ctx context.Context, opts VolumePruneOptions) ([]*VolumePruneReport, error)
VolumeRm(ctx context.Context, namesOrIds []string, opts VolumeRmOptions) ([]*VolumeRmReport, error)
}
type ContainerExportOptions ¶ added in v1.9.0
type ContainerExportOptions struct {
Output string
}
type ContainerFilter ¶
func CompileContainerFilters ¶
func CompileContainerFilters(filters url.Values) ContainerFilter
type ContainerInitOptions ¶ added in v1.9.0
ContainerInitOptions describes input options for the container init cli
type ContainerInitReport ¶ added in v1.9.0
ContainerInitReport describes the results of a container init
type ContainerInspectReport ¶ added in v1.9.0
type ContainerInspectReport struct {
*define.InspectContainerData
}
type ContainerListOptions ¶ added in v1.9.0
type ContainerListOptions struct {
All bool
Filters map[string][]string
Format string
Last int
Latest bool
Namespace bool
Pod bool
Quiet bool
Size bool
Sort string
Sync bool
Watch uint
}
ContainerListOptions describes the CLI options for listing containers
type ContainerLogsOptions ¶ added in v1.9.0
type ContainerLogsOptions struct {
// Show extra details provided to the logs.
Details bool
// Follow the log output.
Follow bool
// Display logs for the latest container only. Ignored on the remote client.
Latest bool
// Show container names in the output.
Names bool
// Show logs since this timestamp.
Since time.Time
// Number of lines to display at the end of the output.
Tail int64
// Show timestamps in the logs.
Timestamps bool
// Write the logs to Writer.
Writer io.Writer
}
ContainerLogsOptions describes the options to extract container logs.
type ContainerMountOptions ¶ added in v1.9.0
ContainerMountOptions describes the input values for mounting containers in the CLI
type ContainerMountReport ¶ added in v1.9.0
ContainerMountReport describes the response from container mount
type ContainerRunOptions ¶ added in v1.9.0
type ContainerRunOptions struct {
Detach bool
DetachKeys string
ErrorStream *os.File
InputStream *os.File
OutputStream *os.File
Rm bool
SigProxy bool
Spec *specgen.SpecGenerator
}
ContainerRunOptions describes the options needed to run a container from the CLI
type ContainerRunReport ¶ added in v1.9.0
ContainerRunReport describes the results of running a container
type ContainerStartOptions ¶ added in v1.9.0
type ContainerStartOptions struct {
Attach bool
DetachKeys string
Interactive bool
Latest bool
SigProxy bool
Stdout *os.File
Stderr *os.File
Stdin *os.File
}
ContainerStartOptions describes the val from the CLI needed to start a container
type ContainerStartReport ¶ added in v1.9.0
ContainerStartReport describes the response from starting containers from the cli
type ContainerUnmountOptions ¶ added in v1.9.0
ContainerUnmountOptions are the options from the cli for unmounting
type ContainerUnmountReport ¶ added in v1.9.0
ContainerUnmountReport describes the response from umounting a container
type DiffOptions ¶ added in v1.9.0
type DiffOptions struct {
Format string `json:",omitempty"` // CLI only
Latest bool `json:",omitempty"` // API and CLI, only supported by containers
Archive bool `json:",omitempty"` // CLI only
}
All API and CLI diff commands and diff sub-commands use the same options
type DiffReport ¶ added in v1.9.0
DiffReport provides changes for object
type EngineMode ¶
type EngineMode string
EngineMode is the connection type podman is using to access libpod
type ExecOptions ¶ added in v1.9.0
type ExecOptions struct {
Cmd []string
DetachKeys string
Envs map[string]string
Interactive bool
Latest bool
PreserveFDs uint
Privileged bool
Streams define.AttachStreams
Tty bool
User string
WorkDir string
}
ExecOptions describes the cli values to exec into a container
type HealthCheckOptions ¶ added in v1.9.0
type HealthCheckOptions struct{}
type IdOrNameResponse ¶ added in v1.9.0
type IdOrNameResponse struct {
// The Id or Name of an object
IdOrName string
}
type IdOrNamed ¶
type IdOrNamed interface {
Identifier
Named
}
IdOrName interface allows filters to access ID() or Name() of object
type IdOrNames ¶
type IdOrNames interface {
Identifier
Names
}
IdOrName interface allows filters to access ID() or Names() of object
type Identifier ¶
type Identifier interface {
Id() string
}
Identifier interface allows filters to access ID() of object
type Image ¶
type Image struct {
ID string `json:"Id"`
RepoTags []string `json:",omitempty"`
RepoDigests []string `json:",omitempty"`
Parent string `json:",omitempty"`
Comment string `json:",omitempty"`
Created string `json:",omitempty"`
Container string `json:",omitempty"`
ContainerConfig *container.Config `json:",omitempty"`
DockerVersion string `json:",omitempty"`
Author string `json:",omitempty"`
Config *container.Config `json:",omitempty"`
Architecture string `json:",omitempty"`
Variant string `json:",omitempty"`
Os string `json:",omitempty"`
OsVersion string `json:",omitempty"`
Size int64 `json:",omitempty"`
VirtualSize int64 `json:",omitempty"`
GraphDriver docker.GraphDriverData `json:",omitempty"`
RootFS docker.RootFS `json:",omitempty"`
Metadata docker.ImageMetadata `json:",omitempty"`
// Podman extensions
Digest digest.Digest `json:",omitempty"`
PodmanVersion string `json:",omitempty"`
ManifestType string `json:",omitempty"`
User string `json:",omitempty"`
History []v1.History `json:",omitempty"`
NamesHistory []string `json:",omitempty"`
HealthCheck *manifest.Schema2HealthConfig `json:",omitempty"`
}
type ImageDeleteOptions ¶
type ImageDeleteReport ¶
type ImageDeleteReport struct {
Untagged []string `json:",omitempty"`
Deleted []string `json:",omitempty"`
Errors []error
ImageNotFound error
ImageInUse error
}
ImageDeleteResponse is the response for removing one or more image(s) from storage and containers what was untagged vs actually removed
type ImageEngine ¶
type ImageEngine interface {
Config(ctx context.Context) (*config.Config, error)
Delete(ctx context.Context, nameOrId []string, opts ImageDeleteOptions) (*ImageDeleteReport, error)
Diff(ctx context.Context, nameOrId string, options DiffOptions) (*DiffReport, error)
Exists(ctx context.Context, nameOrId string) (*BoolReport, error)
History(ctx context.Context, nameOrId string, opts ImageHistoryOptions) (*ImageHistoryReport, error)
Import(ctx context.Context, opts ImageImportOptions) (*ImageImportReport, error)
Inspect(ctx context.Context, names []string, opts InspectOptions) (*ImageInspectReport, error)
List(ctx context.Context, opts ImageListOptions) ([]*ImageSummary, error)
Load(ctx context.Context, opts ImageLoadOptions) (*ImageLoadReport, error)
Prune(ctx context.Context, opts ImagePruneOptions) (*ImagePruneReport, error)
Pull(ctx context.Context, rawImage string, opts ImagePullOptions) (*ImagePullReport, error)
Push(ctx context.Context, source string, destination string, opts ImagePushOptions) error
Save(ctx context.Context, nameOrId string, tags []string, options ImageSaveOptions) error
Tag(ctx context.Context, nameOrId string, tags []string, options ImageTagOptions) error
Untag(ctx context.Context, nameOrId string, tags []string, options ImageUntagOptions) error
Search(ctx context.Context, term string, opts ImageSearchOptions) ([]ImageSearchReport, error)
}
type ImageFilter ¶
func CompileImageFilters ¶
func CompileImageFilters(filters url.Values) ImageFilter
type ImageHistoryLayer ¶
type ImageHistoryOptions ¶
type ImageHistoryOptions struct{}
type ImageHistoryReport ¶
type ImageHistoryReport struct {
Layers []ImageHistoryLayer
}
type ImageImportOptions ¶ added in v1.9.0
type ImageImportReport ¶ added in v1.9.0
type ImageImportReport struct {
Id string
}
type ImageInspectReport ¶ added in v1.9.0
type ImageListOptions ¶
type ImageLoadOptions ¶ added in v1.9.0
type ImageLoadReport ¶ added in v1.9.0
type ImageLoadReport struct {
Name string
}
type ImagePruneOptions ¶
type ImagePruneReport ¶
type ImagePullOptions ¶ added in v1.9.0
type ImagePullOptions struct {
// AllTags can be specified to pull all tags of the spiecifed image. Note
// that this only works if the specified image does not include a tag.
AllTags bool
// Authfile is the path to the authentication file. Ignored for remote
// calls.
Authfile string
// CertDir is the path to certificate directories. Ignored for remote
// calls.
CertDir string
// Credentials for authenticating against the registry in the format
// USERNAME:PASSWORD.
Credentials string
// OverrideArch will overwrite the local architecture for image pulls.
OverrideArch string
// OverrideOS will overwrite the local operating system (OS) for image
// pulls.
OverrideOS string
// Quiet can be specified to suppress pull progress when pulling. Ignored
// for remote calls.
Quiet bool
// SignaturePolicy to use when pulling. Ignored for remote calls.
SignaturePolicy string
// TLSVerify to enable/disable HTTPS and certificate verification.
TLSVerify types.OptionalBool
}
ImagePullOptions are the arguments for pulling images.
type ImagePullReport ¶ added in v1.9.0
type ImagePullReport struct {
Images []string
}
ImagePullReport is the response from pulling one or more images.
type ImagePushOptions ¶ added in v1.9.0
type ImagePushOptions struct {
// Authfile is the path to the authentication file. Ignored for remote
// calls.
Authfile string
// CertDir is the path to certificate directories. Ignored for remote
// calls.
CertDir string
// Compress tarball image layers when pushing to a directory using the 'dir'
// transport. Default is same compression type as source. Ignored for remote
// calls.
Compress bool
// Credentials for authenticating against the registry in the format
// USERNAME:PASSWORD.
Credentials string
// DigestFile, after copying the image, write the digest of the resulting
// image to the file. Ignored for remote calls.
DigestFile string
// Format is the Manifest type (oci, v2s1, or v2s2) to use when pushing an
// image using the 'dir' transport. Default is manifest type of source.
// Ignored for remote calls.
Format string
// Quiet can be specified to suppress pull progress when pulling. Ignored
// for remote calls.
Quiet bool
// RemoveSignatures, discard any pre-existing signatures in the image.
// Ignored for remote calls.
RemoveSignatures bool
// SignaturePolicy to use when pulling. Ignored for remote calls.
SignaturePolicy string
// SignBy adds a signature at the destination using the specified key.
// Ignored for remote calls.
SignBy string
// TLSVerify to enable/disable HTTPS and certificate verification.
TLSVerify types.OptionalBool
}
ImagePushOptions are the arguments for pushing images.
type ImageSaveOptions ¶ added in v1.9.0
type ImageSearchOptions ¶ added in v1.9.0
type ImageSearchOptions struct {
// Authfile is the path to the authentication file. Ignored for remote
// calls.
Authfile string
// Filters for the search results.
Filters []string
// Limit the number of results.
Limit int
// NoTrunc will not truncate the output.
NoTrunc bool
// TLSVerify to enable/disable HTTPS and certificate verification.
TLSVerify types.OptionalBool
}
ImageSearchOptions are the arguments for searching images.
type ImageSearchReport ¶ added in v1.9.0
type ImageSearchReport struct {
// Index is the image index (e.g., "docker.io" or "quay.io")
Index string
// Name is the canoncical name of the image (e.g., "docker.io/library/alpine").
Name string
// Description of the image.
Description string
// Stars is the number of stars of the image.
Stars int
// Official indicates if it's an official image.
Official string
// Automated indicates if the image was created by an automated build.
Automated string
}
ImageSearchReport is the response from searching images.
type ImageSummary ¶
type ImageSummary struct {
ID string `json:"Id"`
ParentId string `json:",omitempty"`
RepoTags []string `json:",omitempty"`
Created int64 `json:",omitempty"`
Size int64 `json:",omitempty"`
VirtualSize int64 `json:",omitempty"`
Labels map[string]string `json:",omitempty"`
Containers int `json:",omitempty"`
ReadOnly bool `json:",omitempty"`
Dangling bool `json:",omitempty"`
// Podman extensions
Names []string `json:",omitempty"`
Digest string `json:",omitempty"`
Digests []string `json:",omitempty"`
ConfigDigest string `json:",omitempty"`
History []string `json:",omitempty"`
}
func (*ImageSummary) Id ¶
func (i *ImageSummary) Id() string
func (*ImageSummary) IsDangling ¶
func (i *ImageSummary) IsDangling() bool
func (*ImageSummary) IsReadOnly ¶
func (i *ImageSummary) IsReadOnly() bool
type ImageTagOptions ¶ added in v1.9.0
type ImageTagOptions struct{}
type ImageUntagOptions ¶ added in v1.9.0
type ImageUntagOptions struct{}
type InspectOptions ¶ added in v1.9.0
type InspectOptions struct {
Format string `json:",omitempty"`
Latest bool `json:",omitempty"`
Size bool `json:",omitempty"`
}
All CLI inspect commands and inspect sub-commands use the same options
type KillOptions ¶ added in v1.9.0
type KillReport ¶ added in v1.9.0
type ListContainer ¶ added in v1.9.0
type ListContainer struct {
// Container command
Command []string
// Container creation time
Created int64
// If container has exited/stopped
Exited bool
// Time container exited
ExitedAt int64
// If container has exited, the return code from the command
ExitCode int32
// The unique identifier for the container
ID string `json:"Id"`
// Container image
Image string
// If this container is a Pod infra container
IsInfra bool
// Labels for container
Labels map[string]string
// User volume mounts
Mounts []string
// The names assigned to the container
Names []string
// Namespaces the container belongs to. Requires the
// namespace boolean to be true
Namespaces ListContainerNamespaces
// The process id of the container
Pid int
// If the container is part of Pod, the Pod ID. Requires the pod
// boolean to be set
Pod string
// If the container is part of Pod, the Pod name. Requires the pod
// boolean to be set
PodName string
// Port mappings
Ports []ocicni.PortMapping
// Size of the container rootfs. Requires the size boolean to be true
Size *shared.ContainerSize
// Time when container started
StartedAt int64
// State of container
State string
}
Listcontainer describes a container suitable for listing
type ListContainerNamespaces ¶ added in v1.9.0
type ListContainerNamespaces struct {
// Mount namespace
MNT string `json:"Mnt,omitempty"`
// Cgroup namespace
Cgroup string `json:"Cgroup,omitempty"`
// IPC namespace
IPC string `json:"Ipc,omitempty"`
// Network namespace
NET string `json:"Net,omitempty"`
// PID namespace
PIDNS string `json:"Pidns,omitempty"`
// UTS namespace
UTS string `json:"Uts,omitempty"`
// User namespace
User string `json:"User,omitempty"`
}
ListContainer Namespaces contains the identifiers of the container's Linux namespaces
type ListPodContainer ¶ added in v1.9.0
type ListPodsReport ¶ added in v1.9.0
type Named ¶
type Named interface {
Name() string
}
Named interface allows filters to access Name() of object
type Names ¶
type Names interface {
Names() []string
}
Named interface allows filters to access Name() of object
type NetOptions ¶ added in v1.9.0
type NetOptions struct {
AddHosts []string
CNINetworks []string
DNSHost bool
DNSOptions []string
DNSSearch []string
DNSServers []net.IP
Network specgen.Namespace
NoHosts bool
PublishPorts []ocicni.PortMapping
StaticIP *net.IP
StaticMAC *net.HardwareAddr
}
NetOptions reflect the shared network options between pods and containers
type PauseUnPauseOptions ¶ added in v1.9.0
type PauseUnPauseOptions struct {
All bool
}
type PauseUnpauseReport ¶ added in v1.9.0
type PodCreateOptions ¶ added in v1.9.0
type PodCreateOptions struct {
CGroupParent string
Hostname string
Infra bool
InfraImage string
InfraCommand string
Labels map[string]string
Name string
Net *NetOptions
}
func (PodCreateOptions) ToPodSpecGen ¶ added in v1.9.0
func (p PodCreateOptions) ToPodSpecGen(s *specgen.PodSpecGenerator)
type PodCreateReport ¶ added in v1.9.0
type PodCreateReport struct {
Id string
}
type PodDeleteReport ¶
type PodDeleteReport struct{ Report }
type PodInspectOptions ¶ added in v1.9.0
type PodInspectReport ¶ added in v1.9.0
type PodInspectReport struct {
*libpod.PodInspect
}
type PodKillOptions ¶ added in v1.9.0
type PodKillReport ¶ added in v1.9.0
type PodPSOptions ¶ added in v1.9.0
type PodPauseOptions ¶ added in v1.9.0
type PodPauseReport ¶ added in v1.9.0
type PodPruneOptions ¶
type PodPruneOptions struct{}
type PodPruneReport ¶
type PodPruneReport struct{ Report }
type PodRestartOptions ¶ added in v1.9.0
type PodRestartReport ¶ added in v1.9.0
type PodRmOptions ¶ added in v1.9.0
type PodRmReport ¶ added in v1.9.0
type PodStartOptions ¶ added in v1.9.0
type PodStartReport ¶ added in v1.9.0
type PodStopOptions ¶ added in v1.9.0
type PodStopReport ¶ added in v1.9.0
type PodTopOptions ¶ added in v1.9.0
type PodUnpauseReport ¶ added in v1.9.0
type PodmanConfig ¶ added in v1.9.0
type PodmanConfig struct {
*config.Config
*pflag.FlagSet
CGroupUsage string // rootless code determines Usage message
ConmonPath string // --conmon flag will set Engine.ConmonPath
CpuProfile string // Hidden: Should CPU profile be taken
EngineMode EngineMode // ABI or Tunneling mode
Identities []string // ssh identities for connecting to server
MaxWorks int // maximum number of parallel threads
RuntimePath string // --runtime flag will set Engine.RuntimePath
SpanCloser io.Closer // Close() for tracing object
SpanCtx context.Context // context to use when tracing
Span opentracing.Span // tracing object
Syslog bool // write to StdOut and Syslog, not supported when tunneling
Trace bool // Hidden: Trace execution
Uri string // URI to API Service
Runroot string
StorageDriver string
StorageOpts []string
}
PodmanConfig combines the defaults and settings from the file system with the flags given in os.Args. Some runtime state is also stored here.
func (PodmanConfig) DefaultCgroupNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultCgroupNS() string
func (PodmanConfig) DefaultDNSOptions ¶ added in v1.9.0
func (c PodmanConfig) DefaultDNSOptions() []string
func (PodmanConfig) DefaultDNSSearches ¶ added in v1.9.0
func (c PodmanConfig) DefaultDNSSearches() []string
func (PodmanConfig) DefaultDNSServers ¶ added in v1.9.0
func (c PodmanConfig) DefaultDNSServers() []string
func (PodmanConfig) DefaultDetachKeys ¶ added in v1.9.0
func (c PodmanConfig) DefaultDetachKeys() string
func (PodmanConfig) DefaultDevices ¶ added in v1.9.0
func (c PodmanConfig) DefaultDevices() []string
func (PodmanConfig) DefaultEnv ¶ added in v1.9.0
func (c PodmanConfig) DefaultEnv() []string
func (PodmanConfig) DefaultIPCNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultIPCNS() string
func (PodmanConfig) DefaultInitPath ¶ added in v1.9.0
func (c PodmanConfig) DefaultInitPath() string
func (PodmanConfig) DefaultNetNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultNetNS() string
func (PodmanConfig) DefaultPidNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultPidNS() string
func (PodmanConfig) DefaultPidsDescription ¶ added in v1.9.0
func (c PodmanConfig) DefaultPidsDescription() string
func (PodmanConfig) DefaultPidsLimit ¶ added in v1.9.0
func (c PodmanConfig) DefaultPidsLimit() int64
func (PodmanConfig) DefaultSecurityOptions ¶ added in v1.9.0
func (c PodmanConfig) DefaultSecurityOptions() []string
DefaultSecurityOptions: getter for security options from configuration
func (PodmanConfig) DefaultShmSize ¶ added in v1.9.0
func (c PodmanConfig) DefaultShmSize() string
func (PodmanConfig) DefaultSysctls ¶ added in v1.9.0
func (c PodmanConfig) DefaultSysctls() []string
DefaultSysctls
func (PodmanConfig) DefaultUTSNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultUTSNS() string
func (PodmanConfig) DefaultUlimits ¶ added in v1.9.0
func (c PodmanConfig) DefaultUlimits() []string
func (PodmanConfig) DefaultUserNS ¶ added in v1.9.0
func (c PodmanConfig) DefaultUserNS() string
func (PodmanConfig) DefaultVolumes ¶ added in v1.9.0
func (c PodmanConfig) DefaultVolumes() []string
type PodunpauseOptions ¶ added in v1.9.0
type PsSortedCreateTime ¶ added in v1.9.0
type PsSortedCreateTime struct{ SortListContainers }
func (PsSortedCreateTime) Less ¶ added in v1.9.0
func (a PsSortedCreateTime) Less(i, j int) bool
type RestartOptions ¶ added in v1.9.0
type RestartReport ¶ added in v1.9.0
type RestoreOptions ¶ added in v1.9.0
type RestoreReport ¶ added in v1.9.0
type ServiceOptions ¶ added in v1.9.0
type ServiceOptions struct {
URI string // Path to unix domain socket service should listen on
Timeout time.Duration // duration of inactivity the service should wait before shutting down
Command *cobra.Command // CLI command provided. Used in V1 code
}
ServiceOptions provides the input for starting an API Service
type SortContainers ¶ added in v1.9.0
SortContainers helps us set-up ability to sort by createTime
func (SortContainers) Len ¶ added in v1.9.0
func (a SortContainers) Len() int
func (SortContainers) Swap ¶ added in v1.9.0
func (a SortContainers) Swap(i, j int)
type SortCreateTime ¶ added in v1.9.0
type SortCreateTime struct{ SortContainers }
func (SortCreateTime) Less ¶ added in v1.9.0
func (a SortCreateTime) Less(i, j int) bool
type SortListContainers ¶ added in v1.9.0
type SortListContainers []ListContainer
func SortPsOutput ¶ added in v1.9.0
func SortPsOutput(sortBy string, psOutput SortListContainers) (SortListContainers, error)
func (SortListContainers) Len ¶ added in v1.9.0
func (a SortListContainers) Len() int
func (SortListContainers) Swap ¶ added in v1.9.0
func (a SortListContainers) Swap(i, j int)
type StopOptions ¶ added in v1.9.0
type StopReport ¶ added in v1.9.0
type StringSliceReport ¶ added in v1.9.0
type StringSliceReport struct {
Value []string
}
StringSliceReport wraps a string slice.
type TopOptions ¶ added in v1.9.0
type Volume ¶
type Volume struct {
Identifier
}
type VolumeConfigResponse ¶ added in v1.9.0
type VolumeConfigResponse struct {
// Name is the name of the volume.
Name string `json:"Name"`
// Driver is the driver used to create the volume.
// This will be properly implemented in a future version.
Driver string `json:"Driver"`
// Mountpoint is the path on the host where the volume is mounted.
Mountpoint string `json:"Mountpoint"`
// CreatedAt is the date and time the volume was created at. This is not
// stored for older Libpod volumes; if so, it will be omitted.
CreatedAt time.Time `json:"CreatedAt,omitempty"`
// Status is presently unused and provided only for Docker compatibility.
// In the future it will be used to return information on the volume's
// current state.
Status map[string]string `json:"Status,omitempty"`
// Labels includes the volume's configured labels, key:value pairs that
// can be passed during volume creation to provide information for third
// party tools.
Labels map[string]string `json:"Labels"`
// Scope is unused and provided solely for Docker compatibility. It is
// unconditionally set to "local".
Scope string `json:"Scope"`
// Options is a set of options that were used when creating the volume.
// It is presently not used.
Options map[string]string `json:"Options"`
// UID is the UID that the volume was created with.
UID int `json:"UID,omitempty"`
// GID is the GID that the volume was created with.
GID int `json:"GID,omitempty"`
// Anonymous indicates that the volume was created as an anonymous
// volume for a specific container, and will be be removed when any
// container using it is removed.
Anonymous bool `json:"Anonymous,omitempty"`
}
type VolumeCreateOptions ¶ added in v1.9.0
type VolumeCreateOptions struct {
// New volume's name. Can be left blank
Name string `schema:"name"`
// Volume driver to use
Driver string `schema:"driver"`
// User-defined key/value metadata.
Label map[string]string `schema:"label"`
// Mapping of driver options and values.
Options map[string]string `schema:"opts"`
}
swagger:model VolumeCreate
type VolumeDeleteOptions ¶
type VolumeDeleteOptions struct{}
type VolumeDeleteReport ¶
type VolumeDeleteReport struct{ Report }
type VolumeFilter ¶
func CompileVolumeFilters ¶
func CompileVolumeFilters(filters url.Values) VolumeFilter
type VolumeInspectOptions ¶ added in v1.9.0
type VolumeInspectOptions struct {
All bool
}
type VolumeInspectReport ¶ added in v1.9.0
type VolumeInspectReport struct {
*VolumeConfigResponse
}
type VolumeListOptions ¶ added in v1.9.0
type VolumeListReport ¶ added in v1.9.0
type VolumeListReport struct {
VolumeConfigResponse
}
type VolumePruneOptions ¶ added in v1.9.0
type VolumePruneOptions struct {
Force bool
}
type VolumePruneReport ¶
type VolumeRmOptions ¶ added in v1.9.0
type VolumeRmReport ¶ added in v1.9.0
type WaitOptions ¶ added in v1.9.0
type WaitOptions struct {
Condition define.ContainerStatus
Interval time.Duration
Latest bool
}