manifest

Documentation

Index

• func WriteApplicationManifest(application Application, filePath string) error
• type Application
  • func ReadAndMergeManifests(pathToManifest string) ([]Application, error)
  • func (app Application) MarshalYAML() (interface{}, error)
  • func (app Application) String() string
  • func (app *Application) UnmarshalYAML(unmarshaller func(interface{}) error) error
• type Manifest
  • func (manifest *Manifest) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ManifestCreationError
  • func (e ManifestCreationError) Error() string
• type UnsupportedFieldsError
  • func (e UnsupportedFieldsError) Error() string

Functions

func WriteApplicationManifest

func WriteApplicationManifest(application Application, filePath string) error

WriteApplicationManifest writes the provided application to the given filepath. If the filepath does not exist, it will create it.

Types

type Application

type Application struct {
	Buildpack types.FilteredString
	Command   types.FilteredString
	// DiskQuota is the disk size in megabytes.
	DiskQuota      types.NullByteSizeInMb
	DockerImage    string
	DockerUsername string
	DockerPassword string
	// EnvironmentVariables can be any valid json type (ie, strings not
	// guaranteed, although CLI only ships strings).
	EnvironmentVariables    map[string]string
	HealthCheckHTTPEndpoint string
	// HealthCheckType attribute defines the number of seconds that is allocated
	// for starting an application.
	HealthCheckTimeout int
	HealthCheckType    string
	Instances          types.NullInt
	// Memory is the amount of memory in megabytes.
	Memory    types.NullByteSizeInMb
	Name      string
	NoRoute   bool
	Path      string
	Routes    []string
	Services  []string
	StackName string
}

func ReadAndMergeManifests

func ReadAndMergeManifests(pathToManifest string) ([]Application, error)

ReadAndMergeManifests reads the manifest at provided path and returns a fully merged set of applications.

func (Application) MarshalYAML

func (app Application) MarshalYAML() (interface{}, error)

func (Application) String

func (app Application) String() string

func (*Application) UnmarshalYAML

func (app *Application) UnmarshalYAML(unmarshaller func(interface{}) error) error

type Manifest

type Manifest struct {
	Applications []Application `yaml:"applications"`
}

func (*Manifest) UnmarshalYAML

func (manifest *Manifest) UnmarshalYAML(unmarshal func(interface{}) error) error

type ManifestCreationError

type ManifestCreationError struct {
	Err error
}

func (ManifestCreationError) Error

func (e ManifestCreationError) Error() string

type UnsupportedFieldsError

type UnsupportedFieldsError struct {
}

func (UnsupportedFieldsError) Error

func (e UnsupportedFieldsError) Error() string