app

Documentation

Overview

Package app implements functionality related to reading and writing app configuration files.

Index

• Constants
• func NameFromContext(ctx context.Context) string
• func WithConfig(ctx context.Context, cfg *Config) context.Context
• func WithName(ctx context.Context, name string) context.Context
• type Build
• type Config
  • func ConfigFromContext(ctx context.Context) *Config
  • func LoadConfig(ctx context.Context, path string, platformVersion string) (cfg *Config, err error)
  • func NewConfig() *Config
  • func (c *Config) DeterminePlatform(ctx context.Context, r io.ReadSeeker) (err error)
  • func (c *Config) DockerBuildTarget() string
  • func (c *Config) Dockerfile() string
  • func (c *Config) EncodeTo(w io.Writer) error
  • func (c *Config) ForMachines() bool
  • func (c *Config) GetEnvVariables() map[string]string
  • func (c *Config) GetPrimaryRegion() string
  • func (ac *Config) HasBuilder() bool
  • func (ac *Config) HasBuiltin() bool
  • func (c *Config) HasDefinition() bool
  • func (c *Config) HasServices() bool
  • func (ac *Config) Image() string
  • func (c *Config) InternalPort() (int, error)
  • func (c *Config) SetDockerCommand(cmd string)
  • func (c *Config) SetDockerEntrypoint(entrypoint string)
  • func (c *Config) SetEnvVariable(name, value string)
  • func (c *Config) SetEnvVariables(vals map[string]string)
  • func (c *Config) SetInternalPort(port int) bool
  • func (c *Config) SetKillSignal(signal string)
  • func (c *Config) SetMachinesPlatform()
  • func (c *Config) SetNomadPlatform()
  • func (c *Config) SetPlatformVersion(platform string)
  • func (c *Config) SetPrimaryRegion(regionCode string)
  • func (c *Config) SetProcess(name, value string)
  • func (c *Config) SetReleaseCommand(cmd string)
  • func (c *Config) SetStatics(statics []sourcecode.Static)
  • func (c *Config) SetVolumes(volumes []sourcecode.Volume)
  • func (c *Config) Validate() (err error)
  • func (c *Config) WriteToDisk() (err error)
  • func (c *Config) WriteToFile(filename string) (err error)
• type HttpService
• type SlimConfig
• type VM

Constants

const (
	// DefaultConfigFileName denotes the default application configuration file name.
	DefaultConfigFileName = "fly.toml"
	// Config is versioned, initially, to separate nomad from machine apps without having to consult
	// the API
	NomadPlatform    = "nomad"
	MachinesPlatform = "machines"
)

Functions

func NameFromContext

func NameFromContext(ctx context.Context) string

NameFromContext returns the app name ctx carries or an empty string.

func WithConfig

func WithConfig(ctx context.Context, cfg *Config) context.Context

WithConfig derives a context that carries cfg from ctx.

func WithName

func WithName(ctx context.Context, name string) context.Context

WithName derives a context that carries the given app name from ctx.

Types

type Build

type Build struct {
	Builder    string
	Args       map[string]string
	Buildpacks []string
	// Or...
	Builtin  string
	Settings map[string]interface{}
	// Or...
	Image string
	// Or...
	Dockerfile        string
	DockerBuildTarget string
}

type Config

type Config struct {
	AppName     string                 `toml:"app,omitempty"`
	Build       *Build                 `toml:"build,omitempty"`
	HttpService *HttpService           `toml:"http_service,omitempty"`
	VM          *VM                    `toml:"vm,omitempty"`
	Definition  map[string]interface{} `toml:"definition,omitempty"`
	Path        string                 `toml:"path,omitempty"`
	Services    []api.MachineService   `toml:"services"`
	Env         map[string]string      `toml:"env" json:"env"`
	Metrics     *api.MachineMetrics    `toml:"metrics" json:"metrics"`
	// contains filtered or unexported fields
}

Config wraps the properties of app configuration.

func ConfigFromContext

