project

Documentation

Index

• type Container
• type ContainerService
• type ContainerServiceHooks
• type ContainerServiceVolume
• type DNSSettings
• type DomainExpose
• type DomainSecurity
• type DomainSecurityAuthentication
• type Domains
• type Project
  • func LoadProjectDefinition(filepath string) (*Project, error)
  • func (project *Project) GetDirectoryPath() string
  • func (project *Project) GetRuntimeDataDirectoryPath() string
• type Registries

Types

type Container

type Container struct {
	Registries []Registries
	Services   []ContainerService
}

type ContainerService

type ContainerService struct {
	Name        string
	Image       string
	User        string
	Volumes     []ContainerServiceVolume `yaml:"volumes,omitempty"`
	Hooks       ContainerServiceHooks    `yaml:"hooks,omitempty"`
	VolumesFrom []string                 `yaml:"volumes_from,omitempty"`
	Environment map[string]string        `yaml:"environment,omitempty"`
}

type ContainerServiceHooks

type ContainerServiceHooks struct {
	ExecuteAfterSetup    string `yaml:"execute_after_setup"`
	ExecuteBeforeDestroy string `yaml:"execute_before_destroy"`
}

type ContainerServiceVolume

type ContainerServiceVolume struct {
	Type string
	Src  string
	Dest string
	User string
	Mode string
}

type DNSSettings

type DNSSettings struct {
	Provider string
}

type DomainExpose

type DomainExpose struct {
	InternalPort            int `yaml:"internal_port"`
	ExternalPort            int `yaml:"external_port"`
	Service                 string
	ProxyWebsocketLocations []string `yaml:"proxy_websocket_locations,omitempty"`
}

type DomainSecurity

type DomainSecurity struct {
	Authentication []DomainSecurityAuthentication `yaml:"authentication,omitempty"`
}

type DomainSecurityAuthentication

type DomainSecurityAuthentication struct {
	Type     string
	Username string
	Password string
}

type Domains

type Domains struct {
	Domain   string
	Expose   []DomainExpose
	Security DomainSecurity `yaml:"security,omitempty"`
	DNS      DNSSettings    `yaml:"dns,omitempty"`
}

type Project

type Project struct {
	Name                    string
	Domains                 []Domains
	Container               Container
	ProjectDefinitionFolder string
}

func LoadProjectDefinition

func LoadProjectDefinition(filepath string) (*Project, error)

func (*Project) GetDirectoryPath

func (project *Project) GetDirectoryPath() string

func (*Project) GetRuntimeDataDirectoryPath

func (project *Project) GetRuntimeDataDirectoryPath() string

type Registries

type Registries struct {
	Username string
	Password string
	Url      string `yaml:"url,omitempty"`
}