Documentation
¶
Index ¶
- Constants
- Variables
- func AddObjectsToTemplate(template *Template, objects []runtime.Object, ...) error
- func AddToScheme(scheme *runtime.Scheme)
- func DeepCopy_api_Parameter(in Parameter, out *Parameter, c *conversion.Cloner) error
- func DeepCopy_api_Template(in Template, out *Template, c *conversion.Cloner) error
- func DeepCopy_api_TemplateList(in TemplateList, out *TemplateList, c *conversion.Cloner) error
- func Kind(kind string) unversioned.GroupKind
- func Resource(resource string) unversioned.GroupResource
- func TemplateToSelectableFields(template *Template) fields.Set
- type Parameter
- type Template
- type TemplateList
Constants ¶
const GroupName = ""
const (
// TemplateDisplayName is an optional annotation that stores the name displayed by a UI when referencing a template.
TemplateDisplayName = "openshift.io/display-name"
)
These constants represent annotations keys affixed to templates
Variables ¶
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func AddObjectsToTemplate ¶ added in v1.1.4
func AddObjectsToTemplate(template *Template, objects []runtime.Object, targetVersions ...unversioned.GroupVersion) error
AddObjectsToTemplate adds the objects to the template using the target versions to choose the conversion destination
func DeepCopy_api_Parameter ¶ added in v1.3.0
func DeepCopy_api_Parameter(in Parameter, out *Parameter, c *conversion.Cloner) error
func DeepCopy_api_Template ¶ added in v1.3.0
func DeepCopy_api_Template(in Template, out *Template, c *conversion.Cloner) error
func DeepCopy_api_TemplateList ¶ added in v1.3.0
func DeepCopy_api_TemplateList(in TemplateList, out *TemplateList, c *conversion.Cloner) error
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
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
// message is an optional instructional message that will
// be displayed when this template is instantiated.
// This field should inform the user how to utilize the newly created resources.
// Parameter substitution will be performed on the message before being
// displayed so that generated credentials and other parameters can be
// included in the output.
Message string
// parameters is an optional array of Parameters used during the
// Template to Config transformation.
Parameters []Parameter
// objects is an array of resources to include in this template.
Objects []runtime.Object
// objectLabels is an optional 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) GetObjectKind ¶ added in v1.1.4
func (obj *Template) GetObjectKind() unversioned.ObjectKind
type TemplateList ¶
type TemplateList struct {
unversioned.TypeMeta
unversioned.ListMeta
Items []Template
}
TemplateList is a list of Template objects.
func (*TemplateList) GetObjectKind ¶ added in v1.1.4
func (obj *TemplateList) GetObjectKind() unversioned.ObjectKind
Source Files
¶
- deep_copy_generated.go
- fields.go
- helpers.go
- register.go
- types.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
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. |