Help us shape the future of Go! Take the 2026 Go Developer Survey

podman

package
v0.4.25 Latest Latest
Warning

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

 Go to latest Published: Oct 15, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ProviderPodman        = runtimecontract.ProviderPodman
	LogCollectionJournald = runtimecontract.LogCollectionJournald
)

Variables

View Source 
var ErrResourceOwnership = bhruntime.ErrResourceOwnership
View Source 
var ErrRuntimeNotFound = bhruntime.ErrRuntimeNotFound

Functions

func QuadletAvailable 

func QuadletAvailable(ctx context.Context) bool

QuadletAvailable reports whether this host can run rootless Podman Quadlet units.

func RenderComposeProjectFilesJSON 

func RenderComposeProjectFilesJSON(composePaths []string, environment map[string]string) (string, error)

func WriteQuadletProject 

func WriteQuadletProject(dir string, project QuadletProject) error

Types

type ImageIdentity 

type ImageIdentity = runtimecontract.ImageIdentity

type LogCollectionMode 

type LogCollectionMode = runtimecontract.LogCollectionMode

type PodmanProvider 

type PodmanProvider = Provider

func (PodmanProvider) BuildProjectFilesSelectedProgress 

func (p PodmanProvider) BuildProjectFilesSelectedProgress(ctx context.Context, project, workdir string, environment map[string]string, services []string, onProgress func(string), composeFiles ...string) error

func (PodmanProvider) Config 

func (p PodmanProvider) Config(ctx context.Context, composeFile, envFile string) error

func (PodmanProvider) ConfigJSONProjectFilesEnv 

func (p PodmanProvider) ConfigJSONProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) (string, error)

func (PodmanProvider) ConfigProject 

func (p PodmanProvider) ConfigProject(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) ConfigProjectFiles 

func (p PodmanProvider) ConfigProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) error

func (PodmanProvider) ConfigProjectFilesEnv 

func (p PodmanProvider) ConfigProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) error

func (PodmanProvider) ContainerLogConfigProjectService 

func (p PodmanProvider) ContainerLogConfigProjectService(context.Context, string, string) (string, string, error)

func (PodmanProvider) DestroyOwnedProjectResources 

func (p PodmanProvider) DestroyOwnedProjectResources(ctx context.Context, project string, resources []ProjectResource) error

func (PodmanProvider) DestroyProject 

func (p PodmanProvider) DestroyProject(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) DestroyProjectRemoveOrphans 

func (p PodmanProvider) DestroyProjectRemoveOrphans(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) DiagnosticsProject 

func (p PodmanProvider) DiagnosticsProject(ctx context.Context, project, composeFile, envFile string) string

func (PodmanProvider) Down 

func (p PodmanProvider) Down(ctx context.Context, composeFile, envFile string) error

func (PodmanProvider) DownProject 

func (p PodmanProvider) DownProject(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) DownProjectFiles 

func (p PodmanProvider) DownProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) error

func (PodmanProvider) DownProjectFilesEnv 

func (p PodmanProvider) DownProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) error

func (PodmanProvider) DownProjectRemoveOrphans 

func (p PodmanProvider) DownProjectRemoveOrphans(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) ExecProject 

func (p PodmanProvider) ExecProject(ctx context.Context, project, composeFile, envFile, service string, args ...string) (string, error)

func (PodmanProvider) ExecProjectFiles 

func (p PodmanProvider) ExecProjectFiles(ctx context.Context, project, workdir, service string, composeFiles []string, args ...string) (string, error)

func (PodmanProvider) ExecProjectFilesInput 

func (p PodmanProvider) ExecProjectFilesInput(ctx context.Context, project, workdir, service string, composeFiles []string, input []byte, args ...string) (string, error)

func (PodmanProvider) ExecProjectInput 

func (p PodmanProvider) ExecProjectInput(ctx context.Context, project, composeFile, envFile string, input []byte, service string, args ...string) (string, error)

func (PodmanProvider) InspectProjectResource 

func (p PodmanProvider) InspectProjectResource(ctx context.Context, project string, resource ProjectResource) (bool, error)

func (PodmanProvider) InspectProjectResources 

