@flyteorg/flyteidl 0.24.1 → 0.24.4

package/protos/docs/core/core.rst

@@ -2697,46 +2697,6 @@ Define a set of simple types.
 
 
 
-.. _ref_flyteidl/core/workflow_closure.proto:
-
-flyteidl/core/workflow_closure.proto
-==================================================================
-
-
-
-
-
-.. _ref_flyteidl.core.WorkflowClosure:
-
-WorkflowClosure
-------------------------------------------------------------------
-
-Defines an enclosed package of workflow and tasks it references.
-
-
-
-.. csv-table:: WorkflowClosure type fields
-   :header: "Field", "Type", "Label", "Description"
-   :widths: auto
-
-   "workflow", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "required. Workflow template."
-   "tasks", ":ref:`ref_flyteidl.core.TaskTemplate`", "repeated", "optional. A collection of tasks referenced by the workflow. Only needed if the workflow references tasks."
-
-
-
-
-
- 
-
- 
-
- 
-
- 
-
-
-
-
 .. _ref_flyteidl/core/workflow.proto:
 
 flyteidl/core/workflow.proto
@@ -3057,6 +3017,46 @@ Failure Handling Strategy
 
 
 
+.. _ref_flyteidl/core/workflow_closure.proto:
+
+flyteidl/core/workflow_closure.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.core.WorkflowClosure:
+
+WorkflowClosure
+------------------------------------------------------------------
+
+Defines an enclosed package of workflow and tasks it references.
+
+
+
+.. csv-table:: WorkflowClosure type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "workflow", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "required. Workflow template."
+   "tasks", ":ref:`ref_flyteidl.core.TaskTemplate`", "repeated", "optional. A collection of tasks referenced by the workflow. Only needed if the workflow references tasks."
+
+
+
+
+
+ 
+
+ 
+
+ 
+
+ 
+
+
+
+
 .. _ref_google/protobuf/timestamp.proto:
 
 google/protobuf/timestamp.proto

package/protos/docs/service/service.rst

@@ -201,6 +201,85 @@ RPCs defined in this service must be anonymously accessible.
 
 
 
+.. _ref_flyteidl/service/dataproxy.proto:
+
+flyteidl/service/dataproxy.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.service.CreateUploadLocationRequest:
+
+CreateUploadLocationRequest
+------------------------------------------------------------------
+
+CreateUploadLocationRequest specified request for the CreateUploadLocation API.
+
+
+
+.. csv-table:: CreateUploadLocationRequest type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "project", ":ref:`ref_string`", "", "Project to create the upload location for +required"
+   "domain", ":ref:`ref_string`", "", "Domain to create the upload location for. +required"
+   "suffix", ":ref:`ref_string`", "", "Suffix specifies a desired suffix for the generated location. E.g. `/file.py` or `pre/fix/file.zip`. +optional. By default, the service will generate a random file name."
+   "expires_in", ":ref:`ref_google.protobuf.Duration`", "", "ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this exceeds the platform allowed max. +optional. The default value comes from a global config."
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.CreateUploadLocationResponse:
+
+CreateUploadLocationResponse
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: CreateUploadLocationResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "signed_url", ":ref:`ref_string`", "", "SignedUrl specifies the url to use to upload content to (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)"
+   "native_url", ":ref:`ref_string`", "", "NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
+   "expires_at", ":ref:`ref_google.protobuf.Timestamp`", "", "ExpiresAt defines when will the signed URL expires."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+
+
+.. _ref_flyteidl.service.DataProxy:
+
+DataProxy
+------------------------------------------------------------------
+
+DataProxy defines an RPC Service that allows access to user-data in a controlled manner.
+
+.. csv-table:: DataProxy service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+
+   "CreateUploadLocation", ":ref:`ref_flyteidl.service.CreateUploadLocationRequest`", ":ref:`ref_flyteidl.service.CreateUploadLocationResponse`", "Retrieves user information about the currently logged in user."
+ <!-- end services -->
+
+
+
+
 .. _ref_flyteidl/service/identity.proto:
 
 flyteidl/service/identity.proto

