@flyteorg/flyteidl 1.3.1 → 1.3.3

package/gen/pb-js/flyteidl.d.ts

@@ -19160,6 +19160,9 @@ export namespace flyteidl {
 
             /** UserInfoResponse picture */
             picture?: (string|null);
+
+            /** UserInfoResponse additionalClaims */
+            additionalClaims?: (google.protobuf.IStruct|null);
         }
 
         /** Represents a UserInfoResponse. */
@@ -19192,6 +19195,9 @@ export namespace flyteidl {
             /** UserInfoResponse picture. */
             public picture: string;
 
+            /** UserInfoResponse additionalClaims. */
+            public additionalClaims?: (google.protobuf.IStruct|null);
+
             /**
              * Creates a new UserInfoResponse instance using the specified properties.
              * @param [properties] Properties to set

package/gen/pb-js/flyteidl.js

@@ -44528,6 +44528,7 @@
                  * @property {string|null} [familyName] UserInfoResponse familyName
                  * @property {string|null} [email] UserInfoResponse email
                  * @property {string|null} [picture] UserInfoResponse picture
+                 * @property {google.protobuf.IStruct|null} [additionalClaims] UserInfoResponse additionalClaims
                  */
     
                 /**
@@ -44601,6 +44602,14 @@
                  */
                 UserInfoResponse.prototype.picture = "";
     
+                /**
+                 * UserInfoResponse additionalClaims.
+                 * @member {google.protobuf.IStruct|null|undefined} additionalClaims
+                 * @memberof flyteidl.service.UserInfoResponse
+                 * @instance
+                 */
+                UserInfoResponse.prototype.additionalClaims = null;
+    
                 /**
                  * Creates a new UserInfoResponse instance using the specified properties.
                  * @function create
@@ -44639,6 +44648,8 @@
                         writer.uint32(/* id 6, wireType 2 =*/50).string(message.email);
                     if (message.picture != null && message.hasOwnProperty("picture"))
                         writer.uint32(/* id 7, wireType 2 =*/58).string(message.picture);
+                    if (message.additionalClaims != null && message.hasOwnProperty("additionalClaims"))
+                        $root.google.protobuf.Struct.encode(message.additionalClaims, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim();
                     return writer;
                 };
     
@@ -44681,6 +44692,9 @@
                         case 7:
                             message.picture = reader.string();
                             break;
+                        case 8:
+                            message.additionalClaims = $root.google.protobuf.Struct.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -44721,6 +44735,11 @@
                     if (message.picture != null && message.hasOwnProperty("picture"))
                         if (!$util.isString(message.picture))
                             return "picture: string expected";
+                    if (message.additionalClaims != null && message.hasOwnProperty("additionalClaims")) {
+                        var error = $root.google.protobuf.Struct.verify(message.additionalClaims);
+                        if (error)
+                            return "additionalClaims." + error;
+                    }
                     return null;
                 };
     

package/package.json

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

package/protos/docs/plugins/plugins.rst

@@ -38,6 +38,100 @@ will be executed concurrently.
 
 
 
+..
+   end messages
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
+
+
+
+
+.. _ref_flyteidl/plugins/dask.proto:
+
+flyteidl/plugins/dask.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.DaskCluster:
+
+DaskCluster
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: DaskCluster type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "image", ":ref:`ref_string`", "", "Optional image to use for the scheduler as well as the default worker group. If unset, will use the default image."
+   "nWorkers", ":ref:`ref_int32`", "", "Number of workers in the default worker group"
+   "resources", ":ref:`ref_flyteidl.core.Resources`", "", "Resources assigned to the scheduler as well as all pods of the default worker group. As per https://kubernetes.dask.org/en/latest/kubecluster.html?highlight=limit#best-practices it is advised to only set limits. If requests are not explicitly set, the plugin will make sure to set requests==limits. The plugin sets ` --memory-limit` as well as `--nthreads` for the workers according to the limit."
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.DaskJob:
+
+DaskJob
+------------------------------------------------------------------
+
+Custom Proto for Dask Plugin
+
+
+
+.. csv-table:: DaskJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "namespace", ":ref:`ref_string`", "", "Optional namespace to use for the dask pods. If none is given, the namespace of the Flyte task is used"
+   "jobPodSpec", ":ref:`ref_flyteidl.plugins.JobPodSpec`", "", "Spec for the job pod"
+   "cluster", ":ref:`ref_flyteidl.plugins.DaskCluster`", "", "Cluster"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.JobPodSpec:
+
+JobPodSpec
+------------------------------------------------------------------
+
+Specification for the job pod
+
+
+
+.. csv-table:: JobPodSpec type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "image", ":ref:`ref_string`", "", "Optional image to use. If unset, will use the default image."
+   "resources", ":ref:`ref_flyteidl.core.Resources`", "", "Resources assigned to the job pod."
+
+
+
+
+
+
 ..
    end messages
 