func (p PodmanProvider) InspectProjectResources(ctx context.Context, project string, resources []ProjectResource) ([]ProjectResource, error)

func (PodmanProvider) LogCollectionMode 

func (p PodmanProvider) LogCollectionMode() LogCollectionMode

func (PodmanProvider) LogsProject 

func (p PodmanProvider) LogsProject(ctx context.Context, project, composeFile, envFile string, services ...string) (string, error)

func (PodmanProvider) LogsProjectFilesEnv added in v0.4.19 

func (p PodmanProvider) LogsProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, services []string, composeFiles ...string) (string, error)

func (PodmanProvider) ObserveProjectServiceCompletion added in v0.4.25 

func (p PodmanProvider) ObserveProjectServiceCompletion(ctx context.Context, project, compose, env, service string) (bool, error)

ObserveProjectServiceCompletion reuses Quadlet's existing successful-exit authority when Podman has removed the one-shot container. It never starts or repairs a unit, synthesizes a container, or changes stored completion state.

func (PodmanProvider) ProjectServiceLogDriver 

func (p PodmanProvider) ProjectServiceLogDriver(ctx context.Context, project, service string) (string, error)

func (PodmanProvider) RetireOwnedProjectContainers added in v0.4.25 

func (p PodmanProvider) RetireOwnedProjectContainers(ctx context.Context, project string, resources []ProjectResource) error

RetireOwnedProjectContainers stops owned Quadlet units and preserves all anonymous and named data volumes. It never passes a volume removal request.

func (PodmanProvider) RunProjectFilesEnv 

func (p PodmanProvider) RunProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, stdin io.Reader, stdout, stderr io.Writer, composeFiles []string, args ...string) error

func (PodmanProvider) RunningServicesProject 

func (p PodmanProvider) RunningServicesProject(ctx context.Context, project, composeFile, envFile string) ([]string, error)

func (PodmanProvider) RunningServicesProjectFiles 

func (p PodmanProvider) RunningServicesProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) ([]string, error)

func (PodmanProvider) RunningServicesProjectFilesEnv 

func (p PodmanProvider) RunningServicesProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) ([]string, error)

func (PodmanProvider) ServiceStatesProjectFilesEnv 

func (p PodmanProvider) ServiceStatesProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) ([]ServiceState, error)

func (PodmanProvider) ServicesProjectFiles 

func (p PodmanProvider) ServicesProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) ([]string, error)

func (PodmanProvider) ServicesProjectFilesEnv 

func (p PodmanProvider) ServicesProjectFilesEnv(ctx context.Context, project, workdir string, environment map[string]string, composeFiles ...string) ([]string, error)

func (PodmanProvider) Status 

func (p PodmanProvider) Status(ctx context.Context, composeFile, envFile string) (string, error)

func (PodmanProvider) StatusProject 

func (p PodmanProvider) StatusProject(ctx context.Context, project, composeFile, envFile string) (string, error)

func (PodmanProvider) StatusProjectFiles 

func (p PodmanProvider) StatusProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) (string, error)

func (PodmanProvider) StopOwnedProjectContainers added in v0.4.18 

func (p PodmanProvider) StopOwnedProjectContainers(ctx context.Context, project string) error

func (PodmanProvider) StopProject 

func (p PodmanProvider) StopProject(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) StopProjectFilesSelected 

func (p PodmanProvider) StopProjectFilesSelected(ctx context.Context, project, workdir string, environment map[string]string, services []string, composeFiles ...string) error

func (PodmanProvider) Up 

func (p PodmanProvider) Up(ctx context.Context, composeFile, envFile string) error

func (PodmanProvider) UpProject 

func (p PodmanProvider) UpProject(ctx context.Context, project, composeFile, envFile string) error

func (PodmanProvider) UpProjectFiles 

func (p PodmanProvider) UpProjectFiles(ctx context.Context, project, workdir string, composeFiles ...string) error

func (PodmanProvider) UpProjectFilesSelected 

func (p PodmanProvider) UpProjectFilesSelected(ctx context.Context, project, workdir string, environment map[string]string, services []string, composeFiles ...string) error

