kuberay: Dataflow¶

Controller Watches¶

Kubernetes resources this controller monitors for changes. Each watch triggers reconciliation when the watched resource is created, updated, or deleted.

Type	GVK	Source
For	ray/v1/RayCluster	`ray-operator/controllers/ray/raycluster_controller.go:1526`
For	ray/v1/RayCronJob	`ray-operator/controllers/ray/raycronjob_controller.go:182`
For	ray/v1/RayJob	`ray-operator/controllers/ray/rayjob_controller.go:839`
For	ray/v1/RayService	`ray-operator/controllers/ray/rayservice_controller.go:582`
Owns	/v1/Pod	`ray-operator/controllers/ray/raycluster_controller.go:1531`
Owns	/v1/Secret	`ray-operator/controllers/ray/raycluster_controller.go:1533`
Owns	/v1/Service	`ray-operator/controllers/ray/rayjob_controller.go:841`
Owns	/v1/Service	`ray-operator/controllers/ray/raycluster_controller.go:1532`
Owns	/v1/Service	`ray-operator/controllers/ray/rayservice_controller.go:588`
Owns	batch/v1/Job	`ray-operator/controllers/ray/rayjob_controller.go:842`
Owns	ray/v1/RayCluster	`ray-operator/controllers/ray/rayjob_controller.go:840`
Owns	ray/v1/RayCluster	`ray-operator/controllers/ray/rayservice_controller.go:587`
Owns	ray/v1/RayJob	`ray-operator/controllers/ray/raycronjob_controller.go:183`

Reconciliation Flow¶

How the controller interacts with the Kubernetes API during reconciliation.

sequenceDiagram
    %% Static dataflow for kuberay

    participant KubernetesAPI as Kubernetes API
    participant kuberay_operator as kuberay-operator

    KubernetesAPI->>+kuberay_operator: Watch RayCluster (reconcile)
    KubernetesAPI->>+kuberay_operator: Watch RayCronJob (reconcile)
    KubernetesAPI->>+kuberay_operator: Watch RayJob (reconcile)
    KubernetesAPI->>+kuberay_operator: Watch RayService (reconcile)
    kuberay_operator->>KubernetesAPI: Create/Update Pod
    kuberay_operator->>KubernetesAPI: Create/Update Secret
    kuberay_operator->>KubernetesAPI: Create/Update Service
    kuberay_operator->>KubernetesAPI: Create/Update Service
    kuberay_operator->>KubernetesAPI: Create/Update Service
    kuberay_operator->>KubernetesAPI: Create/Update Job
    kuberay_operator->>KubernetesAPI: Create/Update RayCluster
    kuberay_operator->>KubernetesAPI: Create/Update RayCluster
    kuberay_operator->>KubernetesAPI: Create/Update RayJob

    Note over kuberay_operator: Exposed Services
    Note right of kuberay_operator: kuberay-operator:8080/TCP [monitoring-port]
    Note right of kuberay_operator: webhook-service:443/TCP []

Webhooks¶

Name	Type	Path	Failure Policy	Source
vraycluster.kb.io	validating	/validate-ray-io-v1-raycluster	fail	`ray-operator/pkg/webhooks/v1/raycluster_webhook.go`
vrayjob.kb.io	validating	/validate-ray-io-v1-rayjob	fail	`ray-operator/pkg/webhooks/v1/rayjob_webhook.go`
vrayservice.kb.io	validating	/validate-ray-io-v1-rayservice	fail	`ray-operator/pkg/webhooks/v1/rayservice_webhook.go`

HTTP Endpoints¶

Method	Path	Source
*	/	`experimental/cmd/main.go:111`
GET	/	`historyserver/pkg/historyserver/router.go:102`
GET	/	`historyserver/pkg/historyserver/router.go:64`
GET	/	`historyserver/pkg/historyserver/router.go:55`
GET	/actors	`historyserver/pkg/historyserver/router.go:277`
GET	/actors/{single_actor:*}	`historyserver/pkg/historyserver/router.go:285`
*	/api/v1/namespaces/{namespace}/services/{service}/proxy	`apiserversdk/proxy.go:64`
*	/api/v1/namespaces/{namespace}/services/{service}/proxy/	`apiserversdk/proxy.go:65`
*	/apis/ray.io/v1/	`apiserversdk/proxy.go:46`
GET	/cluster_status	`historyserver/pkg/historyserver/router.go:111`
POST	/events	`historyserver/pkg/collector/eventcollector/eventcollector.go:91`
GET	/grafana_health	`historyserver/pkg/historyserver/router.go:114`
GET	/jobs/	`historyserver/pkg/historyserver/router.go:121`
GET	/jobs/{job_id}	`historyserver/pkg/historyserver/router.go:125`
*	/livez	`historyserver/pkg/historyserver/router.go:262`
GET	/prometheus_health	`historyserver/pkg/historyserver/router.go:117`
*	/readz	`historyserver/pkg/historyserver/router.go:256`
GET	/v0/cluster_metadata	`historyserver/pkg/historyserver/router.go:130`
GET	/v0/logs	`historyserver/pkg/historyserver/router.go:134`
GET	/v0/logs/{media_type}	`historyserver/pkg/historyserver/router.go:140`
GET	/v0/tasks	`historyserver/pkg/historyserver/router.go:163`
GET	/v0/tasks/summarize	`historyserver/pkg/historyserver/router.go:174`
GET	/v0/tasks/timeline	`historyserver/pkg/historyserver/router.go:182`
GET	/{namespace}/{name}/{session}	`historyserver/pkg/historyserver/router.go:297`
GET	/{node_id}	`historyserver/pkg/historyserver/router.go:91`
GET	/{subpath:*}	`historyserver/pkg/historyserver/router.go:191`
*	GET /api/v1/namespaces/{namespace}/events	`apiserversdk/proxy.go:47`
*	POST /apis/ray.io/v1/namespaces/{namespace}/rayclusters	`apiserversdk/proxy.go:53`
*	POST /apis/ray.io/v1/namespaces/{namespace}/rayjobs	`apiserversdk/proxy.go:55`
*	POST /apis/ray.io/v1/namespaces/{namespace}/rayservices	`apiserversdk/proxy.go:57`
*	PUT /apis/ray.io/v1/namespaces/{namespace}/rayclusters/{name}	`apiserversdk/proxy.go:54`
*	PUT /apis/ray.io/v1/namespaces/{namespace}/rayjobs/{name}	`apiserversdk/proxy.go:56`
*	PUT /apis/ray.io/v1/namespaces/{namespace}/rayservices/{name}	`apiserversdk/proxy.go:58`

Configuration¶

ConfigMaps and Helm values that control this component's runtime behavior.

Helm¶

Chart: kuberay-apiserver v1.1.0