@flyteorg/flyteidl 1.16.0 → 2.0.0-alpha2

package/protos/flyteidl/service/agent.proto

@@ -1,79 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-
-import "google/api/annotations.proto";
-import "flyteidl/admin/agent.proto";
-
-// SyncAgentService defines an RPC Service that allows propeller to send the request to the agent server synchronously.
-service SyncAgentService {
-  // ExecuteTaskSync streams the create request and inputs to the agent service and streams the outputs back.
-  rpc ExecuteTaskSync (stream flyteidl.admin.ExecuteTaskSyncRequest) returns (stream flyteidl.admin.ExecuteTaskSyncResponse){
-    option (google.api.http) = {
-      post: "/api/v1/agent/task/stream"
-      body: "*"
-    };
-  };
-}
-
-// AsyncAgentService defines an RPC Service that allows propeller to send the request to the agent server asynchronously.
-service AsyncAgentService {
-  // CreateTask sends a task create request to the agent service.
-  rpc CreateTask (flyteidl.admin.CreateTaskRequest) returns (flyteidl.admin.CreateTaskResponse){
-    option (google.api.http) = {
-      post: "/api/v1/agent/task"
-      body: "*"
-    };
-  };
-
-  // Get job status.
-  rpc GetTask (flyteidl.admin.GetTaskRequest) returns (flyteidl.admin.GetTaskResponse){
-    option (google.api.http) = {
-      get: "/api/v1/agent/task/{task_category.name}/{task_category.version}/{resource_meta}"
-    };
-  };
-
-  // Delete the task resource.
-  rpc DeleteTask (flyteidl.admin.DeleteTaskRequest) returns (flyteidl.admin.DeleteTaskResponse){
-    option (google.api.http) = {
-      delete: "/api/v1/agent/task_executions/{task_category.name}/{task_category.version}/{resource_meta}"
-    };
-  };
-
-  // GetTaskMetrics returns one or more task execution metrics, if available.
-  //
-  // Errors include
-  //  * OutOfRange if metrics are not available for the specified task time range
-  //  * various other errors
-  rpc GetTaskMetrics(flyteidl.admin.GetTaskMetricsRequest) returns (flyteidl.admin.GetTaskMetricsResponse){
-    option (google.api.http) = {
-      get: "/api/v1/agent/task/metrics/{task_category.name}/{task_category.version}/{resource_meta}"
-    };
-  };
-
-  // GetTaskLogs returns task execution logs, if available.
-  rpc GetTaskLogs(flyteidl.admin.GetTaskLogsRequest) returns (stream flyteidl.admin.GetTaskLogsResponse){
-    option (google.api.http) = {
-      get: "/api/v1/agent/task/logs/{task_category.name}/{task_category.version}/{resource_meta}"
-    };
-  };
-}
-
-// AgentMetadataService defines an RPC service that is also served over HTTP via grpc-gateway.
-// This service allows propeller or users to get the metadata of agents.
-service AgentMetadataService {
-  // Fetch a :ref:`ref_flyteidl.admin.Agent` definition.
-  rpc GetAgent (flyteidl.admin.GetAgentRequest) returns (flyteidl.admin.GetAgentResponse){
-    option (google.api.http) = {
-      get: "/api/v1/agent/{name}"
-    };
-  };
-
-  // Fetch a list of :ref:`ref_flyteidl.admin.Agent` definitions.
-  rpc ListAgents (flyteidl.admin.ListAgentsRequest) returns (flyteidl.admin.ListAgentsResponse){
-    option (google.api.http) = {
-      get: "/api/v1/agents"
-    };
-  };
-}

package/protos/flyteidl/service/auth.proto

