Add annotations parameter

docs/sphinx/user-docs/cluster-configuration.rst

@@ -26,6 +26,7 @@ requirements for creating the Ray Cluster.
        worker_memory_limits=2, # Default 2
        # image="", # Optional Field
        labels={"exampleLabel": "example", "secondLabel": "example"},
+       annotations={"key1":"value1", "key2":"value2"},
    ))
 
 .. note::

src/codeflare_sdk/common/utils/unit_test_support.py

@@ -442,5 +442,6 @@ def create_cluster_all_config_params(mocker, cluster_name, is_appwrapper) -> Clu
         extended_resource_mapping={"example.com/gpu": "GPU", "intel.com/gpu": "TPU"},
         overwrite_default_resource_mapping=True,
         local_queue="local-queue-default",
+        annotations={"key1": "value1", "key2": "value2"},
     )
     return Cluster(config)

src/codeflare_sdk/ray/cluster/build_ray_cluster.py

@@ -191,7 +191,7 @@ def get_metadata(cluster: "codeflare_sdk.ray.cluster.Cluster"):
     )
 
     # Get the NB annotation if it exists - could be useful in future for a "annotations" parameter.
-    annotations = get_nb_annotations()
+    annotations = with_nb_annotations(cluster.config.annotations)
     if annotations != {}:
         object_meta.annotations = annotations  # As annotations are not a guarantee they are appended to the metadata after creation.
     return object_meta
@@ -213,11 +213,10 @@ def get_labels(cluster: "codeflare_sdk.ray.cluster.Cluster"):
     return labels
 
 
-def get_nb_annotations():
+def with_nb_annotations(annotations: dict):
     """
-    The get_nb_annotations() function generates the annotation for NB Prefix if the SDK is running in a notebook
+    The with_nb_annotations() function generates the annotation for NB Prefix if the SDK is running in a notebook and appends any user set annotations
     """
-    annotations = {}
 
     # Notebook annotation
     nb_prefix = os.environ.get("NB_PREFIX")

src/codeflare_sdk/ray/cluster/config.py

@@ -89,6 +89,8 @@ class ClusterConfiguration:
             A dictionary of custom resource mappings to map extended resource requests to RayCluster resource names
         overwrite_default_resource_mapping:
             A boolean indicating whether to overwrite the default resource mapping.
+        annotations:
+            A dictionary of annotations to apply to the cluster.
     """
 
     name: str
@@ -126,6 +128,7 @@ class ClusterConfiguration:
     extended_resource_mapping: Dict[str, str] = field(default_factory=dict)
     overwrite_default_resource_mapping: bool = False
     local_queue: Optional[str] = None
+    annotations: Dict[str, str] = field(default_factory=dict)
 
     def __post_init__(self):
         if not self.verify_tls:

src/codeflare_sdk/ray/cluster/test_config.py

@@ -93,6 +93,11 @@ def test_config_creation_all_parameters(mocker):
     )
     assert cluster.config.overwrite_default_resource_mapping == True
     assert cluster.config.local_queue == "local-queue-default"
+    assert cluster.config.annotations == {
+        "app.kubernetes.io/managed-by": "test-prefix",
+        "key1": "value1",
+        "key2": "value2",
+    }
 
     assert filecmp.cmp(
         f"{aw_dir}test-all-params.yaml",

tests/test_cluster_yamls/appwrapper/unit-test-all-params.yaml

@@ -13,6 +13,8 @@ spec:
       metadata:
         annotations:
           app.kubernetes.io/managed-by: test-prefix
+          key1: value1
+          key2: value2
         labels:
           controller-tools.k8s.io: '1.0'
           key1: value1

tests/test_cluster_yamls/ray/unit-test-all-params.yaml

@@ -3,6 +3,8 @@ kind: RayCluster
 metadata:
   annotations:
     app.kubernetes.io/managed-by: test-prefix
+    key1: value1
+    key2: value2
   labels:
     controller-tools.k8s.io: '1.0'
     key1: value1