Documentation
¶
Index ¶
- Constants
- Variables
- func ConvertToEntitiesEvent(e libpodEvents.Event) *types.Event
- func ConvertToLibpodEvent(e Event) *libpodEvents.Event
- func ToPodSpecGen(s specgen.PodSpecGenerator, p *PodCreateOptions) (*specgen.PodSpecGenerator, error)
- func ValidatePodStatsOptions(args []string, options *PodStatsOptions) error
- type ApplyOptions
- type ArtifactAddOptions
- type ArtifactAddReport
- type ArtifactBlob
- type ArtifactExtractOptions
- type ArtifactInspectOptions
- type ArtifactInspectReport
- type ArtifactListOptions
- type ArtifactListReport
- type ArtifactPullOptions
- type ArtifactPullReport
- type ArtifactPushOptions
- type ArtifactPushReport
- type ArtifactRemoveOptions
- type ArtifactRemoveReport
- 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 ContainerCleanupOptions
- type ContainerCleanupReport
- type ContainerCloneOptions
- type ContainerCopyFunc
- type ContainerCpOptions
- type ContainerCreateOptions
- type ContainerCreateReport
- type ContainerCreateResponse
- type ContainerEngine
- type ContainerExistsOptions
- type ContainerExportOptions
- type ContainerInitOptions
- type ContainerInitReport
- type ContainerInspectReport
- type ContainerListOptions
- type ContainerLogsOptions
- type ContainerMode
- 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 ContainerUpdateOptions
- type CopyOptions
- type DiffOptions
- type DiffReport
- type EngineMode
- type EngineSetup
- type Event
- type EventsOptions
- type ExecOptions
- type ExternalContainerFilter
- type FarmBuildOptions
- type FarmInspectReport
- type GenerateKubeOptions
- type GenerateKubeReport
- type GenerateSpecOptions
- type GenerateSpecReport
- type GenerateSystemdOptions
- type GenerateSystemdReport
- type HealthCheckOptions
- type IDOrNameResponse
- type IDResponse
- type ImageEngine
- 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 ImagePushReport
- type ImagePushStream
- type ImageRemoveOptions
- type ImageRemoveReport
- type ImageSaveOptions
- type ImageScpConnections
- type ImageScpOptions
- type ImageScpReport
- 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 KubeGenerateOptions
- type KubePlayReport
- type ListContainer
- type ListContainerNamespaces
- type ListPodContainer
- type ListPodsReport
- type ListQuadlet
- type ListRegistriesReport
- type ListReporter
- type LocksReport
- type MachineHostInfo
- type MachineInfo
- type ManifestAddArtifactOptions
- type ManifestAddOptions
- type ManifestAnnotateOptions
- type ManifestCreateOptions
- type ManifestInspectOptions
- type ManifestModifyOptions
- type ManifestModifyReport
- type ManifestPushReport
- type ManifestRemoveOptions
- type ManifestRemoveReport
- type NetFlags
- type NetOptions
- type NetworkConnectOptions
- type NetworkContainerInfo
- type NetworkCreateOptions
- type NetworkCreateReport
- type NetworkDisconnectOptions
- type NetworkInspectReport
- type NetworkListOptions
- type NetworkPruneOptions
- type NetworkPruneReport
- type NetworkReloadOptions
- type NetworkReloadReport
- type NetworkRmOptions
- type NetworkRmReport
- type NetworkUpdateOptions
- type PauseUnPauseOptions
- type PauseUnpauseReport
- type PlayKubeDownOptions
- type PlayKubeOptions
- type PlayKubePod
- type PlayKubeReport
- type PlayKubeTeardown
- type PlayKubeVolume
- type PlaySecret
- type PodCloneOptions
- type PodCloneReport
- type PodCreateOptions
- type PodCreateReport
- type PodDeleteReport
- type PodInspectReport
- type PodKillOptions
- type PodKillReport
- type PodLogsOptions
- type PodPSOptions
- type PodPauseOptions
- type PodPauseReport
- type PodPruneOptions
- type PodPruneReport
- type PodRestartOptions
- type PodRestartReport
- type PodRmOptions
- type PodRmReport
- type PodSpec
- type PodStartOptions
- type PodStartReport
- type PodStatsOptions
- type PodStatsReport
- type PodStopOptions
- type PodStopReport
- type PodTopOptions
- type PodUnpauseReport
- type PodmanConfig
- type PodunpauseOptions
- type PsSortedCreateTime
- type QuadletInstallOptions
- type QuadletInstallReport
- type QuadletListOptions
- type QuadletRemoveOptions
- type QuadletRemoveReport
- type Report
- type RestartOptions
- type RestartReport
- type RestoreOptions
- type RestoreReport
- type RmOptions
- type ScpCreateCommandsOptions
- type ScpExecuteTransferOptions
- type ScpExecuteTransferReport
- type ScpLoadReport
- type ScpLoadToRemoteOptions
- type ScpLoadToRemoteReport
- type ScpSaveToRemoteOptions
- type ScpSaveToRemoteReport
- type ScpTransferImageOptions
- type ScpTransferOptions
- type ScpTransferReport
- type SecretCreateOptions
- type SecretCreateReport
- type SecretCreateRequest
- type SecretDriverSpec
- type SecretInfoReport
- type SecretInfoReportCompat
- type SecretInspectOptions
- 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 StringSliceReport
- type SwagErrNoSuchSecret
- type SwagErrSecretInUse
- type SwagSecretCreateResponse
- type SwagSecretInspectCompatResponse
- type SwagSecretInspectResponse
- type SwagSecretListCompatResponse
- type SwagSecretListResponse
- type SystemCheckOptions
- type SystemCheckReport
- type SystemDfContainerReport
- type SystemDfImageReport
- type SystemDfOptions
- type SystemDfReport
- type SystemDfVolumeReport
- type SystemMigrateOptions
- type SystemPruneOptions
- type SystemPruneReport
- type SystemUnshareOptions
- type SystemVersionReport
- type TopOptions
- type VolumeConfigResponse
- type VolumeCreateOptions
- type VolumeDeleteOptions
- type VolumeDeleteReport
- type VolumeExportOptions
- type VolumeImportOptions
- type VolumeInspectReport
- type VolumeListOptions
- type VolumeListReport
- type VolumeMountReport
- type VolumePruneOptions
- type VolumeReloadReport
- type VolumeRmOptions
- type VolumeRmReport
- type VolumeUnmountReport
- type WaitOptions
- type WaitReport
Constants ¶
const ( ABIMode = EngineMode("abi") TunnelMode = EngineMode("tunnel") )
const ( LocalFarmImageBuilderName = "(local)" LocalFarmImageBuilderDriver = "local" )
const ( InfraMode = ContainerMode("infra") CloneMode = ContainerMode("clone") UpdateMode = ContainerMode("update") CreateMode = ContainerMode("create") )
Variables ¶
var ( TypePVC = "PersistentVolumeClaim" TypePod = "Pod" TypeService = "Service" )
Functions ¶
func ConvertToEntitiesEvent ¶
func ConvertToEntitiesEvent(e libpodEvents.Event) *types.Event
ConvertToEntitiesEvent converts a libpod event to an entities one.
func ConvertToLibpodEvent ¶
func ConvertToLibpodEvent(e Event) *libpodEvents.Event
ConvertToLibpodEvent converts an entities event to a libpod one.
func ToPodSpecGen ¶
func ToPodSpecGen(s specgen.PodSpecGenerator, p *PodCreateOptions) (*specgen.PodSpecGenerator, error)
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 ApplyOptions ¶
type ApplyOptions struct {
// Kubeconfig - path to the cluster's kubeconfig file.
Kubeconfig string
// Namespace - namespace to deploy the workload in on the cluster.
Namespace string
// CACertFile - the path to the CA cert file for the Kubernetes cluster.
CACertFile string
// File - the path to the Kubernetes yaml to deploy.
File string
// Service - creates a service for the container being deployed.
Service bool
}
ApplyOptions controls the deployment of kube yaml files to a Kubernetes Cluster
type ArtifactAddOptions ¶
type ArtifactAddReport ¶
type ArtifactAddReport = entitiesTypes.ArtifactAddReport
type ArtifactBlob ¶
type ArtifactBlob = entitiesTypes.ArtifactBlob
type ArtifactExtractOptions ¶
type ArtifactExtractOptions struct {
// Title annotation value to extract only a single blob matching that name.
// Conflicts with Digest. Optional.
Title string
// Digest of the blob to extract.
// Conflicts with Title. Optional.
Digest string
// ExcludeTitle option allows single blobs to be exported
// with their title/filename empty. Optional.
// Default: False
ExcludeTitle bool
}
type ArtifactInspectOptions ¶
type ArtifactInspectOptions struct {
// Note: Remote is not currently implemented but will be used for
// remote inspect of artifacts on registries
Remote bool
}
type ArtifactInspectReport ¶
type ArtifactInspectReport = entitiesTypes.ArtifactInspectReport
type ArtifactListOptions ¶
type ArtifactListOptions struct{}
type ArtifactListReport ¶
type ArtifactListReport = entitiesTypes.ArtifactListReport
type ArtifactPullOptions ¶
type ArtifactPullOptions struct {
// containers-auth.json(5) file to use when authenticating against
// container registries.
AuthFilePath string
// Path to the certificates directory.
CertDirPath string
// Allow contacting registries over HTTP, or HTTPS with failed TLS
// verification. Note that this does not affect other TLS connections.
InsecureSkipTLSVerify types.OptionalBool
// Maximum number of retries with exponential backoff when facing
// transient network errors.
// Default 3.
MaxRetries *uint
// RetryDelay used for the exponential back off of MaxRetries.
// Default 1 time.Second.
RetryDelay string
// OciDecryptConfig contains the config that can be used to decrypt an image if it is
// encrypted if non-nil. If nil, it does not attempt to decrypt an image.
OciDecryptConfig *encconfig.DecryptConfig
// Quiet can be specified to suppress pull progress when pulling. Ignored
// for remote calls. //TODO: Verify that claim
Quiet bool
// SignaturePolicyPath to overwrite the default one.
SignaturePolicyPath string
// Writer is used to display copy information including progress bars.
Writer io.Writer
// Username to use when authenticating at a container registry.
Username string
// Password to use when authenticating at a container registry.
Password string
// IdentityToken is used to authenticate the user and get
// an access token for the registry.
IdentityToken string `json:"identitytoken,omitempty"`
}
type ArtifactPullReport ¶
type ArtifactPullReport = entitiesTypes.ArtifactPullReport
type ArtifactPushOptions ¶
type ArtifactPushOptions struct {
ImagePushOptions
DigestFile string
EncryptLayers []int
EncryptionKeys []string
}
type ArtifactPushReport ¶
type ArtifactPushReport = entitiesTypes.ArtifactPushReport
type ArtifactRemoveOptions ¶
type ArtifactRemoveReport ¶
type ArtifactRemoveReport = entitiesTypes.ArtifactRemoveReport
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 ¶
type AuthConfig = types.AuthConfig
type AuthReport ¶
type AuthReport = types.AuthReport
type AutoUpdateOptions ¶
type AutoUpdateOptions struct {
// Authfile to use when contacting registries.
Authfile string
// Only check for but do not perform any update. If an update is
// pending, it will be indicated in the Updated field of
// AutoUpdateReport.
DryRun bool
// If restarting the service with the new image failed, restart it
// another time with the previous image.
Rollback bool
// Allow contacting registries over HTTP, or HTTPS with failed TLS
// verification. Note that this does not affect other TLS connections.
InsecureSkipTLSVerify types.OptionalBool
}
AutoUpdateOptions are the options for running auto-update.
type AutoUpdateReport ¶
type AutoUpdateReport struct {
// ID of the container *before* an update.
ContainerID string
// Name of the container *before* an update.
ContainerName string
// Name of the image.
ImageName string
// The configured auto-update policy.
Policy string
// SystemdUnit running a container configured for auto updates.
SystemdUnit string
// Indicates the update status: true, false, failed, pending (see
// DryRun).
Updated string
}
AutoUpdateReport contains the results from running auto-update.
type BoolReport ¶
type BoolReport struct {
Value bool
}
type BuildOptions ¶
type BuildOptions = entitiesTypes.BuildOptions
BuildOptions describe the options for building container images.
type BuildReport ¶
type BuildReport = entitiesTypes.BuildReport
BuildReport is the image-build report.
type CheckpointOptions ¶
type CheckpointReport ¶
type CheckpointReport = types.CheckpointReport
type CommitOptions ¶
type CommitReport ¶
type CommitReport struct {
Id string
}
type ComponentVersion ¶
type ComponentVersion = types.SystemComponentVersion
type ContainerCleanupOptions ¶
type ContainerCleanupOptions struct {
All bool
Exec string
Latest bool
Remove bool
RemoveImage bool
StoppedOnly bool // Only cleanup if the container is stopped, i.e. was running before
}
ContainerCleanupOptions are the CLI values for the cleanup command
type ContainerCleanupReport ¶
type ContainerCleanupReport struct {
CleanErr error
Id string
RawInput string
RmErr error
RmiErr error
}
ContainerCleanupReport describes the response from a container cleanup
type ContainerCloneOptions ¶
type ContainerCloneOptions struct {
ID string
Destroy bool
CreateOpts ContainerCreateOptions
Image string
RawImageName string
Run bool
Force bool
}
ContainerCloneOptions contains options for cloning an existing container
type ContainerCopyFunc ¶
type ContainerCopyFunc = types.ContainerCopyFunc
type ContainerCpOptions ¶
type ContainerCpOptions struct {
// Pause the container while copying.
Pause bool
// Extract the tarfile into the destination directory.
Extract bool
// OverwriteDirNonDir allows for overwriting a directory with a
// non-directory and vice versa.
OverwriteDirNonDir bool
}
ContainerCpOptions describes input options for cp.
type ContainerCreateOptions ¶
type ContainerCreateOptions struct {
Annotation []string
Attach []string
Authfile string
BlkIOWeight string
BlkIOWeightDevice []string
CapAdd []string
CapDrop []string
CgroupNS string
CgroupsMode string
CgroupParent string `json:"cgroup_parent,omitempty"`
CIDFile string
ConmonPIDFile string `json:"container_conmon_pidfile,omitempty"`
CPUPeriod uint64
CPUQuota int64
CPURTPeriod uint64
CPURTRuntime int64
CPUS float64 `json:"cpus,omitempty"`
CPUSetCPUs string `json:"cpuset_cpus,omitempty"`
CPUSetMems string
Devices []string `json:"devices,omitempty"`
DeviceCgroupRule []string
DeviceReadBPs []string `json:"device_read_bps,omitempty"`
DeviceReadIOPs []string
DeviceWriteBPs []string
DeviceWriteIOPs []string
Entrypoint *string `json:"container_command,omitempty"`
Env []string
EnvHost bool
EnvFile []string
Expose []string
GIDMap []string
GPUs []string
GroupAdd []string
HealthCmd string
HealthInterval string
HealthRetries uint
HealthLogDestination string
HealthMaxLogCount uint
HealthMaxLogSize uint
HealthStartPeriod string
HealthTimeout string
HealthOnFailure string
Hostname string `json:"hostname,omitempty"`
HTTPProxy bool
HostUsers []string
ImageVolume string
Init bool
InitContainerType string
InitPath string
IntelRdtClosID string
Interactive bool
IPC string
Label []string
LabelFile []string
LogDriver string
LogOptions []string
Memory string
MemoryReservation string
MemorySwap string
MemorySwappiness int64
Name string `json:"container_name"`
NoHealthCheck bool
OOMKillDisable bool
OOMScoreAdj *int
Arch string
OS string
Variant string
PID string `json:"pid,omitempty"`
PIDsLimit *int64
Platform string
Pod string
PodIDFile string
Personality string
PreserveFDs uint
PreserveFD []uint
Privileged bool
PublishAll bool
Pull string
Quiet bool
ReadOnly bool
ReadWriteTmpFS bool
Restart string
Replace bool
Requires []string
Retry *uint `json:"retry,omitempty"`
RetryDelay string `json:"retry_delay,omitempty"`
Rm bool
RootFS bool
Secrets []string
SecurityOpt []string `json:"security_opt,omitempty"`
SdNotifyMode string
ShmSize string
ShmSizeSystemd string
SignaturePolicy string
StartupHCCmd string
StartupHCInterval string
StartupHCRetries uint
StartupHCSuccesses uint
StartupHCTimeout string
StopSignal string
StopTimeout uint
StorageOpts []string
SubGIDName string
SubUIDName string
Sysctl []string `json:"sysctl,omitempty"`
Systemd string
Timeout uint
TLSVerify commonFlag.OptionalBool
TmpFS []string
TTY bool
Timezone string
Umask string
EnvMerge []string
UnsetEnv []string
UnsetEnvAll bool
UIDMap []string
Ulimit []string
User string
UserNS string `json:"-"`
UTS string
Mount []string
Volume []string `json:"volume,omitempty"`
VolumesFrom []string `json:"volumes_from,omitempty"`
Workdir string
SeccompPolicy string
PidFile string
ChrootDirs []string
IsInfra bool
IsClone bool
DecryptionKeys []string
CertDir string
Creds string
Net *NetOptions `json:"net,omitempty"`
CgroupConf []string
GroupEntry string
PasswdEntry string
// launch, using them directly from shared storage (like NFS)
SharedBaseLayers bool
}
func NewInfraContainerCreateOptions ¶
func NewInfraContainerCreateOptions() ContainerCreateOptions
type ContainerCreateReport ¶
type ContainerCreateReport struct {
Id string
}
type ContainerCreateResponse ¶
type ContainerCreateResponse = entitiesTypes.ContainerCreateResponse
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)
ContainerClone(ctx context.Context, ctrClone ContainerCloneOptions) (*ContainerCreateReport, error)
ContainerCommit(ctx context.Context, nameOrID string, options CommitOptions) (*CommitReport, error)
ContainerCopyFromArchive(ctx context.Context, nameOrID, path string, reader io.Reader, options CopyOptions) (ContainerCopyFunc, error)
ContainerCopyToArchive(ctx context.Context, nameOrID string, path string, writer io.Writer) (ContainerCopyFunc, error)
ContainerCreate(ctx context.Context, s *specgen.SpecGenerator) (*ContainerCreateReport, 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)
ContainerListExternal(ctx context.Context) ([]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) ([]*reports.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)
ContainerUpdate(ctx context.Context, options *ContainerUpdateOptions) (string, error)
ContainerWait(ctx context.Context, namesOrIds []string, options WaitOptions) ([]WaitReport, error)
Diff(ctx context.Context, namesOrIds []string, options DiffOptions) (*DiffReport, error)
Events(ctx context.Context, opts EventsOptions) error
GenerateSpec(ctx context.Context, opts *GenerateSpecOptions) (*GenerateSpecReport, 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)
KubeApply(ctx context.Context, body io.Reader, opts ApplyOptions) error
Locks(ctx context.Context) (*LocksReport, error)
Migrate(ctx context.Context, options SystemMigrateOptions) error
NetworkConnect(ctx context.Context, networkname string, options NetworkConnectOptions) error
NetworkCreate(ctx context.Context, network netTypes.Network, createOptions *netTypes.NetworkCreateOptions) (*netTypes.Network, error)
NetworkUpdate(ctx context.Context, networkname string, options NetworkUpdateOptions) 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) ([]netTypes.Network, 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, body io.Reader, opts PlayKubeOptions) (*PlayKubeReport, error)
PlayKubeDown(ctx context.Context, body io.Reader, opts PlayKubeDownOptions) (*PlayKubeReport, error)
PodCreate(ctx context.Context, specg PodSpec) (*PodCreateReport, error)
PodClone(ctx context.Context, podClone PodCloneOptions) (*PodCloneReport, error)
PodExists(ctx context.Context, nameOrID string) (*BoolReport, error)
PodInspect(ctx context.Context, namesOrID []string, options InspectOptions) ([]*PodInspectReport, []error, error)
PodKill(ctx context.Context, namesOrIds []string, options PodKillOptions) ([]*PodKillReport, error)
PodLogs(ctx context.Context, pod string, options PodLogsOptions) 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)
QuadletInstall(ctx context.Context, pathsOrURLs []string, options QuadletInstallOptions) (*QuadletInstallReport, error)
QuadletList(ctx context.Context, options QuadletListOptions) ([]*ListQuadlet, error)
QuadletPrint(ctx context.Context, quadlet string) (string, error)
QuadletRemove(ctx context.Context, quadlets []string, options QuadletRemoveOptions) (*QuadletRemoveReport, error)
Renumber(ctx context.Context) error
Reset(ctx context.Context) error
SetupRootless(ctx context.Context, noMoveProcess bool, cgroupMode string) error
SecretCreate(ctx context.Context, name string, reader io.Reader, options SecretCreateOptions) (*SecretCreateReport, error)
SecretInspect(ctx context.Context, nameOrIDs []string, options SecretInspectOptions) ([]*SecretInfoReport, []error, error)
SecretList(ctx context.Context, opts SecretListRequest) ([]*SecretInfoReport, error)
SecretRm(ctx context.Context, nameOrID []string, opts SecretRmOptions) ([]*SecretRmReport, error)
SecretExists(ctx context.Context, nameOrID string) (*BoolReport, error)
Shutdown(ctx context.Context)
SystemDf(ctx context.Context, options SystemDfOptions) (*SystemDfReport, error)
SystemCheck(ctx context.Context, options SystemCheckOptions) (*SystemCheckReport, error)
Version(ctx context.Context) (*SystemVersionReport, error)
VolumeCreate(ctx context.Context, opts VolumeCreateOptions) (*IDOrNameResponse, error)
VolumeExists(ctx context.Context, namesOrID string) (*BoolReport, error)
VolumeMounted(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)
VolumeMount(ctx context.Context, namesOrIds []string) ([]*VolumeMountReport, error)
VolumePrune(ctx context.Context, options VolumePruneOptions) ([]*reports.PruneReport, error)
VolumeRm(ctx context.Context, namesOrIds []string, opts VolumeRmOptions) ([]*VolumeRmReport, error)
VolumeUnmount(ctx context.Context, namesOrIds []string) ([]*VolumeUnmountReport, error)
VolumeReload(ctx context.Context) (*VolumeReloadReport, error)
VolumeExport(ctx context.Context, nameOrID string, options VolumeExportOptions) error
VolumeImport(ctx context.Context, nameOrID string, options VolumeImportOptions) error
}
type ContainerExistsOptions ¶
type ContainerExistsOptions struct {
External bool
}
ContainerExistsOptions describes the cli values to check if a container exists
type ContainerExportOptions ¶
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
// Show logs until this timestamp.
Until time.Time
// Number of lines to display at the end of the output.
Tail int64
// Show timestamps in the logs.
Timestamps bool
// Show different colors in the logs.
Colors 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.
func PodLogsOptionsToContainerLogsOptions ¶
func PodLogsOptionsToContainerLogsOptions(options PodLogsOptions) ContainerLogsOptions
PodLogsOptionsToContainerLogsOptions converts PodLogOptions to ContainerLogOptions
type ContainerMode ¶
type ContainerMode string
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
Ports []nettypes.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
PreserveFD []uint
Rm bool
SigProxy bool
Spec *specgen.SpecGenerator
Passwd bool
}
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 imageTypes.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 {
Filters map[string][]string
All bool
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 ContainerStatReport = types.ContainerStatReport
type ContainerStatsOptions ¶
type ContainerStatsOptions struct {
// Get all containers stats
All bool
// Operate on the latest known container. Only supported for local
// clients.
Latest bool
// Stream stats.
Stream bool
// Interval in seconds
Interval int
}
ContainerStatsOptions describes input options for getting stats on containers
type ContainerStatsReport ¶
type ContainerStatsReport = types.ContainerStatsReport
type ContainerUnmountOptions ¶
ContainerUnmountOptions are the options from the cli for unmounting
type ContainerUnmountReport ¶
ContainerUnmountReport describes the response from umounting a container
type ContainerUpdateOptions ¶
type ContainerUpdateOptions = types.ContainerUpdateOptions
ContainerUpdateOptions containers options for updating an existing containers cgroup configuration
type CopyOptions ¶
type CopyOptions struct {
// If used with ContainerCopyFromArchive and set to true
// it will change ownership of files from the source tar archive
// to the primary uid/gid of the destination container.
Chown bool
// Map to translate path names.
Rename map[string]string
// NoOverwriteDirNonDir when true prevents an existing directory or file from being overwritten
// by the other type
NoOverwriteDirNonDir bool
}
type DiffOptions ¶
type DiffOptions struct {
Format string `json:",omitempty"` // CLI only
Latest bool `json:",omitempty"` // API and CLI, only supported by containers
Type define.DiffType // Type which should be compared
}
DiffOptions all API and CLI diff commands and diff sub-commands use the same options
type DiffReport ¶
DiffReport provides changes for object
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 EventsOptions ¶
type ExecOptions ¶
type ExecOptions struct {
Cmd []string
DetachKeys string
Envs map[string]string
Interactive bool
Latest bool
PreserveFDs uint
PreserveFD []uint
Privileged bool
Tty bool
User string
WorkDir string
}
ExecOptions describes the cli values to exec into a container
type ExternalContainerFilter ¶
type ExternalContainerFilter func(*ListContainer) bool
ExternalContainerFilter is a function to determine whether a container list is included in command output. Container lists to be outputted are tested using the function. A true return will include the container list, a false return will exclude it.
type FarmBuildOptions ¶
type FarmBuildOptions = entitiesTypes.FarmBuildOptions
FarmBuildOptions describes the options for building container images on farm nodes
type FarmInspectReport ¶
type FarmInspectReport = entitiesTypes.FarmInspectReport
FarmInspectReport describes the response from farm inspect
type GenerateKubeOptions ¶
type GenerateKubeOptions struct {
// PodmanOnly - add podman-only reserved annotations in the generated YAML file (Cannot be used by Kubernetes)
PodmanOnly bool
// Service - generate YAML for a Kubernetes _service_ object.
Service bool
// Type - the k8s kind to be generated i.e Pod or Deployment
Type string
// Replicas - the value to set in the replicas field for a Deployment
Replicas int32
// UseLongAnnotations - don't truncate annotations to the Kubernetes maximum length of 63 characters
UseLongAnnotations bool
}
GenerateKubeOptions control the generation of Kubernetes YAML files.
type GenerateSpecOptions ¶
type GenerateSpecReport ¶
type GenerateSpecReport = types.GenerateSpecReport
type GenerateSystemdOptions ¶
type GenerateSystemdOptions struct {
Name bool
New bool
RestartPolicy *string
RestartSec *uint
StartTimeout *uint
StopTimeout *uint
ContainerPrefix string
PodPrefix string
Separator string
NoHeader bool
TemplateUnitFile bool
Wants []string
After []string
Requires []string
AdditionalEnvVariables []string
}
GenerateSystemdOptions control the generation of systemd unit files.
type GenerateSystemdReport ¶
type GenerateSystemdReport = types.GenerateSystemdReport
GenerateSystemdReport
type HealthCheckOptions ¶
type HealthCheckOptions struct{}
type IDOrNameResponse ¶
type IDOrNameResponse struct {
// The Id or Name of an object
IDOrName string
}
type IDResponse ¶
type IDResponse = entitiesTypes.IDResponse
type ImageEngine ¶
type ImageEngine interface {
ArtifactAdd(ctx context.Context, name string, artifactBlobs []ArtifactBlob, opts ArtifactAddOptions) (*ArtifactAddReport, error)
ArtifactExtract(ctx context.Context, name string, target string, opts ArtifactExtractOptions) error
ArtifactExtractTarStream(ctx context.Context, w io.Writer, name string, opts ArtifactExtractOptions) error
ArtifactInspect(ctx context.Context, name string, opts ArtifactInspectOptions) (*ArtifactInspectReport, error)
ArtifactList(ctx context.Context, opts ArtifactListOptions) ([]*ArtifactListReport, error)
ArtifactPull(ctx context.Context, name string, opts ArtifactPullOptions) (*ArtifactPullReport, error)
ArtifactPush(ctx context.Context, name string, opts ArtifactPushOptions) (*ArtifactPushReport, error)
ArtifactRm(ctx context.Context, opts ArtifactRemoveOptions) (*ArtifactRemoveReport, error)
Build(ctx context.Context, containerFiles []string, opts BuildOptions) (*BuildReport, error)
Config(ctx context.Context) (*config.Config, 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) (*ImagePushReport, error)
Remove(ctx context.Context, images []string, opts ImageRemoveOptions) (*ImageRemoveReport, []error)
Save(ctx context.Context, nameOrID string, tags []string, options ImageSaveOptions) error
Scp(ctx context.Context, src, dst string, opts ImageScpOptions) (*ImageScpReport, 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, name string, images []string, opts ManifestCreateOptions) (string, error)
ManifestExists(ctx context.Context, name string) (*BoolReport, error)
ManifestInspect(ctx context.Context, name string, opts ManifestInspectOptions) (*define.ManifestListData, error)
ManifestAdd(ctx context.Context, listName string, imageNames []string, opts ManifestAddOptions) (string, error)
ManifestAddArtifact(ctx context.Context, name string, files []string, opts ManifestAddArtifactOptions) (string, error)
ManifestAnnotate(ctx context.Context, names, image string, opts ManifestAnnotateOptions) (string, error)
ManifestRemoveDigest(ctx context.Context, names, image string) (string, error)
ManifestRm(ctx context.Context, names []string, imageRmOpts ImageRemoveOptions) (*ImageRemoveReport, []error)
ManifestPush(ctx context.Context, name, destination string, imagePushOpts ImagePushOptions) (string, error)
ManifestListClear(ctx context.Context, name string) (string, error)
Sign(ctx context.Context, names []string, options SignOptions) (*SignReport, error)
FarmNodeName(ctx context.Context) string
FarmNodeDriver(ctx context.Context) string
FarmNodeInspect(ctx context.Context) (*FarmInspectReport, error)
}
type ImageHistoryLayer ¶
type ImageHistoryLayer = entitiesTypes.ImageHistoryLayer
type ImageHistoryOptions ¶
type ImageHistoryOptions struct{}
type ImageHistoryReport ¶
type ImageHistoryReport = entitiesTypes.ImageHistoryReport
type ImageImportOptions ¶
type ImageImportReport ¶
type ImageImportReport = entitiesTypes.ImageImportReport
type ImageInspectReport ¶
type ImageInspectReport = entitiesTypes.ImageInspectReport
ImageInspectReport is the data when inspecting an image.
type ImageListOptions ¶
type ImageListOptions struct {
All bool
// ExtendedAttributes is used by the libpod endpoint only to deliver extra information
// that the compat endpoint does not
ExtendedAttributes bool
Filter []string
}
Image List Options
type ImageLoadOptions ¶
type ImageLoadReport ¶
type ImageLoadReport = entitiesTypes.ImageLoadReport
type ImageMountOptions ¶
ImageMountOptions describes the input values for mounting images in the CLI
type ImageMountReport ¶
type ImageMountReport = entitiesTypes.ImageMountReport
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
// Retry number of times to retry pull in case of failure
Retry *uint
// RetryDelay between retries in case of pull failures
RetryDelay string
// 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
// Writer is used to display copy information including progress bars.
Writer io.Writer
// OciDecryptConfig contains the config that can be used to decrypt an image if it is
// encrypted if non-nil. If nil, it does not attempt to decrypt an image.
OciDecryptConfig *encconfig.DecryptConfig
}
ImagePullOptions are the arguments for pulling images.
type ImagePullReport ¶
type ImagePullReport = entitiesTypes.ImagePullReport
ImagePullReport is the response from pulling one or more images.
type ImagePushOptions ¶
type ImagePushOptions struct {
// All indicates that all images referenced in a 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
// Format is the Manifest type (oci, v2s1, or v2s2) to use when pushing an
// image. Default is manifest type of source, with fallbacks.
// Ignored for remote calls.
Format string
// Quiet can be specified to suppress push progress when pushing.
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
// Retry number of times to retry push in case of failure
Retry *uint
// RetryDelay between retries in case of push failures
RetryDelay string
// SignaturePolicy to use when pulling. Ignored for remote calls.
SignaturePolicy string
// Signers, if non-empty, asks for signatures to be added during the copy
// using the provided signers.
// Rejected for remote calls.
Signers []*signer.Signer
// SignBy adds a signature at the destination using the specified key.
// Ignored for remote calls.
SignBy string
// SignPassphrase, if non-empty, specifies a passphrase to use when signing
// with the key ID from SignBy.
SignPassphrase string
// SignBySigstorePrivateKeyFile, if non-empty, asks for a signature to be added
// during the copy, using a sigstore private key file at the provided path.
// Ignored for remote calls.
SignBySigstorePrivateKeyFile string
// SignSigstorePrivateKeyPassphrase is the passphrase to use when signing with
// SignBySigstorePrivateKeyFile.
SignSigstorePrivateKeyPassphrase []byte
// SkipTLSVerify to skip HTTPS and certificate verification.
SkipTLSVerify types.OptionalBool
// Progress to get progress notifications
Progress chan types.ProgressProperties
// CompressionFormat is the format to use for the compression of the blobs
CompressionFormat string
// CompressionLevel is the level to use for the compression of the blobs
CompressionLevel *int
// Writer is used to display copy information including progress bars.
Writer io.Writer
// OciEncryptConfig when non-nil indicates that an image should be encrypted.
// The encryption options is derived from the construction of EncryptConfig object.
OciEncryptConfig *encconfig.EncryptConfig
// OciEncryptLayers represents the list of layers to encrypt.
// If nil, don't encrypt any layers.
// If non-nil and len==0, denotes encrypt all layers.
// integers in the slice represent 0-indexed layer indices, with support for negative
// indexing. i.e. 0 is the first layer, -1 is the last (top-most) layer.
OciEncryptLayers *[]int
// If necessary, add clones of existing instances with requested compression algorithms to manifest list
// Note: Following option is only valid for `manifest push`
AddCompression []string
// ForceCompressionFormat ensures that the compression algorithm set in
// CompressionFormat is used exclusively, and blobs of other compression
// algorithms are not reused.
ForceCompressionFormat bool
}
ImagePushOptions are the arguments for pushing images.
type ImagePushReport ¶
type ImagePushReport struct {
// The digest of the manifest of the pushed image.
ManifestDigest string
}
ImagePushReport is the response from pushing an image.
type ImagePushStream ¶
type ImagePushStream = entitiesTypes.ImagePushStream
ImagePushStream is the response from pushing an image. Only used in the remote API.
type ImageRemoveOptions ¶
type ImageRemoveOptions struct {
// All will remove all images.
All bool
// Force will force image removal including containers using the images.
Force bool
// Ignore if a specified image does not exist and do not throw an error.
Ignore bool
// Confirms if given name is a manifest list and removes it, otherwise returns error.
LookupManifest bool
// NoPrune will not remove dangling images
NoPrune bool
DisableForceRemoveContainers bool
}
ImageRemoveOptions can be used to alter image removal.
type ImageRemoveReport ¶
type ImageRemoveReport = entitiesTypes.ImageRemoveReport
ImageRemoveReport 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
// Accept uncompressed layers when copying OCI images.
OciAcceptUncompressedLayers bool
// Output - write image to the specified path.
Output string
// Quiet - suppress output when copying images
Quiet bool
SignaturePolicy string
}
ImageSaveOptions provide options for saving images.
type ImageScpConnections ¶
type ImageScpConnections struct {
// Connections holds the raw string values for connections (ssh or unix)
Connections []string
// URI contains the ssh connection URLs to be used by the client
URI []*url.URL
// Identities contains ssh identity keys to be used by the client
Identities []string
}
ImageScpConnections provides the ssh related information used in remote image transfer
type ImageScpOptions ¶
type ImageScpOptions struct {
ScpExecuteTransferOptions
}
ImageScpOptions provides options for ImageEngine.Scp()
type ImageScpReport ¶
type ImageScpReport struct{}
ImageScpReport provides results from ImageEngine.Scp()
type ImageSearchOptions ¶
type ImageSearchOptions 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
// Username for authenticating against the registry.
Username string
// Password for authenticating against the registry.
Password string
// IdentityToken is used to authenticate the user and get
// an access token for the registry.
IdentityToken string
// Filters for the search results.
Filters []string
// Limit the number of results.
Limit int
// 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 = entitiesTypes.ImageSearchReport
ImageSearchReport is the response from searching images.
type ImageSummary ¶
type ImageSummary = entitiesTypes.ImageSummary
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 = entitiesTypes.ImageTreeReport
ImageTreeReport provides results from ImageEngine.Tree()
type ImageUnmountOptions ¶
ImageUnmountOptions are the options from the cli for unmounting
type ImageUnmountReport ¶
type ImageUnmountReport = entitiesTypes.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"`
}
InspectOptions all CLI inspect commands and inspect sub-commands use the same options
type KillOptions ¶
type KillReport ¶
type KubeGenerateOptions ¶
type KubeGenerateOptions = GenerateKubeOptions
type KubePlayReport ¶
type KubePlayReport = entitiesTypes.KubePlayReport
type ListContainer ¶
type ListContainer = types.ListContainer
ListContainer describes a container suitable for listing
type ListContainerNamespaces ¶
type ListContainerNamespaces = types.ListContainerNamespaces
ListContainerNamespaces contains the identifiers of the container's Linux namespaces
type ListPodContainer ¶
type ListPodContainer = types.ListPodContainer
type ListPodsReport ¶
type ListPodsReport = types.ListPodsReport
type ListQuadlet ¶
type ListQuadlet struct {
// Name is the name of the Quadlet file
Name string
// UnitName is the name of the systemd unit created from the Quadlet.
// May be empty if systemd has not be reloaded since it was installed.
UnitName string
// Path to the Quadlet on disk
Path string
// What is the status of the Quadlet - if present in systemd, will be a
// systemd status, else will mention if the Quadlet has syntax errors
Status string
// If multiple quadlets were installed together they will belong
// to common App.
App string
}
A ListQuadlet is a single Quadlet to be listed by `podman quadlet list`
type ListRegistriesReport ¶
type ListRegistriesReport = types.ListRegistriesReport
type ListReporter ¶
type LocksReport ¶
type LocksReport = types.LocksReport
type MachineHostInfo ¶
type MachineHostInfo struct {
Arch string `json:"Arch"`
CurrentMachine string `json:"CurrentMachine"`
// TODO(6.0): Change `DefaultName` to `ActiveMachineConnection` to fix address
// confusion as shown in https://github.com/containers/podman/issues/23353.
// The name `DefaultMachine` can cause confusion with the user in thinking that
// they can set a default podman machine via system connections. However,
// regardless of which system connection is default, the default podman machine
// will always be podman-machine-default.
DefaultMachine string `json:"DefaultMachine"`
EventsDir string `json:"EventsDir"`
MachineConfigDir string `json:"MachineConfigDir"`
MachineImageDir string `json:"MachineImageDir"`
MachineState string `json:"MachineState"`
NumberOfMachines int `json:"NumberOfMachines"`
OS string `json:"OS"`
VMType string `json:"VMType"`
}
MachineHostInfo contains info on the machine host
type MachineInfo ¶
type MachineInfo struct {
Host *MachineHostInfo `json:"Host"`
Version define.Version `json:"Version"`
}
MachineInfo contains info on the machine host and version info
type ManifestAddArtifactOptions ¶
type ManifestAddArtifactOptions struct {
ManifestAnnotateOptions
// Note to future maintainers: keep these fields synchronized with ManifestModifyOptions!
Type *string `json:"artifact_type" schema:"artifact_type"`
LayerType string `json:"artifact_layer_type" schema:"artifact_layer_type"`
ConfigType string `json:"artifact_config_type" schema:"artifact_config_type"`
Config string `json:"artifact_config" schema:"artifact_config"`
ExcludeTitles bool `json:"artifact_exclude_titles" schema:"artifact_exclude_titles"`
Annotations map[string]string `json:"artifact_annotations" schema:"artifact_annotations"`
Subject string `json:"artifact_subject" schema:"artifact_subject"`
Files []string `json:"artifact_files" schema:"-"`
}
ManifestAddArtifactOptions provides the model for creating artifact manifests for files and adding those manifests to a manifest list
swagger:model
type ManifestAddOptions ¶
type ManifestAddOptions struct {
ManifestAnnotateOptions
// True when operating on a list to include all images
All bool `json:"all" schema:"all"`
// authfile to use when pushing manifest list
Authfile string `json:"-" schema:"-"`
// Home directory for certificates when pushing a manifest list
CertDir string `json:"-" schema:"-"`
// Password to authenticate to registry when pushing manifest list
Password string `json:"-" schema:"-"`
// Should TLS registry certificate be verified?
SkipTLSVerify types.OptionalBool `json:"-" schema:"-"`
// Username to authenticate to registry when pushing manifest list
Username string `json:"-" schema:"-"`
// Images is an optional list of image references to add to manifest list
Images []string `json:"images" schema:"images"`
}
ManifestAddOptions provides model for adding digests to manifest list
swagger:model
type ManifestAnnotateOptions ¶
type ManifestAnnotateOptions struct {
// Annotation to add to the item in the manifest list
Annotation []string `json:"annotation" schema:"annotation"`
// Annotations to add to the item in the manifest list by a map which is preferred over Annotation
Annotations map[string]string `json:"annotations" schema:"annotations"`
// Arch overrides the architecture for the item in the manifest list
Arch string `json:"arch" schema:"arch"`
// Feature list for the item in the manifest list
Features []string `json:"features" schema:"features"`
// OS overrides the operating system for the item in the manifest list
OS string `json:"os" schema:"os"`
// OS features for the item in the manifest list
OSFeatures []string `json:"os_features" schema:"os_features"`
// OSVersion overrides the operating system for the item in the manifest list
OSVersion string `json:"os_version" schema:"os_version"`
// Variant for the item in the manifest list
Variant string `json:"variant" schema:"variant"`
// IndexAnnotation is a slice of key=value annotations to add to the manifest list itself
IndexAnnotation []string `json:"index_annotation" schema:"index_annotation"`
// IndexAnnotations is a map of key:value annotations to add to the manifest list itself, by a map which is preferred over IndexAnnotation
IndexAnnotations map[string]string `json:"index_annotations" schema:"index_annotations"`
// IndexSubject is a subject value to set in the manifest list itself
IndexSubject string `json:"subject" schema:"subject"`
}
ManifestAnnotateOptions provides model for annotating manifest list
type ManifestCreateOptions ¶
type ManifestCreateOptions struct {
// True when adding lists to include all images
All bool `schema:"all"`
// Amend an extant list if there's already one with the desired name
Amend bool `schema:"amend"`
// Should TLS registry certificate be verified?
SkipTLSVerify types.OptionalBool `json:"-" schema:"-"`
// Annotations to set on the list, which forces it to be OCI format
Annotations map[string]string `json:"annotations" schema:"annotations"`
}
ManifestCreateOptions provides model for creating manifest list or image index
type ManifestInspectOptions ¶
type ManifestInspectOptions struct {
// Path to an authentication file.
Authfile string `json:"-" schema:"-"`
// Should TLS registry certificate be verified?
SkipTLSVerify types.OptionalBool `json:"-" schema:"-"`
}
ManifestInspectOptions provides model for inspecting manifest
type ManifestModifyOptions ¶
type ManifestModifyOptions struct {
Operation string `json:"operation" schema:"operation"` // Valid values: update, remove, annotate
ManifestAddOptions
ManifestRemoveOptions
// The following are all of the fields from ManifestAddArtifactOptions.
// We can't just embed the whole structure because it embeds a
// ManifestAnnotateOptions, which would conflict with the one that
// ManifestAddOptions embeds.
ArtifactType *string `json:"artifact_type" schema:"artifact_type"`
ArtifactLayerType string `json:"artifact_layer_type" schema:"artifact_layer_type"`
ArtifactConfigType string `json:"artifact_config_type" schema:"artifact_config_type"`
ArtifactConfig string `json:"artifact_config" schema:"artifact_config"`
ArtifactExcludeTitles bool `json:"artifact_exclude_titles" schema:"artifact_exclude_titles"`
ArtifactAnnotations map[string]string `json:"artifact_annotations" schema:"artifact_annotations"`
ArtifactSubject string `json:"artifact_subject" schema:"artifact_subject"`
ArtifactFiles []string `json:"artifact_files" schema:"-"`
}
ManifestModifyOptions provides the model for mutating a manifest
swagger 2.0 does not support oneOf for schema validation.
Operation "update" uses all fields. Operation "remove" uses fields: Operation and Images Operation "annotate" uses fields: Operation and Annotations
swagger:model
type ManifestModifyReport ¶
type ManifestModifyReport = entitiesTypes.ManifestModifyReport
ManifestModifyReport provides the model for removed digests and changed manifest
type ManifestPushReport ¶
type ManifestPushReport = entitiesTypes.ManifestPushReport
ManifestPushReport provides the model for the pushed manifest
type ManifestRemoveOptions ¶
type ManifestRemoveOptions struct {
}
ManifestRemoveOptions provides the model for removing digests from a manifest
swagger:model
type ManifestRemoveReport ¶
type ManifestRemoveReport = entitiesTypes.ManifestRemoveReport
ManifestRemoveReport provides the model for the removed manifest
type NetFlags ¶
type NetFlags struct {
AddHosts []string `json:"add-host,omitempty"`
DNS []string `json:"dns,omitempty"`
DNSOpt []string `json:"dns-opt,omitempty"`
DNDSearch []string `json:"dns-search,omitempty"`
MacAddr string `json:"mac-address,omitempty"`
Publish []string `json:"publish,omitempty"`
IP string `json:"ip,omitempty"`
NoHostname bool `json:"no-hostname,omitempty"`
NoHosts bool `json:"no-hosts,omitempty"`
Network string `json:"network,omitempty"`
NetworkAlias []string `json:"network-alias,omitempty"`
}
type NetOptions ¶
type NetOptions struct {
AddHosts []string `json:"hostadd,omitempty"`
Aliases []string `json:"network_alias,omitempty"`
Networks map[string]types.PerNetworkOptions `json:"networks,omitempty"`
UseImageResolvConf bool `json:"no_manage_resolv_conf,omitempty"`
DNSOptions []string `json:"dns_option,omitempty"`
DNSSearch []string `json:"dns_search,omitempty"`
DNSServers []net.IP `json:"dns_server,omitempty"`
HostsFile string `json:"hosts_file,omitempty"`
Network specgen.Namespace `json:"netns"`
NoHostname bool `json:"no_manage_hostname,omitempty"`
NoHosts bool `json:"no_manage_hosts,omitempty"`
PublishPorts []types.PortMapping `json:"portmappings,omitempty"`
// NetworkOptions are additional options for each network
NetworkOptions map[string][]string `json:"network_options,omitempty"`
}
NetOptions reflect the shared network options between pods and containers
type NetworkConnectOptions ¶
type NetworkConnectOptions = entitiesTypes.NetworkConnectOptions
NetworkConnectOptions describes options for connecting a container to a network
type NetworkContainerInfo ¶
type NetworkContainerInfo = entitiesTypes.NetworkContainerInfo
type NetworkCreateOptions ¶
type NetworkCreateOptions struct {
DisableDNS bool
Driver string
Gateways []net.IP
Internal bool
Labels map[string]string
MacVLAN string
NetworkDNSServers []string
Ranges []string
Subnets []string
Routes []string
IPv6 bool
// Mapping of driver options and values.
Options map[string]string
// IgnoreIfExists if true, do not fail if the network already exists
IgnoreIfExists bool
// InterfaceName sets the NetworkInterface in the network config
InterfaceName string
}
NetworkCreateOptions describes options to create a network
type NetworkCreateReport ¶
type NetworkCreateReport = entitiesTypes.NetworkCreateReport
NetworkCreateReport describes a created network for the cli
type NetworkDisconnectOptions ¶
NetworkDisconnectOptions describes options for disconnecting containers from networks
type NetworkInspectReport ¶
type NetworkInspectReport = entitiesTypes.NetworkInspectReport
type NetworkListOptions ¶
NetworkListOptions describes options for listing networks in cli
type NetworkPruneOptions ¶
NetworkPruneOptions describes options for pruning unused networks
type NetworkPruneReport ¶
type NetworkPruneReport = entitiesTypes.NetworkPruneReport
NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
type NetworkReloadOptions ¶
NetworkReloadOptions describes options for reloading container network configuration.
type NetworkReloadReport ¶
type NetworkReloadReport = entitiesTypes.NetworkReloadReport
NetworkReloadReport describes the results of reloading a container network.
type NetworkRmOptions ¶
NetworkRmOptions describes options for removing networks
type NetworkRmReport ¶
type NetworkRmReport = entitiesTypes.NetworkRmReport
NetworkRmReport describes the results of network removal
type NetworkUpdateOptions ¶
type NetworkUpdateOptions struct {
AddDNSServers []string `json:"adddnsservers"`
RemoveDNSServers []string `json:"removednsservers"`
}
NetworkUpdateOptions describes options to update a network
type PauseUnPauseOptions ¶
type PauseUnpauseReport ¶
type PlayKubeDownOptions ¶
type PlayKubeDownOptions struct {
// Force - remove volumes if passed
Force bool
}
PlayKubeDownOptions are options for tearing down pods
type PlayKubeOptions ¶
type PlayKubeOptions struct {
// Annotations - Annotations to add to Pods
Annotations map[string]string
// Authfile - path to an authentication file.
Authfile string
// Indicator to build all images with Containerfile or Dockerfile
Build types.OptionalBool
// CertDir - to a directory containing TLS certifications and keys.
CertDir string
// ContextDir - directory containing image contexts used for Build
ContextDir string
// Down indicates whether to bring contents of a yaml file "down"
// as in stop
Down bool
// ExitCodePropagation decides how the main PID of the Kube service
// should exit depending on the containers' exit codes.
ExitCodePropagation string
// Replace indicates whether to delete and recreate a yaml file
Replace bool
// Do not create /etc/hostname within the pod's containers,
// instead use the version from the image
NoHostname bool
// Do not create /etc/hosts within the pod's containers,
// instead use the version from the image
NoHosts bool
// Username for authenticating against the registry.
Username string
// Password for authenticating against the registry.
Password string
// Networks - name of the network to connect to.
Networks []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
// StaticIPs - Static IP address used by the pod(s).
StaticIPs []net.IP
// StaticMACs - Static MAC address used by the pod(s).
StaticMACs []net.HardwareAddr
// ConfigMaps - slice of pathnames to kubernetes configmap YAMLs.
ConfigMaps []string
// LogDriver for the container. For example: journald
LogDriver string
// LogOptions for the log driver for the container.
LogOptions []string
// Start - don't start the pod if false
Start types.OptionalBool
// ServiceContainer - creates a service container that is started before and is stopped after all pods.
ServiceContainer bool
// UseLongAnnotations - use annotations that were not truncated to the
// Kubernetes maximum length of 63 characters
UseLongAnnotations bool
// Userns - define the user namespace to use.
Userns string
// IsRemote - was the request triggered by running podman-remote
IsRemote bool
// Force - remove volumes on --down
Force bool
// PublishPorts - configure how to expose ports configured inside the K8S YAML file
PublishPorts []string
// PublishAllPorts - whether to publish all ports defined in the K8S YAML file
// (containerPort, hostPort) otherwise only hostPort will be published
PublishAllPorts bool
// Wait - indicates whether to return after having created the pods
Wait bool
// SystemContext - used when building the image
SystemContext *types.SystemContext
}
PlayKubeOptions controls playing kube YAML files.
type PlayKubePod ¶
type PlayKubePod = entitiesTypes.PlayKubePod
PlayKubePod represents a single pod and associated containers created by play kube
type PlayKubeReport ¶
type PlayKubeReport = entitiesTypes.PlayKubeReport
PlayKubeReport contains the results of running play kube.
type PlayKubeTeardown ¶
type PlayKubeTeardown = entitiesTypes.PlayKubeTeardown
PlayKubeDownReport contains the results of tearing down play kube
type PlayKubeVolume ¶
type PlayKubeVolume entitiesTypes.PlayKubeVolume
PlayKubeVolume represents a single volume created by play kube.
type PlaySecret ¶
type PlaySecret = entitiesTypes.PlaySecret
type PodCloneOptions ¶
type PodCloneOptions struct {
ID string
Destroy bool
CreateOpts PodCreateOptions
InfraOptions ContainerCreateOptions
PerContainerOptions ContainerCreateOptions
Start bool
}
PodCloneOptions contains options for cloning an existing pod
type PodCloneReport ¶
type PodCloneReport = types.PodCloneReport
type PodCreateOptions ¶
type PodCreateOptions struct {
CgroupParent string `json:"cgroup_parent,omitempty"`
CreateCommand []string `json:"create_command,omitempty"`
Devices []string `json:"devices,omitempty"`
DeviceReadBPs []string `json:"device_read_bps,omitempty"`
ExitPolicy string `json:"exit_policy,omitempty"`
Hostname string `json:"hostname,omitempty"`
Infra bool `json:"infra,omitempty"`
InfraImage string `json:"infra_image,omitempty"`
InfraName string `json:"container_name,omitempty"`
InfraCommand *string `json:"container_command,omitempty"`
InfraConmonPidFile string `json:"container_conmon_pidfile,omitempty"`
Ipc string `json:"ipc,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
Name string `json:"name,omitempty"`
Net *NetOptions `json:"net,omitempty"`
Restart string `json:"restart,omitempty"`
Pid string `json:"pid,omitempty"`
Cpus float64 `json:"cpus,omitempty"`
CpusetCpus string `json:"cpuset_cpus,omitempty"`
Userns specgen.Namespace `json:"-"`
Volume []string `json:"volume,omitempty"`
VolumesFrom []string `json:"volumes_from,omitempty"`
SecurityOpt []string `json:"security_opt,omitempty"`
Sysctl []string `json:"sysctl,omitempty"`
Uts string `json:"uts,omitempty"`
}
PodCreateOptions provides all possible options for creating a pod and its infra container. The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping. swagger:model PodCreateOptions
func (*PodCreateOptions) CPULimits ¶
func (p *PodCreateOptions) CPULimits() *specs.LinuxCPU
type PodCreateReport ¶
type PodCreateReport = types.PodCreateReport
type PodDeleteReport ¶
type PodDeleteReport struct{ Report }
type PodInspectReport ¶
type PodInspectReport = types.PodInspectReport
type PodKillOptions ¶
type PodKillReport ¶
type PodKillReport = types.PodKillReport
type PodLogsOptions ¶
type PodLogsOptions struct {
// Other fields are exactly same as ContainerLogOpts
ContainerLogsOptions
// If specified will only fetch the logs of specified container
ContainerName string
// Show different colors in the logs.
Color bool
}
PodLogsOptions describes the options to extract pod logs.
type PodPSOptions ¶
type PodPauseOptions ¶
type PodPauseReport ¶
type PodPauseReport = types.PodPauseReport
type PodPruneOptions ¶
type PodPruneOptions struct {
Force bool `json:"force" schema:"force"`
}
type PodPruneReport ¶
type PodPruneReport = types.PodPruneReport
type PodRestartOptions ¶
type PodRestartReport ¶
type PodRestartReport = types.PodRestartReport
type PodRmOptions ¶
type PodRmReport ¶
type PodRmReport = types.PodRmReport
type PodStartOptions ¶
type PodStartReport ¶
type PodStartReport = types.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 = types.PodStatsReport
PodStatsReport includes pod-resource statistics data.
type PodStopReport ¶
type PodStopReport = types.PodStopReport
type PodTopOptions ¶
type PodUnpauseReport ¶
type PodUnpauseReport = types.PodUnpauseReport
type PodmanConfig ¶
type PodmanConfig struct {
*pflag.FlagSet
ContainersConf *config.Config
ContainersConfDefaultsRO *config.Config // The read-only! defaults from containers.conf.
DBBackend string // Hidden: change the database backend
DockerConfig string // Path to directory containing authentication config file
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
HooksDir []string
CdiSpecDirs []string
Identity string // ssh identity for connecting to server
TLSCertFile string // tls client cert for connecting to server
TLSKeyFile string // tls client cert private key for connection to server
TLSCAFile string // tls certificate authority to verify server connection
IsRenumber bool // Is this a system renumber command? If so, a number of checks will be relaxed
IsReset bool // Is this a system reset command? If so, a number of checks will be skipped/omitted
MaxWorks int // maximum number of parallel threads
MemoryProfile string // Hidden: Should memory profile be taken
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 logging information to syslog as well as the console
Trace bool // Hidden: Trace execution
URI string // URI to RESTful API Service
FarmNodeName string // Name of farm node
ConnectionError error // Error when looking up the connection in setupRemoteConnection()
Runroot string
ImageStore string
StorageDriver string
StorageOpts []string
SSHMode string
MachineMode bool
TransientStore bool
GraphRoot string
PullOptions []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 QuadletInstallOptions ¶
type QuadletInstallOptions struct {
// Whether to reload systemd after installation is completed
ReloadSystemd bool
}
QuadletInstallOptions contains options to the `podman quadlet install` command
type QuadletInstallReport ¶
type QuadletInstallReport struct {
// InstalledQuadlets is a map of the path of the quadlet file to be installed
// to where it was installed to.
InstalledQuadlets map[string]string
// QuadletErrors is a map of the path of the quadlet file to be installed
// to the error that occurred attempting to install it
QuadletErrors map[string]error
}
QuadletInstallReport contains the output of the `quadlet install` command including what files were successfully installed (and to where), and what files errored (and why).
type QuadletListOptions ¶
type QuadletListOptions struct {
// Filters contains filters that will limit what Quadlets are displayed
Filters []string
}
QuadletListOptions contains options to the `podman quadlet list` command.
type QuadletRemoveOptions ¶
type QuadletRemoveOptions struct {
// Force indicates that running quadlets should be removed as well
Force bool
// All indicates all quadlets should be removed
All bool
// Ignore indicates that missing quadlets should not cause an error
Ignore bool
// ReloadSystemd determines whether systemd will be reloaded after the Quadlet is removed.
ReloadSystemd bool
}
QuadletRemoveOptions contains parameters for removing Quadlets
type QuadletRemoveReport ¶
type QuadletRemoveReport struct {
// Removed is a list of quadlets that were successfully removed
Removed []string
// Errors is a map of Quadlet name to error that occurred during removal.
Errors map[string]error
}
QuadletRemoveReport contains the results of an operation to remove obe or more quadlets
type RestartOptions ¶
type RestartReport ¶
type RestoreOptions ¶
type RestoreOptions struct {
All bool
IgnoreRootFS bool
IgnoreVolumes bool
IgnoreStaticIP bool
IgnoreStaticMAC bool
Import string
CheckpointImage bool
Keep bool
Latest bool
Name string
TCPEstablished bool
TCPClose bool
ImportPrevious string
PublishPorts []string
Pod string
PrintStats bool
FileLocks bool
}
type RestoreReport ¶
type RestoreReport = types.RestoreReport
type ScpExecuteTransferOptions ¶
type ScpExecuteTransferOptions struct {
// ParentFlags are the arguments to apply to the parent podman command when called via ssh
ParentFlags []string
// Quiet Determines if the save and load operation will be done quietly
Quiet bool
// SSHMode is the specified ssh.EngineMode which should be used
SSHMode ssh.EngineMode
}
type ScpExecuteTransferReport ¶
type ScpExecuteTransferReport struct {
// LoadReport provides results from calling podman load
LoadReport *ScpLoadReport
// Source contains data relating to the source of the image to transfer
Source *ScpTransferImageOptions
// Dest contains data relating to the destination of the image to transfer
Dest *ScpTransferImageOptions
// ParentFlags are the arguments to apply to the parent podman command when called via ssh
ParentFlags []string
}
type ScpLoadReport ¶
type ScpLoadReport = ImageLoadReport
type ScpLoadToRemoteOptions ¶
type ScpLoadToRemoteOptions struct {
// Dest contains data relating to the destination of the image to transfer
Dest ScpTransferImageOptions
// LocalFile is a path to a local file containing saved image data to transfer
LocalFile string
// Tag is the name of the tag to be given to the loaded image (unused)
Tag string
// URL points to the remote location for loading to
URL *url.URL
// Iden is a path to an optional identity file with ssh key
Iden string
// SSHMode is the specified ssh.EngineMode which should be used
SSHMode ssh.EngineMode
}
type ScpLoadToRemoteReport ¶
type ScpSaveToRemoteOptions ¶
type ScpSaveToRemoteOptions struct {
Image string
// LocalFile is a path to a local file to copy the saved image to
LocalFile string
// Tag is the name of the tag to be given to the saved image (unused)
Tag string
// URL points to the remote location for saving from
URL *url.URL
// Iden is a path to an optional identity file with ssh key
Iden string
// SSHMode is the specified ssh.EngineMode which should be used
SSHMode ssh.EngineMode
}
type ScpSaveToRemoteReport ¶
type ScpSaveToRemoteReport struct{}
type ScpTransferImageOptions ¶
type ScpTransferImageOptions struct {
// Remote determines if this entity is operating on a remote machine
Remote bool `json:"remote,omitempty"`
// File is the input/output file for the save and load Operation
File string `json:"file,omitempty"`
// Quiet Determines if the save and load operation will be done quietly
Quiet bool `json:"quiet,omitempty"`
// Image is the image the user is providing to save and load
Image string `json:"image,omitempty"`
// User is used in conjunction with Transfer to determine if a valid user was given to save from/load into
User string `json:"user,omitempty"`
// Tag is the name to be used for the image on the destination
Tag string `json:"tag,omitempty"`
}
ScpTransferImageOptions provide options for securely copying images to and from a remote host
type ScpTransferOptions ¶
type ScpTransferOptions struct {
// ParentFlags are the arguments to apply to the parent podman command when called.
ParentFlags []string
}
type ScpTransferReport ¶
type ScpTransferReport struct{}
type SecretCreateOptions ¶
type SecretCreateReport ¶
type SecretCreateReport = types.SecretCreateReport
type SecretCreateRequest ¶
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
// Labels are labels on the secret
Labels map[string]string
}
swagger:model SecretCreate
type SecretDriverSpec ¶
type SecretDriverSpec = types.SecretDriverSpec
type SecretInfoReport ¶
type SecretInfoReport = types.SecretInfoReport
type SecretInfoReportCompat ¶
type SecretInfoReportCompat = types.SecretInfoReportCompat
type SecretInspectOptions ¶
type SecretInspectOptions struct {
ShowSecret bool
}
type SecretListReport ¶
type SecretListReport = types.SecretListReport
type SecretListRequest ¶
type SecretRmOptions ¶
type SecretRmReport ¶
type SecretRmReport = types.SecretRmReport
type SecretSpec ¶
type SecretSpec = types.SecretSpec
type SecretVersion ¶
type SecretVersion = types.SecretVersion
type ServiceOptions ¶
type ServiceOptions = types.ServiceOptions
ServiceOptions provides the input for starting an API and sidecar pprof services
type SetTrustOptions ¶
SetTrustOptions describes the CLI options for setting trust
type ShowTrustOptions ¶
ShowTrustOptions are the cli options for showing trust
type ShowTrustReport ¶
type ShowTrustReport = entitiesTypes.ShowTrustReport
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 StopOptions ¶
type StopReport ¶
type StringSliceReport ¶
type StringSliceReport struct {
Value []string
}
StringSliceReport wraps a string slice.
type SwagErrNoSuchSecret ¶
type SwagErrNoSuchSecret struct {
// in:body
Body struct {
errorhandling.ErrorModel
}
}
No such secret swagger:response NoSuchSecret
type SwagErrSecretInUse ¶
type SwagErrSecretInUse struct {
// in:body
Body struct {
errorhandling.ErrorModel
}
}
Secret in use swagger:response SecretInUse
type SwagSecretCreateResponse ¶
type SwagSecretCreateResponse struct {
// in:body
Body struct {
SecretCreateReport
}
}
Secret create response swagger:response SecretCreateResponse
type SwagSecretInspectCompatResponse ¶
type SwagSecretInspectCompatResponse struct {
// in:body
Body SecretInfoReportCompat
}
Secret inspect compat swagger:response SecretInspectCompatResponse
type SwagSecretInspectResponse ¶
type SwagSecretInspectResponse struct {
// in:body
Body SecretInfoReport
}
Secret inspect response swagger:response SecretInspectResponse
type SwagSecretListCompatResponse ¶
type SwagSecretListCompatResponse struct {
// in:body
Body []*SecretInfoReportCompat
}
Secret list response swagger:response SecretListCompatResponse
type SwagSecretListResponse ¶
type SwagSecretListResponse struct {
// in:body
Body []*SecretInfoReport
}
Secret list response swagger:response SecretListResponse
type SystemCheckOptions ¶
type SystemCheckOptions = types.SystemCheckOptions
type SystemCheckReport ¶
type SystemCheckReport = types.SystemCheckReport
type SystemDfContainerReport ¶
type SystemDfContainerReport = types.SystemDfContainerReport
type SystemDfImageReport ¶
type SystemDfImageReport = types.SystemDfImageReport
type SystemDfOptions ¶
type SystemDfOptions = types.SystemDfOptions
type SystemDfReport ¶
type SystemDfReport = types.SystemDfReport
type SystemDfVolumeReport ¶
type SystemDfVolumeReport = types.SystemDfVolumeReport
type SystemMigrateOptions ¶
type SystemMigrateOptions = types.SystemMigrateOptions
type SystemPruneOptions ¶
type SystemPruneOptions = types.SystemPruneOptions
type SystemPruneReport ¶
type SystemPruneReport = types.SystemPruneReport
type SystemUnshareOptions ¶
type SystemUnshareOptions = types.SystemUnshareOptions
type SystemVersionReport ¶
type SystemVersionReport = types.SystemVersionReport
type TopOptions ¶
type VolumeConfigResponse ¶
type VolumeConfigResponse = types.VolumeConfigResponse
type VolumeCreateOptions ¶
type VolumeCreateOptions = types.VolumeCreateOptions
VolumeCreateOptions provides details for creating volumes
type VolumeDeleteOptions ¶
type VolumeDeleteOptions struct{}
type VolumeDeleteReport ¶
type VolumeDeleteReport struct{ Report }
type VolumeExportOptions ¶
VolumeExportOptions describes the options required to export a volume.
type VolumeImportOptions ¶
type VolumeImportOptions struct {
// Input will be closed upon being fully consumed
Input io.Reader
}
VolumeImportOptions describes the options required to import a volume
type VolumeInspectReport ¶
type VolumeInspectReport = types.VolumeInspectReport
type VolumeListOptions ¶
type VolumeListReport ¶
type VolumeListReport = types.VolumeListReport
type VolumeMountReport ¶
type VolumeMountReport = types.VolumeMountReport
VolumeMountReport describes the response from volume mount
type VolumePruneOptions ¶
VolumePruneOptions describes the options needed to prune a volume from the CLI
type VolumeReloadReport ¶
type VolumeReloadReport = types.VolumeReloadReport
VolumeReloadReport describes the response from reload volume plugins
type VolumeRmOptions ¶
type VolumeRmReport ¶
type VolumeRmReport = types.VolumeRmReport
type VolumeUnmountReport ¶
type VolumeUnmountReport = types.VolumeUnmountReport
VolumeUnmountReport describes the response from umounting a volume
type WaitOptions ¶
type WaitOptions struct {
// Conditions to wait on. Includes container statuses such as
// "running" or "stopped" and health-related values such "healthy".
Conditions []string
// Time interval to wait before polling for completion.
Interval time.Duration
// Ignore errors when a specified container is missing and mark its
// return code as -1.
Ignore bool
// Use the latest created container.
Latest bool
// Wait for exit of first container which matches conditions, ignore other ones.
ExitFirstMatch bool
}
WaitOptions are arguments for waiting for a container.
type WaitReport ¶
type WaitReport struct {
// Error while waiting.
Error error
// ExitCode of the container.
ExitCode int32
}
WaitReport is the result of waiting a container.