func ConfigFromContext(ctx context.Context) *Config

ConfigFromContext returns the Config ctx carries.

func LoadConfig

func LoadConfig(ctx context.Context, path string, platformVersion string) (cfg *Config, err error)

LoadConfig loads the app config at the given path.

func NewConfig

func NewConfig() *Config

func (*Config) DeterminePlatform

func (c *Config) DeterminePlatform(ctx context.Context, r io.ReadSeeker) (err error)

func (*Config) DockerBuildTarget

func (c *Config) DockerBuildTarget() string

func (*Config) Dockerfile

func (c *Config) Dockerfile() string

func (*Config) EncodeTo

func (c *Config) EncodeTo(w io.Writer) error

func (*Config) ForMachines

func (c *Config) ForMachines() bool

ForMachines is true when the config is intended for the machines platform

func (*Config) GetEnvVariables

func (c *Config) GetEnvVariables() map[string]string

func (*Config) GetPrimaryRegion

func (c *Config) GetPrimaryRegion() string

SetPrimaryRegion gets the region to be used for deployment. primaryRegion is private to avoid being marshalled to TOML.

func (*Config) HasBuilder

func (ac *Config) HasBuilder() bool

func (*Config) HasBuiltin

func (ac *Config) HasBuiltin() bool

func (*Config) HasDefinition

func (c *Config) HasDefinition() bool

func (*Config) HasServices

func (c *Config) HasServices() bool

HasServices - Does this config have a services section

func (*Config) Image

func (ac *Config) Image() string

func (*Config) InternalPort

func (c *Config) InternalPort() (int, error)

func (*Config) SetDockerCommand

func (c *Config) SetDockerCommand(cmd string)

func (*Config) SetDockerEntrypoint

func (c *Config) SetDockerEntrypoint(entrypoint string)

func (*Config) SetEnvVariable

func (c *Config) SetEnvVariable(name, value string)

func (*Config) SetEnvVariables

func (c *Config) SetEnvVariables(vals map[string]string)

func (*Config) SetInternalPort

func (c *Config) SetInternalPort(port int) bool

func (*Config) SetKillSignal

func (c *Config) SetKillSignal(signal string)

func (*Config) SetMachinesPlatform

func (c *Config) SetMachinesPlatform()

SetMachinesPlatform informs the TOML marshaller that this config is for the machines platform

func (*Config) SetNomadPlatform

func (c *Config) SetNomadPlatform()

SetNomadPlatform informs the TOML marshaller that this config is for the nomad platform

func (*Config) SetPlatformVersion

func (c *Config) SetPlatformVersion(platform string)

func (*Config) SetPrimaryRegion

func (c *Config) SetPrimaryRegion(regionCode string)

SetPrimaryRegion sets the region to be used for deployment. primaryRegion is private to avoid being marshalled to TOML.

func (*Config) SetProcess

func (c *Config) SetProcess(name, value string)

func (*Config) SetReleaseCommand

func (c *Config) SetReleaseCommand(cmd string)

func (*Config) SetStatics

func (c *Config) SetStatics(statics []sourcecode.Static)

func (*Config) SetVolumes

func (c *Config) SetVolumes(volumes []sourcecode.Volume)

func (*Config) Validate

func (c *Config) Validate() (err error)

func (*Config) WriteToDisk

func (c *Config) WriteToDisk() (err error)

func (*Config) WriteToFile

func (c *Config) WriteToFile(filename string) (err error)

type HttpService

type HttpService struct {
	InternalPort int  `json:"internal_port" toml:"internal_port" validate:"required,numeric"`
	ForceHttps   bool `toml:"force_https"`
}

type SlimConfig

type SlimConfig struct {
	AppName string `toml:"app,omitempty"`
}

Use this type to unmarshal fly.toml with the goal of retreiving the app name only

type VM

type VM struct {
	CpuCount int `toml:"cpu_count,omitempty"`
	Memory   int `toml:"memory,omitempty"`
}