Skip to main content

Config

Config is config for 'ray' plugin

Attributes

AttributeTypeDescription
ShutdownAfterJobFinishesboolDetermines whether to delete the Ray cluster once the Ray job succeeds or fails.
TTLSecondsAfterFinishedint32Specifies the Time To Live (TTL) in seconds to clean up the RayCluster, effective only when ShutdownAfterJobFinishes is set to true.
ServiceTypestringDefines the Kubernetes Service Type for the Ray cluster, with valid values being 'ClusterIP', 'NodePort', and 'LoadBalancer'.
IncludeDashboardboolIf set to true, a Ray Dashboard will be started.
DashboardHoststringSpecifies the host to bind the dashboard server to, which can be 'localhost' (127.0.0.1) or '0.0.0.0' (available from all interfaces), defaulting to 'localhost'.
DeprecatedNodeIPAddressstringSpecifies the IP address of the head node, defaulting to the pod IP address; this attribute is deprecated, use DefaultConfig.[HeadNode|WorkerNode].IPAddress instead.
RemoteClusterConfigpluginmachinery.ClusterConfigStores the configuration for a remote Ray cluster.
Logslogs.LogConfigContains the log configuration for Ray jobs.
LogsSidecar*v1.ContainerDefines a sidecar container to be injected into head pods for capturing Ray job logs.
DashboardURLTemplate*tasklog.TemplateLogPluginProvides a template for the URL of the Ray dashboard running on a head node.
Defaults[DefaultConfig](defaultconfig.md?sid=flyteplugins_go_tasks_plugins_k8s_ray_defaultconfig)Contains default configuration settings for Ray jobs.
EnableUsageStatsboolIf true, enables usage statistics for Ray jobs, which are submitted to usage-stats.ray.io as per the Ray documentation.
ServiceAccountstringSpecifies the Kubernetes service account under which the Ray job will run.