project

Documentation

Index

• Variables
• type BuildOptions
• type CertConfig
• type CreateOptions
• type DownOptions
• type Duration
• type HostConfig
• type HostConfigs
• type LogOptions
• type Networks
• type Project
  • func New(ctx context.Context, projectName string) (*Project, error)
  • func (p *Project) GetScenarios(filter string) []string
  • func (p *Project) Mount(ctx context.Context, sources []string, path string) error
  • func (p *Project) Reload(ctx context.Context) error
  • func (p *Project) SaveState() error
  • func (p *Project) Umount(ctx context.Context, sources []string) error
  • func (p *Project) Validate() error
  • func (p *Project) WithSelectedServices(names []string, options ...types.DependencyOption) (*Project, error)
• type PsOptions
• type RunOptions
• type ScenarioConfig
• type ScenarioConfigs
• type SourceConfig
• type SourceConfigs
• type StartOptions
• type UpOptions

Variables

var IgnoreDependencies = types.IgnoreDependencies

var IncludeDependents = types.IncludeDependents

var ProjectLabel = api.ProjectLabel

var ServiceLabel = api.ServiceLabel

var WorkingDirLabel = api.WorkingDirLabel

Types

type BuildOptions

type BuildOptions = api.BuildOptions

type CertConfig

type CertConfig struct {
	Domains  []string `yaml:"domains"`
	KeyFile  string   `yaml:"keyFile"`
	CertFile string   `yaml:"certFile"`
}

type CreateOptions

type CreateOptions = api.CreateOptions

type DownOptions

type DownOptions = api.DownOptions

type Duration

type Duration = types.Duration

type HostConfig

type HostConfig struct {
	IP    string   `yaml:"ip"`
	Hosts []string `yaml:"hosts"`
}

type HostConfigs

type HostConfigs []HostConfig

type LogOptions

type LogOptions = api.LogOptions

type Networks

type Networks = types.Networks

type Project

type Project struct {
	*types.Project

	Sources      SourceConfigs
	Scenarios    ScenarioConfigs
	HostEntities []string // IP hostname1 [hostname2] [hostname3] ...
	CertConfig   CertConfig

	LocalMounts map[string]string // some service's full mount path -> local path
	HasHosts    bool
	// contains filtered or unexported fields
}

Replacement of composer service with our state keeper. Another extended service (with client inside) will be used.

func New

func New(ctx context.Context, projectName string) (*Project, error)

func (*Project) GetScenarios

func (p *Project) GetScenarios(filter string) []string

func (*Project) Mount

func (p *Project) Mount(ctx context.Context, sources []string, path string) error

func (*Project) Reload

func (p *Project) Reload(ctx context.Context) error

func (*Project) SaveState

func (p *Project) SaveState() error

func (*Project) Umount

func (p *Project) Umount(ctx context.Context, sources []string) error

func (*Project) Validate

func (p *Project) Validate() error

func (*Project) WithSelectedServices

func (p *Project) WithSelectedServices(names []string, options ...types.DependencyOption) (*Project, error)

type PsOptions

type PsOptions = api.PsOptions

type RunOptions

type RunOptions = api.RunOptions

type ScenarioConfig

type ScenarioConfig struct {
	Service     string   `yaml:"service"`
	Description string   `yaml:"description"`
	Command     []string `yaml:"command"`
	Entrypoint  []string `yaml:"entrypoint"`
	Tty         *bool    `yaml:"tty"`        // default: true
	Interactive *bool    `yaml:"stdin_open"` // default: true
	WorkingDir  string   `yaml:"working_dir"`
	User        string   `yaml:"user"`
}

type ScenarioConfigs

type ScenarioConfigs map[string]ScenarioConfig

type SourceConfig

type SourceConfig struct {
	URL            string   `yaml:"url"`
	Branch         string   `yaml:"branch"`
	SparseCheckout []string `yaml:"sparseCheckout"`
	Environment    []string `yaml:"environment"`
}

type SourceConfigs

type SourceConfigs map[string]SourceConfig

type StartOptions

type StartOptions = api.StartOptions

type UpOptions

type UpOptions = api.UpOptions