You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/reference/yaml.md
+21-7
Original file line number
Diff line number
Diff line change
@@ -128,21 +128,35 @@ Or only using nodes running with Windows:
128
128
129
129
#### Function: Labels
130
130
131
-
Labels can be applied through a map which are passed directly to the container scheduler. Labels are also available from the OpenFaaS REST API for querying or grouping functions.
131
+
Labels can be applied through a map which is passed directly to the container scheduler.
132
+
Labels are also available from the OpenFaaS REST API for querying or grouping functions.
132
133
133
-
Example of setting a "topic" for the Kafka event connector:
134
+
Example of using a label to group by user or apply a `canary` label:
134
135
135
136
```yaml
136
137
labels:
137
-
topic: "kafka.payments-received"
138
+
canary: true
139
+
Git-Owner: alexellis
138
140
```
139
141
140
-
You may also want to group functions by user or apply a `canary` label:
142
+
> Important note: When used with a Kubernetes provider, labels support a restricted character set and length.
143
+
*"Valid label values must be 63 characters or less and must be empty or begin and end with an alphanumeric character
144
+
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between."*
145
+
>
146
+
>See [Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)
147
+
for more information
148
+
149
+
#### Function: Annotations
150
+
151
+
Annotations are a collection of meta-data which is stored with the function by the provider.
152
+
Annotations are also available from the OpenFaaS REST API for querying.
153
+
154
+
Example of setting a "topic" for the Kafka event connector:
0 commit comments