common

package
v5.7.1 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2025 License: Apache-2.0 Imports: 57 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// AllType can be of type ImageType or ContainerType.
	AllType = "all"
	// ArtifactType is the artifact type.
	ArtifactType = "artifact"
	// ContainerType is the container type.
	ContainerType = "container"
	// ImageType is the image type.
	ImageType = "image"
	// NetworkType is the network type
	NetworkType = "network"
	// PodType is the pod type.
	PodType = "pod"
	// VolumeType is the volume type
	VolumeType = "volume"
)

Variables

View Source 
var (
	// ChangeCmds is the list of valid Change commands to passed to the Commit call
	ChangeCmds = []string{"CMD", "ENTRYPOINT", "ENV", "EXPOSE", "LABEL", "ONBUILD", "STOPSIGNAL", "USER", "VOLUME", "WORKDIR"}
	// LogLevels supported by podman
	LogLevels = []string{"trace", "debug", "info", "warn", "warning", "error", "fatal", "panic"}
	// ValidSaveFormats is the list of support podman save formats
	ValidSaveFormats = []string{define.OCIManifestDir, define.OCIArchive, define.V2s2ManifestDir, define.V2s2Archive}
)
View Source 
var FarmBuildHiddenFlags = []string{"arch", "all-platforms", "compress", "cw", "disable-content-trust",
	"logsplit", "manifest", "os", "output", "platform", "sign-by", "signature-policy", "stdin",
	"variant"}

FarmBuildHiddenFlags are the flags hidden from the farm build command because they are either not supported or don't make sense in the farm build use case

Functions

func AutoCompleteFarms 

