Documentation
¶
Index ¶
- type AppNotInManifestError
- type Application
- type ApplicationModel
- type Docker
- type InterpolationError
- type InvalidManifestApplicationPathError
- type InvalidYAMLError
- type Locator
- type Parser
- func (parser Parser) AppNames() []string
- func (parser Parser) Apps() []Application
- func (parser Parser) ContainsManifest() bool
- func (parser Parser) ContainsMultipleApps() bool
- func (parser Parser) ContainsPrivateDockerImages() bool
- func (parser Parser) FullRawManifest() []byte
- func (parser Parser) GetPathToManifest() string
- func (parser *Parser) InterpolateAndParse(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV, ...) error
- func (parser Parser) RawAppManifest(appName string) ([]byte, error)
- func (parser Parser) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppNotInManifestError ¶
type AppNotInManifestError struct {
Name string
}
func (AppNotInManifestError) Error ¶
func (e AppNotInManifestError) Error() string
type Application ¶
type Application struct {
ApplicationModel
FullUnmarshalledApplication map[string]interface{}
}
func (Application) MarshalYAML ¶
func (application Application) MarshalYAML() (interface{}, error)
func (*Application) UnmarshalYAML ¶
func (application *Application) UnmarshalYAML(unmarshal func(v interface{}) error) error
type ApplicationModel ¶
type ApplicationModel struct {
Name string `yaml:"name"`
Docker *Docker `yaml:"docker"`
Path string `yaml:"path"`
NoRoute bool `yaml:"no-route"`
RandomRoute bool `yaml:"random-route"`
}
ApplicationModel can be accessed through the top level Application struct To add a field for the CLI to extract from the manifest, just add it to this struct.
type InterpolationError ¶
type InterpolationError struct {
Err error
}
func (InterpolationError) Error ¶
func (e InterpolationError) Error() string
type InvalidManifestApplicationPathError ¶
type InvalidManifestApplicationPathError struct {
Path string
}
func (InvalidManifestApplicationPathError) Error ¶
func (InvalidManifestApplicationPathError) Error() string
type InvalidYAMLError ¶
type InvalidYAMLError struct {
Err error
}
func (InvalidYAMLError) Error ¶
func (e InvalidYAMLError) Error() string
type Locator ¶
type Locator struct {
FilesToCheckFor []string
}
func NewLocator ¶
func NewLocator() *Locator
type Parser ¶
type Parser struct {
Applications []Application
// contains filtered or unexported fields
}
func (Parser) Apps ¶
func (parser Parser) Apps() []Application
func (Parser) ContainsManifest ¶
func (Parser) ContainsMultipleApps ¶
func (Parser) ContainsPrivateDockerImages ¶
func (Parser) FullRawManifest ¶
func (Parser) GetPathToManifest ¶
func (*Parser) InterpolateAndParse ¶
func (parser *Parser) InterpolateAndParse(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV, appName string) error
InterpolateAndParse reads the manifest at the provided paths, interpolates variables if a vars file is provided, and sets the current manifest to the resulting manifest. For manifests with only 1 application, appName will override the name of the single app defined. For manifests with multiple applications, appName will filter the applications and leave only a single application in the resulting parsed manifest structure.
Source Files
Click to show internal directories.
Click to hide internal directories.