common

package
v2.2.1 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2020 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// TypeBind is the type for mounting host dir
	TypeBind = "bind"
	// TypeVolume is the type for named volumes
	TypeVolume = "volume"
	// TypeTmpfs is the type for mounting tmpfs
	TypeTmpfs = "tmpfs"
	// TypeDevpts is the type for creating a devpts
	TypeDevpts = "devpts"
)

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{"debug", "info", "warn", "error", "fatal", "panic"}
)
View Source 
var (
	// DefaultHealthCheckInterval default value
	DefaultHealthCheckInterval = "30s"
	// DefaultHealthCheckRetries default value
	DefaultHealthCheckRetries uint = 3
	// DefaultHealthCheckStartPeriod default value
	DefaultHealthCheckStartPeriod = "0s"
	// DefaultHealthCheckTimeout default value
	DefaultHealthCheckTimeout = "30s"
	// DefaultImageVolume default value
	DefaultImageVolume = "bind"
)

Functions

func AutocompleteCgroupManager added in v2.2.0 

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

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

func AutocompleteCgroupMode added in v2.2.0 

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

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

func AutocompleteChangeInstructions added in v2.2.0 

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

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

func AutocompleteContainers added in v2.2.0 

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

AutocompleteContainers - Autocomplete all container names.

func AutocompleteContainersAndImages added in v2.2.0 

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

AutocompleteContainersAndImages - Autocomplete container names and pod names.

func AutocompleteContainersAndPods added in v2.2.0 

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

AutocompleteContainersAndPods - Autocomplete container names and pod names.

func AutocompleteContainersCreated added in v2.2.0 

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

AutocompleteContainersCreated - Autocomplete only created container names.

func AutocompleteContainersExited added in v2.2.0 

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

AutocompleteContainersExited - Autocomplete only exited container names.

func AutocompleteContainersPaused added in v2.2.0 

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

AutocompleteContainersPaused - Autocomplete only paused container names.

func AutocompleteContainersRunning added in v2.2.0 

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

AutocompleteContainersRunning - Autocomplete only running container names.

func AutocompleteContainersStartable added in v2.2.0 

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

AutocompleteContainersStartable - Autocomplete only created and exited container names.

func AutocompleteCpCommand added in v2.2.0 

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

AutocompleteCpCommand - Autocomplete podman cp command args.

func AutocompleteCreateAttach added in v2.2.0 

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

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

func AutocompleteCreateRun added in v2.2.0 

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 AutocompleteDetachKeys added in v2.2.0 

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

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

func AutocompleteEventBackend added in v2.2.0 

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

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

func AutocompleteEventFilter added in v2.2.0 

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

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

func AutocompleteImageFilters added in v2.2.0 

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

AutocompleteImageFilters - Autocomplete image ls --filter options.

func AutocompleteImageFormat added in v2.2.0 

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

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

func AutocompleteImageSaveFormat added in v2.2.0 

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

AutocompleteImageSaveFormat - Autocomplete image save format options. -> "oci-archive", "oci-dir", "docker-dir"

func AutocompleteImageSort added in v2.2.0 

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

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

func AutocompleteImageVolume added in v2.2.0 

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

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

func AutocompleteImages added in v2.2.0 

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

AutocompleteImages - Autocomplete images.

func AutocompleteInspectType added in v2.2.0 

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

AutocompleteInspectType - Autocomplete inspect type options. -> "container", "image", "all"

func AutocompleteJSONFormat added in v2.2.0 

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

AutocompleteJSONFormat - Autocomplete format flag option. -> "json"

func AutocompleteLogDriver added in v2.2.0 

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

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

func AutocompleteLogLevel added in v2.2.0 

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

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

func AutocompleteLogOpt added in v2.2.0 

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

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

func AutocompleteManifestFormat added in v2.2.0 

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

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

func AutocompleteMountFlag added in v2.2.0 

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

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

func AutocompleteNamespace added in v2.2.0 

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

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

func AutocompleteNetworkConnectCmd added in v2.2.0 

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

AutocompleteNetworkConnectCmd - Autocomplete podman network connect/disconnect command args.

func AutocompleteNetworkDriver added in v2.2.0 

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

AutocompleteNetworkDriver - Autocomplete network driver option. -> "bridge"

func AutocompleteNetworkFilters added in v2.2.0 

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

AutocompleteNetworkFilters - Autocomplete network ls --filter options.

func AutocompleteNetworks added in v2.2.0 

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

AutocompleteNetworks - Autocomplete networks.

func AutocompletePodPsFilters added in v2.2.0 

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

AutocompletePodPsFilters - Autocomplete pod ps filter options.

func AutocompletePodPsSort added in v2.2.0 

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

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

func AutocompletePodShareNamespace added in v2.2.0 

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

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

func AutocompletePods added in v2.2.0 

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

AutocompletePods - Autocomplete all pod names.

func AutocompletePodsRunning added in v2.2.0 

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

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

func AutocompletePsFilters added in v2.2.0 

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

AutocompletePsFilters - Autocomplete ps filter options.

func AutocompletePsSort added in v2.2.0 

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

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

func AutocompletePullOption added in v2.2.0 

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

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

func AutocompleteRegistries added in v2.2.0 

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

AutocompleteRegistries - Autocomplete registries.

func AutocompleteRestartOption added in v2.2.0 

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

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

func AutocompleteSDNotify added in v2.2.0 

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

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

func AutocompleteSecurityOption added in v2.2.0 

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

AutocompleteSecurityOption - Autocomplete security options options.

