Module codeflare_sdk.cluster.model

The model sub-module defines Enums containing information for Ray cluster states and AppWrapper states, and CodeFlare cluster states, as well as dataclasses to store information for Ray clusters and AppWrappers.

# Copyright 2022 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.

"""
The model sub-module defines Enums containing information for Ray cluster
states and AppWrapper states, and CodeFlare cluster states, as well as
dataclasses to store information for Ray clusters and AppWrappers.
"""

from dataclasses import dataclass
from enum import Enum


class RayClusterStatus(Enum):
    """
    Defines the possible reportable states of a Ray cluster.
    """

    # https://github.com/ray-project/kuberay/blob/master/ray-operator/apis/ray/v1alpha1/raycluster_types.go#L95
    READY = "ready"
    UNHEALTHY = "unhealthy"
    FAILED = "failed"
    UNKNOWN = "unknown"


class AppWrapperStatus(Enum):
    """
    Defines the possible reportable states of an AppWrapper.
    """

    QUEUEING = "queueing"
    PENDING = "pending"
    RUNNING = "running"
    FAILED = "failed"
    DELETED = "deleted"
    COMPLETED = "completed"
    RUNNING_HOLD_COMPLETION = "runningholdcompletion"


class CodeFlareClusterStatus(Enum):
    """
    Defines the possible reportable states of a Codeflare cluster.
    """

    READY = 1
    STARTING = 2
    QUEUED = 3
    QUEUEING = 4
    FAILED = 5
    UNKNOWN = 6


@dataclass
class RayCluster:
    """
    For storing information about a Ray cluster.
    """

    name: str
    status: RayClusterStatus
    head_cpus: int
    head_mem: str
    head_gpu: int
    workers: int
    worker_mem_min: str
    worker_mem_max: str
    worker_cpu: int
    worker_gpu: int
    namespace: str
    dashboard: str


@dataclass
class AppWrapper:
    """
    For storing information about an AppWrapper.
    """

    name: str
    status: AppWrapperStatus
    can_run: bool
    job_state: str

Classes

class AppWrapper (name: str, status: AppWrapperStatus, can_run: bool, job_state: str)

For storing information about an AppWrapper.

Expand source code

class AppWrapper:
    """
    For storing information about an AppWrapper.
    """

    name: str
    status: AppWrapperStatus
    can_run: bool
    job_state: str

Class variables

var can_run : bool

var job_state : str

var name : str

var status : AppWrapperStatus

class AppWrapperStatus (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines the possible reportable states of an AppWrapper.

Expand source code

class AppWrapperStatus(Enum):
    """
    Defines the possible reportable states of an AppWrapper.
    """

    QUEUEING = "queueing"
    PENDING = "pending"
    RUNNING = "running"
    FAILED = "failed"
    DELETED = "deleted"
    COMPLETED = "completed"
    RUNNING_HOLD_COMPLETION = "runningholdcompletion"

Ancestors

• enum.Enum

Class variables

var COMPLETED

var DELETED

var FAILED

var PENDING

var QUEUEING

var RUNNING

var RUNNING_HOLD_COMPLETION

class CodeFlareClusterStatus (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines the possible reportable states of a Codeflare cluster.

Expand source code

class CodeFlareClusterStatus(Enum):
    """
    Defines the possible reportable states of a Codeflare cluster.
    """

    READY = 1
    STARTING = 2
    QUEUED = 3
    QUEUEING = 4
    FAILED = 5
    UNKNOWN = 6

Ancestors

• enum.Enum

Class variables

var FAILED

var QUEUED

var QUEUEING

var READY

var STARTING

var UNKNOWN

class RayCluster (name: str, status: RayClusterStatus, head_cpus: int, head_mem: str, head_gpu: int, workers: int, worker_mem_min: str, worker_mem_max: str, worker_cpu: int, worker_gpu: int, namespace: str, dashboard: str)

For storing information about a Ray cluster.

Expand source code

class RayCluster:
    """
    For storing information about a Ray cluster.
    """

    name: str
    status: RayClusterStatus
    head_cpus: int
    head_mem: str
    head_gpu: int
    workers: int
    worker_mem_min: str
    worker_mem_max: str
    worker_cpu: int
    worker_gpu: int
    namespace: str
    dashboard: str

Class variables

var dashboard : str

var head_cpus : int

var head_gpu : int

var head_mem : str

var name : str

var namespace : str

var status : RayClusterStatus

var worker_cpu : int

var worker_gpu : int

var worker_mem_max : str

var worker_mem_min : str

var workers : int

class RayClusterStatus (value, names=None, *, module=None, qualname=None, type=None, start=1)

Defines the possible reportable states of a Ray cluster.

Expand source code

class RayClusterStatus(Enum):
    """
    Defines the possible reportable states of a Ray cluster.
    """

    # https://github.com/ray-project/kuberay/blob/master/ray-operator/apis/ray/v1alpha1/raycluster_types.go#L95
    READY = "ready"
    UNHEALTHY = "unhealthy"
    FAILED = "failed"
    UNKNOWN = "unknown"

Ancestors

• enum.Enum

Class variables

var FAILED

var READY

var UNHEALTHY

var UNKNOWN