func AutoCompleteFarms(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func AutoCompletePodsPause 

func AutoCompletePodsPause(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutoCompletePodsPause - Autocomplete only paused pod names When a pod has a few containers paused, that ends up in degraded state So autocomplete degraded pod names as well

func AutocompleteArtifactAdd added in v5.4.0 

func AutocompleteArtifactAdd(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func AutocompleteArtifacts added in v5.4.0 

func AutocompleteArtifacts(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func AutocompleteCgroupManager 

func AutocompleteCgroupManager(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteCgroupManager - Autocomplete cgroup manager options. -> "cgroupfs", "systemd"

func AutocompleteCgroupMode 

func AutocompleteCgroupMode(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteCgroupMode - Autocomplete cgroup mode options. -> "enabled", "disabled", "no-conmon", "split"

func AutocompleteChangeInstructions 

func AutocompleteChangeInstructions(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteChangeInstructions - Autocomplete change instructions options for commit and import. -> "CMD", "ENTRYPOINT", "ENV", "EXPOSE", "LABEL", "ONBUILD", "STOPSIGNAL", "USER", "VOLUME", "WORKDIR"

func AutocompleteCheckpointCompressType 

func AutocompleteCheckpointCompressType(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteCheckpointCompressType - Autocomplete checkpoint compress type options. -> "gzip", "none", "zstd"

func AutocompleteClone 

func AutocompleteClone(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteClone - Autocomplete container and image names

func AutocompleteCommitCommand 

func AutocompleteCommitCommand(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteCommitCommand - Autocomplete podman commit command args.

func AutocompleteCompressionFormat 

func AutocompleteCompressionFormat(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteCompressionFormat - Autocomplete compression-format type options.

func AutocompleteContainerOneArg 

func AutocompleteContainerOneArg(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainerOneArg - Autocomplete containers as fist arg.

func AutocompleteContainers 

func AutocompleteContainers(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainers - Autocomplete all container names.

func AutocompleteContainersAndImages 

func AutocompleteContainersAndImages(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersAndImages - Autocomplete container names and pod names.

func AutocompleteContainersAndPods 

func AutocompleteContainersAndPods(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersAndPods - Autocomplete container names and pod names.

func AutocompleteContainersConfModules 

func AutocompleteContainersConfModules(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersConfModules- Autocomplete containers.conf modules.

func AutocompleteContainersCreated 

func AutocompleteContainersCreated(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersCreated - Autocomplete only created container names.

func AutocompleteContainersExited 

func AutocompleteContainersExited(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersExited - Autocomplete only exited container names.

func AutocompleteContainersPaused 

func AutocompleteContainersPaused(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersPaused - Autocomplete only paused container names.

func AutocompleteContainersRunning 

func AutocompleteContainersRunning(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersRunning - Autocomplete only running container names.

func AutocompleteContainersStartable 

func AutocompleteContainersStartable(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteContainersStartable - Autocomplete only created and exited container names.

func AutocompleteCpCommand 

func AutocompleteCpCommand(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteCpCommand - Autocomplete podman cp command args.

func AutocompleteCreateAttach 

func AutocompleteCreateAttach(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteCreateAttach - Autocomplete create --attach options. -> "stdin", "stdout", "stderr"

func AutocompleteCreateRun 

func AutocompleteCreateRun(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteCreateRun - Autocomplete only the fist argument as image and then do file completion.

func AutocompleteDefaultOneArg 

func AutocompleteDefaultOneArg(_ *cobra.Command, args []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteDefaultOneArg - Autocomplete path only for the first argument.

func AutocompleteDetachKeys 

func AutocompleteDetachKeys(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteDetachKeys - Autocomplete detach-keys options. -> "ctrl-"

func AutocompleteEventBackend 

func AutocompleteEventBackend(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteEventBackend - Autocomplete event backend options. -> "file", "journald", "none"

func AutocompleteEventFilter 

func AutocompleteEventFilter(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteEventFilter - Autocomplete event filter flag options. -> "container=", "event=", "image=", "pod=", "volume=", "type="

func AutocompleteExecCommand 

func AutocompleteExecCommand(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteExecCommand - Autocomplete podman exec command args.

func AutocompleteForGenerate 

func AutocompleteForGenerate(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func AutocompleteForKube 

func AutocompleteForKube(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteForKube - Autocomplete all Podman objects supported by kube generate.

func AutocompleteFormat 

func AutocompleteFormat(o any) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteFormat - Autocomplete json or a given struct to use for a go template. The input can be nil, In this case only json will be autocompleted. This function will only work for pointer to structs other types are not supported. When "{{." is typed the field and method names of the given struct will be completed. This also works recursive for nested structs.

func AutocompleteHealthOnFailure 

func AutocompleteHealthOnFailure(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteHealthOnFailure - action to take once the container turns unhealthy.

func AutocompleteHostsFile added in v5.4.0 

func AutocompleteHostsFile(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteHostsFile - Autocomplete hosts file options. -> "image", "none", paths

func AutocompleteImageFilters 

func AutocompleteImageFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteImageFilters - Autocomplete image ls --filter options.

func AutocompleteImageFormat 

func AutocompleteImageFormat(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteImageFormat - Autocomplete image format options. -> "oci", "docker"

func AutocompleteImageSaveFormat 

func AutocompleteImageSaveFormat(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteImageSaveFormat - Autocomplete image save format options.

func AutocompleteImageSearchFilters 

func AutocompleteImageSearchFilters(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteImageSearchFilters - Autocomplete `search --filter`.

func AutocompleteImageSort 

func AutocompleteImageSort(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteImageSort - Autocomplete images sort options. -> "created", "id", "repository", "size", "tag"

func AutocompleteImageVolume 

func AutocompleteImageVolume(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteImageVolume - Autocomplete image volume options. -> "bind", "tmpfs", "ignore"

func AutocompleteImages 

func AutocompleteImages(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteImages - Autocomplete images.

func AutocompleteInitCtr 

func AutocompleteInitCtr(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteInitCtr - Autocomplete init container type -> "once", "always"

func AutocompleteInspect 

func AutocompleteInspect(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteInspect - Autocomplete podman inspect.

func AutocompleteInspectType 

func AutocompleteInspectType(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteInspectType - Autocomplete inspect type options.

func AutocompleteLogDriver 

func AutocompleteLogDriver(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteLogDriver - Autocomplete log-driver options. -> "journald", "none", "k8s-file", "passthrough", "passthrough-tty"

func AutocompleteLogLevel 

func AutocompleteLogLevel(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteLogLevel - Autocomplete log level options. -> "trace", "debug", "info", "warn", "error", "fatal", "panic"

func AutocompleteLogOpt 

func AutocompleteLogOpt(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteLogOpt - Autocomplete log-opt options. -> "path=", "tag="

func AutocompleteManifestFormat 

func AutocompleteManifestFormat(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteManifestFormat - Autocomplete manifest format options. -> "oci", "v2s2"

func AutocompleteManifestListAndMember added in v5.3.0 

func AutocompleteManifestListAndMember(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteManifestListAndMember - Autocomplete names of manifest lists and digests of items in them.

func AutocompleteMountFlag 

func AutocompleteMountFlag(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteMountFlag - Autocomplete mount flag options. -> "type=bind,", "type=volume,", "type=tmpfs,"

func AutocompleteNamespace 

func AutocompleteNamespace(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteNamespace - Autocomplete namespace options. -> host,container:[name],ns:path,private

func AutocompleteNetworkBackend 

func AutocompleteNetworkBackend(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkBackend - Autocomplete network backend options. -> "cni", "netavark"

func AutocompleteNetworkConnectCmd 

func AutocompleteNetworkConnectCmd(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkConnectCmd - Autocomplete podman network connect/disconnect command args.

func AutocompleteNetworkDriver 

func AutocompleteNetworkDriver(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkDriver - Autocomplete network driver option.

func AutocompleteNetworkFilters 

func AutocompleteNetworkFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkFilters - Autocomplete network ls --filter options.

func AutocompleteNetworkFlag 

func AutocompleteNetworkFlag(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkFlag - Autocomplete network flag options.

func AutocompleteNetworkIPAMDriver 

func AutocompleteNetworkIPAMDriver(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkIPAMDriver - Autocomplete network ipam driver option. -> "bridge", "macvlan"

func AutocompleteNetworkInterfaceNames added in v5.7.0 

func AutocompleteNetworkInterfaceNames(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworkInterfaceNames - Autocomplete network create --interface-name options.

func AutocompleteNetworks 

func AutocompleteNetworks(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteNetworks - Autocomplete networks.

func AutocompletePodExitPolicy 

func AutocompletePodExitPolicy(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompletePodExitPolicy - Autocomplete pod exit policy.

func AutocompletePodPsFilters 

func AutocompletePodPsFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePodPsFilters - Autocomplete pod ps filter options.

func AutocompletePodPsSort 

func AutocompletePodPsSort(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompletePodPsSort - Autocomplete images sort options. -> "created", "id", "name", "status", "number"

func AutocompletePodShareNamespace 

func AutocompletePodShareNamespace(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePodShareNamespace - Autocomplete pod create --share flag option. -> "ipc", "net", "pid", "user", "uts", "cgroup", "none"

func AutocompletePods 

func AutocompletePods(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePods - Autocomplete all pod names.

func AutocompletePodsRunning 

func AutocompletePodsRunning(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePodsRunning - Autocomplete only running pod names. It considers degraded as running.

func AutocompletePruneFilters 

func AutocompletePruneFilters(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePruneFilters - Autocomplete container/image prune --filter options.

func AutocompletePsFilters 

func AutocompletePsFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompletePsFilters - Autocomplete ps filter options.

func AutocompletePsSort 

func AutocompletePsSort(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompletePsSort - Autocomplete images sort options. -> "command", "created", "id", "image", "names", "runningfor", "size", "status"

func AutocompletePullOption 

func AutocompletePullOption(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompletePullOption - Autocomplete pull options for create and run command. -> "always", "missing", "never"

func AutocompleteQuadletFilters added in v5.6.0 

func AutocompleteQuadletFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteQuadletFilters - Autocomplete quadlet filter options.

func AutocompleteQuadlets added in v5.6.0 

func AutocompleteQuadlets(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteQuadlets - Autocomplete quadlets.

func AutocompleteRegistries 

func AutocompleteRegistries(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteRegistries - Autocomplete registries.

func AutocompleteRestartOption 

func AutocompleteRestartOption(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteRestartOption - Autocomplete restart options for create and run command. -> "always", "no", "on-failure", "unless-stopped"

func AutocompleteRunlabelCommand 

func AutocompleteRunlabelCommand(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteRunlabelCommand - Autocomplete podman container runlabel command args.

func AutocompleteSDNotify 

func AutocompleteSDNotify(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteSDNotify - Autocomplete sdnotify options. -> "container", "conmon", "ignore"

func AutocompleteSSH 

func AutocompleteSSH(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSSH - Autocomplete ssh modes

func AutocompleteScp 

func AutocompleteScp(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteScp returns a list of connections, images, or both, depending on the amount of arguments

func AutocompleteSecretCreate 

func AutocompleteSecretCreate(_ *cobra.Command, args []string, _ string) ([]string, cobra.ShellCompDirective)

func AutocompleteSecretFilters 

func AutocompleteSecretFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSecretFilters - Autocomplete secret ls --filter options.

func AutocompleteSecrets 

func AutocompleteSecrets(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSecrets - Autocomplete secrets.

func AutocompleteSecurityOption 

func AutocompleteSecurityOption(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSecurityOption - Autocomplete security options options.

func AutocompleteStopSignal 

func AutocompleteStopSignal(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteStopSignal - Autocomplete stop signal options. Autocompletes signals both lower or uppercase depending on the user input.

func AutocompleteSysctl added in v5.7.0 

func AutocompleteSysctl(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSysctl - autocomplete list all sysctl names

func AutocompleteSystemConnections 

func AutocompleteSystemConnections(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteSystemConnections - Autocomplete system connections.

func AutocompleteSystemdFlag 

func AutocompleteSystemdFlag(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteSystemdFlag - Autocomplete systemd flag options. -> "true", "false", "always"

func AutocompleteSystemdRestartOptions 

func AutocompleteSystemdRestartOptions(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteSystemdRestartOptions - Autocomplete systemd restart options. -> "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", "always"

func AutocompleteTopCmd 

func AutocompleteTopCmd(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteTopCmd - Autocomplete podman top/pod top command args.

func AutocompleteTrustType 

func AutocompleteTrustType(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteTrustType - Autocomplete trust type options. -> "signedBy", "accept", "reject"

func AutocompleteUserFlag 

func AutocompleteUserFlag(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteUserFlag - Autocomplete user flag based on the names and groups (includes ids after first char) in /etc/passwd and /etc/group files. -> user:group

func AutocompleteUserNamespace 

func AutocompleteUserNamespace(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteUserNamespace - Autocomplete namespace options. -> same as AutocompleteNamespace with "auto", "keep-id" added

func AutocompleteVolumeFilters 

func AutocompleteVolumeFilters(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteVolumeFilters - Autocomplete volume ls --filter options.

func AutocompleteVolumeFlag 

func AutocompleteVolumeFlag(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteVolumeFlag - Autocomplete volume flag options. -> volumes and paths

func AutocompleteVolumes 

func AutocompleteVolumes(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

AutocompleteVolumes - Autocomplete volumes.

func AutocompleteWaitCondition 

func AutocompleteWaitCondition(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

AutocompleteWaitCondition - Autocomplete wait condition options. -> "unknown", "configured", "created", "running", "stopped", "paused", "exited", "removing"

func ClearScreen added in v5.5.0 

func ClearScreen()

ClearScreen clears the screen and puts the cursor back to position 1,1 Useful when printing output in an interval like podman stats. When the stdout is not a terminal this is a NOP.

func ContainerToPodOptions 

func ContainerToPodOptions(containerCreate *entities.ContainerCreateOptions, podCreate *entities.PodCreateOptions) error

ContainerToPodOptions takes the Container and Pod Create options, assigning the matching values back to podCreate for the purpose of the libpod API For this function to succeed, the JSON tags in PodCreateOptions and ContainerCreateOptions need to match due to the Marshalling and Unmarshalling done. The types of the options also need to match or else the unmarshalling will fail even if the tags match

func DefineBuildFlags 

func DefineBuildFlags(cmd *cobra.Command, buildOpts *BuildFlagsWrapper, isFarmBuild bool)

func DefineCreateDefaults 

func DefineCreateDefaults(opts *entities.ContainerCreateOptions)

DefineCreateDefaults is used to initialize ctr create options before flag initialization

func DefineCreateFlags 

func DefineCreateFlags(cmd *cobra.Command, cf *entities.ContainerCreateOptions, mode entities.ContainerMode)

DefineCreateFlags declares and instantiates the container create flags

func DefineNetFlags 

func DefineNetFlags(cmd *cobra.Command)

func DefineSigningFlags added in v5.7.0 

func DefineSigningFlags(cmd *cobra.Command, cliOpts *SigningCLIOnlyOptions, pushOpts *entities.ImagePushOptions)

func Env 

func Env() []string

func GetHealthCheckOverrideConfig added in v5.5.0 

func GetHealthCheckOverrideConfig(cmd *cobra.Command, vals *entities.ContainerCreateOptions) (*manifest.Schema2HealthConfig, error)

func LogDriver 

func LogDriver() string

func NetFlagsToNetOptions 

func NetFlagsToNetOptions(opts *entities.NetOptions, flags pflag.FlagSet) (*entities.NetOptions, error)

NetFlagsToNetOptions parses the network flags for the given cmd.

func ParseBuildOpts 

func ParseBuildOpts(cmd *cobra.Command, args []string, buildOpts *BuildFlagsWrapper) (*entities.BuildOptions, error)

func PrepareSigning 

func PrepareSigning(pushOpts *entities.ImagePushOptions, cliOpts *SigningCLIOnlyOptions) (func(), error)

PrepareSigning updates pushOpts.Signers, pushOpts.SignPassphrase and SignSigstorePrivateKeyPassphrase based on cliOpts, and validates pushOpts.Sign* consistency. It may interactively prompt for a passphrase if one is required and wasn’t provided otherwise; or it may interactively trigger an OIDC authentication, using standard input/output, or even open a web browser. Returns a cleanup callback on success, which must be called when done.

func SetRegistriesConfPath added in v5.4.0 

func SetRegistriesConfPath(systemContext *types.SystemContext)

SetRegistriesConfPath sets the registries.conf path for the specified context. NOTE: this is a verbatim copy from c/common/libimage which we're not using to prevent leaking c/storage into this file. Maybe this should go into c/image?

Types

type BuildFlagsWrapper 

type BuildFlagsWrapper struct {
	// Buildah stuff first
	buildahCLI.BudResults
	buildahCLI.LayerResults
	buildahCLI.FromAndBudResults
	buildahCLI.NameSpaceResults
	buildahCLI.UserNSResults

	// SquashAll squashes all layers into a single layer.
	SquashAll bool
	// Cleanup removes built images from remote connections on success
	Cleanup bool
}

BuildFlagsWrapper are local to cmd/ as the build code is using Buildah-internal types. Hence, after parsing, we are converting buildFlagsWrapper to the entities' options which essentially embed the Buildah types.

type SigningCLIOnlyOptions added in v5.7.0 

type SigningCLIOnlyOptions struct {
	// contains filtered or unexported fields
}

SigningCLIOnlyOptions contains signing-related CLI options. Some other options are defined in entities.ImagePushOptions.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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