@@ -1,94 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-
-import "google/api/annotations.proto";
-import "protoc-gen-openapiv2/options/annotations.proto";
-
-message OAuth2MetadataRequest {}
-
-// OAuth2MetadataResponse defines an RFC-Compliant response for /.well-known/oauth-authorization-server metadata
-// as defined in https://tools.ietf.org/html/rfc8414
-message OAuth2MetadataResponse {
-    // Defines the issuer string in all JWT tokens this server issues. The issuer can be admin itself or an external
-    // issuer.
-    string issuer = 1;
-
-    // URL of the authorization server's authorization endpoint [RFC6749]. This is REQUIRED unless no grant types are
-    // supported that use the authorization endpoint.
-    string authorization_endpoint = 2;
-
-    // URL of the authorization server's token endpoint [RFC6749].
-    string token_endpoint = 3;
-
-    // Array containing a list of the OAuth 2.0 response_type values that this authorization server supports.
-    repeated string response_types_supported = 4;
-
-    // JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this authorization server supports.
-    repeated string scopes_supported = 5;
-
-    // JSON array containing a list of client authentication methods supported by this token endpoint.
-    repeated string token_endpoint_auth_methods_supported = 6;
-
-    // URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the
-    // client uses to validate signatures from the authorization server.
-    string jwks_uri = 7;
-
-    // JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by
-    // this authorization server.
-    repeated string code_challenge_methods_supported = 8;
-
-    // JSON array containing a list of the OAuth 2.0 grant type values that this authorization server supports.
-    repeated string grant_types_supported = 9;
-
-    // URL of the authorization server's device authorization endpoint, as defined in Section 3.1 of [RFC8628]
-    string device_authorization_endpoint = 10;
-}
-
-message PublicClientAuthConfigRequest {}
-
-// FlyteClientResponse encapsulates public information that flyte clients (CLIs... etc.) can use to authenticate users.
-message PublicClientAuthConfigResponse {
-    // client_id to use when initiating OAuth2 authorization requests.
-    string client_id = 1;
-    // redirect uri to use when initiating OAuth2 authorization requests.
-    string redirect_uri = 2;
-    // scopes to request when initiating OAuth2 authorization requests.
-    repeated string scopes = 3;
-    // Authorization Header to use when passing Access Tokens to the server. If not provided, the client should use the
-    // default http `Authorization` header.
-    string authorization_metadata_key = 4;
-    // ServiceHttpEndpoint points to the http endpoint for the backend. If empty, clients can assume the endpoint used
-    // to configure the gRPC connection can be used for the http one respecting the insecure flag to choose between
-    // SSL or no SSL connections.
-    string service_http_endpoint = 5;
-    // audience to use when initiating OAuth2 authorization requests.
-    string audience = 6;
-}
-
-// The following defines an RPC service that is also served over HTTP via grpc-gateway.
-// Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
-// RPCs defined in this service must be anonymously accessible.
-service AuthMetadataService {
-    // Anonymously accessible. Retrieves local or external oauth authorization server metadata.
-    rpc GetOAuth2Metadata (OAuth2MetadataRequest) returns (OAuth2MetadataResponse) {
-        option (google.api.http) = {
-            get: "/.well-known/oauth-authorization-server"
-        };
-        option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-            description: "Retrieves OAuth2 authorization server metadata. This endpoint is anonymously accessible."
-        };
-    }
-
-    // Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization
-    // requests.
-    rpc GetPublicClientConfig (PublicClientAuthConfigRequest) returns (PublicClientAuthConfigResponse) {
-        option (google.api.http) = {
-            get: "/config/v1/flyte_client"
-        };
-        option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-            description: "Retrieves public flyte client info. This endpoint is anonymously accessible."
-        };
-    }
-}

package/protos/flyteidl/service/dataproxy.proto

