@flyteorg/flyteidl 1.1.7 → 1.1.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "1.1.7",
+  "version": "1.1.10",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/docs/core/core.rst

@@ -645,7 +645,7 @@ Represents the error message from the execution.
 NodeExecution
 ------------------------------------------------------------------
 
-Indicates various phases of Node Execution
+Indicates various phases of Node Execution that only include the time spent to run the nodes/workflows
 
 
 

package/protos/docs/plugins/plugins.rst

@@ -281,6 +281,166 @@ of a hive task's TaskTemplate
 
 
 
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
+
+
+
+
+.. _ref_flyteidl/plugins/ray.proto:
+
+flyteidl/plugins/ray.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.HeadGroupSpec:
+
+HeadGroupSpec
+------------------------------------------------------------------
+
+HeadGroupSpec are the spec for the head pod
+
+
+
+.. csv-table:: HeadGroupSpec type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "ray_start_params", ":ref:`ref_flyteidl.plugins.HeadGroupSpec.RayStartParamsEntry`", "repeated", "Optional. RayStartParams are the params of the start command: address, object-store-memory. Refer to https://docs.ray.io/en/latest/ray-core/package-ref.html#ray-start"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.HeadGroupSpec.RayStartParamsEntry:
+
+HeadGroupSpec.RayStartParamsEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: HeadGroupSpec.RayStartParamsEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.RayCluster:
+
+RayCluster
+------------------------------------------------------------------
+
+Define Ray cluster defines the desired state of RayCluster
+
+
+
+.. csv-table:: RayCluster type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "head_group_spec", ":ref:`ref_flyteidl.plugins.HeadGroupSpec`", "", "HeadGroupSpecs are the spec for the head pod"
+   "worker_group_spec", ":ref:`ref_flyteidl.plugins.WorkerGroupSpec`", "repeated", "WorkerGroupSpecs are the specs for the worker pods"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.RayJob:
+
+RayJob
+------------------------------------------------------------------
+
+RayJobSpec defines the desired state of RayJob
+
+
+
+.. csv-table:: RayJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "ray_cluster", ":ref:`ref_flyteidl.plugins.RayCluster`", "", "RayClusterSpec is the cluster template to run the job"
+   "runtime_env", ":ref:`ref_string`", "", "runtime_env is base64 encoded. Ray runtime environments: https://docs.ray.io/en/latest/ray-core/handling-dependencies.html#runtime-environments"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.WorkerGroupSpec:
+
+WorkerGroupSpec
+------------------------------------------------------------------
+
+WorkerGroupSpec are the specs for the worker pods
+
+
+
+.. csv-table:: WorkerGroupSpec type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "group_name", ":ref:`ref_string`", "", "Required. RayCluster can have multiple worker groups, and it distinguishes them by name"
+   "replicas", ":ref:`ref_int32`", "", "Required. Desired replicas of the worker group. Defaults to 1."
+   "min_replicas", ":ref:`ref_int32`", "", "Optional. Min replicas of the worker group. MinReplicas defaults to 1."
+   "max_replicas", ":ref:`ref_int32`", "", "Optional. Max replicas of the worker group. MaxReplicas defaults to maxInt32"
+   "ray_start_params", ":ref:`ref_flyteidl.plugins.WorkerGroupSpec.RayStartParamsEntry`", "repeated", "Optional. RayStartParams are the params of the start command: address, object-store-memory. Refer to https://docs.ray.io/en/latest/ray-core/package-ref.html#ray-start"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.WorkerGroupSpec.RayStartParamsEntry:
+
+WorkerGroupSpec.RayStartParamsEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: WorkerGroupSpec.RayStartParamsEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+
 ..
    end messages
 

package/protos/flyteidl/core/execution.proto

@@ -22,7 +22,7 @@ message WorkflowExecution {
     }
 }
 
-// Indicates various phases of Node Execution
+// Indicates various phases of Node Execution that only include the time spent to run the nodes/workflows
 message NodeExecution {
     enum Phase {
         UNDEFINED = 0;

package/protos/flyteidl/core/tasks.proto

@@ -137,7 +137,6 @@ message TaskTemplate {
     // to use as required.
     // reserve the field numbers 1 through 15 for very frequently occurring message elements
     map<string, string> config = 16;
-
 }
 
 // ----------------- First class Plugins

package/protos/flyteidl/plugins/ray.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package flyteidl.plugins;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/plugins";
+
+import "google/protobuf/timestamp.proto";
+
+// RayJobSpec defines the desired state of RayJob
+message RayJob {
+  // RayClusterSpec is the cluster template to run the job
+  RayCluster ray_cluster = 1;
+  // runtime_env is base64 encoded.
+  // Ray runtime environments: https://docs.ray.io/en/latest/ray-core/handling-dependencies.html#runtime-environments
+  string runtime_env = 2;
+}
+
+// Define Ray cluster defines the desired state of RayCluster
+message RayCluster {
+  // HeadGroupSpecs are the spec for the head pod
+  HeadGroupSpec head_group_spec = 1;
+  // WorkerGroupSpecs are the specs for the worker pods
+  repeated WorkerGroupSpec worker_group_spec = 2;
+}
+
+// HeadGroupSpec are the spec for the head pod
+message HeadGroupSpec {
+  // Optional. RayStartParams are the params of the start command: address, object-store-memory.
+  // Refer to https://docs.ray.io/en/latest/ray-core/package-ref.html#ray-start
+  map<string, string> ray_start_params = 1;
+}
+
+// WorkerGroupSpec are the specs for the worker pods
+message WorkerGroupSpec {
+  // Required. RayCluster can have multiple worker groups, and it distinguishes them by name
+  string group_name = 1;
+  // Required. Desired replicas of the worker group. Defaults to 1.
+  int32 replicas = 2;
+  // Optional. Min replicas of the worker group. MinReplicas defaults to 1.
+  int32 min_replicas = 3;
+  // Optional. Max replicas of the worker group. MaxReplicas defaults to maxInt32
+  int32 max_replicas = 4;
+  // Optional. RayStartParams are the params of the start command: address, object-store-memory.
+  // Refer to https://docs.ray.io/en/latest/ray-core/package-ref.html#ray-start
+  map<string, string> ray_start_params = 5;
+}