cli

Documentation

Index

• Variables
• func ProjectFromOptions(options *ProjectOptions) (*types.Project, error)
• func WithConfigFileEnv(o *ProjectOptions) error
• func WithDefaultConfigPath(o *ProjectOptions) error
• func WithDiscardEnvFile(o *ProjectOptions) error
• func WithDotEnv(o *ProjectOptions) error
• func WithOsEnv(o *ProjectOptions) error
• type ProjectOptions
  • func NewProjectOptions(configs []string, opts ...ProjectOptionsFn) (*ProjectOptions, error)
  • func (o ProjectOptions) GetWorkingDir() (string, error)
• type ProjectOptionsFn
  • func WithConsistency(consistency bool) ProjectOptionsFn
  • func WithEnv(env []string) ProjectOptionsFn
  • func WithEnvFile(file string) ProjectOptionsFn
  • func WithEnvFiles(file ...string) ProjectOptionsFn
  • func WithInterpolation(interpolation bool) ProjectOptionsFn
  • func WithLoadOptions(loadOptions ...func(*loader.Options)) ProjectOptionsFn
  • func WithName(name string) ProjectOptionsFn
  • func WithNormalization(normalization bool) ProjectOptionsFn
  • func WithProfiles(profiles []string) ProjectOptionsFn
  • func WithResolvedPaths(resolve bool) ProjectOptionsFn
  • func WithWorkingDirectory(wd string) ProjectOptionsFn

Variables

var DefaultFileNames = []string{"compose.yaml", "compose.yml", "docker-compose.yml", "docker-compose.yaml"}

DefaultFileNames defines the Compose file names for auto-discovery (in order of preference)

var DefaultOverrideFileNames = []string{"compose.override.yml", "compose.override.yaml", "docker-compose.override.yml", "docker-compose.override.yaml"}

DefaultOverrideFileNames defines the Compose override file names for auto-discovery (in order of preference)

Functions

func ProjectFromOptions

func ProjectFromOptions(options *ProjectOptions) (*types.Project, error)

ProjectFromOptions load a compose project based on command line options

func WithConfigFileEnv

func WithConfigFileEnv(o *ProjectOptions) error

WithConfigFileEnv allow to set compose config file paths by COMPOSE_FILE environment variable

func WithDefaultConfigPath

func WithDefaultConfigPath(o *ProjectOptions) error

WithDefaultConfigPath searches for default config files from working directory

func WithDiscardEnvFile

func WithDiscardEnvFile(o *ProjectOptions) error

WithDiscardEnvFiles sets discards the `env_file` section after resolving to the `environment` section

func WithDotEnv

func WithDotEnv(o *ProjectOptions) error

WithDotEnv imports environment variables from .env file

func WithOsEnv

func WithOsEnv(o *ProjectOptions) error

WithOsEnv imports environment variables from OS

Types

type ProjectOptions

type ProjectOptions struct {
	// Name is a valid Compose project name to be used or empty.
	//
	// If empty, the project loader will automatically infer a reasonable
	// project name if possible.
	Name string

	// WorkingDir is a file path to use as the project directory or empty.
	//
	// If empty, the project loader will automatically infer a reasonable
	// working directory if possible.
	WorkingDir string

	// ConfigPaths are file paths to one or more Compose files.
	//
	// These are applied in order by the loader following the merge logic
	// as described in the spec.
	//
	// The first entry is required and is the primary Compose file.
	// For convenience, WithConfigFileEnv and WithDefaultConfigPath
	// are provided to populate this in a predictable manner.
	ConfigPaths []string

	// Environment are additional environment variables to make available
	// for interpolation.
	//
	// NOTE: For security, the loader does not automatically expose any
	// process environment variables. For convenience, WithOsEnv can be
	// used if appropriate.
	Environment map[string]string

	// EnvFiles are file paths to ".env" files with additional environment
	// variable data.
	//
	// These are loaded in-order, so it is possible to override variables or
	// in subsequent files.
	//
	// This field is optional, but any file paths that are included here must
	// exist or an error will be returned during load.
	EnvFiles []string
	// contains filtered or unexported fields
}

ProjectOptions provides common configuration for loading a project.

func NewProjectOptions

func NewProjectOptions(configs []string, opts ...ProjectOptionsFn) (*ProjectOptions, error)

NewProjectOptions creates ProjectOptions

func (ProjectOptions) GetWorkingDir

func (o ProjectOptions) GetWorkingDir() (string, error)

type ProjectOptionsFn

type ProjectOptionsFn func(*ProjectOptions) error

func WithConsistency

func WithConsistency(consistency bool) ProjectOptionsFn

WithConsistency set ProjectOptions to enable/skip consistency

func WithEnv

func WithEnv(env []string) ProjectOptionsFn

WithEnv defines a key=value set of variables used for compose file interpolation

func WithEnvFile

func WithEnvFile(file string) ProjectOptionsFn

WithEnvFile set an alternate env file deprecated - use WithEnvFiles

func WithEnvFiles

func WithEnvFiles(file ...string) ProjectOptionsFn

WithEnvFiles set alternate env files

func WithInterpolation

func WithInterpolation(interpolation bool) ProjectOptionsFn

WithInterpolation set ProjectOptions to enable/skip interpolation

func WithLoadOptions

func WithLoadOptions(loadOptions ...func(*loader.Options)) ProjectOptionsFn

WithLoadOptions provides a hook to control how compose files are loaded

func WithName

func WithName(name string) ProjectOptionsFn

WithName defines ProjectOptions' name

func WithNormalization

func WithNormalization(normalization bool) ProjectOptionsFn

WithNormalization set ProjectOptions to enable/skip normalization

func WithProfiles

func WithProfiles(profiles []string) ProjectOptionsFn

WithProfiles sets profiles to be activated

func WithResolvedPaths

func WithResolvedPaths(resolve bool) ProjectOptionsFn

WithResolvedPaths set ProjectOptions to enable paths resolution

func WithWorkingDirectory

func WithWorkingDirectory(wd string) ProjectOptionsFn

WithWorkingDirectory defines ProjectOptions' working directory