@@ -1,205 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-
-import "google/api/annotations.proto";
-import "protoc-gen-openapiv2/options/annotations.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/literals.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;
-
-  // Data proxy generates these headers for client, and they have to add these headers to the request when uploading the file.
-  map<string, string> headers = 4;
-}
-
-// CreateUploadLocationRequest specified request for the CreateUploadLocation API.
-// The implementation in data proxy service will create the s3 location with some server side configured prefixes,
-// and then:
-//   - project/domain/(a deterministic str representation of the content_md5)/filename (if present); OR
-//   - project/domain/filename_root (if present)/filename (if present).
-message CreateUploadLocationRequest {
-  // Project to create the upload location for
-  // +required
-  string project = 1;
-
-  // Domain to create the upload location for.
-  // +required
-  string domain = 2;
-
-  // Filename 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 consistent name based on the provided parameters.
-  string filename = 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;
-
-  // ContentMD5 restricts the upload location to the specific MD5 provided. The ContentMD5 will also appear in the
-  // generated path.
-  // +required
-  bytes content_md5 = 5;
-
-  // If present, data proxy will use this string in lieu of the md5 hash in the path. When the filename is also included
-  // this makes the upload location deterministic. The native url will still be prefixed by the upload location prefix
-  // in data proxy config. This option is useful when uploading multiple files.
-  // +optional
-  string filename_root = 6;
-
-  // If true, the data proxy will add content_md5 to the metadata to the signed URL and
-  // it will force clients to add this metadata to the object.
-  // This make sure dataproxy is backward compatible with the old flytekit.
-  bool add_content_md5_metadata = 7;
-
-
-  // Optional, org key applied to the resource.
-  string org = 8;
-}
-
-// CreateDownloadLocationRequest specified request for the CreateDownloadLocation API.
-message CreateDownloadLocationRequest {
-  option deprecated = true;
-  // NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
-  string native_url = 1;
-
-  // 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 = 2;
-}
-
-message CreateDownloadLocationResponse {
-  option deprecated = true;
-  // SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
-  string signed_url = 1;
-  // ExpiresAt defines when will the signed URL expires.
-  google.protobuf.Timestamp expires_at = 2;
-}
-
-// ArtifactType
-enum ArtifactType {
-  // ARTIFACT_TYPE_UNDEFINED is the default, often invalid, value for the enum.
-  ARTIFACT_TYPE_UNDEFINED = 0;
-
-  // ARTIFACT_TYPE_DECK refers to the deck html file optionally generated after a task, a workflow or a launch plan
-  // finishes executing.
-  ARTIFACT_TYPE_DECK = 1;
-}
-
-// CreateDownloadLinkRequest defines the request parameters to create a download link (signed url)
-message CreateDownloadLinkRequest {
-  // ArtifactType of the artifact requested.
-  ArtifactType artifact_type = 1;
-
-  // 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 = 2;
-
-  oneof source {
-    // NodeId is the unique identifier for the node execution. For a task node, this will retrieve the output of the
-    // most recent attempt of the task.
-    core.NodeExecutionIdentifier node_execution_id = 3;
-  }
-}
-
-// CreateDownloadLinkResponse defines the response for the generated links
-message CreateDownloadLinkResponse {
-  // SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
-  repeated string signed_url = 1 [deprecated = true];
-
-  // ExpiresAt defines when will the signed URL expire.
-  google.protobuf.Timestamp expires_at = 2 [deprecated = true];
-
-  // New wrapper object containing the signed urls and expiration time
-  PreSignedURLs pre_signed_urls = 3;
-}
-
-// Wrapper object since the message is shared across this and the GetDataResponse
-message PreSignedURLs {
-  // SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
-  repeated string signed_url = 1;
-
-  // ExpiresAt defines when will the signed URL expire.
-  google.protobuf.Timestamp expires_at = 2;
-}
-
-// General request artifact to retrieve data from a Flyte artifact url.
-message GetDataRequest {
-  // A unique identifier in the form of flyte://<something> that uniquely, for a given Flyte
-  // backend, identifies a Flyte artifact ([i]nput, [o]output, flyte [d]eck, etc.).
-  // e.g. flyte://v1/proj/development/execid/n2/0/i (for 0th task execution attempt input)
-  //      flyte://v1/proj/development/execid/n2/i (for node execution input)
-  //      flyte://v1/proj/development/execid/n2/o/o3 (the o3 output of the second node)
-  string flyte_url = 1;
-}
-
-message GetDataResponse {
-  oneof data {
-    // literal map data will be returned
-    core.LiteralMap literal_map = 1;
-
-    // Flyte deck html will be returned as a signed url users can download
-    PreSignedURLs pre_signed_urls = 2;
-
-    // Single literal will be returned. This is returned when the user/url requests a specific output or input
-    // by name. See the o3 example above.
-    core.Literal literal = 3;
-  }
-}
-
-// DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.
-service DataProxyService {
-  // CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain.
-  rpc CreateUploadLocation (CreateUploadLocationRequest) returns (CreateUploadLocationResponse) {
-    option (google.api.http) = {
-      post: "/api/v1/dataproxy/artifact_urn"
-      body: "*"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Creates a write-only http location that is accessible for tasks at runtime."
-    };
-  }
-
-  // CreateDownloadLocation creates a signed url to download artifacts.
-  rpc CreateDownloadLocation (CreateDownloadLocationRequest) returns (CreateDownloadLocationResponse) {
-    option deprecated = true;
-    option (google.api.http) = {
-      get: "/api/v1/dataproxy/artifact_urn"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Deprecated: Please use CreateDownloadLink instead. Creates a read-only http location that is accessible for tasks at runtime."
-    };
-  }
-
-  // CreateDownloadLocation creates a signed url to download artifacts.
-  rpc CreateDownloadLink (CreateDownloadLinkRequest) returns (CreateDownloadLinkResponse) {
-    option (google.api.http) = {
-      post: "/api/v1/dataproxy/artifact_link"
-      body: "*"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Creates a read-only http location that is accessible for tasks at runtime."
-    };
-  }
-
-  rpc GetData (GetDataRequest) returns (GetDataResponse) {
-    // Takes an address like flyte://v1/proj/development/execid/n2/0/i and return the actual data
-    option (google.api.http) = {
-      get: "/api/v1/data"
-    };
-  }
-}

