Documentation
¶
Overview ¶
Package api defines and registers types for Template objects.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var SchemeGroupVersion = unversioned.GroupVersion{Group: "", Version: ""}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Kind ¶ added in v1.1.2
func Kind(kind string) unversioned.GroupKind
Kind takes an unqualified kind and returns back a Group qualified GroupKind
func Resource ¶ added in v1.1.2
func Resource(resource string) unversioned.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
func TemplateToSelectableFields ¶ added in v1.0.8
func TemplateToSelectableFields(template *Template) fields.Set
TemplateToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc
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
// Optional: The name that will show in UI instead of parameter 'Name'
DisplayName string
// Optional: Parameter can have description
Description string
// Optional: Value holds the Parameter data. If specified, the generator
// will be ignored. The value replaces all occurrences of the Parameter
// ${Name} expression during the Template to Config transformation.
Value string
// 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
// Optional: From is an input value for the generator.
From string
// Optional: Indicates the parameter must have a value. Defaults to false.
Required bool
}
Parameter defines a name/value variable that is to be processed during the Template to Config transformation.
type Template ¶
type Template struct {
unversioned.TypeMeta
kapi.ObjectMeta
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter
// Required: A list of resources to create
Objects []runtime.Object
// Optional: ObjectLabels is a set of labels that are applied to every
// object during the Template to Config transformation
ObjectLabels map[string]string
}
Template contains the inputs needed to produce a Config.
func (*Template) IsAnAPIObject ¶
func (*Template) IsAnAPIObject()
type TemplateList ¶ added in v0.3.2
type TemplateList struct {
unversioned.TypeMeta
unversioned.ListMeta
Items []Template
}
TemplateList is a list of Template objects.
func (*TemplateList) IsAnAPIObject ¶ added in v0.3.2
func (*TemplateList) 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. |