Skip to content

Refactor Kueue module #696

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 1 commit into from
Oct 4, 2024
Merged

Refactor Kueue module #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/codeflare_sdk/common/kueue/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
from .kueue import (
get_default_kueue_name,
local_queue_exists,
add_queue_label,
)
78 changes: 78 additions & 0 deletions src/codeflare_sdk/common/kueue/kueue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Copyright 2024 IBM, Red Hat
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from typing import Optional
from codeflare_sdk.common import _kube_api_error_handling
from codeflare_sdk.common.kubernetes_cluster.auth import config_check, get_api_client
from kubernetes import client
from kubernetes.client.exceptions import ApiException


def get_default_kueue_name(namespace: str):
# If the local queue is set, use it. Otherwise, try to use the default queue.
try:
config_check()
api_instance = client.CustomObjectsApi(get_api_client())
local_queues = api_instance.list_namespaced_custom_object(
group="kueue.x-k8s.io",
version="v1beta1",
namespace=namespace,
plural="localqueues",
)
except ApiException as e: # pragma: no cover
if e.status == 404 or e.status == 403:
return
else:
return _kube_api_error_handling(e)
for lq in local_queues["items"]:
if (
"annotations" in lq["metadata"]
and "kueue.x-k8s.io/default-queue" in lq["metadata"]["annotations"]
and lq["metadata"]["annotations"]["kueue.x-k8s.io/default-queue"].lower()
== "true"
):
return lq["metadata"]["name"]


def local_queue_exists(namespace: str, local_queue_name: str):
# get all local queues in the namespace
try:
config_check()
api_instance = client.CustomObjectsApi(get_api_client())
local_queues = api_instance.list_namespaced_custom_object(
group="kueue.x-k8s.io",
version="v1beta1",
namespace=namespace,
plural="localqueues",
)
except Exception as e: # pragma: no cover
return _kube_api_error_handling(e)
# check if local queue with the name provided in cluster config exists
for lq in local_queues["items"]:
if lq["metadata"]["name"] == local_queue_name:
return True
return False


def add_queue_label(item: dict, namespace: str, local_queue: Optional[str]):
lq_name = local_queue or get_default_kueue_name(namespace)
if lq_name == None:
return
elif not local_queue_exists(namespace, lq_name):
raise ValueError(
"local_queue provided does not exist or is not in this namespace. Please provide the correct local_queue name in Cluster Configuration"
)
if not "labels" in item["metadata"]:
item["metadata"]["labels"] = {}
item["metadata"]["labels"].update({"kueue.x-k8s.io/queue-name": lq_name})
62 changes: 1 addition & 61 deletions src/codeflare_sdk/ray/cluster/generate_yaml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,17 @@
"""

import json
from typing import Optional
import typing
import yaml
import os
import uuid
from kubernetes import client
from ...common import _kube_api_error_handling
from ...common.kueue import add_queue_label
from ...common.kubernetes_cluster.auth import (
get_api_client,
config_check,
)
from kubernetes.client.exceptions import ApiException
import codeflare_sdk


Expand Down Expand Up @@ -229,65 +228,6 @@ def del_from_list_by_name(l: list, target: typing.List[str]) -> list:
return [x for x in l if x["name"] not in target]


def get_default_kueue_name(namespace: str):
# If the local queue is set, use it. Otherwise, try to use the default queue.
try:
config_check()
api_instance = client.CustomObjectsApi(get_api_client())
local_queues = api_instance.list_namespaced_custom_object(
group="kueue.x-k8s.io",
version="v1beta1",
namespace=namespace,
plural="localqueues",
)
except ApiException as e: # pragma: no cover
if e.status == 404 or e.status == 403:
return
else:
return _kube_api_error_handling(e)
for lq in local_queues["items"]:
if (
"annotations" in lq["metadata"]
and "kueue.x-k8s.io/default-queue" in lq["metadata"]["annotations"]
and lq["metadata"]["annotations"]["kueue.x-k8s.io/default-queue"].lower()
== "true"
):
return lq["metadata"]["name"]


def local_queue_exists(namespace: str, local_queue_name: str):
# get all local queues in the namespace
try:
config_check()
api_instance = client.CustomObjectsApi(get_api_client())
local_queues = api_instance.list_namespaced_custom_object(
group="kueue.x-k8s.io",
version="v1beta1",
namespace=namespace,
plural="localqueues",
)
except Exception as e: # pragma: no cover
return _kube_api_error_handling(e)
# check if local queue with the name provided in cluster config exists
for lq in local_queues["items"]:
if lq["metadata"]["name"] == local_queue_name:
return True
return False


def add_queue_label(item: dict, namespace: str, local_queue: Optional[str]):
lq_name = local_queue or get_default_kueue_name(namespace)
if lq_name == None:
return
elif not local_queue_exists(namespace, lq_name):
raise ValueError(
"local_queue provided does not exist or is not in this namespace. Please provide the correct local_queue name in Cluster Configuration"
)
if not "labels" in item["metadata"]:
item["metadata"]["labels"] = {}
item["metadata"]["labels"].update({"kueue.x-k8s.io/queue-name": lq_name})


def augment_labels(item: dict, labels: dict):
if not "labels" in item["metadata"]:
item["metadata"]["labels"] = {}
Expand Down
18 changes: 9 additions & 9 deletions tests/unit_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,7 +968,7 @@ def test_ray_details(mocker, capsys):
return_value="",
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)
cf = Cluster(
Expand Down Expand Up @@ -2007,7 +2007,7 @@ def test_get_cluster_openshift(mocker):
]
mocker.patch("kubernetes.client.ApisApi", return_value=mock_api)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)

Expand Down Expand Up @@ -2042,7 +2042,7 @@ def custom_side_effect(group, version, namespace, plural, **kwargs):
],
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)

Expand Down Expand Up @@ -2085,7 +2085,7 @@ def test_get_cluster(mocker):
return_value=ingress_retrieval(cluster_name="quicktest", client_ing=True),
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)
cluster = get_cluster("quicktest")
Expand Down Expand Up @@ -2123,7 +2123,7 @@ def test_get_cluster_no_mcad(mocker):
return_value=ingress_retrieval(cluster_name="quicktest", client_ing=True),
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)
cluster = get_cluster("quicktest")
Expand Down Expand Up @@ -2359,7 +2359,7 @@ def test_cluster_status(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)
fake_aw = AppWrapper("test", AppWrapperStatus.FAILED)
Expand Down Expand Up @@ -2462,7 +2462,7 @@ def test_wait_ready(mocker, capsys):
"codeflare_sdk.ray.cluster.cluster._ray_cluster_status", return_value=None
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)
mocker.patch.object(
Expand Down Expand Up @@ -2694,11 +2694,11 @@ def test_cluster_throw_for_no_raycluster(mocker: MockerFixture):
return_value="opendatahub",
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.get_default_kueue_name",
"codeflare_sdk.common.kueue.kueue.get_default_kueue_name",
return_value="default",
)
mocker.patch(
"codeflare_sdk.ray.cluster.generate_yaml.local_queue_exists",
"codeflare_sdk.common.kueue.kueue.local_queue_exists",
return_value="true",
)

Expand Down
Loading