package/protos/flyteidl/service/external_plugin_service.proto

@@ -1,79 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-import "flyteidl/core/literals.proto";
-import "flyteidl/core/tasks.proto";
-
-// ExternalPluginService defines an RPC Service that allows propeller to send the request to the backend plugin server.
-service ExternalPluginService {
-  // Send a task create request to the backend plugin server.
-  rpc CreateTask (TaskCreateRequest) returns (TaskCreateResponse){option deprecated = true;};
-  // Get job status.
-  rpc GetTask (TaskGetRequest) returns (TaskGetResponse){option deprecated = true;};
-  // Delete the task resource.
-  rpc DeleteTask (TaskDeleteRequest) returns (TaskDeleteResponse){option deprecated = true;};
-}
-
-// The state of the execution is used to control its visibility in the UI/CLI.
-enum State {
-  option deprecated = true;
-  RETRYABLE_FAILURE = 0;
-  PERMANENT_FAILURE = 1;
-  PENDING = 2;
-  RUNNING = 3;
-  SUCCEEDED = 4;
-}
-
-// Represents a request structure to create task.
-message TaskCreateRequest {
-  option deprecated = true;
-  // The inputs required to start the execution. All required inputs must be
-  // included in this map. If not required and not provided, defaults apply.
-  // +optional
-  core.LiteralMap inputs = 1;
-  // Template of the task that encapsulates all the metadata of the task.
-  core.TaskTemplate template = 2;
-  // Prefix for where task output data will be written. (e.g. s3://my-bucket/randomstring)
-  string output_prefix = 3;
-}
-
-// Represents a create response structure.
-message TaskCreateResponse {
-  option deprecated = true;
-  string job_id = 1;
-}
-
-// A message used to fetch a job state from backend plugin server.
-message TaskGetRequest {
-  option deprecated = true;
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1;
-  // The unique id identifying the job.
-  string job_id = 2;
-}
-
-// Response to get an individual task state.
-message TaskGetResponse {
-  option deprecated = true;
-  // The state of the execution is used to control its visibility in the UI/CLI.
-  State state = 1;
-  // The outputs of the execution. It's typically used by sql task. Flyteplugins service will create a
-  // Structured dataset pointing to the query result table.
-  // +optional
-  core.LiteralMap outputs = 2;
-}
-
-// A message used to delete a task.
-message TaskDeleteRequest {
-  option deprecated = true;
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1;
-  // The unique id identifying the job.
-  string job_id = 2;
-}
-
-// Response to delete a task.
-message TaskDeleteResponse {
-  option deprecated = true;
-}