func AutocompleteStopSignal added in v2.2.0 

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

AutocompleteStopSignal - Autocomplete stop signal options. -> "SIGHUP", "SIGINT", "SIGKILL", "SIGTERM"

func AutocompleteSystemConnections added in v2.2.0 

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

AutocompleteSystemConnections - Autocomplete system connections.

func AutocompleteSystemdFlag added in v2.2.0 

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

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

func AutocompleteSystemdRestartOptions added in v2.2.0 

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

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

func AutocompleteTopCmd added in v2.2.0 

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

AutocompleteTopCmd - Autocomplete podman top/pod top command args.

func AutocompleteTrustType added in v2.2.0 

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

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

func AutocompleteUserFlag added in v2.2.0 

func AutocompleteUserFlag(cmd *cobra.Command, args []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 added in v2.2.0 

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 added in v2.2.0 

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

AutocompleteVolumeFilters - Autocomplete volume ls --filter options.

func AutocompleteVolumeFlag added in v2.2.0 

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

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

func AutocompleteVolumes added in v2.2.0 

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

AutocompleteVolumes - Autocomplete volumes.

func AutocompleteWaitCondition added in v2.2.0 

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

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

func ChangesToJSON added in v2.2.0 

func ChangesToJSON(diffs *entities.DiffReport) error

func ChangesToTable added in v2.2.0 

func ChangesToTable(diffs *entities.DiffReport) error

func DefineCreateFlags added in v2.2.0 

func DefineCreateFlags(cmd *cobra.Command, cf *ContainerCLIOpts)

func DefineNetFlags added in v2.2.0 

func DefineNetFlags(cmd *cobra.Command)

func FillOutSpecGen 

func FillOutSpecGen(s *specgen.SpecGenerator, c *ContainerCLIOpts, args []string) error

func NetFlagsToNetOptions 

func NetFlagsToNetOptions(cmd *cobra.Command) (*entities.NetOptions, error)

func ReadPodIDFile 

func ReadPodIDFile(path string) (string, error)

ReadPodIDFile reads the specified file and returns its content (i.e., first line).

func ReadPodIDFiles 

func ReadPodIDFiles(files []string) ([]string, error)

ReadPodIDFiles reads the specified files and returns their content (i.e., first line).

Types

type ChangesReportJSON added in v2.2.0 

type ChangesReportJSON struct {
	Changed []string `json:"changed,omitempty"`
	Added   []string `json:"added,omitempty"`
	Deleted []string `json:"deleted,omitempty"`
}

type ContainerCLIOpts 

type ContainerCLIOpts struct {
	Annotation        []string
	Attach            []string
	Authfile          string
	BlkIOWeight       string
	BlkIOWeightDevice []string
	CapAdd            []string
	CapDrop           []string
	CgroupNS          string
	CGroupsMode       string
	CGroupParent      string
	CIDFile           string
	ConmonPIDFile     string
	CPUPeriod         uint64
	CPUQuota          int64
	CPURTPeriod       uint64
	CPURTRuntime      int64
	CPUShares         uint64
	CPUS              float64
	CPUSetCPUs        string
	CPUSetMems        string
	Devices           []string
	DeviceCGroupRule  []string
	DeviceReadBPs     []string
	DeviceReadIOPs    []string
	DeviceWriteBPs    []string
	DeviceWriteIOPs   []string
	Entrypoint        *string
	Env               []string
	EnvHost           bool
	EnvFile           []string
	Expose            []string
	GIDMap            []string
	GroupAdd          []string
	HealthCmd         string
	HealthInterval    string
	HealthRetries     uint
	HealthStartPeriod string
	HealthTimeout     string
	Hostname          string
	HTTPProxy         bool
	ImageVolume       string
	Init              bool
	InitPath          string
	Interactive       bool
	IPC               string
	KernelMemory      string
	Label             []string
	LabelFile         []string
	LogDriver         string
	LogOptions        []string
	Memory            string
	MemoryReservation string
	MemorySwap        string
	MemorySwappiness  int64
	Name              string
	NoHealthCheck     bool
	OOMKillDisable    bool
	OOMScoreAdj       int
	OverrideArch      string
	OverrideOS        string
	OverrideVariant   string
	PID               string
	PIDsLimit         *int64
	Pod               string
	PodIDFile         string
	PreserveFDs       uint
	Privileged        bool
	PublishAll        bool
	Pull              string
	Quiet             bool
	ReadOnly          bool
	ReadOnlyTmpFS     bool
	Restart           string
	Replace           bool
	Rm                bool
	RootFS            bool
	SecurityOpt       []string
	SdNotifyMode      string
	ShmSize           string
	SignaturePolicy   string
	StopSignal        string
	StopTimeout       uint
	StoreageOpt       []string
	SubUIDName        string
	SubGIDName        string
	Sysctl            []string
	Systemd           string
	TmpFS             []string
	TTY               bool
	Timezone          string
	Umask             string
	UIDMap            []string
	Ulimit            []string
	User              string
	UserNS            string
	UTS               string
	Mount             []string
	Volume            []string
	VolumesFrom       []string
	Workdir           string
	SeccompPolicy     string

	Net *entities.NetOptions

	CgroupConf []string
}

func ContainerCreateToContainerCLIOpts added in v2.2.0 

func ContainerCreateToContainerCLIOpts(cc handlers.CreateContainerConfig, cgroupsManager string) (*ContainerCLIOpts, []string, error)

ContainerCreateToContainerCLIOpts converts a compat input struct to cliopts so it can be converted to a specgen spec.

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.