Documentation ¶
Index ¶
- Constants
- func ConvertToLibpodEvent(e Event) *libpodEvents.Event
- 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 ValidatePodStatsOptions(args []string, options *PodStatsOptions) error
- type AttachOptions
- type AuthConfig
- type AuthReport
- type AutoUpdateOptions
- type AutoUpdateReport
- type BoolReport
- type BuildOptions
- type BuildReport
- type CheckpointOptions
- type CheckpointReport
- type CommitOptions
- type CommitReport
- type ComponentVersion
- type Container
- type ContainerCleanupOptions
- type ContainerCleanupReport
- type ContainerCopyFunc
- type ContainerCpOptions
- type ContainerCreateReport
- type ContainerCreateResponse
- type ContainerEngine
- type ContainerExistsOptions
- type ContainerExportOptions
- type ContainerFilter
- type ContainerInitOptions
- type ContainerInitReport
- type ContainerInspectReport
- type ContainerListOptions
- type ContainerLogsOptions
- type ContainerMountOptions
- type ContainerMountReport
- type ContainerPortOptions
- type ContainerPortReport
- type ContainerPruneOptions
- type ContainerRenameOptions
- type ContainerRunOptions
- type ContainerRunReport
- type ContainerRunlabelOptions
- type ContainerRunlabelReport
- type ContainerStartOptions
- type ContainerStartReport
- type ContainerStatReport
- type ContainerStatsOptions
- type ContainerStatsReport
- type ContainerUnmountOptions
- type ContainerUnmountReport
- type DiffOptions
- type DiffReport
- type DockerVolumeCreate
- type EngineMode
- type EngineSetup
- type Event
- type EventsOptions
- type ExecOptions
- type GenerateKubeOptions
- type GenerateKubeReport
- type GenerateSystemdOptions
- type GenerateSystemdReport
- type HealthCheckOptions
- type IDOrNameResponse
- type IDOrNamed
- type IDOrNames
- type Identifier
- type Image
- type ImageEngine
- type ImageFilter
- type ImageHistoryLayer
- type ImageHistoryOptions
- type ImageHistoryReport
- type ImageImportOptions
- type ImageImportReport
- type ImageInspectReport
- type ImageListOptions
- type ImageLoadOptions
- type ImageLoadReport
- type ImageMountOptions
- type ImageMountReport
- type ImagePruneOptions
- type ImagePullOptions
- type ImagePullReport
- type ImagePushOptions
- type ImageRemoveOptions
- type ImageRemoveReport
- type ImageSaveOptions
- type ImageSearchOptions
- type ImageSearchReport
- type ImageSummary
- type ImageTagOptions
- type ImageTreeOptions
- type ImageTreeReport
- type ImageUnmountOptions
- type ImageUnmountReport
- type ImageUntagOptions
- type InspectOptions
- type KillOptions
- type KillReport
- type ListContainer
- type ListContainerNamespaces
- type ListPodContainer
- type ListPodsReport
- type ListRegistriesReport
- type ManifestAddOptions
- type ManifestAnnotateOptions
- type ManifestCreateOptions
- type Named
- type Names
- type NetOptions
- type NetworkConnectOptions
- type NetworkCreateOptions
- type NetworkCreateReport
- type NetworkDisconnectOptions
- type NetworkInspectReport
- type NetworkListOptions
- type NetworkListReport
- type NetworkPruneOptions
- type NetworkPruneReport
- type NetworkReloadOptions
- type NetworkReloadReport
- type NetworkRmOptions
- type NetworkRmReport
- type PauseUnPauseOptions
- type PauseUnpauseReport
- type PlayKubeOptions
- type PlayKubePod
- type PlayKubeReport
- 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 PodStatsOptions
- type PodStatsReport
- type PodStopOptions
- type PodStopReport
- type PodTopOptions
- type PodUnpauseReport
- type PodmanConfig
- type PodunpauseOptions
- type PsSortedCreateTime
- type Report
- type RestartOptions
- type RestartReport
- type RestoreOptions
- type RestoreReport
- type RmOptions
- type RmReport
- type SecretCreateOptions
- type SecretCreateReport
- type SecretCreateRequest
- type SecretDriverSpec
- type SecretInfoReport
- type SecretInfoReportCompat
- type SecretListReport
- type SecretListRequest
- type SecretRmOptions
- type SecretRmReport
- type SecretSpec
- type SecretVersion
- type ServiceOptions
- type SetTrustOptions
- type ShowTrustOptions
- type ShowTrustReport
- type SignOptions
- type SignReport
- type SortListContainers
- type StopOptions
- type StopReport
- type StringSet
- type StringSliceReport
- type SwagDockerVolumeInfoResponse
- type SwagDockerVolumePruneResponse
- type SwagErrNoSuchSecret
- type SwagErrSecretInUse
- type SwagSecretCreateResponse
- type SwagSecretInspectCompatResponse
- type SwagSecretInspectResponse
- type SwagSecretListCompatResponse
- type SwagSecretListResponse
- type SwagVolumeListResponse
- type SystemDfContainerReport
- type SystemDfImageReport
- type SystemDfOptions
- type SystemDfReport
- type SystemDfVolumeReport
- type SystemEngine
- type SystemMigrateOptions
- type SystemPruneOptions
- type SystemPruneReport
- type SystemResetOptions
- type SystemVersionReport
- type TopOptions
- type Volume
- type VolumeConfigResponse
- type VolumeCreateOptions
- type VolumeDeleteOptions
- type VolumeDeleteReport
- type VolumeFilter
- type VolumeInfo
- type VolumeInspectReport
- type VolumeListBody
- type VolumeListOptions
- type VolumeListReport
- type VolumePruneOptions
- type VolumeRmOptions
- type VolumeRmReport
- type WaitOptions
- type WaitReport
Constants ¶
const ( ABIMode = EngineMode("abi") TunnelMode = EngineMode("tunnel") MigrateMode = EngineSetup("migrate") NoFDsMode = EngineSetup("disablefds") NormalMode = EngineSetup("normal") RenumberMode = EngineSetup("renumber") ResetMode = EngineSetup("reset") )
Variables ¶
This section is empty.
Functions ¶
func ConvertToLibpodEvent ¶
func ConvertToLibpodEvent(e Event) *libpodEvents.Event
ConvertToLibpodEvent converts an entities event to a libpod one.
func FilterIDFn ¶
func FilterIDFn(id []string) func(Identifier) bool
func FilterIDOrNameFn ¶
func FilterNameFn ¶
func FilterNamesFn ¶
func ValidatePodStatsOptions ¶
func ValidatePodStatsOptions(args []string, options *PodStatsOptions) error
ValidatePodStatsOptions validates the specified slice and options. Allows for sharing code in the front- and the back-end.
Types ¶
type AttachOptions ¶
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 AuthConfig ¶ added in v3.1.0
type AuthConfig struct {
types.AuthConfig
}
swagger:model AuthConfig
type AuthReport ¶ added in v3.1.0
AuthReport describes the response for authentication check
type AutoUpdateOptions ¶
type AutoUpdateOptions struct { // Authfile to use when contacting registries. Authfile string }
AutoUpdateOptions are the options for running auto-update.
type AutoUpdateReport ¶
type AutoUpdateReport struct { // Units - the restarted systemd units during auto-update. Units []string }
AutoUpdateReport contains the results from running auto-update.
type BoolReport ¶
type BoolReport struct {
Value bool
}
type BuildOptions ¶
type BuildOptions struct {
imagebuildah.BuildOptions
}
BuildOptions describe the options for building container images.
type BuildReport ¶
type BuildReport struct { // ID of the image. ID string }
BuildReport is the image-build report.
type CheckpointOptions ¶
type CheckpointReport ¶
type CommitOptions ¶
type CommitReport ¶
type CommitReport struct {
Id string //nolint
}
type ComponentVersion ¶
type ContainerCleanupOptions ¶
type ContainerCleanupOptions struct { All bool Exec string Latest bool Remove bool RemoveImage bool }
ContainerCleanupOptions are the CLI values for the cleanup command
type ContainerCleanupReport ¶
ContainerCleanupReport describes the response from a container cleanup
type ContainerCopyFunc ¶
type ContainerCopyFunc func() error
type ContainerCpOptions ¶
type ContainerCpOptions struct { // Pause the container while copying. Pause bool // Extract the tarfile into the destination directory. Extract bool }
ContainerCpOptions describes input options for cp.
type ContainerCreateReport ¶
type ContainerCreateReport struct {
Id string //nolint
}
type ContainerCreateResponse ¶
type ContainerCreateResponse struct { // ID of the container created ID string `json:"Id"` // Warnings during container creation Warnings []string `json:"Warnings"` }
ContainerCreateResponse is the response struct for creating a container
type ContainerEngine ¶
type ContainerEngine interface { AutoUpdate(ctx context.Context, options AutoUpdateOptions) (*AutoUpdateReport, []error) 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) ContainerCopyFromArchive(ctx context.Context, nameOrID string, path string, reader io.Reader) (ContainerCopyFunc, error) ContainerCopyToArchive(ctx context.Context, nameOrID string, path string, writer io.Writer) (ContainerCopyFunc, 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, streams define.AttachStreams) (int, error) ContainerExecDetached(ctx context.Context, nameOrID string, options ExecOptions) (string, error) ContainerExists(ctx context.Context, nameOrID string, options ContainerExistsOptions) (*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, error) ContainerKill(ctx context.Context, namesOrIds []string, options KillOptions) ([]*KillReport, error) ContainerList(ctx context.Context, options ContainerListOptions) ([]ListContainer, error) ContainerLogs(ctx context.Context, containers []string, options ContainerLogsOptions) error ContainerMount(ctx context.Context, nameOrIDs []string, options ContainerMountOptions) ([]*ContainerMountReport, error) ContainerPause(ctx context.Context, namesOrIds []string, options PauseUnPauseOptions) ([]*PauseUnpauseReport, error) ContainerPort(ctx context.Context, nameOrID string, options ContainerPortOptions) ([]*ContainerPortReport, error) ContainerPrune(ctx context.Context, options ContainerPruneOptions) ([]*reports.PruneReport, error) ContainerRename(ctr context.Context, nameOrID string, options ContainerRenameOptions) 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) ContainerRunlabel(ctx context.Context, label string, image string, args []string, opts ContainerRunlabelOptions) error ContainerStart(ctx context.Context, namesOrIds []string, options ContainerStartOptions) ([]*ContainerStartReport, error) ContainerStat(ctx context.Context, nameOrDir string, path string) (*ContainerStatReport, error) ContainerStats(ctx context.Context, namesOrIds []string, options ContainerStatsOptions) (chan ContainerStatsReport, 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) Events(ctx context.Context, opts EventsOptions) error GenerateSystemd(ctx context.Context, nameOrID string, opts GenerateSystemdOptions) (*GenerateSystemdReport, error) GenerateKube(ctx context.Context, nameOrIDs []string, opts GenerateKubeOptions) (*GenerateKubeReport, error) SystemPrune(ctx context.Context, options SystemPruneOptions) (*SystemPruneReport, error) HealthCheckRun(ctx context.Context, nameOrID string, options HealthCheckOptions) (*define.HealthCheckResults, error) Info(ctx context.Context) (*define.Info, error) NetworkConnect(ctx context.Context, networkname string, options NetworkConnectOptions) error NetworkCreate(ctx context.Context, name string, options NetworkCreateOptions) (*NetworkCreateReport, error) NetworkDisconnect(ctx context.Context, networkname string, options NetworkDisconnectOptions) error NetworkExists(ctx context.Context, networkname string) (*BoolReport, error) NetworkInspect(ctx context.Context, namesOrIds []string, options InspectOptions) ([]NetworkInspectReport, []error, error) NetworkList(ctx context.Context, options NetworkListOptions) ([]*NetworkListReport, error) NetworkPrune(ctx context.Context, options NetworkPruneOptions) ([]*NetworkPruneReport, error) NetworkReload(ctx context.Context, names []string, options NetworkReloadOptions) ([]*NetworkReloadReport, error) NetworkRm(ctx context.Context, namesOrIds []string, options NetworkRmOptions) ([]*NetworkRmReport, error) PlayKube(ctx context.Context, path string, opts PlayKubeOptions) (*PlayKubeReport, 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) PodPrune(ctx context.Context, options PodPruneOptions) ([]*PodPruneReport, 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) PodStats(ctx context.Context, namesOrIds []string, options PodStatsOptions) ([]*PodStatsReport, 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) SetupRootless(ctx context.Context, cmd *cobra.Command) error SecretCreate(ctx context.Context, name string, reader io.Reader, options SecretCreateOptions) (*SecretCreateReport, error) SecretInspect(ctx context.Context, nameOrIDs []string) ([]*SecretInfoReport, []error, error) SecretList(ctx context.Context) ([]*SecretInfoReport, error) SecretRm(ctx context.Context, nameOrID []string, opts SecretRmOptions) ([]*SecretRmReport, error) Shutdown(ctx context.Context) SystemDf(ctx context.Context, options SystemDfOptions) (*SystemDfReport, error) Version(ctx context.Context) (*SystemVersionReport, error) VolumeCreate(ctx context.Context, opts VolumeCreateOptions) (*IDOrNameResponse, error) VolumeExists(ctx context.Context, namesOrID string) (*BoolReport, error) VolumeInspect(ctx context.Context, namesOrIds []string, opts InspectOptions) ([]*VolumeInspectReport, []error, error) VolumeList(ctx context.Context, opts VolumeListOptions) ([]*VolumeListReport, error) VolumePrune(ctx context.Context, options VolumePruneOptions) ([]*reports.PruneReport, error) VolumeRm(ctx context.Context, namesOrIds []string, opts VolumeRmOptions) ([]*VolumeRmReport, error) }
type ContainerExistsOptions ¶
type ContainerExistsOptions struct {
External bool
}
ContainerExistsOptions describes the cli values to check if a container exists
type ContainerExportOptions ¶
type ContainerExportOptions struct {
Output string
}
type ContainerFilter ¶
func CompileContainerFilters ¶
func CompileContainerFilters(filters url.Values) ContainerFilter
type ContainerInitOptions ¶
ContainerInitOptions describes input options for the container init cli
type ContainerInitReport ¶
ContainerInitReport describes the results of a container init
type ContainerInspectReport ¶
type ContainerInspectReport struct {
*define.InspectContainerData
}
type ContainerListOptions ¶
type ContainerListOptions struct { All bool Filters map[string][]string Format string Last int Latest bool Namespace bool Pod bool Quiet bool Size bool External bool Sort string Sync bool Watch uint }
ContainerListOptions describes the CLI options for listing containers
type ContainerLogsOptions ¶
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 stdout to this Writer. StdoutWriter io.Writer // Write the stderr to this Writer. StderrWriter io.Writer }
ContainerLogsOptions describes the options to extract container logs.
type ContainerMountOptions ¶
ContainerMountOptions describes the input values for mounting containers in the CLI
type ContainerMountReport ¶
ContainerMountReport describes the response from container mount
type ContainerPortOptions ¶
ContainerPortOptions describes the options to obtain port information on containers
type ContainerPortReport ¶
type ContainerPortReport struct { Id string //nolint Ports []ocicni.PortMapping }
ContainerPortReport describes the output needed for the CLI to output ports
type ContainerPruneOptions ¶
ContainerPruneOptions describes the options needed to prune a container from the CLI
type ContainerRenameOptions ¶
type ContainerRenameOptions struct { // NewName is the new name that will be given to the container. NewName string }
ContainerRenameOptions describes input options for renaming a container.
type ContainerRunOptions ¶
type ContainerRunOptions struct { CIDFile string Detach bool DetachKeys string ErrorStream *os.File InputStream *os.File OutputStream *os.File PreserveFDs uint Rm bool SigProxy bool Spec *specgen.SpecGenerator }
ContainerRunOptions describes the options needed to run a container from the CLI
type ContainerRunReport ¶
ContainerRunReport describes the results of running a container
type ContainerRunlabelOptions ¶
type ContainerRunlabelOptions struct { // Authfile - path to an authentication file. Authfile string // CertDir - path to a directory containing TLS certifications and // keys. CertDir string // Credentials - `user:password` to use when pulling an image. Credentials string // Display - do not execute but print the command. Display bool // Replace - replace an existing container with a new one from the // image. Replace bool // Name - use this name when executing the runlabel container. Name string // Optional1 - fist optional parameter for install. Optional1 string // Optional2 - second optional parameter for install. Optional2 string // Optional3 - third optional parameter for install. Optional3 string // Pull - pull the specified image if it's not in the local storage. Pull bool // Quiet - suppress output when pulling images. Quiet bool // SignaturePolicy - path to a signature-policy file. SignaturePolicy string // SkipTLSVerify - skip HTTPS and certificate verifications when // contacting registries. SkipTLSVerify types.OptionalBool }
ContainerRunlabelOptions are the options to execute container-runlabel.
type ContainerRunlabelReport ¶
type ContainerRunlabelReport struct { }
ContainerRunlabelReport contains the results from executing container-runlabel.
type ContainerStartOptions ¶
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 ¶
ContainerStartReport describes the response from starting containers from the cli
type ContainerStatReport ¶
type ContainerStatsOptions ¶
type ContainerStatsOptions struct { // Operate on the latest known container. Only supported for local // clients. Latest bool // Stream stats. Stream bool }
ContainerStatsOptions describes input options for getting stats on containers
type ContainerStatsReport ¶
type ContainerStatsReport struct { // Error from reading stats. Error error // Results, set when there is no error. Stats []define.ContainerStats }
ContainerStatsReport is used for streaming container stats.
type ContainerUnmountOptions ¶
ContainerUnmountOptions are the options from the cli for unmounting
type ContainerUnmountReport ¶
ContainerUnmountReport describes the response from umounting a container
type DiffOptions ¶
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 ¶
DiffReport provides changes for object
type DockerVolumeCreate ¶
type DockerVolumeCreate docker_api_types_volume.VolumeCreateBody
swagger:model DockerVolumeCreate
type EngineMode ¶
type EngineMode string
EngineMode is the connection type podman is using to access libpod
type EngineSetup ¶
type EngineSetup string
EngineSetup calls out whether a "normal" or specialized engine should be created
type Event ¶
type Event struct { // TODO: it would be nice to have full control over the types at some // point and fork such Docker types. dockerEvents.Message }
Event combines various event-related data such as time, event type, status and more.
func ConvertToEntitiesEvent ¶
func ConvertToEntitiesEvent(e libpodEvents.Event) *Event
ConvertToEntitiesEvent converts a libpod event to an entities one.
type EventsOptions ¶
type ExecOptions ¶
type ExecOptions struct { Cmd []string DetachKeys string Envs map[string]string Interactive bool Latest bool PreserveFDs uint Privileged bool Tty bool User string WorkDir string }
ExecOptions describes the cli values to exec into a container
type GenerateKubeOptions ¶
type GenerateKubeOptions struct { // Service - generate YAML for a Kubernetes _service_ object. Service bool }
GenerateKubeOptions control the generation of Kubernetes YAML files.
type GenerateKubeReport ¶
type GenerateKubeReport struct { // Reader - the io.Reader to reader the generated YAML file. Reader io.Reader }
GenerateKubeReport
type GenerateSystemdOptions ¶
type GenerateSystemdOptions struct { // Name - use container/pod name instead of its ID. Name bool // New - create a new container instead of starting a new one. New bool // RestartPolicy - systemd restart policy. RestartPolicy string // StopTimeout - time when stopping the container. StopTimeout *uint // ContainerPrefix - systemd unit name prefix for containers ContainerPrefix string // PodPrefix - systemd unit name prefix for pods PodPrefix string // Separator - systemd unit name separator between name/id and prefix Separator string // NoHeader - skip header generation NoHeader bool }
GenerateSystemdOptions control the generation of systemd unit files.
type GenerateSystemdReport ¶
type GenerateSystemdReport struct { // Units of the generate process. key = unit name -> value = unit content Units map[string]string }
GenerateSystemdReport
type HealthCheckOptions ¶
type HealthCheckOptions struct{}
type IDOrNameResponse ¶
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 ImageEngine ¶
type ImageEngine interface { Build(ctx context.Context, containerFiles []string, opts BuildOptions) (*BuildReport, error) Config(ctx context.Context) (*config.Config, 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, namesOrIDs []string, opts InspectOptions) ([]*ImageInspectReport, []error, error) List(ctx context.Context, opts ImageListOptions) ([]*ImageSummary, error) Load(ctx context.Context, opts ImageLoadOptions) (*ImageLoadReport, error) Mount(ctx context.Context, images []string, options ImageMountOptions) ([]*ImageMountReport, error) Prune(ctx context.Context, opts ImagePruneOptions) ([]*reports.PruneReport, error) Pull(ctx context.Context, rawImage string, opts ImagePullOptions) (*ImagePullReport, error) Push(ctx context.Context, source string, destination string, opts ImagePushOptions) error Remove(ctx context.Context, images []string, opts ImageRemoveOptions) (*ImageRemoveReport, []error) Save(ctx context.Context, nameOrID string, tags []string, options ImageSaveOptions) error Search(ctx context.Context, term string, opts ImageSearchOptions) ([]ImageSearchReport, error) SetTrust(ctx context.Context, args []string, options SetTrustOptions) error ShowTrust(ctx context.Context, args []string, options ShowTrustOptions) (*ShowTrustReport, error) Shutdown(ctx context.Context) Tag(ctx context.Context, nameOrID string, tags []string, options ImageTagOptions) error Tree(ctx context.Context, nameOrID string, options ImageTreeOptions) (*ImageTreeReport, error) Unmount(ctx context.Context, images []string, options ImageUnmountOptions) ([]*ImageUnmountReport, error) Untag(ctx context.Context, nameOrID string, tags []string, options ImageUntagOptions) error ManifestCreate(ctx context.Context, names, images []string, opts ManifestCreateOptions) (string, error) ManifestExists(ctx context.Context, name string) (*BoolReport, error) ManifestInspect(ctx context.Context, name string) ([]byte, error) ManifestAdd(ctx context.Context, opts ManifestAddOptions) (string, error) ManifestAnnotate(ctx context.Context, names []string, opts ManifestAnnotateOptions) (string, error) ManifestRemove(ctx context.Context, names []string) (string, error) ManifestPush(ctx context.Context, name, destination string, imagePushOpts ImagePushOptions) (string, error) Sign(ctx context.Context, names []string, options SignOptions) (*SignReport, 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 ¶
type ImageImportReport ¶
type ImageImportReport struct {
Id string // nolint
}
type ImageInspectReport ¶
ImageInspectReport is the data when inspecting an image.
type ImageListOptions ¶
type ImageListOptions struct { All bool `json:"all" schema:"all"` Filter []string `json:"Filter,omitempty"` }
Image List Options
type ImageLoadOptions ¶
type ImageLoadReport ¶
type ImageLoadReport struct {
Names []string
}
type ImageMountOptions ¶
ImageMountOptions describes the input values for mounting images in the CLI
type ImageMountReport ¶
type ImageMountReport struct { Err error Id string // nolint Name string Repositories []string Path string }
ImageMountReport describes the response from image mount
type ImagePruneOptions ¶
type ImagePullOptions ¶
type ImagePullOptions struct { // AllTags can be specified to pull all tags of an image. Note // that this only works if the 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 // Username for authenticating against the registry. Username string // Password for authenticating against the registry. Password string // Arch will overwrite the local architecture for image pulls. Arch string // OS will overwrite the local operating system (OS) for image // pulls. OS string // Variant will overwrite the local variant for image pulls. Variant 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 // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify types.OptionalBool // PullPolicy whether to pull new image PullPolicy config.PullPolicy }
ImagePullOptions are the arguments for pulling images.
type ImagePullReport ¶
type ImagePullReport struct { // Stream used to provide output from c/image Stream string `json:"stream,omitempty"` // Error contains text of errors from c/image Error string `json:"error,omitempty"` // Images contains the ID's of the images pulled Images []string `json:"images,omitempty"` // ID contains image id (retained for backwards compatibility) ID string `json:"id,omitempty"` }
ImagePullReport is the response from pulling one or more images.
type ImagePushOptions ¶
type ImagePushOptions struct { // All indicates that all images referenced in an manifest list should be pushed All 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 // 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 // Username for authenticating against the registry. Username string // Password for authenticating against the registry. Password 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 // Rm indicates whether to remove the manifest list if push succeeds Rm 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 // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify types.OptionalBool // Progress to get progress notifications Progress chan types.ProgressProperties }
ImagePushOptions are the arguments for pushing images.
type ImageRemoveOptions ¶
type ImageRemoveOptions struct { // All will remove all images. All bool // Foce will force image removal including containers using the images. Force bool }
ImageRemoveOptions can be used to alter image removal.
type ImageRemoveReport ¶
type ImageRemoveReport struct { // Deleted images. Deleted []string `json:",omitempty"` // Untagged images. Can be longer than Deleted. Untagged []string `json:",omitempty"` // ExitCode describes the exit codes as described in the `podman rmi` // man page. ExitCode int }
ImageRemoveResponse is the response for removing one or more image(s) from storage and images what was untagged vs actually removed.
type ImageSaveOptions ¶
type ImageSaveOptions struct { // Compress layers when saving to a directory. Compress bool // Format of saving the image: oci-archive, oci-dir (directory with oci // manifest type), docker-archive, docker-dir (directory with v2s2 // manifest type). Format string // MultiImageArchive denotes if the created archive shall include more // than one image. Additional tags will be interpreted as references // to images which are added to the archive. MultiImageArchive bool // Output - write image to the specified path. Output string // Do not save the signature from the source image RemoveSignatures bool // Quiet - suppress output when copying images Quiet bool }
ImageSaveOptions provide options for saving images.
type ImageSearchOptions ¶
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 // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify types.OptionalBool // ListTags search the available tags of the repository ListTags bool }
ImageSearchOptions are the arguments for searching images.
type ImageSearchReport ¶
type ImageSearchReport struct { // Index is the image index (e.g., "docker.io" or "quay.io") Index string // Name is the canonical 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 // Tag is the repository tag Tag string }
ImageSearchReport is the response from searching images.
type ImageSummary ¶
type ImageSummary struct { ID string `json:"Id"` ParentId string // nolint RepoTags []string RepoDigests []string Created int64 Size int64 VirtualSize int64 Labels map[string]string Containers int ReadOnly bool `json:",omitempty"` Dangling bool `json:",omitempty"` // Podman extensions Names []string `json:",omitempty"` Digest 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 ¶
type ImageTagOptions struct{}
type ImageTreeOptions ¶
type ImageTreeOptions struct {
WhatRequires bool // Show all child images and layers of the specified image
}
ImageTreeOptions provides options for ImageEngine.Tree()
type ImageTreeReport ¶
type ImageTreeReport struct {
Tree string // TODO: Refactor move presentation work out of server
}
ImageTreeReport provides results from ImageEngine.Tree()
type ImageUnmountOptions ¶
ImageUnmountOptions are the options from the cli for unmounting
type ImageUnmountReport ¶
ImageUnmountReport describes the response from umounting an image
type ImageUntagOptions ¶
type ImageUntagOptions struct{}
type InspectOptions ¶
type InspectOptions struct { // Format - change the output to JSON or a Go template. Format string `json:",omitempty"` // Latest - inspect the latest container Podman is aware of. Latest bool `json:",omitempty"` // Size (containers only) - display total file size. Size bool `json:",omitempty"` // Type -- return JSON for specified type. Type string `json:",omitempty"` // All -- inspect all All bool `json:",omitempty"` }
All CLI inspect commands and inspect sub-commands use the same options
type KillOptions ¶
type KillReport ¶
type ListContainer ¶
type ListContainer struct { // AutoRemove AutoRemove bool // Container command Command []string // Container creation time Created time.Time // Human readable container creation time. CreatedAt string // 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 // Container image ID ImageID 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 network names assigned to the container Networks []string // 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 *define.ContainerSize // Time when container started StartedAt int64 // State of container State string // Status is a human-readable approximation of a duration for json output Status string }
Listcontainer describes a container suitable for listing
func (ListContainer) CGROUPNS ¶
func (l ListContainer) CGROUPNS() string
func (ListContainer) IPC ¶
func (l ListContainer) IPC() string
func (ListContainer) MNT ¶
func (l ListContainer) MNT() string
func (ListContainer) NET ¶
func (l ListContainer) NET() string
func (ListContainer) PIDNS ¶
func (l ListContainer) PIDNS() string
func (ListContainer) USERNS ¶
func (l ListContainer) USERNS() string
func (ListContainer) UTS ¶
func (l ListContainer) UTS() string
type ListContainerNamespaces ¶
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 ¶
type ListPodsReport ¶
type ListRegistriesReport ¶
type ListRegistriesReport struct {
Registries []string
}
ListRegistriesReport is the report when querying for a sorted list of registries which may be contacted during certain operations.
type ManifestAddOptions ¶
type ManifestAddOptions struct { All bool `json:"all" schema:"all"` Annotation []string `json:"annotation" schema:"annotation"` Arch string `json:"arch" schema:"arch"` Authfile string `json:"-" schema:"-"` CertDir string `json:"-" schema:"-"` Features []string `json:"features" schema:"features"` Images []string `json:"images" schema:"images"` OS string `json:"os" schema:"os"` OSVersion string `json:"os_version" schema:"os_version"` Password string `json:"-" schema:"-"` SkipTLSVerify types.OptionalBool `json:"-" schema:"-"` Username string `json:"-" schema:"-"` Variant string `json:"variant" schema:"variant"` }
type ManifestAnnotateOptions ¶
type ManifestAnnotateOptions struct { Annotation []string `json:"annotation"` Arch string `json:"arch" schema:"arch"` Features []string `json:"features" schema:"features"` OS string `json:"os" schema:"os"` OSFeatures []string `json:"os_features" schema:"os_features"` OSVersion string `json:"os_version" schema:"os_version"` Variant string `json:"variant" schema:"variant"` }
type ManifestCreateOptions ¶
type ManifestCreateOptions struct {
All bool `schema:"all"`
}
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 ¶
type NetOptions struct { AddHosts []string Aliases []string CNINetworks []string UseImageResolvConf bool DNSOptions []string DNSSearch []string DNSServers []net.IP Network specgen.Namespace NoHosts bool PublishPorts []specgen.PortMapping StaticIP *net.IP StaticMAC *net.HardwareAddr // NetworkOptions are additional options for each network NetworkOptions map[string][]string }
NetOptions reflect the shared network options between pods and containers
type NetworkConnectOptions ¶
NetworkConnectOptions describes options for connecting a container to a network
type NetworkCreateOptions ¶
type NetworkCreateOptions struct { DisableDNS bool Driver string Gateway net.IP Internal bool Labels map[string]string MacVLAN string Range net.IPNet Subnet net.IPNet IPv6 bool // Mapping of driver options and values. Options map[string]string }
NetworkCreateOptions describes options to create a network swagger:model NetworkCreateOptions
type NetworkCreateReport ¶
type NetworkCreateReport struct {
Filename string
}
NetworkCreateReport describes a created network for the cli
type NetworkDisconnectOptions ¶
NetworkDisconnectOptions describes options for disconnecting containers from networks
type NetworkInspectReport ¶
type NetworkInspectReport map[string]interface{}
NetworkInspectReport describes the results from inspect networks
type NetworkListOptions ¶
NetworkListOptions describes options for listing networks in cli
type NetworkListReport ¶
type NetworkListReport struct { *libcni.NetworkConfigList Labels map[string]string }
NetworkListReport describes the results from listing networks
type NetworkPruneOptions ¶ added in v3.1.0
NetworkPruneOptions describes options for pruning unused cni networks
type NetworkPruneReport ¶ added in v3.1.0
NetworkPruneReport containers the name of network and an error associated in its pruning (removal) swagger:model NetworkPruneReport
type NetworkReloadOptions ¶
NetworkReloadOptions describes options for reloading container network configuration.
type NetworkReloadReport ¶
NetworkReloadReport describes the results of reloading a container network.
type NetworkRmOptions ¶
type NetworkRmOptions struct {
Force bool
}
NetworkRmOptions describes options for removing networks
type NetworkRmReport ¶
NetworkRmReport describes the results of network removal
type PauseUnPauseOptions ¶
type PauseUnPauseOptions struct {
All bool
}
type PauseUnpauseReport ¶
type PlayKubeOptions ¶
type PlayKubeOptions struct { // Authfile - path to an authentication file. Authfile string // CertDir - to a directory containing TLS certifications and keys. CertDir string // Username for authenticating against the registry. Username string // Password for authenticating against the registry. Password string // Network - name of the CNI network to connect to. Network string // Quiet - suppress output when pulling images. Quiet bool // SignaturePolicy - path to a signature-policy file. SignaturePolicy string // SkipTLSVerify - skip https and certificate validation when // contacting container registries. SkipTLSVerify types.OptionalBool // SeccompProfileRoot - path to a directory containing seccomp // profiles. SeccompProfileRoot string // ConfigMaps - slice of pathnames to kubernetes configmap YAMLs. ConfigMaps []string // LogDriver for the container. For example: journald LogDriver string // Start - don't start the pod if false Start types.OptionalBool }
PlayKubeOptions controls playing kube YAML files.
type PlayKubePod ¶
type PlayKubePod struct { // ID - ID of the pod created as a result of play kube. ID string // Containers - the IDs of the containers running in the created pod. Containers []string // Logs - non-fatal errors and log messages while processing. Logs []string // ContainerErrors - any errors that occurred while starting containers // in the pod. ContainerErrors []string }
PlayKubePod represents a single pod and associated containers created by play kube
type PlayKubeReport ¶
type PlayKubeReport struct { // Pods - pods created by play kube. Pods []PlayKubePod }
PlayKubeReport contains the results of running play kube.
type PodCreateOptions ¶
type PodCreateOptions struct { CGroupParent string CreateCommand []string Hostname string Infra bool InfraImage string InfraCommand string InfraConmonPidFile string Labels map[string]string Name string Net *NetOptions }
func (PodCreateOptions) ToPodSpecGen ¶
func (p PodCreateOptions) ToPodSpecGen(s *specgen.PodSpecGenerator)
type PodCreateReport ¶
type PodCreateReport struct {
Id string //nolint
}
type PodDeleteReport ¶
type PodDeleteReport struct{ Report }
type PodInspectOptions ¶
type PodInspectReport ¶
type PodInspectReport struct {
*define.InspectPodData
}
type PodKillOptions ¶
type PodKillReport ¶
type PodPSOptions ¶
type PodPauseOptions ¶
type PodPauseReport ¶
type PodPruneOptions ¶
type PodPruneOptions struct {
Force bool `json:"force" schema:"force"`
}
type PodPruneReport ¶
type PodRestartOptions ¶
type PodRestartReport ¶
type PodRmReport ¶
type PodStartOptions ¶
type PodStartReport ¶
type PodStatsOptions ¶
type PodStatsOptions struct { // All - provide stats for all running pods. All bool // Latest - provide stats for the latest pod. Latest bool }
PodStatsOptions are options for the pod stats command.
type PodStatsReport ¶
type PodStatsReport struct { CPU string MemUsage string MemUsageBytes string Mem string NetIO string BlockIO string PIDS string Pod string CID string Name string }
PodStatsReport includes pod-resource statistics data.
type PodStopReport ¶
type PodTopOptions ¶
type PodUnpauseReport ¶
type PodmanConfig ¶
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 Identity string // ssh identity for connecting to server MaxWorks int // maximum number of parallel threads RegistriesConf string // allows for specifying a custom registries.conf Remote bool // Connection to Podman API Service will use RESTful API RuntimePath string // --runtime flag will set Engine.RuntimePath RuntimeFlags []string // global flags for the container runtime Syslog bool // write to StdOut and Syslog, not supported when tunneling Trace bool // Hidden: Trace execution URI string // URI to RESTful 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.
type PodunpauseOptions ¶
type PsSortedCreateTime ¶
type PsSortedCreateTime struct{ SortListContainers }
func (PsSortedCreateTime) Less ¶
func (a PsSortedCreateTime) Less(i, j int) bool
type RestartOptions ¶
type RestartReport ¶
type RestoreOptions ¶
type RestoreReport ¶
type SecretCreateOptions ¶ added in v3.1.0
type SecretCreateOptions struct {
Driver string
}
type SecretCreateReport ¶ added in v3.1.0
type SecretCreateReport struct {
ID string
}
type SecretCreateRequest ¶ added in v3.1.0
type SecretCreateRequest struct { // User-defined name of the secret. Name string // Base64-url-safe-encoded (RFC 4648) data to store as secret. Data string // Driver represents a driver (default "file") Driver SecretDriverSpec }
swagger:model SecretCreate
type SecretDriverSpec ¶ added in v3.1.0
type SecretInfoReport ¶ added in v3.1.0
type SecretInfoReportCompat ¶ added in v3.1.0
type SecretInfoReportCompat struct { SecretInfoReport Version SecretVersion }
type SecretListReport ¶ added in v3.1.0
type SecretListRequest ¶ added in v3.1.0
type SecretRmOptions ¶ added in v3.1.0
type SecretRmOptions struct {
All bool
}
type SecretRmReport ¶ added in v3.1.0
type SecretSpec ¶ added in v3.1.0
type SecretSpec struct { Name string Driver SecretDriverSpec }
type SecretVersion ¶ added in v3.1.0
type SecretVersion struct {
Index int
}
type ServiceOptions ¶
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 SetTrustOptions ¶
SetTrustOptions describes the CLI options for setting trust
type ShowTrustOptions ¶
ShowTrustOptions are the cli options for showing trust
type ShowTrustReport ¶
type ShowTrustReport struct { Raw []byte SystemRegistriesDirPath string JSONOutput []byte Policies []*trust.Policy }
ShowTrustReport describes the results of show trust
type SignOptions ¶
SignOptions describes input options for the CLI signing
type SortListContainers ¶
type SortListContainers []ListContainer
func SortPsOutput ¶
func SortPsOutput(sortBy string, psOutput SortListContainers) (SortListContainers, error)
func (SortListContainers) Len ¶
func (a SortListContainers) Len() int
func (SortListContainers) Swap ¶
func (a SortListContainers) Swap(i, j int)
type StopReport ¶
type StringSet ¶
type StringSet struct {
// contains filtered or unexported fields
}
func NewStringSet ¶
type StringSliceReport ¶
type StringSliceReport struct {
Value []string
}
StringSliceReport wraps a string slice.
type SwagDockerVolumeInfoResponse ¶
type SwagDockerVolumeInfoResponse struct { // in:body Body struct { docker_api_types.Volume } }
This response definition is used for both the create and inspect endpoints swagger:response DockerVolumeInfoResponse
type SwagDockerVolumePruneResponse ¶
type SwagDockerVolumePruneResponse struct { // in:body Body struct { docker_api_types.VolumesPruneReport } }
Volume prune response swagger:response DockerVolumePruneResponse
type SwagErrNoSuchSecret ¶ added in v3.1.0
type SwagErrNoSuchSecret struct { // in:body Body struct { errorhandling.ErrorModel } }
No such secret swagger:response NoSuchSecret
type SwagErrSecretInUse ¶ added in v3.1.0
type SwagErrSecretInUse struct { // in:body Body struct { errorhandling.ErrorModel } }
Secret in use swagger:response SecretInUse
type SwagSecretCreateResponse ¶ added in v3.1.0
type SwagSecretCreateResponse struct { // in:body Body struct { SecretCreateReport } }
Secret create response swagger:response SecretCreateResponse
type SwagSecretInspectCompatResponse ¶ added in v3.1.0
type SwagSecretInspectCompatResponse struct { // in:body Body SecretInfoReportCompat }
Secret inspect compat swagger:response SecretInspectCompatResponse
type SwagSecretInspectResponse ¶ added in v3.1.0
type SwagSecretInspectResponse struct { // in:body Body SecretInfoReport }
Secret inspect response swagger:response SecretInspectResponse
type SwagSecretListCompatResponse ¶ added in v3.1.0
type SwagSecretListCompatResponse struct { // in:body Body []*SecretInfoReportCompat }
Secret list response swagger:response SecretListCompatResponse
type SwagSecretListResponse ¶ added in v3.1.0
type SwagSecretListResponse struct { // in:body Body []*SecretInfoReport }
Secret list response swagger:response SecretListResponse
type SwagVolumeListResponse ¶
type SwagVolumeListResponse struct { // in:body Body struct { VolumeListBody } }
Volume list response swagger:response VolumeListResponse
type SystemDfContainerReport ¶
type SystemDfContainerReport struct { ContainerID string Image string Command []string LocalVolumes int Size int64 RWSize int64 Created time.Time Status string Names string }
SystemDfContainerReport describes a container for use with df
type SystemDfImageReport ¶
type SystemDfImageReport struct { Repository string Tag string ImageID string Created time.Time Size int64 UniqueSize int64 Containers int }
SystemDfImageReport describes an image for use with df
type SystemDfOptions ¶
SystemDfOptions describes the options for getting df information
type SystemDfReport ¶
type SystemDfReport struct { Images []*SystemDfImageReport Containers []*SystemDfContainerReport Volumes []*SystemDfVolumeReport }
SystemDfReport describes the response for df information
type SystemDfVolumeReport ¶
SystemDfVolumeReport describes a volume and its size
type SystemEngine ¶
type SystemMigrateOptions ¶
type SystemMigrateOptions struct {
NewRuntime string
}
SystemMigrateOptions describes the options needed for the cli to migrate runtimes of containers
type SystemPruneOptions ¶
type SystemPruneOptions struct { All bool Volume bool Filters map[string][]string `json:"filters" schema:"filters"` }
SystemPruneOptions provides options to prune system.
type SystemPruneReport ¶
type SystemPruneReport struct { PodPruneReport []*PodPruneReport ContainerPruneReports []*reports.PruneReport ImagePruneReports []*reports.PruneReport VolumePruneReports []*reports.PruneReport ReclaimedSpace uint64 }
SystemPruneReport provides report after system prune is executed.
type SystemResetOptions ¶
type SystemResetOptions struct {
Force bool
}
SystemResetOptions describes the options for resetting your container runtime storage, etc
type SystemVersionReport ¶
type SystemVersionReport struct { // Always populated Client *define.Version `json:",omitempty"` // May be populated, when in tunnel mode Server *define.Version `json:",omitempty"` }
SystemVersionReport describes version information about the running Podman service
type TopOptions ¶
type Volume ¶
type Volume struct {
Identifier
}
type VolumeConfigResponse ¶
type VolumeConfigResponse struct {
define.InspectVolumeData
}
type VolumeCreateOptions ¶
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 VolumeInfo ¶
type VolumeInfo struct { // Date/Time the volume was created. CreatedAt string `json:"CreatedAt,omitempty"` // Name of the volume driver used by the volume. Only supports local driver // Required: true Driver string `json:"Driver"` // User-defined key/value metadata. // Always included Labels map[string]string `json:"Labels"` // Mount path of the volume on the host. // Required: true Mountpoint string `json:"Mountpoint"` // Name of the volume. // Required: true Name string `json:"Name"` // The driver specific options used when creating the volume. // Required: true Options map[string]string `json:"Options"` // The level at which the volume exists. // Libpod does not implement volume scoping, and this is provided solely for // Docker compatibility. The value is only "local". // Required: true Scope string `json:"Scope"` }
VolumeInfo Volume list response swagger:model VolumeInfo
type VolumeInspectReport ¶
type VolumeInspectReport struct {
*VolumeConfigResponse
}
type VolumeListBody ¶
type VolumeListBody struct {
Volumes []*VolumeInfo
}
VolumeListBody Volume list response swagger:model VolumeListBody
type VolumeListOptions ¶
type VolumeListReport ¶
type VolumeListReport struct {
VolumeConfigResponse
}
type VolumePruneOptions ¶
VolumePruneOptions describes the options needed to prune a volume from the CLI
type VolumeRmOptions ¶
type VolumeRmReport ¶
type WaitOptions ¶
type WaitOptions struct { Condition []define.ContainerStatus Interval time.Duration Latest bool }