Documentation
¶
Index ¶
- func ReadAndInterpolateRawManifest(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV) ([]byte, error)
- func WriteApplicationManifest(application Application, filePath string) error
- type Application
- type EmptyBuildpacksError
- type GlobalFieldsError
- type InheritanceFieldError
- type InterpolationError
- type InvalidYAMLError
- type Manifest
- type ManifestCreationError
- type UnsupportedFieldsError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadAndInterpolateRawManifest ¶
func ReadAndInterpolateRawManifest(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV) ([]byte, error)
ReadAndInterpolateRawManifest reads the manifest at the provided paths, interpolates variables if a vars file is provided, and returns the Unmarshalled result.
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
Buildpacks []string
Command types.FilteredString
DiskQuota types.NullByteSizeInMb
DockerImage string
DockerPassword string
DockerUsername string
Domain string
DropletPath string
// EnvironmentVariables can be any valid json type (ie, strings not
// guaranteed, although CLI only ships strings).
EnvironmentVariables map[string]string
HealthCheckHTTPEndpoint string
// HealthCheckTimeout attribute defines the number of seconds that is allocated
// for starting an application.
HealthCheckTimeout uint64
// HealthCheckType specifies the mechanism used to determine if the application
// is healthy (e.g., an open port or an HTTP endpoint).
HealthCheckType string
Hostname string
Instances types.NullInt
Memory types.NullByteSizeInMb
Name string
NoHostname bool
NoRoute bool
Path string
RandomRoute bool
Routes []string
RoutePath string
Services []string
StackName string
DeprecatedDomain interface{}
DeprecatedDomains interface{}
DeprecatedHost interface{}
DeprecatedHosts interface{}
DeprecatedNoHostname interface{}
}
func ReadAndInterpolateManifest ¶
func ReadAndInterpolateManifest(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV) ([]Application, error)
ReadAndInterpolateManifest reads the manifest at the provided paths, interpolates variables if a vars file is provided, 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 EmptyBuildpacksError ¶
type EmptyBuildpacksError struct{}
func (EmptyBuildpacksError) Error ¶
func (EmptyBuildpacksError) Error() string
type GlobalFieldsError ¶
type GlobalFieldsError struct {
Fields []string
}
func (GlobalFieldsError) Error ¶
func (e GlobalFieldsError) Error() string
type InheritanceFieldError ¶
type InheritanceFieldError struct{}
func (InheritanceFieldError) Error ¶
func (InheritanceFieldError) Error() string
type InterpolationError ¶
type InterpolationError struct {
Err error
}
func (InterpolationError) Error ¶
func (e InterpolationError) Error() string
type InvalidYAMLError ¶
type InvalidYAMLError struct {
Err error
}
func (InvalidYAMLError) Error ¶
func (e InvalidYAMLError) Error() string
type Manifest ¶
type Manifest struct {
Applications []Application `yaml:"applications"`
}
func (*Manifest) UnmarshalYAML ¶
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
Click to show internal directories.
Click to hide internal directories.