Merge pull request #34413 from rh-max/srvls-functions-annotations

SRVOCF-303: Add docs on the function annotations feature

Author: abrennan89

_topic_map.yml

@@ -3132,6 +3132,8 @@ Topics:
     File: serverless-functions-eventing
   - Name: Accessing secrets and config maps from Serverless functions
     File: serverless-functions-accessing-secrets-configmaps
+  - Name: Adding annotations to functions
+    File: serverless-functions-annotations
   - Name: Functions development reference guide
     File: serverless-functions-reference-guide
 # Integrations

modules/serverless-functions-adding-annotations.adoc

@@ -0,0 +1,35 @@
+[id="serverless-functions-adding-annotations_{context}"]
+= Adding annotations to a function
+
+.Procedure
+
+. Open the `func.yaml` file for your function.
+
+. For every annotation that you want to add, add the following YAML to the `annotations` section:
++
+[source,yaml]
+----
+name: test
+namespace: ""
+runtime: go
+...
+annotations:
+  <annotation_name>: "<annotation_value>" <1>
+----
+<1> Substitute `<annotation_name>: "<annotation_value>"` with your annotation.
++
+For example, to indicate that a function was authored by Alice, you might include the following annotation:
++
+[source,yaml]
+----
+name: test
+namespace: ""
+runtime: go
+...
+annotations:
+  author: "[email protected]"
+----
+
+. Save the configuration.
+
+The next time you deploy your function to the cluster, the annotations are added to the corresponding Knative service.

serverless/functions/serverless-functions-annotations.adoc

@@ -0,0 +1,19 @@
+include::modules/serverless-document-attributes.adoc[]
+[id="serverless-functions-attributes"]
+= Adding annotations to functions
+include::modules/common-attributes.adoc[]
+:context: serverless-functions-annotations
+
+toc::[]
+
+You can add Kubernetes annotations to a deployed Serverless function by adding them to the `annotations` section in the `func.yaml` configuration file.
+
+[IMPORTANT]
+====
+There are two limitations of the function annotation feature:
+
+* Once a function annotation propagates to the corresponding Knative service on the cluster, it cannot be removed from the service by deleting it from the `func.yaml` file. You can remove the annotation from the Knative service by modifying the YAML file of the service directly, or by using the Developer Console.
+* You cannot set annotations that are set by Knative, for example, the `autoscaling` annotations.
+====
+
+include::modules/serverless-functions-adding-annotations.adoc[leveloffset=+1]