|
| 1 | +package template |
| 2 | + |
| 3 | +// annotation keys |
| 4 | +const ( |
| 5 | + // IconClassAnnotation is the rss class of an icon representing a template |
| 6 | + IconClassAnnotation = "iconClass" |
| 7 | + |
| 8 | + // ServiceBrokerRoot is the API root of the template service broker. |
| 9 | + ServiceBrokerRoot = "/brokers/template.openshift.io" |
| 10 | + |
| 11 | + // ServiceMetadataIconClass is the key for the template iconClass as returned |
| 12 | + // in the services.metadata map from a service broker catalog response |
| 13 | + ServiceMetadataIconClass = "console.openshift.io/iconClass" |
| 14 | + |
| 15 | + // TemplateUIDIndex is the name of an index on the generated template lister, |
| 16 | + // initialised and used by the template service broker. |
| 17 | + TemplateUIDIndex = "templateuid" |
| 18 | + |
| 19 | + // ExposeAnnotationPrefix indicates that part of an object in a template |
| 20 | + // should be exposed in some way, for example implying that it should be |
| 21 | + // returned by the template service broker in the results of a bind call. |
| 22 | + // The rest of the annotation name following the prefix may be used by the |
| 23 | + // exposer as a key name. The annotation value is a Kubernetes JSONPath |
| 24 | + // template expression which the exposer uses to calculate the exposed |
| 25 | + // value. JSONPath expressions which return multiple and/or complex objects |
| 26 | + // are not permitted (with the exception of []byte, which is permitted). |
| 27 | + // Any []byte values returned are converted to strings. |
| 28 | + ExposeAnnotationPrefix = "template.openshift.io/expose-" |
| 29 | + |
| 30 | + // Base64ExposeAnnotationPrefix is as ExposeAnnotationPrefix, except that |
| 31 | + // any []byte values returned are base64 encoded. |
| 32 | + Base64ExposeAnnotationPrefix = "template.openshift.io/base64-expose-" |
| 33 | + |
| 34 | + // WaitForReadyAnnotation indicates that the TemplateInstance controller |
| 35 | + // should wait for the object to be ready before reporting the template |
| 36 | + // instantiation complete. |
| 37 | + WaitForReadyAnnotation = "template.alpha.openshift.io/wait-for-ready" |
| 38 | + |
| 39 | + // BindableAnnotation indicates whether the template service broker should |
| 40 | + // advertise the template as being bindable (default is true) |
| 41 | + BindableAnnotation = "template.openshift.io/bindable" |
| 42 | + |
| 43 | + // TemplateInstanceFinalizer is used to clean up the objects created by the template instance, |
| 44 | + // when the template instance is deleted. |
| 45 | + TemplateInstanceFinalizer = "template.openshift.io/finalizer" |
| 46 | + |
| 47 | + // TemplateInstanceOwner is a label applied to all objects created from a template instance |
| 48 | + // which contains the uid of the template instance. |
| 49 | + TemplateInstanceOwner = "template.openshift.io/template-instance-owner" |
| 50 | +) |
0 commit comments