Documentation
¶
Overview ¶
Package api defines and registers types for Template objects.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Parameter ¶
type Parameter struct {
// Required: Parameter name must be set and it can be referenced in Template
// Items using ${PARAMETER_NAME}
Name string `json:"name"`
// Optional: Parameter can have description
Description string `json:"description,omitempty"`
// Optional: Generate specifies the generator to be used to generate
// random string from an input value specified by From field. The result
// string is stored into Value field. If empty, no generator is being
// used, leaving the result Value untouched.
Generate string `json:"generate,omitempty"`
// Optional: From is an input value for the generator.
From string `json:"from,omitempty"`
// Optional: Value holds the Parameter data. The Value data can be
// overwritten by the generator. The value replaces all occurances
// of the Parameter ${Name} expression during the Template to Config
// transformation.
Value string `json:"value,omitempty"`
}
Parameter defines a name/value variable that is to be processed during the Template to Config transformation.
type Template ¶
type Template struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// Required: A list of resources that might reference parameters
Items []runtime.Object `json:"items"`
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter `json:"parameters,omitempty"`
}
Template contains the inputs needed to produce a Config.
func (*Template) IsAnAPIObject ¶
func (*Template) IsAnAPIObject()
Directories
¶
Path | Synopsis |
---|---|
Package validation has functions for validating the correctness of Template objects and explaining what is wrong with them when they aren't valid.
|
Package validation has functions for validating the correctness of Template objects and explaining what is wrong with them when they aren't valid. |
Click to show internal directories.
Click to hide internal directories.