@flyteorg/flyteidl 1.16.0 → 2.0.0-alpha2

package/protos/flyteidl/admin/agent.proto

@@ -1,309 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/core/literals.proto";
-import "flyteidl/core/tasks.proto";
-import "flyteidl/core/workflow.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/execution.proto";
-import "flyteidl/core/metrics.proto";
-import "flyteidl/core/security.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/struct.proto";
-
-// 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 subset of runtime task execution metadata that are relevant to external plugins.
-message TaskExecutionMetadata {
-  // ID of the task execution
-  
-  core.TaskExecutionIdentifier task_execution_id = 1;
-  // k8s namespace where the task is executed in
-  string namespace = 2;
-  // Labels attached to the task execution
-  map<string, string> labels = 3;
-  // Annotations attached to the task execution
-  map<string, string> annotations = 4;
-  // k8s service account associated with the task execution
-  string k8s_service_account = 5;
-  // Environment variables attached to the task execution
-  map<string, string> environment_variables = 6;
-  // Represents the maximum number of attempts allowed for a task.
-  // If a task fails, it can be retried up to this maximum number of attempts.
-  int32 max_attempts = 7;
-  // Indicates whether the task execution can be interrupted.
-  // If set to true, the task can be stopped before completion.
-  bool interruptible = 8;
-  // Specifies the threshold for failure count at which the interruptible property
-  // will take effect. If the number of consecutive task failures exceeds this threshold,
-  // interruptible behavior will be activated.
-  int32 interruptible_failure_threshold = 9;
-  // Overrides for specific properties of the task node.
-  // These overrides can be used to customize the behavior of the task node.
-  core.TaskNodeOverrides overrides = 10;
-  // Identity of user running this task execution
-  core.Identity identity = 11;
-}
-
-// Represents a request structure to create task.
-message CreateTaskRequest {
-  // 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;
-  // subset of runtime task execution metadata.
-  TaskExecutionMetadata task_execution_metadata = 4;
-}
-
-// Represents a create response structure.
-message CreateTaskResponse {
-  // ResourceMeta is created by the agent. It could be a string (jobId) or a dict (more complex metadata).
-  bytes resource_meta = 1;
-}
-
-message CreateRequestHeader {
-  // Template of the task that encapsulates all the metadata of the task.
-  core.TaskTemplate template = 1;
-  // Prefix for where task output data will be written. (e.g. s3://my-bucket/randomstring)
-  string output_prefix = 2;
-  // subset of runtime task execution metadata.
-  TaskExecutionMetadata task_execution_metadata = 3;
-  // MaxDatasetSizeBytes is the maximum size of the dataset that can be generated by the task.
-  int64 max_dataset_size_bytes = 4;
-}
-
-
-message ExecuteTaskSyncRequest {
-  oneof part {
-    CreateRequestHeader header = 1;
-    core.LiteralMap inputs = 2;
-  }
-}
-
-message ExecuteTaskSyncResponseHeader {
-  Resource resource = 1;
-}
-
-message ExecuteTaskSyncResponse {
-  // Metadata is created by the agent. It could be a string (jobId) or a dict (more complex metadata).
-  // Resource is for synchronous task execution.
-  oneof res {
-    ExecuteTaskSyncResponseHeader header = 1;
-    core.LiteralMap outputs = 2;
-  }
-}
-
-// A message used to fetch a job resource from flyte agent server.
-message GetTaskRequest {
-  reserved 5;
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1 [deprecated = true];
-  // Metadata about the resource to be pass to the agent.
-  bytes resource_meta = 2;
-  // A predefined yet extensible Task type identifier.
-  TaskCategory task_category = 3;
-  // Prefix for where task output data will be written. (e.g. s3://my-bucket/randomstring)
-  string output_prefix = 4;
-}
-
-// Response to get an individual task resource.
-message GetTaskResponse {
-  Resource resource = 1;
-}
-
-message Resource {
-  // DEPRECATED. The state of the execution is used to control its visibility in the UI/CLI.
-  State state = 1 [deprecated = true];
-  // The outputs of the execution. It's typically used by sql task. Agent service will create a
-  // Structured dataset pointing to the query result table.
-  // +optional
-  core.LiteralMap outputs = 2;
-  // A descriptive message for the current state. e.g. waiting for cluster.
-  string message = 3;
-  // log information for the task execution.
-  repeated core.TaskLog log_links = 4;
-  // The phase of the execution is used to determine the phase of the plugin's execution.
-  core.TaskExecution.Phase phase = 5;
-  // Custom data specific to the agent.
-  google.protobuf.Struct custom_info = 6;
-  // The error raised during execution
-  AgentError agent_error = 7;
-}
-
-// A message used to delete a task.
-message DeleteTaskRequest {
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1 [deprecated = true];
-  // Metadata about the resource to be pass to the agent.
-  bytes resource_meta = 2;
-  // A predefined yet extensible Task type identifier.
-  TaskCategory task_category = 3;
-}
-
-// Response to delete a task.
-message DeleteTaskResponse {}
-
-// A message containing the agent metadata.
-message Agent {
-  // Name is the developer-assigned name of the agent.
-  string name = 1;
-  
-  // SupportedTaskTypes are the types of the tasks that the agent can handle.
-  repeated string supported_task_types = 2 [deprecated = true];
-
-  // IsSync indicates whether this agent is a sync agent. Sync agents are expected to return their
-  // results synchronously when called by propeller. Given that sync agents can affect the performance
-  // of the system, it's important to enforce strict timeout policies.
-  // An Async agent, on the other hand, is required to be able to identify jobs by an
-  // identifier and query for job statuses as jobs progress.
-  bool is_sync = 3;
-
-  // Supported_task_categories are the categories of the tasks that the agent can handle.
-  repeated TaskCategory supported_task_categories = 4;
-}
-
-message TaskCategory {
-  // The name of the task type.
-  string name = 1;
-  // The version of the task type.
-  int32 version = 2;
-}
-
-// A request to get an agent.
-message GetAgentRequest {
-  // The name of the agent.
-  string name = 1;
-}
-
-// A response containing an agent.
-message GetAgentResponse {
-  Agent agent = 1;
-}
-
-// A request to list all agents.
-message ListAgentsRequest {}
-
-// A response containing a list of agents.
-message ListAgentsResponse {
-  repeated Agent agents = 1;
-}
-
-// A request to get the metrics from a task execution.
-message GetTaskMetricsRequest {
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1 [deprecated = true];
-  // Metadata is created by the agent. It could be a string (jobId) or a dict (more complex metadata).
-  bytes resource_meta = 2;
-  // The metrics to query. If empty, will return a default set of metrics.
-  // e.g. EXECUTION_METRIC_USED_CPU_AVG or EXECUTION_METRIC_USED_MEMORY_BYTES_AVG
-  repeated string queries = 3;
-  // Start timestamp, inclusive.
-  google.protobuf.Timestamp start_time = 4;
-  // End timestamp, inclusive..
-  google.protobuf.Timestamp end_time = 5;
-  // Query resolution step width in duration format or float number of seconds.
-  google.protobuf.Duration step = 6;
-  // A predefined yet extensible Task type identifier.
-  TaskCategory task_category = 7;
-}
-
-// A response containing a list of metrics for a task execution.
-message GetTaskMetricsResponse {
-  // The execution metric results.
-  repeated core.ExecutionMetricResult results = 1;
-}
-
-// A request to get the log from a task execution.
-message GetTaskLogsRequest {
-  // A predefined yet extensible Task type identifier.
-  string task_type = 1 [deprecated = true];
-  // Metadata is created by the agent. It could be a string (jobId) or a dict (more complex metadata).
-  bytes resource_meta = 2;
-  // Number of lines to return.
-  uint64 lines = 3;
-  // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-  // in a query. If there are no more results, this value will be empty.
-  string token = 4;
-  // A predefined yet extensible Task type identifier.
-  TaskCategory task_category = 5;
-}
-
-message GetTaskLogsResponseHeader {
-  // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-  // in a query. If there are no more results, this value will be empty.
-  string token = 1;
-}
-
-enum LogLineOriginator {
-  // The originator of the log line is unknown.
-  UNKNOWN = 0;
-
-  // The originator of the log line is the user application.
-  USER = 1;
-
-  // The originator of the log line is the system.
-  SYSTEM = 2;
-}
-
-message LogLine {
-  google.protobuf.Timestamp timestamp = 1;
-
-  // Each line is separated by either CRLF, CR or LF, which are included
-  // at the ends of the lines. This lets clients know whether log emitter
-  // wanted to overwrite the previous line (LF) or append a new line (CRLF).
-  string message = 2;
-
-  LogLineOriginator originator = 3;
-}
-
-message GetTaskLogsResponseBody {
-  // The execution log results.
-  repeated string results = 1 [deprecated = true];
-
-  // Each line is separated by either CRLF, CR or LF, which are included
-  // at the ends of the lines. This lets clients know whether log emitter
-  // wanted to overwrite the previous line (LF) or append a new line (CRLF).
-  repeated LogLine structured_lines = 2;
-}
-
-// A response containing the logs for a task execution.
-message GetTaskLogsResponse {
-  oneof part {
-    GetTaskLogsResponseHeader header = 1;
-    GetTaskLogsResponseBody body = 2;
-  }
-}
-
-// Error message to propagate detailed errors from agent executions to the execution
-// engine.
-message AgentError {
-  // A simplified code for errors, so that we can provide a glossary of all possible errors.
-  string code = 1;
-
-  // Defines a generic error type that dictates the behavior of the retry strategy.
-  enum Kind {
-    NON_RECOVERABLE = 0;
-    RECOVERABLE = 1;
-  }
-
-  // An abstract error kind for this error. Defaults to Non_Recoverable if not specified.
-  Kind kind = 3;
-
-  // Defines the origin of the error (system, user, unknown).
-  core.ExecutionError.ErrorKind origin = 4;
-}

