compose

Documentation

Index

• Constants
• Variables
• func FixupServices(ctx context.Context, provider client.Provider, project *types.Project, ...) error
• func GetNumOfGPUs(ctx context.Context, project *composeTypes.Project) int
• func NormalizeServiceName(s string) string
• func ValidateManagedStore(managedStore any) error
• 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 NewLoader(opts ...LoaderOption) *Loader
  • func (c *Loader) LoadProject(ctx context.Context) (*Project, error)
  • func (c *Loader) LoadProjectName(ctx context.Context) (string, error)
• type LoaderOption
  • func WithPath(paths ...string) LoaderOption
  • func WithProjectName(name string) LoaderOption
• type LoaderOptions
• type Project
  • func LoadFromContent(ctx context.Context, content []byte, nameFallback string) (*Project, error)
• 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_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, project *types.Project, upload UploadMode) error

func GetNumOfGPUs

func GetNumOfGPUs(ctx context.Context, project *composeTypes.Project) int

func NormalizeServiceName

func NormalizeServiceName(s string) string

func ValidateManagedStore

func ValidateManagedStore(managedStore any) error

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 NewLoader

func NewLoader(opts ...LoaderOption) *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 LoaderOption

type LoaderOption func(*LoaderOptions)

func WithPath

func WithPath(paths ...string) LoaderOption

func WithProjectName

func WithProjectName(name string) LoaderOption

type LoaderOptions

type LoaderOptions struct {
	ConfigPaths []string
	ProjectName string
}

type Project

type Project = composeTypes.Project

func LoadFromContent

func LoadFromContent(ctx context.Context, content []byte, nameFallback string) (*Project, error)

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 does start the preview command
)