compose

Documentation

Overview

Package compose provides Docker Compose project processing functionality

Package compose provides Docker Compose file parsing and handling

Index

• Variables
• func LabelConverter(labels types.Labels) []string
• func NameResolver(definedName, keyName string) string
• func OptionsConverter(opts map[string]string) []string
• func ParseComposeFile(path string) (*types.Project, error)
• func ProcessProjects(projects []*types.Project, force bool, existingProcessedUnits map[string]bool, ...) (map[string]bool, error)
• func ReadProjects(path string) ([]*types.Project, error)
• type CleanupOrphanedUnitsFunc
• type ProcessUnitFunc
• type UpdateUnitDatabaseFunc
• type WriteUnitFileFunc

Variables

var (
	ProcessUnit          ProcessUnitFunc          = processUnit
	CleanupOrphanedUnits CleanupOrphanedUnitsFunc = cleanupOrphanedUnits
	WriteUnitFile        WriteUnitFileFunc        = fs.WriteUnitFile
	UpdateUnitDatabase   UpdateUnitDatabaseFunc   = updateUnitDatabase
)

Package variables for testing.

Functions

func LabelConverter

func LabelConverter(labels types.Labels) []string

LabelConverter converts compose-style labels to unit labels.

func NameResolver

func NameResolver(definedName, keyName string) string

NameResolver resolves resource names from compose configs.

func OptionsConverter

func OptionsConverter(opts map[string]string) []string

OptionsConverter converts driver options to unit options.

func ParseComposeFile

func ParseComposeFile(path string) (*types.Project, error)

ParseComposeFile parses a Docker Compose file at the specified path.

func ProcessProjects

func ProcessProjects(projects []*types.Project, force bool, existingProcessedUnits map[string]bool, doCleanup bool) (map[string]bool, error)

ProcessProjects processes Docker Compose projects and converts them to Podman systemd units. It accepts an existing processedUnits map to track units across multiple repository calls and a cleanup flag to control when orphaned unit cleanup should occur.

func ReadProjects

func ReadProjects(path string) ([]*types.Project, error)

ReadProjects reads all Docker Compose projects from a directory path.

Types

type CleanupOrphanedUnitsFunc

type CleanupOrphanedUnitsFunc func(unitRepo repository.Repository, processedUnits map[string]bool) error

CleanupOrphanedUnitsFunc is the function signature for cleaning up orphaned units.

type ProcessUnitFunc

type ProcessUnitFunc func(unitRepo repository.Repository, unitItem *unit.QuadletUnit, force bool, processedUnits map[string]bool, changedUnits *[]unit.QuadletUnit) error

ProcessUnitFunc is the function signature for processing a single quadlet unit.

type UpdateUnitDatabaseFunc

type UpdateUnitDatabaseFunc func(unitRepo repository.Repository, unitItem *unit.QuadletUnit, content string) error

UpdateUnitDatabaseFunc is the function signature for updating the unit database.

type WriteUnitFileFunc

type WriteUnitFileFunc func(unitPath, content string) error

WriteUnitFileFunc is the function signature for writing a unit file.