compose

Documentation

Index

• Constants
• Variables
• func FixupServices(ctx context.Context, provider client.Provider, ...) error
• func NormalizeServiceName(s string) string
• func ValidateProject(project *composeTypes.Project) error
• func ValidateProjectConfig(ctx context.Context, composeProject *composeTypes.Project, ...) error
• func ValidateService(service *types.ServiceConfig) error
• func WalkContextFolder(root, dockerfile string, ...) error
• type ErrMissingConfig
  • func (e ErrMissingConfig) Error() string
• type FixupTarget
• type ListConfigNamesFunc
• type Loader
  • func NewLoaderWithOptions(options LoaderOptions) Loader
  • func NewLoaderWithPath(path string) Loader
  • func (c Loader) LoadProject(ctx context.Context) (*Project, error)
  • func (c Loader) LoadProjectName(ctx context.Context) (string, error)
• type LoaderOptions
• type Project
• type ServiceConfig
• type ServiceNameReplacer
  • func NewServiceNameReplacer(provider client.Provider, services composeTypes.Services) ServiceNameReplacer
  • func (s *ServiceNameReplacer) HasServiceName(name string) bool
  • func (s *ServiceNameReplacer) ReplaceServiceNameWithDNS(serviceName string, key, value string, fixupTarget FixupTarget) string
• type Services
• type UploadMode

Constants

const (
	MiB                  = 1024 * 1024
	ContextFileLimit     = 100
	ContextSizeSoftLimit = 10 * MiB
	ContextSizeHardLimit = 100 * MiB
)

const Mode_HOST = "host"

const Mode_INGRESS = "ingress"

const NetworkPublic = "public"

HACK: Use magic network name "public" to determine if the service is public

const Protocol_HTTP = "http"

const Protocol_TCP = "tcp"

const Protocol_UDP = "udp"

Variables

var ErrDockerfileNotFound = errors.New("dockerfile not found")

Functions

func FixupServices

func FixupServices(ctx context.Context, provider client.Provider, serviceConfigs composeTypes.Services, upload UploadMode) error

func NormalizeServiceName

func NormalizeServiceName(s string) string

func ValidateProject

func ValidateProject(project *composeTypes.Project) error

func ValidateProjectConfig

func ValidateProjectConfig(ctx context.Context, composeProject *composeTypes.Project, listConfigNamesFunc ListConfigNamesFunc) error

func ValidateService

func ValidateService(service *types.ServiceConfig) error

func WalkContextFolder

func WalkContextFolder(root, dockerfile string, fn func(path string, de os.DirEntry, slashPath string) error) error

Types

type ErrMissingConfig

type ErrMissingConfig []string

func (ErrMissingConfig) Error

func (e ErrMissingConfig) Error() string

type FixupTarget

type FixupTarget string

const (
	BuildArgs       FixupTarget = "build argument"
	EnvironmentVars FixupTarget = "environment variable"
)

type ListConfigNamesFunc

type ListConfigNamesFunc func(context.Context) ([]string, error)

type Loader

type Loader struct {
	// contains filtered or unexported fields
}

func NewLoaderWithOptions

func NewLoaderWithOptions(options LoaderOptions) Loader

func NewLoaderWithPath

func NewLoaderWithPath(path string) Loader

func (Loader) LoadProject

func (c Loader) LoadProject(ctx context.Context) (*Project, error)

func (Loader) LoadProjectName

func (c Loader) LoadProjectName(ctx context.Context) (string, error)

type LoaderOptions

type LoaderOptions struct {
	ConfigPaths []string
	ProjectName string
}

type Project

type Project = composeTypes.Project

type ServiceConfig

type ServiceConfig = composeTypes.ServiceConfig

type ServiceNameReplacer

type ServiceNameReplacer struct {
	// contains filtered or unexported fields
}

func NewServiceNameReplacer

func NewServiceNameReplacer(provider client.Provider, services composeTypes.Services) ServiceNameReplacer

func (*ServiceNameReplacer) HasServiceName

func (s *ServiceNameReplacer) HasServiceName(name string) bool

func (*ServiceNameReplacer) ReplaceServiceNameWithDNS

func (s *ServiceNameReplacer) ReplaceServiceNameWithDNS(serviceName string, key, value string, fixupTarget FixupTarget) string

type Services

type Services = composeTypes.Services

type UploadMode

type UploadMode int

const (
	UploadModeDigest  UploadMode = iota // the default: calculate the digest of the tarball so we can skip building the same image twice
	UploadModeForce                     // force: always upload the tarball, even if it's the same as a previous one
	UploadModeIgnore                    // dry-run: don't upload the tarball, just return the path
	UploadModePreview                   // preview: like dry-run but also don't deploy
)