package/protos/flyteidl/datacatalog/datacatalog.proto

@@ -203,34 +203,55 @@ message UpdateArtifactResponse {
  * ReservationID message that is composed of several string fields.
  */
 message ReservationID {
+    // The unique ID for the reserved dataset
     DatasetID dataset_id = 1;
+
+    // The specific artifact tag for the reservation
     string tag_name = 2;
 }
 
 // Try to acquire or extend an artifact reservation. If an active reservation exists, retreive that instance.
 message GetOrExtendReservationRequest {
+    // The unique ID for the reservation
     ReservationID reservation_id = 1;
+
+    // The unique ID of the owner for the reservation
     string owner_id = 2;
-    google.protobuf.Duration heartbeat_interval = 3; // Requested reservation extension heartbeat interval
+
+    // Requested reservation extension heartbeat interval
+    google.protobuf.Duration heartbeat_interval = 3;
 }
 
 // A reservation including owner, heartbeat interval, expiration timestamp, and various metadata.
 message Reservation {
+    // The unique ID for the reservation
     ReservationID reservation_id = 1;
+
+    // The unique ID of the owner for the reservation
     string owner_id = 2;
-    google.protobuf.Duration heartbeat_interval = 3; // Recommended heartbeat interval to extend reservation
-    google.protobuf.Timestamp expires_at = 4; // Expiration timestamp of this reservation
+
+    // Recommended heartbeat interval to extend reservation
+    google.protobuf.Duration heartbeat_interval = 3;
+
+    // Expiration timestamp of this reservation
+    google.protobuf.Timestamp expires_at = 4;
+
+    // Free-form metadata associated with the artifact
     Metadata metadata = 6;
 }
 
 // Response including either a newly minted reservation or the existing reservation
 message GetOrExtendReservationResponse {
+    // The reservation to be acquired or extended
     Reservation reservation = 1;
 }
 
 // Request to release reservation
 message ReleaseReservationRequest {
+    // The unique ID for the reservation
     ReservationID reservation_id = 1;
+
+    // The unique ID of the owner for the reservation
     string owner_id = 2;
 }
 

package/protos/flyteidl/plugins/dask.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+import "flyteidl/core/tasks.proto";
+
+package flyteidl.plugins;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/plugins";
+
+
+// Custom Proto for Dask Plugin.
+message DaskJob {
+    // Spec for the scheduler pod.
+    DaskScheduler scheduler = 1; 
+
+    // Spec of the default worker group.
+    DaskWorkerGroup workers = 2;
+}
+
+// Specification for the scheduler pod.
+message DaskScheduler {
+    // Optional image to use. If unset, will use the default image.
+    string image = 1;
+
+    // Resources assigned to the scheduler pod.
+    core.Resources resources = 2;
+}
+
+message DaskWorkerGroup {
+    // Number of workers in the group.
+    uint32 number_of_workers = 1;
+
+    // Optional image to use for the pods of the worker group. If unset, will use the default image.
+    string image = 2;
+    
+    // Resources assigned to the all pods of the worker group.
+    // As per https://kubernetes.dask.org/en/latest/kubecluster.html?highlight=limit#best-practices 
+    // it is advised to only set limits. If requests are not explicitly set, the plugin will make
+    // sure to set requests==limits.
+    // The plugin sets ` --memory-limit` as well as `--nthreads` for the workers according to the limit.
+    core.Resources resources = 3;
+}

package/protos/flyteidl/service/identity.proto

@@ -4,6 +4,7 @@ package flyteidl.service;
 option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
 
 import "google/api/annotations.proto";
+import "google/protobuf/struct.proto";
 // import "protoc-gen-swagger/options/annotations.proto";
 
 message UserInfoRequest {}
@@ -31,6 +32,9 @@ message UserInfoResponse {
 
   // Profile picture URL
   string picture = 7;
+
+  // Additional claims
+  google.protobuf.Struct additional_claims = 8;
 }
 
 // IdentityService defines an RPC Service that interacts with user/app identities.