package/protos/flyteidl/admin/cluster_assignment.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package flyteidl.admin;
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
+
+
+// Encapsulates specifications for routing an execution onto a specific cluster.
+message ClusterAssignment {
+  Affinity affinity = 1;
+}
+
+// Defines a set of constraints used to select eligible objects based on labels they possess.
+message Affinity {
+  // Multiples selectors are 'and'-ed together to produce the list of matching, eligible objects.
+  repeated Selector selectors = 1;
+}
+
+// A Selector is a specification for identifying a set of objects with corresponding labels.
+message Selector {
+
+  // The label key.
+  string key = 1;
+
+  // One or more values used to match labels.
+  // For equality (or inequality) requirements, values must contain a single element.
+  // For set-based requirements, values may contain one or more elements.
+  repeated string value = 2;
+
+  // Defines how a label with a corresponding key and value is selected or excluded.
+  enum Operator {
+    EQUALS = 0;
+    NOT_EQUALS = 1;
+    IN = 2;
+    NOT_IN = 3;
+    EXISTS = 4; // A label key with any value
+    
+    // K8s supports more operators, we can consider adding them if necessary
+  }
+  Operator operator = 3;
+}
+

package/protos/flyteidl/admin/execution.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package flyteidl.admin;
 option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 
+import "flyteidl/admin/cluster_assignment.proto";
 import "flyteidl/admin/common.proto";
 import "flyteidl/core/literals.proto";
 import "flyteidl/core/execution.proto";
@@ -285,6 +286,9 @@ message ExecutionSpec {
     // User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.).
     // This should be a prefix like s3://my-bucket/my-data
     RawOutputDataConfig raw_output_data_config = 19;
+
+    // Controls how to select an available cluster on which this execution should run.
+    ClusterAssignment cluster_assignment = 20;
 }
 
 // Request to terminate an in-progress execution.  This action is irreversible.
@@ -356,4 +360,4 @@ message ExecutionStateChangeDetails {
     string principal = 3;
 }
 
-message ExecutionUpdateResponse {}
+message ExecutionUpdateResponse {}

package/protos/flyteidl/admin/matchable_resource.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package flyteidl.admin;
 option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 
+import "flyteidl/admin/cluster_assignment.proto";
 import "flyteidl/core/execution.proto";
 
 // Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes
@@ -28,6 +29,9 @@ enum MatchableResource {
 
   // Adds defaults for customizable workflow-execution specifications and overrides.
   WORKFLOW_EXECUTION_CONFIG = 6;
+
+  // Controls how to select an available cluster on which this execution should run.
+  CLUSTER_ASSIGNMENT = 7;
 }
 
 // Defines a set of overridable task resource attributes set during task registration.
@@ -116,6 +120,8 @@ message MatchingAttributes {
     PluginOverrides plugin_overrides = 6;
 
     WorkflowExecutionConfig workflow_execution_config = 7;
+
+    ClusterAssignment cluster_assignment = 8;
   }
 }
 

package/protos/flyteidl/service/dataproxy.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+package flyteidl.service;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
+
+import "google/api/annotations.proto";
+import "protoc-gen-swagger/options/annotations.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+message CreateUploadLocationResponse {
+  // SignedUrl specifies the url to use to upload content to (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
+  string signed_url = 1;
+
+  // NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
+  string native_url = 2;
+
+  // ExpiresAt defines when will the signed URL expires.
+  google.protobuf.Timestamp expires_at = 3;
+}
+
+// CreateUploadLocationRequest specified request for the CreateUploadLocation API.
+message CreateUploadLocationRequest {
+  // Project to create the upload location for
+  // +required
+  string project = 1;
+
+  // Domain to create the upload location for.
+  // +required
+  string domain = 2;
+
+  // Suffix specifies a desired suffix for the generated location. E.g. `/file.py` or `pre/fix/file.zip`.
+  // +optional. By default, the service will generate a random file name.
+  string suffix = 3;
+
+  // ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this
+  // exceeds the platform allowed max.
+  // +optional. The default value comes from a global config.
+  google.protobuf.Duration expires_in = 4;
+}
+
+// DataProxy defines an RPC Service that allows access to user-data in a controlled manner.
+service DataProxy {
+  // Retrieves user information about the currently logged in user.
+  rpc CreateUploadLocation (CreateUploadLocationRequest) returns (CreateUploadLocationResponse) {
+    option (google.api.http) = {
+      post: "/api/v1/dataproxy/artifact_urn"
+      body: "*"
+    };
+    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
+      description: "Creates a write-only http location that is accessible for tasks at runtime."
+    };
+  }
+}