ray-分散式計算框架-叢集與非同步Job管理

0. ray 簡介

ray是開源分散式計算框架，為並行處理提供計算層，用於擴充套件AI與Python應用程式，是ML工作負載統一工具包

• Ray AI Runtime

ML應用程式庫集

• Ray Core

通用分散式計算庫

• Task -- Ray允許任意Python函式在單獨的Python worker上執行，這些非同步Python函式稱為任務
• Actor -- 從函式擴充套件到類，是一個有狀態的工作者，當一個Actor被建立，一個新的worker被建立，並且actor的方法被安排到那個特定的worker上，並且可以訪問和修改那個worker的狀態
• Object -- Task與Actor在物件上建立與計算，被稱為遠端物件，被儲存在ray的分散式共享記憶體物件儲存上，透過物件引用來引用遠端物件。叢集中每個節點都有一個物件儲存，遠端物件儲存在何處(一個或多個節點上)與遠端物件引用的持有者無關
• Placement Groups -- 允許使用者跨多個節點原子性的保留資源組，以供後續Task與Actor使用
• Environment Dependencies -- 當Ray在遠端機器上執行Task或Actor時，它們的依賴環境項(Python包、本地檔案、環境變數)必須可供程式碼執行。解決環境依賴的方式有兩種，一種是在叢集啟動前準備好對叢集的依賴，另一種是在ray的執行時環境動態安裝

• Ray cluster

一組連線到公共 Ray 頭節點的工作節點，透過 kubeRay operator管理執行在k8s上的ray叢集

• 關聯連結
  • Ray Doc: https://docs.ray.io/en/latest/ray-overview/index.html
  • Ray Github: https://ray-project.github.io/kuberay/deploy/helm-cluster/
  • Python raycluster 管理API: https://github.com/ray-project/kuberay/tree/master/clients/python-client
  • Ray Job Python SDK Doc: https://docs.ray.io/en/latest/cluster/running-applications/job-submission/jobs-package-ref.html#ray-job-submission-sdk-ref

1. ray 叢集管理

ray版本：2.3.0

• Kind 建立測試k8s叢集

1主3從叢集

# 配置檔案 -- 一主兩從（預設單主），檔名:k8s-3nodes.yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
- role: worker
- role: worker

建立k8s叢集

kind create cluster --config k8s-3nodes.yaml

• KubeRay 部署ray叢集

# helm方式安裝
# 新增Charts倉庫
helm repo add kuberay https://ray-project.github.io/kuberay-helm/

# 安裝default名稱空間
# 安裝 kubeRay operator
# 下載離線的chart包: helm pull kuberay/kuberay-operator --version 0.5.0
# 本地安裝: helm install kuberay-operator 
helm install kuberay-operator kuberay/kuberay-operator --version 0.5.0

# 建立ray示例叢集，若透過sdk管理則跳過
# 下載離線的ray叢集自定義資源：helm pull kuberay/ray-cluster  --version 0.5.0
helm install raycluster kuberay/ray-cluster --version 0.5.0

# 獲取ray叢集對應的CR
kubectl get raycluster

# 查詢pod的狀態
kubectl get pods

# 轉發svc 8265埠到本地8265埠
kubectl port-forward --address 0.0.0.0 svc/raycluster-kuberay-head-svc 8265:8265

# 登入ray head節點，並執行一個job
kubectl exec -it ${RAYCLUSTER_HEAD_POD} -- bash
python -c "import ray; ray.init(); print(ray.cluster_resources())" # (in Ray head Pod)

# 刪除ray叢集
helm uninstall raycluster

# 刪除kubeRay
helm uninstall kuberay-operator

# 查詢helm管理的資源
helm ls --all-namespaces

• Ray 叢集管理

前置要求：

1. 安裝 KubeRay
2. 安裝 k8s sdk: pip install kubernetes
3. 將python_client複製到PYTHONPATH路徑下或者直接安裝python_client, 該庫路徑為:https://github.com/ray-project/kuberay/tree/master/clients/python-client/python_client

from python_client import kuberay_cluster_api
from python_client.utils import kuberay_cluster_utils, kuberay_cluster_builder


