Expose entire head pod Service to the user (#1040)

Expose entire head pod Service to the user

Author: architkulkarni

helm-chart/kuberay-operator/crds/ray.io_rayclusters.yaml

@@ -18,6 +18,9 @@ spec:
   autoscalerOptions: {{- toYaml .Values.head.autoscalerOptions | nindent 4 }}
   {{- end }}
   headGroupSpec:
+    {{- if .Values.head.headService }}
+    headService: {{- toYaml .Values.head.headService | nindent 6 }}
+    {{- end }}
     serviceType: {{ .Values.service.type }}
     rayStartParams:
     {{- if and (not .Values.head.rayStartParams) (not .Values.head.initArgs) }}

helm-chart/kuberay-operator/crds/ray.io_rayjobs.yaml

@@ -216,3 +216,6 @@ additionalWorkerGroups:
 service:
   # This is optional, and the default is ClusterIP.
   type: ClusterIP
+  # Optional, for the user to provide any additional fields to the service.
+  # See https://pkg.go.dev/k8s.io/Kubernetes/pkg/api/v1#Service
+  headService: {}

helm-chart/kuberay-operator/crds/ray.io_rayservices.yaml

@@ -29,6 +29,8 @@ type RayClusterSpec struct {
 type HeadGroupSpec struct {
 	// ServiceType is Kubernetes service type of the head service. it will be used by the workers to connect to the head pod
 	ServiceType v1.ServiceType `json:"serviceType,omitempty"`
+	// HeadService is the Kubernetes service of the head pod.
+	HeadService *v1.Service `json:"headService,omitempty"`
 	// EnableIngress indicates whether operator should create ingress object for head service or not.
 	EnableIngress *bool `json:"enableIngress,omitempty"`
 	// HeadGroupSpec.Replicas is deprecated and ignored; there can only be one head pod per Ray cluster.

helm-chart/ray-cluster/templates/raycluster-cluster.yaml

@@ -0,0 +1,53 @@
+# ray-service.custom-head-service.yaml: This sample YAML file demonstrates how to set up a custom head service 
+# for a Ray cluster using the field spec.headGroupSpec.headService. 
+# For examples with more realistic resource configuration, see
+# ray-cluster.complete.large.yaml and
+# ray-cluster.autoscaler.large.yaml.
+apiVersion: ray.io/v1alpha1
+kind: RayCluster
+metadata:
+  labels:
+    controller-tools.k8s.io: "1.0"
+    # An unique identifier for the head node and workers of this cluster.
+  name: raycluster-custom-head-service.yaml
+spec:
+  rayVersion: '2.4.0' # should match the Ray version in the image of the containers
+  # Ray head pod template
+  headGroupSpec:
+    # the following params are used to complete the ray start: ray start --head --block --redis-port=6379 ...
+    rayStartParams:
+      dashboard-host: '0.0.0.0'
+      num-cpus: '1' # can be auto-completed from the limits
+    headService:
+      metadata:
+        name: custom-ray-head-service-name
+        labels:
+          custom-label: custom-ray-head-service-label
+        annotations:
+          custom-annotation: custom-ray-head-service-annotation
+      spec:
+        type: LoadBalancer
+        ports:
+        - port: 12345
+          targetPort: 12345
+          name: custom-ray-head-service-port
+    #pod template
+    template:
+      spec:
+        containers:
+        - name: ray-head
+          image: rayproject/ray:2.4.0
+          resources:
+            limits:
+              cpu: 1
+              memory: 2Gi
+            requests:
+              cpu: 500m
+              memory: 2Gi
+          ports:
+          - containerPort: 6379
+            name: gcs-server
+          - containerPort: 8265 # Ray dashboard
+            name: dashboard
+          - containerPort: 10001
+            name: client