This is a cache of https://docs.openshift.com/serverless/1.33/knative-serving/external-ingress-routing/customize-labels-annotations-routes.html. It is a snapshot of the page at 2024-11-24T16:40:54.271+0000.
Customizing lab<strong>e</strong>ls and annotations - <strong>e</strong>xt<strong>e</strong>rnal and Ingr<strong>e</strong>ss routing | S<strong>e</strong>rving | R<strong>e</strong>d Hat Op<strong>e</strong>nShift S<strong>e</strong>rv<strong>e</strong>rl<strong>e</strong>ss 1.33
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
&times;

Customizing labels and annotations

OpenShift Container Platform routes support the use of custom labels and annotations, which you can configure by modifying the metadata spec of a Knative service. Custom labels and annotations are propagated from the service to the Knative route, then to the Knative ingress, and finally to the OpenShift Container Platform route.

Customizing labels and annotations for OpenShift Container Platform routes

Prerequisites

  • You must have the OpenShift Serverless Operator and Knative Serving installed on your OpenShift Container Platform cluster.

  • Install the OpenShift CLI (oc).

Procedure

  1. Create a Knative service that contains the label or annotation that you want to propagate to the OpenShift Container Platform route:

    • To create a service by using YAML:

      example service created by using YAML
      apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: <service_name>
  labels:
    <label_name>: <label_value>
  annotations:
    <annotation_name>: <annotation_value>
...

    • To create a service by using the Knative (kn) CLI, enter:

      example service created by using a kn command
      $ kn service create <service_name> \
  --image=<image> \
  --annotation <annotation_name>=<annotation_value> \
  --label <label_value>=<label_value>

  2. Verify that the OpenShift Container Platform route has been created with the annotation or label that you added by inspecting the output from the following command:

    example command for verification
    $ oc get routes.route.openshift.io \
     -l serving.knative.openshift.io/ingressName=<service_name> \ (1)
     -l serving.knative.openshift.io/ingressNamespace=<service_namespace> \ (2)
     -n knative-serving-ingress -o yaml \
         | grep -e "<label_name>: \"<label_value>\""  -e "<annotation_name>: <annotation_value>" (3)
    1 Use the name of your service.
    2 Use the namespace where your service was created.
    3 Use your values for the label and annotation names and values.