Introduction

Kubernetes annotations are a powerful way to attach arbitrary metadata to Kubernetes objects. Unlike labels, which are used for specifying identifying attributes of objects that are meaningful for the user and Kubernetes, annotations are designed to store non-identifying information, such as build/release IDs and other metadata. Annotations do not constrain the user; almost any kind of information can be attached.

In this article, we will discuss a method to create a patch that adds an annotation to a Kubernetes object.

What Are Annotations?

Annotations are key/value pairs that can be attached to Kubernetes objects. These are not meant to be meaningful to system processes, but instead for external tooling or system integration. This provides flexibility and extensibility for Kubernetes users to enhance their workflows and systems.

Use Cases for Annotations

• Tool Integration: An annotation can be used to store the name of the tool or script that last updated the object.
• Debugging and Monitoring: Storing metadata for debugging, analysis, or monitoring purposes.
• Audit and Compliance Metadata: Attaching compliance-related information, audit results, or certification data.

Creating a Kubernetes Patch

To add an annotation to a Kubernetes resource, you can utilize `kubectl patch`, which allows you to modify Kubernetes objects in a flexible and non-intrusive way. Here we will focus on using JSON patch operations to add annotations.

Prerequisites

• Kubernetes cluster setup.
• `kubectl` configured to communicate with your cluster.

Example: Adding an Annotation

Suppose you have a Deployment resource, and you want to add an annotation to specify the version of the application deployed.

Step-by-step Guide

1. Identify the Kubernetes Object: Retrieve the target object using `kubectl get`.

• JSON Patch: Uses operations like `add`, `remove`, `replace`, and targets specific paths. Suitable for complex modifications.
• Strategic Merge Patch: Commonly used for simpler, field-level modifications, but less suited for deep or complex updates.
• Key Uniqueness: Annotations should use keys that follow the naming convention `mycompany.com/annotation-key` to avoid conflicts.
• Size Constraints: Keep in mind that annotations are stored as part of object metadata and have a size limit.
• Use Meaningful Annotations: Ensure every annotation serves a clear purpose and adds value.