Documentation
¶
Index ¶
Constants ¶
View Source
const GroupName = ""
Variables ¶
View Source
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func AddToScheme ¶ added in v1.1.3
Types ¶
type Parameter ¶
type Parameter struct {
// Name must be set and it can be referenced in Template
// Items using ${PARAMETER_NAME}. Required.
Name string `json:"name" description:"name of the parameter"`
// Optional: The name that will show in UI instead of parameter 'Name'
DisplayName string `json:"displayName,omitempty" description:"optional: provides human readable name for the parameter"`
// Description of a parameter. Optional.
Description string `json:"description,omitempty" description:"optional: describes the parameter"`
// 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. Optional.
Value string `` /* 226-byte string literal not displayed */
// 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. Optional.
Generate string `` /* 264-byte string literal not displayed */
// From is an input value for the generator. Optional.
From string `json:"from,omitempty" description:"input value for the generator"`
// Optional: Indicates the parameter must have a value. Defaults to false.
Required bool `json:"required,omitempty" description:"indicates the parameter must have a non-empty value or be generated"`
}
Parameter defines a name/value variable that is to be processed during the Template to Config transformation.
func (Parameter) SwaggerDoc ¶ added in v1.1.4
type Template ¶
type Template struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// Objects is an array of objects to include in this template. Required.
Objects []runtime.RawExtension `json:"objects" description:"list of objects to include in the template"`
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter `json:"parameters,omitempty" description:"optional: list of parameters used during template to config transformation"`
// Labels is a set of labels that are applied to every
// object during the Template to Config transformation. Optional
Labels map[string]string `` /* 140-byte string literal not displayed */
}
Template contains the inputs needed to produce a Config.
func (*Template) GetObjectKind ¶ added in v1.1.3
func (obj *Template) GetObjectKind() unversioned.ObjectKind
func (Template) SwaggerDoc ¶ added in v1.1.4
type TemplateList ¶
type TemplateList struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is a list of templates
Items []Template `json:"items" description:"list of templates"`
}
TemplateList is a list of Template objects.
func (*TemplateList) GetObjectKind ¶ added in v1.1.3
func (obj *TemplateList) GetObjectKind() unversioned.ObjectKind
func (TemplateList) SwaggerDoc ¶ added in v1.1.4
func (TemplateList) SwaggerDoc() map[string]string
Click to show internal directories.
Click to hide internal directories.