func (PodmanProvider) UpProjectFilesSelectedForceRecreateNoBuild 

func (p PodmanProvider) UpProjectFilesSelectedForceRecreateNoBuild(ctx context.Context, project, workdir string, environment map[string]string, services []string, composeFiles ...string) error

func (PodmanProvider) UpProjectFilesSelectedNoBuildProgress 

func (p PodmanProvider) UpProjectFilesSelectedNoBuildProgress(ctx context.Context, project, workdir string, environment map[string]string, services []string, onProgress func(string), composeFiles ...string) error

func (PodmanProvider) UpProjectFilesSelectedProgress 

func (p PodmanProvider) UpProjectFilesSelectedProgress(ctx context.Context, project, workdir string, environment map[string]string, services []string, onProgress func(string), composeFiles ...string) error

func (PodmanProvider) UpProjectProgress 

func (p PodmanProvider) UpProjectProgress(ctx context.Context, project, composeFile, envFile string, onProgress func(string)) error

func (PodmanProvider) VerifyProjectServiceLogCollection 

func (p PodmanProvider) VerifyProjectServiceLogCollection(ctx context.Context, project, service, expectedTag string) error

type ProjectResource 

type ProjectResource = runtimecontract.ProjectResource

type Provider 

type Provider struct{ bhruntime.Compose }

func New 

func New(ctx context.Context) (*Provider, error)

func (Provider) Capabilities 

func (p Provider) Capabilities() ProviderCapabilities

func (Provider) Descriptor 

func (p Provider) Descriptor() ProviderDescriptor

func (Provider) ExplorerContainerEvidence added in v0.4.25 

func (p Provider) ExplorerContainerEvidence(ctx context.Context, id string) (map[string]string, error)

func (Provider) ExplorerContainerNativeID added in v0.4.25 

func (p Provider) ExplorerContainerNativeID(ctx context.Context, id string) (string, error)

func (Provider) ExplorerOperateContainer added in v0.4.25 

func (p Provider) ExplorerOperateContainer(ctx context.Context, id, operation string) (string, error)

func (Provider) ExplorerRuntimeContainers added in v0.4.25 

func (p Provider) ExplorerRuntimeContainers(ctx context.Context) ([]RuntimeContainer, error)

func (Provider) Kind 

func (p Provider) Kind() ProviderKind

func (Provider) PreferredLocalHTTPSPort 

func (p Provider) PreferredLocalHTTPSPort() int

func (Provider) VerifyLocalRuntimeAuthority added in v0.4.25 

func (p Provider) VerifyLocalRuntimeAuthority(ctx context.Context) error

Observe the same native CLI selection and environment used by this provider, rather than proving an alternate --remote=false engine. Podman documents host.serviceIsRemote and host.security.rootless in its info JSON contract: https://docs.podman.io/en/latest/markdown/podman-info.1.html

type ProviderCapabilities 

type ProviderCapabilities = runtimecontract.ProviderCapabilities

type ProviderDescriptor 

type ProviderDescriptor = runtimecontract.ProviderDescriptor

func Descriptor 

func Descriptor() ProviderDescriptor

type ProviderKind 

type ProviderKind = runtimecontract.ProviderKind

type QuadletProject 

type QuadletProject struct {
	Project           string
	Files             map[string]string
	ServiceUnits      map[string]string
	Containers        map[string]string
	CompletedServices map[string]bool
}

func RenderComposeProjectFilesQuadlets 

func RenderComposeProjectFilesQuadlets(composePaths []string, envFile, project string, selectedServices ...string) (QuadletProject, error)

func RenderComposeProjectFilesQuadletsEnv 

func RenderComposeProjectFilesQuadletsEnv(composePaths []string, envFile string, environment map[string]string, project string, selectedServices ...string) (QuadletProject, error)

func RenderComposeProjectQuadlets 

func RenderComposeProjectQuadlets(composePath, envFile, project string, selectedServices ...string) (QuadletProject, error)

type RuntimeContainer 

type RuntimeContainer = runtimecontract.RuntimeContainer

type ServiceState 

type ServiceState = runtimecontract.ServiceState

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.