package/protos/flyteidl/service/identity.proto

@@ -1,51 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-
-import "google/api/annotations.proto";
-import "google/protobuf/struct.proto";
-import "protoc-gen-openapiv2/options/annotations.proto";
-
-message UserInfoRequest {}
-
-// See the OpenID Connect spec at https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse for more information.
-message UserInfoResponse {
-  // Locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed
-  // by the Client.
-  string subject = 1;
-
-  // Full name
-  string name = 2;
-
-  // Shorthand name by which the End-User wishes to be referred to
-  string preferred_username = 3;
-
-  // Given name(s) or first name(s)
-  string given_name = 4;
-
-  // Surname(s) or last name(s)
-  string family_name = 5;
-
-  // Preferred e-mail address
-  string email = 6;
-
-  // 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.
-service IdentityService {
-  // Retrieves user information about the currently logged in user.
-  rpc UserInfo (UserInfoRequest) returns (UserInfoResponse) {
-    option (google.api.http) = {
-      get: "/me"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Retrieves authenticated identity info."
-    };
-  }
-}

package/protos/flyteidl/service/signal.proto

@@ -1,55 +0,0 @@
-syntax = "proto3";
-package flyteidl.service;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
-
-import "google/api/annotations.proto";
-import "flyteidl/admin/signal.proto";
-import "protoc-gen-openapiv2/options/annotations.proto";
-
-// SignalService defines an RPC Service that may create, update, and retrieve signal(s).
-service SignalService {
-  // Fetches or creates a :ref:`ref_flyteidl.admin.Signal`.
-  rpc GetOrCreateSignal (flyteidl.admin.SignalGetOrCreateRequest) returns (flyteidl.admin.Signal) {
-    // Purposefully left out an HTTP API for this RPC call. This is meant to idempotently retrieve
-    // a signal, meaning the first call will create the signal and all subsequent calls will
-    // fetch the existing signal. This is only useful during Flyte Workflow execution and therefore
-    // is not exposed to mitigate unintended behavior.
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Retrieve a signal, creating it if it does not exist."
-    };
-  }
-
-  // Fetch a list of :ref:`ref_flyteidl.admin.Signal` definitions.
-  rpc ListSignals (flyteidl.admin.SignalListRequest) returns (flyteidl.admin.SignalList) {
-    option (google.api.http) = {
-      get: "/api/v1/signals/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Fetch existing signal definitions matching the input signal id filters."
-    };
-  }
-
-  // Sets the value on a :ref:`ref_flyteidl.admin.Signal` definition
-  rpc SetSignal (flyteidl.admin.SignalSetRequest) returns (flyteidl.admin.SignalSetResponse) {
-    option (google.api.http) = {
-      post: "/api/v1/signals"
-      body: "*"
-    };
-    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      description: "Set a signal value."
-      responses: {
-        key: "400"
-        value: {
-          description: "Returned for bad request that may have failed validation."
-        }
-      }
-      responses: {
-        key: "409"
-        value: {
-          description: "Returned for a request that references an identical entity that has already been registered."
-        }
-      }
-    };
-  }
-}