def main():
    
    # ray叢集管理的api 獲取叢集列表、建立叢集、更新叢集、刪除叢集
    kuberay_api = kuberay_cluster_api.RayClusterApi()

    # CR 構建器，構建ray叢集對應的字典格式的CR
    cr_builder = kuberay_cluster_builder.ClusterBuilder()

    # CR資源物件操作工具，更新cr資源
    cluster_utils = kuberay_cluster_utils.ClusterUtils()

    # 構建叢集的CR，是一個字典物件，可以修改、刪除、新增額外的屬性
    # 可以指定包含特定環境依賴的人ray映象
    cluster = (
        cr_builder.build_meta(name="new-cluster1", labels={"demo-cluster": "yes"}) # 輸入ray群名稱、名稱空間、資源標籤、ray版本資訊
        .build_head(cpu_requests="0", memory_requests="0")   # ray叢集head資訊： ray映象名稱、對應service型別、cpu memory的requests與limits、ray head啟動引數
        .build_worker(group_name="workers", cpu_requests="0", memory_requests="0") # ray叢集worker資訊: worker組名稱、 ray映象名稱、ray啟動命令、cpu memory的requests與limits、預設副本個數、最大與最小副本個數
        .get_cluster()
    )
    
    # 檢查CR是否構建成功
    if not cr_builder.succeeded:
        print("error building the cluster, aborting...")
        return

    # 建立ray叢集
    kuberay_api.create_ray_cluster(body=cluster)

    # 更新ray叢集CR中的worker副本集合
    cluster_to_patch, succeeded = cluster_utils.update_worker_group_replicas(
        cluster, group_name="workers", max_replicas=4, min_replicas=1, replicas=2
    )

    if succeeded:
        # 更新ray叢集
        kuberay_api.patch_ray_cluster(
            name=cluster_to_patch["metadata"]["name"], ray_patch=cluster_to_patch
        )

    # 在原來的叢集的CR中的工作組新增新的工作組
    cluster_to_patch, succeeded = cluster_utils.duplicate_worker_group(
        cluster, group_name="workers", new_group_name="duplicate-workers"
    )

    if succeeded:
        kuberay_api.patch_ray_cluster(
            name=cluster_to_patch["metadata"]["name"], ray_patch=cluster_to_patch
        )

    # 列出所有建立的叢集
    kube_ray_list = kuberay_api.list_ray_clusters(k8s_namespace="default", label_selector='demo-cluster=yes')
    if "items" in kube_ray_list:
        for cluster in kube_ray_list["items"]:
            print(cluster["metadata"]["name"], cluster["metadata"]["namespace"])

    # 刪除叢集
    if "items" in kube_ray_list:
        for cluster in kube_ray_list["items"]:
            print("deleting raycluster = {}".format(cluster["metadata"]["name"]))
            
            # 透過指定名稱刪除ray叢集
            kuberay_api.delete_ray_cluster(
                name=cluster["metadata"]["name"],
                k8s_namespace=cluster["metadata"]["namespace"],
            )


if __name__ == "__main__":
    main()

2. ray Job 管理

前置: pip install -U "ray[default]"

• 建立一個job任務

# 檔名稱: test_job.py
# python 標準庫
import json
import ray
import sys

# 已經在ray節點安裝的庫
import redis

# 透過job提交時傳遞的模組依賴 runtime_env 配置 py_modules，透過 py_nodules傳遞過來就可以直接在job中匯入
from test_module import test_1
import stk12

# 建立一個連線redeis物件，透過redis作為中轉向job傳遞輸入並獲取job的輸出
redis_cli = redis.Redis(host='192.168.6.205', port=6379,  decode_responses=True)

# 透過redis獲取傳入過來的引數
input_params_value = None
if len(sys.argv) > 1:
    input_params_key = sys.argv[1]
    input_params_value = json.loads(redis_cli.get(input_params_key))


# 執行遠端任務
@ray.remote
def hello_world(value):
    return [v + 100 for v in value]

ray.init()

