registry

Documentation

Index

• Constants
• Variables
• func ContainerEngine() entities.ContainerEngine
• func Context() context.Context
• func ContextWithOptions(ctx context.Context) context.Context
• func DefaultAPIAddress() string
• func GetContext() context.Context
• func GetContextWithOptions() context.Context
• func GetExitCode() int
• func ImageEngine() entities.ImageEngine
• func IsRemote() bool
• func JSONLibrary() jsoniter.API
• func NewContainerEngine(cmd *cobra.Command, args []string) (entities.ContainerEngine, error)
• func NewImageEngine(cmd *cobra.Command, args []string) (entities.ImageEngine, error)
• func PodmanConfig() *entities.PodmanConfig
• func SetExitCode(code int)
• type CliCommand
• type PodmanOptionsKey

Constants

const (
	ParentNSRequired  = "ParentNSRequired"
	UnshareNSRequired = "UnshareNSRequired"
)

const DefaultRootAPIAddress = "unix:" + DefaultRootAPIPath

DefaultRootAPIAddress is the default address of the REST socket with unix: prefix

const DefaultRootAPIPath = "/run/podman/podman.sock"

DefaultRootAPIPath is the default path of the REST socket

const DefaultVarlinkAddress = "unix:/run/podman/io.podman"

DefaultVarlinkAddress is the default address of the varlink socket

const ExecErrorCodeGeneric = 125

Variables

var (

	// Commands holds the cobra.Commands to present to the user, including
	// parent if not a child of "root"
	Commands []CliCommand
)

Functions

func ContainerEngine

func ContainerEngine() entities.ContainerEngine

func Context

func Context() context.Context

func ContextWithOptions

func ContextWithOptions(ctx context.Context) context.Context

func DefaultAPIAddress

func DefaultAPIAddress() string

func GetContext

func GetContext() context.Context

GetContext deprecated, use Context()

func GetContextWithOptions

func GetContextWithOptions() context.Context

GetContextWithOptions deprecated, use NewContextWithOptions()

func GetExitCode

func GetExitCode() int

func ImageEngine

func ImageEngine() entities.ImageEngine

func IsRemote

func IsRemote() bool

IsRemote returns true if podman was built to run remote or --remote flag given on CLI Use in init() functions as an initialization check

func JSONLibrary

func JSONLibrary() jsoniter.API

JSONLibrary provides a "encoding/json" compatible API

func NewContainerEngine

func NewContainerEngine(cmd *cobra.Command, args []string) (entities.ContainerEngine, error)

NewContainerEngine is a wrapper for building an ContainerEngine to be used for PreRunE functions

func NewImageEngine

func NewImageEngine(cmd *cobra.Command, args []string) (entities.ImageEngine, error)

NewImageEngine is a wrapper for building an ImageEngine to be used for PreRunE functions

func PodmanConfig

func PodmanConfig() *entities.PodmanConfig

PodmanConfig returns an entities.PodmanConfig built up from environment and CLI

func SetExitCode

func SetExitCode(code int)

Types

type CliCommand

type CliCommand struct {
	Mode    []entities.EngineMode
	Command *cobra.Command
	Parent  *cobra.Command
}

type PodmanOptionsKey

type PodmanOptionsKey struct{}