manifest1

package

v0.0.0-...-3fc6cc6 Latest Latest Go to latest Published: Apr 21, 2026 License: Apache-2.0 Imports: 29 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/convox/rack

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DockerHostExposedPorts() ([]int, error)
func RunAsync(s Stream, cmd *exec.Cmd, done chan error, opts RunnerOptions)
func UpperName(name string) string
type ArgOptions
type Build
- func (b *Build) Hash() string
- func (b *Build) UnmarshalYAML(unmarshal func(interface{}) error) error
type BuildOptions
type Command
- func (c Command) MarshalYAML() (interface{}, error)
- func (c *Command) UnmarshalYAML(unmarshal func(interface{}) error) error
type Environment
- func (ee Environment) Len() int
- func (ee Environment) Less(i, j int) bool
- func (ee Environment) MarshalYAML() (interface{}, error)
- func (ee Environment) Swap(i, j int)
- func (e *Environment) UnmarshalYAML(unmarshal func(interface{}) error) error
type EnvironmentItem
type Exec
- func (e *Exec) CombinedOutput(cmd *exec.Cmd) ([]byte, error)
- func (e *Exec) Run(s Stream, cmd *exec.Cmd, opts RunnerOptions) error
- func (e *Exec) RunAsync(s Stream, cmd *exec.Cmd, done chan error, opts RunnerOptions)
type ExternalNetwork
type InternalNetwork
type Labels
- func (labels Labels) Shift(shift int) error
- func (l *Labels) UnmarshalYAML(unmarshal func(interface{}) error) error
type Manifest
- func Load(data []byte) (*Manifest, error)
- func LoadFile(path string) (*Manifest, error)
- func (m Manifest) BalancerResourceName(process string) string
- func (m Manifest) Balancers() []ManifestBalancer
- func (m *Manifest) Build(dir, appName string, s Stream, opts BuildOptions) error
- func (m Manifest) EntryNames() []string
- func (m *Manifest) ExternalPorts() []int
- func (m Manifest) GetBalancer(name string) *ManifestBalancer
- func (m Manifest) HasExternalPorts() bool
- func (m Manifest) HasProcesses() bool
- func (m *Manifest) InternalPorts() []int
- func (m Manifest) MarshalYAML() (interface{}, error)
- func (m *Manifest) PortConflicts() ([]int, error)
- func (m *Manifest) Push(template, app, build string, stream Stream) error
- func (m *Manifest) Raw() ([]byte, error)
- func (m *Manifest) Run(dir, app string, opts RunOptions) Run
- func (m Manifest) Service(name string) (*Service, error)
- func (m *Manifest) Shift(shift int) error
- func (m *Manifest) UDPPorts() []int
- func (m Manifest) Validate() []error
type ManifestBalancer
- func (mb ManifestBalancer) DrainingTimeout() (string, error)
- func (mb ManifestBalancer) ExternalPorts() []Port
- func (mb ManifestBalancer) FirstPort() string
- func (mb ManifestBalancer) HealthInterval() (string, error)
- func (mb ManifestBalancer) HealthPath() string
- func (mb ManifestBalancer) HealthPort() string
- func (mb ManifestBalancer) HealthProtocol() string
- func (mb ManifestBalancer) HealthThresholdHealthy() string
- func (mb ManifestBalancer) HealthThresholdUnhealthy() string
- func (mb ManifestBalancer) HealthTimeout() string
- func (mb ManifestBalancer) IdleTimeout() (string, error)
- func (mb ManifestBalancer) InstanceProtocol(p Port) string
- func (mb ManifestBalancer) InternalPorts() []Port
- func (mb ManifestBalancer) ListenerProtocol(p Port) string
- func (mb ManifestBalancer) LoadBalancerName(app string) string
- func (mb ManifestBalancer) PortMappings() []Port
- func (mb ManifestBalancer) Ports() []string
- func (mb ManifestBalancer) ProcessName() string
- func (mb ManifestBalancer) Protocol(p Port) string
- func (mb ManifestBalancer) ProxyProtocol(p Port) bool
- func (mb ManifestBalancer) Randoms() map[string]int
- func (mb ManifestBalancer) ResourceName() string
- func (mb ManifestBalancer) Scheme() string
type Memory
- func (m *Memory) UnmarshalYAML(unmarshal func(interface{}) error) error
type MountableVolume
- func (v MountableVolume) IsSystem() bool
type Network
type Networks
type Output
- func NewOutput(quiet bool) Output
- func (o *Output) Stream(prefix string) Stream
type Port
- func (p Port) MarshalYAML() (interface{}, error)
- func (p Port) String() string
type Ports
- func (pp Ports) HasPublic() bool
- func (pp Ports) Shift(shift int)
- func (pp *Ports) UnmarshalYAML(unmarshal func(interface{}) error) error
type Process
- func NewProcess(app string, s Service, m Manifest) Process
- func (p *Process) GenerateArgs(opts *ArgOptions) ([]string, error)
- func (p *Process) Sync(local, remote string, ignores []string) (*sync.Sync, error)
type Protocol
type Proxy
- func (p *Proxy) Start() error
type Run
- func NewRun(m Manifest, dir, app string, opts RunOptions) Run
- func (r *Run) Start() error
- func (r *Run) Stop()
- func (r *Run) Wait(ctx context.Context) error
type RunOptions
type Runner
type RunnerOptions
type Service
- func (s Service) ContainerPorts() []string
- func (s Service) DefaultParams() string
- func (s Service) DeploymentMaximum() string
- func (s Service) DeploymentMinimum() string
- func (s Service) ExternalPorts() []Port
- func (s Service) ExtraHostsMap() map[string]string
- func (s Service) HasBalancer() bool
- func (s Service) InternalPorts() []Port
- func (s Service) IsAgent() bool
- func (s Service) LabelDefault(label, def string) string
- func (s Service) LabelsByPrefix(prefix string) map[string]string
- func (s Service) MountableVolumes() []MountableVolume
- func (s *Service) NetworkName() string
- func (s Service) ParamName(name string) string
- func (s *Service) Process(app string, m Manifest) Process
- func (s *Service) Proxies(app string) []Proxy
- func (s *Service) Randoms() map[string]int
- func (s Service) RegistryImage(appName, buildId string, outputs map[string]string) string
- func (s *Service) SyncPaths() (map[string]string, error)
- func (s Service) TCPPorts() []Port
- func (s *Service) Tag(appName string) string
- func (s Service) UDPPorts() []Port
- func (s Service) UseSecureEnvironment() bool
type Services
- func (ss Services) Len() int
- func (ss Services) Less(i, j int) bool
- func (ss Services) Swap(i, j int)
type Stream