package/protos/flyteidl/admin/cluster_assignment.proto

@@ -1,11 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-
-// Encapsulates specifications for routing an execution onto a specific cluster.
-message ClusterAssignment {
-  reserved 1, 2;
-  string cluster_pool_name = 3;
-}

package/protos/flyteidl/admin/common.proto

@@ -1,337 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/core/execution.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/literals.proto";
-import "google/protobuf/timestamp.proto";
-
-// Encapsulation of fields that identifies a Flyte resource.
-// A Flyte resource can be a task, workflow or launch plan.
-// A resource can internally have multiple versions and is uniquely identified
-// by project, domain, and name.
-message NamedEntityIdentifier {
-    // Name of the project the resource belongs to.
-    string project = 1;
-    // Name of the domain the resource belongs to.
-    // A domain can be considered as a subset within a specific project.
-    string domain = 2;
-    // User provided value for the resource.
-    // The combination of project + domain + name uniquely identifies the resource.
-    // +optional - in certain contexts - like 'List API', 'Launch plans'
-    string name = 3;
-
-    // Optional, org key applied to the resource.
-    string org = 4;
-}
-
-// The status of the named entity is used to control its visibility in the UI.
-enum NamedEntityState {
-    reserved 3, 4;
-    // By default, all named entities are considered active and under development.
-    NAMED_ENTITY_ACTIVE = 0;
-
-    // Archived named entities are no longer visible in the UI.
-    NAMED_ENTITY_ARCHIVED = 1;
-
-    // System generated entities that aren't explicitly created or managed by a user.
-    SYSTEM_GENERATED = 2;
-}
-
-// Additional metadata around a named entity.
-message NamedEntityMetadata {
-    // Common description across all versions of the entity
-    // +optional
-    string description = 1;
-
-    // Shared state across all version of the entity
-    // At this point in time, only workflow entities can have their state archived.
-    NamedEntityState state = 2;
-}
-
-// Encapsulates information common to a NamedEntity, a Flyte resource such as a task,
-// workflow or launch plan. A NamedEntity is exclusively identified by its resource type
-// and identifier.
-message NamedEntity {
-    // Resource type of the named entity. One of Task, Workflow or LaunchPlan.
-    flyteidl.core.ResourceType resource_type = 1;
-    NamedEntityIdentifier id = 2;
-
-    // Additional metadata around a named entity.
-    NamedEntityMetadata metadata = 3;
-}
-
-// Specifies sort ordering in a list request.
-message Sort {
-    enum Direction {
-
-        // By default, fields are sorted in descending order.
-        DESCENDING = 0;
-        ASCENDING = 1;
-    }
-    // Indicates an attribute to sort the response values.
-    // +required
-    string key = 1;
-
-    // Indicates the direction to apply sort key for response values.
-    // +optional
-    Direction direction = 2;
-}
-
-// Represents a request structure to list NamedEntityIdentifiers.
-message NamedEntityIdentifierListRequest {
-    // Name of the project that contains the identifiers.
-    // +required
-    string project = 1;
-
-    // Name of the domain the identifiers belongs to within the project.
-    // +required
-    string domain = 2;
-
-    // Indicates the number of resources to be returned.
-    // +required
-    uint32 limit = 3;
-
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token = 4;
-
-    // Specifies how listed entities should be sorted in the response.
-    // +optional
-    Sort sort_by = 5;
-
-    // Indicates a list of filters passed as string.
-    // +optional
-    string filters = 6;
-
-    // Optional, org key applied to the resource.
-    string org = 7;
-}
-
-// Represents a request structure to list NamedEntity objects
-message NamedEntityListRequest {
-    // Resource type of the metadata to query. One of Task, Workflow or LaunchPlan.
-    // +required
-    flyteidl.core.ResourceType resource_type = 1;
-    // Name of the project that contains the identifiers.
-    // +required
-    string project = 2;
-    // Name of the domain the identifiers belongs to within the project.
-    string domain = 3;
-    // Indicates the number of resources to be returned.
-    uint32 limit = 4;
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token = 5;
-
-    // Specifies how listed entities should be sorted in the response.
-    // +optional
-    Sort sort_by = 6;
-
-    // Indicates a list of filters passed as string.
-    // +optional
-    string filters = 7;
-
-    // Optional, org key applied to the resource.
-    string org = 8;
-}
-
-// Represents a list of NamedEntityIdentifiers.
-message NamedEntityIdentifierList {
-    // A list of identifiers.
-    repeated NamedEntityIdentifier entities = 1;
-
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query. If there are no more results, this value will be empty.
-    string token = 2;
-}
-
-// Represents a list of NamedEntityIdentifiers.
-message NamedEntityList {
-    // A list of NamedEntity objects
-    repeated NamedEntity entities = 1;
-
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query. If there are no more results, this value will be empty.
-    string token = 2;
-}
-
-// A request to retrieve the metadata associated with a NamedEntityIdentifier
-message NamedEntityGetRequest {
-    // Resource type of the metadata to get. One of Task, Workflow or LaunchPlan.
-    // +required
-    flyteidl.core.ResourceType resource_type = 1;
-
-    // The identifier for the named entity for which to fetch metadata.
-    // +required
-    NamedEntityIdentifier id = 2;
-}
-
-// Request to set the referenced named entity state to the configured value.
-message NamedEntityUpdateRequest {
-    // Resource type of the metadata to update
-    // +required
-    flyteidl.core.ResourceType resource_type = 1;
-
-    // Identifier of the metadata to update
-    // +required
-    NamedEntityIdentifier id = 2;
-
-    // Metadata object to set as the new value
-    // +required
-    NamedEntityMetadata metadata = 3;
-}
-
-// Purposefully empty, may be populated in the future.
-message NamedEntityUpdateResponse {
-}
-
-// Shared request structure to fetch a single resource.
-// Resources include: Task, Workflow, LaunchPlan
-message ObjectGetRequest {
-    // Indicates a unique version of resource.
-    // +required
-    core.Identifier id = 1;
-}
-
-// Shared request structure to retrieve a list of resources.
-// Resources include: Task, Workflow, LaunchPlan
-message ResourceListRequest {
-    // id represents the unique identifier of the resource.
-    // +required
-    NamedEntityIdentifier id = 1;
-
-    // Indicates the number of resources to be returned.
-    // +required
-    uint32 limit = 2;
-
-    // In the case of multiple pages of results, this server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token = 3;
-
-    // Indicates a list of filters passed as string.
-    // More info on constructing filters : <Link>
-    // +optional
-    string filters = 4;
-
-    // Sort ordering.
-    // +optional
-    Sort sort_by = 5;
-}
-
-// Defines an email notification specification.
-message EmailNotification {
-    // The list of email addresses recipients for this notification.
-    // +required
-    repeated string recipients_email = 1;
-    // The template to use for this notification.
-    // +optional
-    string template = 2;
-}
-
-// Defines a pager duty notification specification.
-message PagerDutyNotification {
-    // Currently, PagerDuty notifications leverage email to trigger a notification.
-    // +required
-    repeated string recipients_email = 1;
-    // The template to use for this notification.
-    // +optional
-    string template = 2;
-}
-
-// Defines a slack notification specification.
-message SlackNotification {
-    // Currently, Slack notifications leverage email to trigger a notification.
-    // +required
-    repeated string recipients_email = 1;
-    // The template to use for this notification.
-    // +optional
-    string template = 2;
-}
-
-// Represents a structure for notifications based on execution status.
-// The notification content is configured within flyte admin but can be templatized.
-// Future iterations could expose configuring notifications with custom content.
-message Notification {
-    // A list of phases to which users can associate the notifications to.
-    // +required
-    repeated core.WorkflowExecution.Phase phases = 1;
-
-    // The type of notification to trigger.
-    // +required
-    oneof type {
-        EmailNotification email = 2;
-        PagerDutyNotification pager_duty = 3;
-        SlackNotification slack = 4;
-    }
-
-}
-
-// Represents a string url and associated metadata used throughout the platform.
-message UrlBlob {
-    option deprecated = true;
-
-    // Actual url value.
-    string url = 1;
-
-    // Represents the size of the file accessible at the above url.
-    int64 bytes = 2;
-}
-
-// Label values to be applied to an execution resource.
-// In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
-// to specify how to merge labels defined at registration and execution time.
-message Labels {
-    // Map of custom labels to be applied to the execution resource.
-    map<string, string> values = 1;
-}
-
-// Annotation values to be applied to an execution resource.
-// In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
-// to specify how to merge annotations defined at registration and execution time.
-message Annotations {
-    // Map of custom annotations to be applied to the execution resource.
-    map<string, string> values = 1;
-}
-
-// Environment variable values to be applied to an execution resource.
-// In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined
-// to specify how to merge environment variables defined at registration and execution time.
-message Envs {
-    // Map of custom environment variables to be applied to the execution resource.
-    repeated flyteidl.core.KeyValuePair values = 1;
-}
-
-// Defines permissions associated with executions created by this launch plan spec.
-// Use either of these roles when they have permissions required by your workflow execution.
-// Deprecated.
-message AuthRole {
-    option deprecated = true;
-
-    // Defines an optional iam role which will be used for tasks run in executions created with this launch plan.
-    string assumable_iam_role = 1;
-
-    // Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan.
-    string kubernetes_service_account = 2;
-}
-
-
-// Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
-// See https://github.com/flyteorg/flyte/issues/211 for more background information.
-message RawOutputDataConfig {
-    // Prefix for where offloaded data from user workflows will be written
-    // e.g. s3://bucket/key or s3://bucket/
-    string output_location_prefix = 1;
-}
-
-// These URLs are returned as part of node and task execution data requests.
-message FlyteURLs {
-    string inputs      = 1;
-    string outputs     = 2;
-    string deck        = 3;
-}