Skip to content

Add notebook annotation to RayCluster #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 11, 2024
Merged

Add notebook annotation to RayCluster #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9554cdb
Add notebook prefix annotation to RayCluster
Ygnas May 30, 2024
9155253
Tests for the annotation prefix to RayCluster
Ygnas Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/codeflare_sdk/utils/generate_yaml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,17 @@ def augment_labels(item: dict, labels: dict):
item["template"]["metadata"]["labels"].update(labels)


def notebook_annotations(item: dict):
nb_prefix = os.environ.get("NB_PREFIX")
if nb_prefix:
if "template" in item:
if not "annotations" in item["template"]["metadata"]:
item["template"]["metadata"]["annotations"] = {}
item["template"]["metadata"]["annotations"].update(
{"app.kubernetes.io/managed-by": nb_prefix}
)


def write_components(
user_yaml: dict,
output_file_name: str,
Expand Down Expand Up @@ -341,6 +352,7 @@ def generate_appwrapper(
)

augment_labels(item, labels)
notebook_annotations(item)

if appwrapper:
add_queue_label(user_yaml, namespace, local_queue)
Expand Down
2 changes: 2 additions & 0 deletions tests/test-case-no-mcad.yamls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
apiVersion: ray.io/v1
kind: RayCluster
metadata:
annotations:
app.kubernetes.io/managed-by: test-prefix
labels:
controller-tools.k8s.io: '1.0'
kueue.x-k8s.io/queue-name: local-queue-default
Expand Down
3 changes: 3 additions & 0 deletions tests/unit_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,8 @@ def test_cluster_creation_no_mcad(mocker):
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
mocker.patch("os.environ.get", return_value="test-prefix")

config = createClusterConfig()
config.name = "unit-test-cluster-ray"
config.write_to_file = True
Expand Down Expand Up @@ -373,6 +375,7 @@ def test_cluster_creation_no_mcad_local_queue(mocker):
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
mocker.patch("os.environ.get", return_value="test-prefix")
config = createClusterConfig()
config.name = "unit-test-cluster-ray"
config.appwrapper = False
Expand Down