# 輸出傳遞過來的引數
print("input_params_value:", input_params_value, type(input_params_key))

# 執行遠端函式
result = ray.get(hello_world.remote(input_params_value))

# 獲取輸出key
output_key = input_params_key.split(":")[0] + ":output"

# 將輸出結果放入redis
redis_cli.set(output_key, json.dumps(result))

# 測試傳遞過來的Python依賴庫是否能正常匯入
print(test_1.test_1())
print(stk12.__dir__())

• 建立測試自定義模組

# 模組路徑: test_module/test_1.py
def test_1():
    return "test_1"

• 建立一個job提交物件

import json

from ray.job_submission import JobSubmissionClient, JobStatus
import time
import uuid
import redis

# 上傳un到ray叢集供job使用的模組
import test_module
from agi import stk12

# 建立一個連線redeis物件
redis_cli = redis.Redis(host='192.168.6.205', port=6379,  decode_responses=True)

# 建立一個client，指定遠端ray叢集的head地址
client = JobSubmissionClient("http://127.0.0.1:8265")

# 建立任務的ID
id = uuid.uuid4().hex
input_params_key = f"{id}:input"
input_params_value = [1, 2, 3, 4, 5]

# 將輸入引數存入redis，供遠端函式job使用
redis_cli.set(input_params_key, json.dumps(input_params_value))


# 提交一個ray job 是一個獨立的ray應用程式
job_id = client.submit_job(
    # 執行該job的入口指令碼
    entrypoint=f"python test_job.py {input_params_key}",

    # 將本地檔案上傳到ray叢集
    runtime_env={
        "working_dir": "./",
        "py_modules": [test_module, stk12],
        "env_vars": {"testenv": "test-1"}
    },

    # 自定義任務ID
    submission_id=f"{id}"
)

# 輸出job ID
print("job_id:", job_id)


def wait_until_status(job_id, status_to_wait_for, timeout_seconds=5):
    """輪詢獲取Job的狀態，當完成時獲取任務的的日誌輸出"""
    start = time.time()
    while time.time() - start <= timeout_seconds:
        # 獲取任務的狀態
        status = client.get_job_status(job_id)
        print(f"status: {status}")

        # 檢查任務的狀態
        if status in status_to_wait_for:
            break
        time.sleep(1)


wait_until_status(job_id, {JobStatus.SUCCEEDED, JobStatus.STOPPED, JobStatus.FAILED})

# 輸出job日誌
logs = client.get_job_logs(job_id)
print(logs)

# 輸出從job中獲取的任務
output_key = job_id + ":output"
output_value = redis_cli.get(output_key)
print("output:", output_value)

• job 管理

from ray.job_submission import JobSubmissionClient, JobDetails, JobInfo, JobType, JobStatus
# 建立一個job提交客戶端，如果管理多個ray叢集的Job則切換或者建立多個連線ray head節點的客戶端
job_cli = JobSubmissionClient("http://127.0.0.1:8265")

# Job資訊，對應Job中submission_id屬性
job_id = "b9ad6ff9ada445a29fb54307f1394594"
job_info = job_cli.get_job_info(job_id)

# 獲取提交的所有job
jobs = job_cli.list_jobs()

for job in jobs:

    # 獲取job的狀態
    job_status = job_cli.get_job_status(job.submission_id)
    print(f"job_id: {job.submission_id}, job_status: {job_status}")

    # 輸出job的json格式詳情
    print("job:", job.json())

# 停止Job
job_cli.stop_job(job_id)

# 刪除 job
# job_cli.delete_job(job_id)

# 提交 Job
# job_cli.submit_job()

# 獲取版本資訊
print("version:", job_cli.get_version())

3. 產品場景

• 將週期、耗時任務非同步化

映象檔案打包下載、檔案同步、運維指令碼、資料匯出與同步、映象同步、服務啟停、TATC衛星專案中演算法任務的執行、批次同型別任務的計算(如衛星專案中衛星軌跡的計算)、備份任務

• k8s中每個租戶可以建立與刪除自己的ray叢集例項，線上IDE中將計算型任務交給ray來執行，不消耗IED所在環境的計算資源