Adding Labels, Anotations and Patches (4.3)

Owned by Jenni Wallin
Aug 26, 2024
2 min read

This page explains the Kubernetes labels, annotations and patches that you can add into the following services and objects in your EC Deployment:

  • Execution Context pod

  • HPA used for the auto scaling

  • Ingress

  • Cluster IP

  • Load Balancer

  • NodePort

image-20240214-091400.png
Check boxes for Annotations, Labels and Patches represented under Additional Values.

Adding Annotations

Annotations will allow you to set key/value mappings to your objects and services in your EC Deployment.

For more information regarding the use of annotations, you can refer to the official documentation on Kubernetes at: Annotations

Adding Labels

Labels will allow you to set key/value pairs to your objects and services in your EC Deployment.

For more information regarding the use of labels, you can refer to the official documentation on Kubernetes at: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

Adding Patches

Patches will allow you to update and customize the objects and services in your EC Deployment. Usage Engine supports the following patching strategies:

  1. JSON Patch (RFC6902)

  2. Merge Patch (RFC7386)

  3. Strategic Merge Patch (https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/)

Warning!

It is advisable that you be familiar with patches and how it works before you attempt to patch any Kubernetes objects and services in your EC Deployment. This is because a single mistake may require you to completely remove your EC Deployment and start over from the beginning.

 

Note!

To patch an array, list or a map, you must use the Strategic Merge Patch strategy. Using JSON or Merge Patch strategies will cause the list to be replaced entirely by the value you have defined in the patch.

 

Not all of the API's can be patched. For a comprehensive list of which Kubernetes APIs can be patched or on their patch strategies, you may refer to this documentation: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/

There are a few examples of patches that could be applied to the EC Deployment. They can be found under EC Deployment Patch Examples(4.3).