Constants ¶

This section is empty.

Variables ¶

View Source

var Docker = func(args ...string) *exec.Cmd {
	return exec.Command("docker", args...)
}

View Source

var ManifestRandomPorts = true

View Source

var PrefixColors = []color.Attribute{
	color.FgMagenta,
	color.FgBlue,
	color.FgCyan,
	color.FgYellow,
	color.FgGreen,
}

View Source

var StaticColors = map[string]color.Attribute{
	"convox": color.FgWhite,
	"build":  color.FgWhite,
}

Functions ¶

func DockerHostExposedPorts ¶

func DockerHostExposedPorts() ([]int, error)

func RunAsync ¶

func RunAsync(s Stream, cmd *exec.Cmd, done chan error, opts RunnerOptions)

RunAsync runs a command asynchronously and streams the output

func UpperName ¶

func UpperName(name string) string

Types ¶

type ArgOptions ¶

type ArgOptions struct {
	Command     string
	IgnorePorts bool
	Name        string
}

type Build ¶

type Build struct {
	Context    string            `yaml:"context,omitempty"`
	Dockerfile string            `yaml:"dockerfile,omitempty"`
	Args       map[string]string `yaml:"args,omitempty"`
}

see yaml.go for unmarshallers

func (*Build) Hash ¶

func (b *Build) Hash() string

Hash returns a string suitable for using as a map key

func (*Build) UnmarshalYAML ¶

func (b *Build) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.

type BuildOptions ¶

type BuildOptions struct {
	Cache       bool
	Environment map[string]string
	Service     string
	Verbose     bool
}

type Command ¶

type Command struct {
	String string   `yaml:"-"`
	Array  []string `yaml:"-"`
}

Command represents the command docker will run either in string or array of strings

func (Command) MarshalYAML ¶

func (c Command) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface for the Command type

func (*Command) UnmarshalYAML ¶

func (c *Command) UnmarshalYAML(unmarshal func(interface{}) error) error

type Environment ¶

type Environment []EnvironmentItem

Environment is a service's default environment

func (Environment) Len ¶

func (ee Environment) Len() int

func (Environment) Less ¶

func (ee Environment) Less(i, j int) bool

func (Environment) MarshalYAML ¶

func (ee Environment) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface for the Environment type

func (Environment) Swap ¶

func (ee Environment) Swap(i, j int)

func (*Environment) UnmarshalYAML ¶

func (e *Environment) UnmarshalYAML(unmarshal func(interface{}) error) error

type EnvironmentItem ¶

type EnvironmentItem struct {
	Name   string
	Value  string
	Needed