@flyteorg/flyteidl 1.16.0 → 2.0.0-test1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +6 -9
- package/LICENSE +0 -202
- package/NOTICE +0 -4
- package/README.md +0 -14
- package/gen/pb-js/flyteidl.d.ts +0 -28307
- package/gen/pb-js/flyteidl.js +0 -66636
- package/protos/buf.lock +0 -18
- package/protos/buf.yaml +0 -12
- package/protos/docs/admin/admin.rst +0 -4623
- package/protos/docs/admin/index.rst +0 -13
- package/protos/docs/contributing.md +0 -68
- package/protos/docs/core/core.rst +0 -3952
- package/protos/docs/core/index.rst +0 -15
- package/protos/docs/datacatalog/datacatalog.rst +0 -1313
- package/protos/docs/datacatalog/index.rst +0 -16
- package/protos/docs/event/event.rst +0 -726
- package/protos/docs/event/index.rst +0 -27
- package/protos/docs/plugins/index.rst +0 -14
- package/protos/docs/plugins/plugins.rst +0 -780
- package/protos/docs/restructuredtext.tmpl +0 -129
- package/protos/docs/service/index.rst +0 -13
- package/protos/docs/service/service.rst +0 -543
- package/protos/docs/withoutscalar_restructuredtext.tmpl +0 -105
- package/protos/docs_index.rst +0 -19
- package/protos/flyteidl/admin/agent.proto +0 -309
- package/protos/flyteidl/admin/cluster_assignment.proto +0 -11
- package/protos/flyteidl/admin/common.proto +0 -337
- package/protos/flyteidl/admin/description_entity.proto +0 -95
- package/protos/flyteidl/admin/event.proto +0 -70
- package/protos/flyteidl/admin/execution.proto +0 -436
- package/protos/flyteidl/admin/launch_plan.proto +0 -231
- package/protos/flyteidl/admin/matchable_resource.proto +0 -194
- package/protos/flyteidl/admin/node_execution.proto +0 -248
- package/protos/flyteidl/admin/notification.proto +0 -27
- package/protos/flyteidl/admin/project.proto +0 -132
- package/protos/flyteidl/admin/project_attributes.proto +0 -69
- package/protos/flyteidl/admin/project_domain_attributes.proto +0 -80
- package/protos/flyteidl/admin/schedule.proto +0 -43
- package/protos/flyteidl/admin/signal.proto +0 -86
- package/protos/flyteidl/admin/task.proto +0 -71
- package/protos/flyteidl/admin/task_execution.proto +0 -171
- package/protos/flyteidl/admin/version.proto +0 -27
- package/protos/flyteidl/admin/workflow.proto +0 -92
- package/protos/flyteidl/admin/workflow_attributes.proto +0 -89
- package/protos/flyteidl/cacheservice/cacheservice.proto +0 -143
- package/protos/flyteidl/core/artifact_id.proto +0 -112
- package/protos/flyteidl/core/catalog.proto +0 -63
- package/protos/flyteidl/core/compiler.proto +0 -64
- package/protos/flyteidl/core/condition.proto +0 -63
- package/protos/flyteidl/core/dynamic_job.proto +0 -32
- package/protos/flyteidl/core/errors.proto +0 -42
- package/protos/flyteidl/core/execution.proto +0 -156
- package/protos/flyteidl/core/execution_envs.proto +0 -45
- package/protos/flyteidl/core/identifier.proto +0 -80
- package/protos/flyteidl/core/interface.proto +0 -64
- package/protos/flyteidl/core/literals.proto +0 -205
- package/protos/flyteidl/core/metrics.proto +0 -50
- package/protos/flyteidl/core/security.proto +0 -135
- package/protos/flyteidl/core/tasks.proto +0 -392
- package/protos/flyteidl/core/types.proto +0 -208
- package/protos/flyteidl/core/workflow.proto +0 -361
- package/protos/flyteidl/core/workflow_closure.proto +0 -18
- package/protos/flyteidl/datacatalog/datacatalog.proto +0 -420
- package/protos/flyteidl/event/cloudevents.proto +0 -81
- package/protos/flyteidl/event/event.proto +0 -347
- package/protos/flyteidl/plugins/array_job.proto +0 -30
- package/protos/flyteidl/plugins/common.proto +0 -27
- package/protos/flyteidl/plugins/dask.proto +0 -41
- package/protos/flyteidl/plugins/kubeflow/common.proto +0 -28
- package/protos/flyteidl/plugins/kubeflow/mpi.proto +0 -47
- package/protos/flyteidl/plugins/kubeflow/pytorch.proto +0 -53
- package/protos/flyteidl/plugins/kubeflow/tensorflow.proto +0 -46
- package/protos/flyteidl/plugins/mpi.proto +0 -20
- package/protos/flyteidl/plugins/presto.proto +0 -14
- package/protos/flyteidl/plugins/pytorch.proto +0 -25
- package/protos/flyteidl/plugins/qubole.proto +0 -26
- package/protos/flyteidl/plugins/ray.proto +0 -59
- package/protos/flyteidl/plugins/spark.proto +0 -42
- package/protos/flyteidl/plugins/tensorflow.proto +0 -18
- package/protos/flyteidl/plugins/waitable.proto +0 -15
- package/protos/flyteidl/service/admin.proto +0 -668
- package/protos/flyteidl/service/agent.proto +0 -79
- package/protos/flyteidl/service/auth.proto +0 -94
- package/protos/flyteidl/service/dataproxy.proto +0 -205
- package/protos/flyteidl/service/external_plugin_service.proto +0 -79
- package/protos/flyteidl/service/identity.proto +0 -51
- package/protos/flyteidl/service/signal.proto +0 -55
|
@@ -1,231 +0,0 @@
|
|
|
1
|
-
syntax = "proto3";
|
|
2
|
-
|
|
3
|
-
package flyteidl.admin;
|
|
4
|
-
option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
|
|
5
|
-
|
|
6
|
-
import "flyteidl/core/execution.proto";
|
|
7
|
-
import "flyteidl/core/execution_envs.proto";
|
|
8
|
-
import "flyteidl/core/literals.proto";
|
|
9
|
-
import "flyteidl/core/identifier.proto";
|
|
10
|
-
import "flyteidl/core/interface.proto";
|
|
11
|
-
import "flyteidl/core/security.proto";
|
|
12
|
-
import "flyteidl/admin/schedule.proto";
|
|
13
|
-
import "flyteidl/admin/cluster_assignment.proto";
|
|
14
|
-
import "flyteidl/admin/common.proto";
|
|
15
|
-
import "google/protobuf/any.proto";
|
|
16
|
-
import "google/protobuf/timestamp.proto";
|
|
17
|
-
import "google/protobuf/wrappers.proto";
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
// Request to register a launch plan. The included LaunchPlanSpec may have a complete or incomplete set of inputs required
|
|
21
|
-
// to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to
|
|
22
|
-
// set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have successfully created a launch plan.
|
|
23
|
-
message LaunchPlanCreateRequest {
|
|
24
|
-
// Uniquely identifies a launch plan entity.
|
|
25
|
-
core.Identifier id = 1;
|
|
26
|
-
|
|
27
|
-
// User-provided launch plan details, including reference workflow, inputs and other metadata.
|
|
28
|
-
LaunchPlanSpec spec = 2;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
message LaunchPlanCreateResponse {
|
|
32
|
-
// Purposefully empty, may be populated in the future.
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
// By default any launch plan regardless of state can be used to launch a workflow execution.
|
|
36
|
-
// However, at most one version of a launch plan
|
|
37
|
-
// (e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be
|
|
38
|
-
// active at a time in regards to *schedules*. That is, at most one schedule in a NamedEntityIdentifier
|
|
39
|
-
// group will be observed and trigger executions at a defined cadence.
|
|
40
|
-
enum LaunchPlanState {
|
|
41
|
-
INACTIVE = 0;
|
|
42
|
-
ACTIVE = 1;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
// A LaunchPlan provides the capability to templatize workflow executions.
|
|
46
|
-
// Launch plans simplify associating one or more schedules, inputs and notifications with your workflows.
|
|
47
|
-
// Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow
|
|
48
|
-
// definition doesn't necessarily have a default value for said input.
|
|
49
|
-
message LaunchPlan {
|
|
50
|
-
// Uniquely identifies a launch plan entity.
|
|
51
|
-
core.Identifier id = 1;
|
|
52
|
-
|
|
53
|
-
// User-provided launch plan details, including reference workflow, inputs and other metadata.
|
|
54
|
-
LaunchPlanSpec spec = 2;
|
|
55
|
-
|
|
56
|
-
// Values computed by the flyte platform after launch plan registration.
|
|
57
|
-
LaunchPlanClosure closure = 3;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
// Response object for list launch plan requests.
|
|
61
|
-
// See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
|
|
62
|
-
message LaunchPlanList {
|
|
63
|
-
repeated LaunchPlan launch_plans = 1;
|
|
64
|
-
|
|
65
|
-
// In the case of multiple pages of results, the server-provided token can be used to fetch the next page
|
|
66
|
-
// in a query. If there are no more results, this value will be empty.
|
|
67
|
-
string token = 2;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
// Defines permissions associated with executions created by this launch plan spec.
|
|
71
|
-
// Use either of these roles when they have permissions required by your workflow execution.
|
|
72
|
-
// Deprecated.
|
|
73
|
-
message Auth {
|
|
74
|
-
option deprecated = true;
|
|
75
|
-
|
|
76
|
-
// Defines an optional iam role which will be used for tasks run in executions created with this launch plan.
|
|
77
|
-
string assumable_iam_role = 1;
|
|
78
|
-
|
|
79
|
-
// Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan.
|
|
80
|
-
string kubernetes_service_account = 2;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
// User-provided launch plan definition and configuration values.
|
|
84
|
-
message LaunchPlanSpec {
|
|
85
|
-
// Reference to the Workflow template that the launch plan references
|
|
86
|
-
core.Identifier workflow_id = 1;
|
|
87
|
-
|
|
88
|
-
// Metadata for the Launch Plan
|
|
89
|
-
LaunchPlanMetadata entity_metadata = 2;
|
|
90
|
-
|
|
91
|
-
// Input values to be passed for the execution.
|
|
92
|
-
// These can be overridden when an execution is created with this launch plan.
|
|
93
|
-
core.ParameterMap default_inputs = 3;
|
|
94
|
-
|
|
95
|
-
// Fixed, non-overridable inputs for the Launch Plan.
|
|
96
|
-
// These can not be overridden when an execution is created with this launch plan.
|
|
97
|
-
core.LiteralMap fixed_inputs = 4;
|
|
98
|
-
|
|
99
|
-
// String to indicate the role to use to execute the workflow underneath
|
|
100
|
-
string role = 5 [deprecated = true];
|
|
101
|
-
|
|
102
|
-
// Custom labels to be applied to the execution resource.
|
|
103
|
-
Labels labels = 6;
|
|
104
|
-
|
|
105
|
-
// Custom annotations to be applied to the execution resource.
|
|
106
|
-
Annotations annotations = 7;
|
|
107
|
-
|
|
108
|
-
// Indicates the permission associated with workflow executions triggered with this launch plan.
|
|
109
|
-
Auth auth = 8 [deprecated = true];
|
|
110
|
-
|
|
111
|
-
AuthRole auth_role = 9 [deprecated = true];
|
|
112
|
-
|
|
113
|
-
// Indicates security context for permissions triggered with this launch plan
|
|
114
|
-
core.SecurityContext security_context = 10;
|
|
115
|
-
|
|
116
|
-
// Indicates the runtime priority of the execution.
|
|
117
|
-
core.QualityOfService quality_of_service = 16;
|
|
118
|
-
|
|
119
|
-
// Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
|
|
120
|
-
RawOutputDataConfig raw_output_data_config = 17;
|
|
121
|
-
|
|
122
|
-
// Controls the maximum number of tasknodes that can be run in parallel for the entire workflow.
|
|
123
|
-
// This is useful to achieve fairness. Note: MapTasks are regarded as one unit,
|
|
124
|
-
// and parallelism/concurrency of MapTasks is independent from this.
|
|
125
|
-
int32 max_parallelism = 18;
|
|
126
|
-
|
|
127
|
-
// Allows for the interruptible flag of a workflow to be overwritten for a single execution.
|
|
128
|
-
// Omitting this field uses the workflow's value as a default.
|
|
129
|
-
// As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
|
|
130
|
-
// around the bool field.
|
|
131
|
-
google.protobuf.BoolValue interruptible = 19;
|
|
132
|
-
|
|
133
|
-
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
134
|
-
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
135
|
-
// data once execution finishes successfully.
|
|
136
|
-
bool overwrite_cache = 20;
|
|
137
|
-
|
|
138
|
-
// Environment variables to be set for the execution.
|
|
139
|
-
Envs envs = 21;
|
|
140
|
-
|
|
141
|
-
// Execution environment assignments to be set for the execution.
|
|
142
|
-
repeated core.ExecutionEnvAssignment execution_env_assignments = 22;
|
|
143
|
-
|
|
144
|
-
// ClusterAssignment controls how to select an available cluster on which executions of this LaunchPlan should run.
|
|
145
|
-
// This can be overwritten at execution creation level.
|
|
146
|
-
ClusterAssignment cluster_assignment = 23;
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
// Values computed by the flyte platform after launch plan registration.
|
|
150
|
-
// These include expected_inputs required to be present in a CreateExecutionRequest
|
|
151
|
-
// to launch the reference workflow as well timestamp values associated with the launch plan.
|
|
152
|
-
message LaunchPlanClosure {
|
|
153
|
-
// Indicate the Launch plan state.
|
|
154
|
-
LaunchPlanState state = 1;
|
|
155
|
-
|
|
156
|
-
// Indicates the set of inputs expected when creating an execution with the Launch plan
|
|
157
|
-
core.ParameterMap expected_inputs = 2;
|
|
158
|
-
|
|
159
|
-
// Indicates the set of outputs expected to be produced by creating an execution with the Launch plan
|
|
160
|
-
core.VariableMap expected_outputs = 3;
|
|
161
|
-
|
|
162
|
-
// Time at which the launch plan was created.
|
|
163
|
-
google.protobuf.Timestamp created_at = 4;
|
|
164
|
-
|
|
165
|
-
// Time at which the launch plan was last updated.
|
|
166
|
-
google.protobuf.Timestamp updated_at = 5;
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
// Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch
|
|
170
|
-
// the reference workflow.
|
|
171
|
-
message LaunchPlanMetadata {
|
|
172
|
-
// Schedule to execute the Launch Plan
|
|
173
|
-
Schedule schedule = 1;
|
|
174
|
-
|
|
175
|
-
// List of notifications based on Execution status transitions
|
|
176
|
-
repeated Notification notifications = 2;
|
|
177
|
-
|
|
178
|
-
// Additional metadata for how to launch the launch plan
|
|
179
|
-
google.protobuf.Any launch_conditions = 3;
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
// Request to set the referenced launch plan state to the configured value.
|
|
183
|
-
// See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
|
|
184
|
-
message LaunchPlanUpdateRequest {
|
|
185
|
-
// Identifier of launch plan for which to change state.
|
|
186
|
-
// +required.
|
|
187
|
-
core.Identifier id = 1;
|
|
188
|
-
|
|
189
|
-
// Desired state to apply to the launch plan.
|
|
190
|
-
// +required.
|
|
191
|
-
LaunchPlanState state = 2;
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
// Purposefully empty, may be populated in the future.
|
|
195
|
-
message LaunchPlanUpdateResponse {
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
// Represents a request struct for finding an active launch plan for a given NamedEntityIdentifier
|
|
199
|
-
// See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
|
|
200
|
-
message ActiveLaunchPlanRequest {
|
|
201
|
-
// +required.
|
|
202
|
-
NamedEntityIdentifier id = 1;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
// Represents a request structure to list active launch plans within a project/domain and optional org.
|
|
206
|
-
// See :ref:`ref_flyteidl.admin.LaunchPlan` for more details
|
|
207
|
-
message ActiveLaunchPlanListRequest {
|
|
208
|
-
// Name of the project that contains the identifiers.
|
|
209
|
-
// +required.
|
|
210
|
-
string project = 1;
|
|
211
|
-
|
|
212
|
-
// Name of the domain the identifiers belongs to within the project.
|
|
213
|
-
// +required.
|
|
214
|
-
string domain = 2;
|
|
215
|
-
|
|
216
|
-
// Indicates the number of resources to be returned.
|
|
217
|
-
// +required.
|
|
218
|
-
uint32 limit = 3;
|
|
219
|
-
|
|
220
|
-
// In the case of multiple pages of results, the server-provided token can be used to fetch the next page
|
|
221
|
-
// in a query.
|
|
222
|
-
// +optional
|
|
223
|
-
string token = 4;
|
|
224
|
-
|
|
225
|
-
// Sort ordering.
|
|
226
|
-
// +optional
|
|
227
|
-
Sort sort_by = 5;
|
|
228
|
-
|
|
229
|
-
// Optional, org key applied to the resource.
|
|
230
|
-
string org = 6;
|
|
231
|
-
}
|
|
@@ -1,194 +0,0 @@
|
|
|
1
|
-
syntax = "proto3";
|
|
2
|
-
|
|
3
|
-
package flyteidl.admin;
|
|
4
|
-
option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
|
|
5
|
-
|
|
6
|
-
import "flyteidl/admin/common.proto";
|
|
7
|
-
import "flyteidl/admin/cluster_assignment.proto";
|
|
8
|
-
import "flyteidl/core/execution.proto";
|
|
9
|
-
import "flyteidl/core/execution_envs.proto";
|
|
10
|
-
import "flyteidl/core/security.proto";
|
|
11
|
-
import "google/protobuf/wrappers.proto";
|
|
12
|
-
|
|
13
|
-
// Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes
|
|
14
|
-
// based on matching tags.
|
|
15
|
-
enum MatchableResource {
|
|
16
|
-
// Applies to customizable task resource requests and limits.
|
|
17
|
-
TASK_RESOURCE = 0;
|
|
18
|
-
|
|
19
|
-
// Applies to configuring templated kubernetes cluster resources.
|
|
20
|
-
CLUSTER_RESOURCE = 1;
|
|
21
|
-
|
|
22
|
-
// Configures task and dynamic task execution queue assignment.
|
|
23
|
-
EXECUTION_QUEUE = 2;
|
|
24
|
-
|
|
25
|
-
// Configures the K8s cluster label to be used for execution to be run
|
|
26
|
-
EXECUTION_CLUSTER_LABEL = 3;
|
|
27
|
-
|
|
28
|
-
// Configures default quality of service when undefined in an execution spec.
|
|
29
|
-
QUALITY_OF_SERVICE_SPECIFICATION = 4;
|
|
30
|
-
|
|
31
|
-
// Selects configurable plugin implementation behavior for a given task type.
|
|
32
|
-
PLUGIN_OVERRIDE = 5;
|
|
33
|
-
|
|
34
|
-
// Adds defaults for customizable workflow-execution specifications and overrides.
|
|
35
|
-
WORKFLOW_EXECUTION_CONFIG = 6;
|
|
36
|
-
|
|
37
|
-
// Controls how to select an available cluster on which this execution should run.
|
|
38
|
-
CLUSTER_ASSIGNMENT = 7;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
// Defines a set of overridable task resource attributes set during task registration.
|
|
42
|
-
message TaskResourceSpec {
|
|
43
|
-
string cpu = 1;
|
|
44
|
-
|
|
45
|
-
string gpu = 2;
|
|
46
|
-
|
|
47
|
-
string memory = 3;
|
|
48
|
-
|
|
49
|
-
string storage = 4;
|
|
50
|
-
|
|
51
|
-
string ephemeral_storage = 5;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
// Defines task resource defaults and limits that will be applied at task registration.
|
|
55
|
-
message TaskResourceAttributes {
|
|
56
|
-
TaskResourceSpec defaults = 1;
|
|
57
|
-
|
|
58
|
-
TaskResourceSpec limits = 2;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
message ClusterResourceAttributes {
|
|
62
|
-
// Custom resource attributes which will be applied in cluster resource creation (e.g. quotas).
|
|
63
|
-
// Map keys are the *case-sensitive* names of variables in templatized resource files.
|
|
64
|
-
// Map values should be the custom values which get substituted during resource creation.
|
|
65
|
-
map<string, string> attributes = 1;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
message ExecutionQueueAttributes {
|
|
69
|
-
// Tags used for assigning execution queues for tasks defined within this project.
|
|
70
|
-
repeated string tags = 1;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
message ExecutionClusterLabel {
|
|
74
|
-
// Label value to determine where the execution will be run
|
|
75
|
-
string value = 1;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
// This MatchableAttribute configures selecting alternate plugin implementations for a given task type.
|
|
79
|
-
// In addition to an override implementation a selection of fallbacks can be provided or other modes
|
|
80
|
-
// for handling cases where the desired plugin override is not enabled in a given Flyte deployment.
|
|
81
|
-
message PluginOverride {
|
|
82
|
-
// A predefined yet extensible Task type identifier.
|
|
83
|
-
string task_type = 1;
|
|
84
|
-
|
|
85
|
-
// A set of plugin ids which should handle tasks of this type instead of the default registered plugin. The list will be tried in order until a plugin is found with that id.
|
|
86
|
-
repeated string plugin_id = 2;
|
|
87
|
-
|
|
88
|
-
enum MissingPluginBehavior {
|
|
89
|
-
// By default, if this plugin is not enabled for a Flyte deployment then execution will fail.
|
|
90
|
-
FAIL = 0;
|
|
91
|
-
|
|
92
|
-
// Uses the system-configured default implementation.
|
|
93
|
-
USE_DEFAULT = 1;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
// Defines the behavior when no plugin from the plugin_id list is not found.
|
|
97
|
-
MissingPluginBehavior missing_plugin_behavior = 4;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
message PluginOverrides {
|
|
102
|
-
repeated PluginOverride overrides = 1;
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
// Adds defaults for customizable workflow-execution specifications and overrides.
|
|
106
|
-
message WorkflowExecutionConfig {
|
|
107
|
-
// Can be used to control the number of parallel nodes to run within the workflow. This is useful to achieve fairness.
|
|
108
|
-
int32 max_parallelism = 1;
|
|
109
|
-
|
|
110
|
-
// Indicates security context permissions for executions triggered with this matchable attribute.
|
|
111
|
-
core.SecurityContext security_context = 2;
|
|
112
|
-
|
|
113
|
-
// Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
|
|
114
|
-
RawOutputDataConfig raw_output_data_config = 3;
|
|
115
|
-
|
|
116
|
-
// Custom labels to be applied to a triggered execution resource.
|
|
117
|
-
Labels labels = 4;
|
|
118
|
-
|
|
119
|
-
// Custom annotations to be applied to a triggered execution resource.
|
|
120
|
-
Annotations annotations = 5;
|
|
121
|
-
|
|
122
|
-
// Allows for the interruptible flag of a workflow to be overwritten for a single execution.
|
|
123
|
-
// Omitting this field uses the workflow's value as a default.
|
|
124
|
-
// As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
|
|
125
|
-
// around the bool field.
|
|
126
|
-
google.protobuf.BoolValue interruptible = 6;
|
|
127
|
-
|
|
128
|
-
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
129
|
-
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
130
|
-
// data once execution finishes successfully.
|
|
131
|
-
bool overwrite_cache = 7;
|
|
132
|
-
|
|
133
|
-
// Environment variables to be set for the execution.
|
|
134
|
-
Envs envs = 8;
|
|
135
|
-
|
|
136
|
-
// Execution environment assignments to be set for the execution.
|
|
137
|
-
repeated core.ExecutionEnvAssignment execution_env_assignments = 9;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
// Generic container for encapsulating all types of the above attributes messages.
|
|
141
|
-
message MatchingAttributes {
|
|
142
|
-
oneof target {
|
|
143
|
-
TaskResourceAttributes task_resource_attributes = 1;
|
|
144
|
-
|
|
145
|
-
ClusterResourceAttributes cluster_resource_attributes = 2;
|
|
146
|
-
|
|
147
|
-
ExecutionQueueAttributes execution_queue_attributes = 3;
|
|
148
|
-
|
|
149
|
-
ExecutionClusterLabel execution_cluster_label = 4;
|
|
150
|
-
|
|
151
|
-
core.QualityOfService quality_of_service = 5;
|
|
152
|
-
|
|
153
|
-
PluginOverrides plugin_overrides = 6;
|
|
154
|
-
|
|
155
|
-
WorkflowExecutionConfig workflow_execution_config = 7;
|
|
156
|
-
|
|
157
|
-
ClusterAssignment cluster_assignment = 8;
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
// Represents a custom set of attributes applied for either a domain (and optional org); a domain and project (and optional org);
|
|
162
|
-
// or domain, project and workflow name (and optional org).
|
|
163
|
-
// These are used to override system level defaults for kubernetes cluster resource management,
|
|
164
|
-
// default execution values, and more all across different levels of specificity.
|
|
165
|
-
message MatchableAttributesConfiguration {
|
|
166
|
-
MatchingAttributes attributes = 1;
|
|
167
|
-
|
|
168
|
-
string domain = 2;
|
|
169
|
-
|
|
170
|
-
string project = 3;
|
|
171
|
-
|
|
172
|
-
string workflow = 4;
|
|
173
|
-
|
|
174
|
-
string launch_plan = 5;
|
|
175
|
-
|
|
176
|
-
// Optional, org key applied to the resource.
|
|
177
|
-
string org = 6;
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
// Request all matching resource attributes for a resource type.
|
|
181
|
-
// See :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for more details
|
|
182
|
-
message ListMatchableAttributesRequest {
|
|
183
|
-
// +required
|
|
184
|
-
MatchableResource resource_type = 1;
|
|
185
|
-
|
|
186
|
-
// Optional, org filter applied to list project requests.
|
|
187
|
-
string org = 2;
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
// Response for a request for all matching resource attributes for a resource type.
|
|
191
|
-
// See :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for more details
|
|
192
|
-
message ListMatchableAttributesResponse {
|
|
193
|
-
repeated MatchableAttributesConfiguration configurations = 1;
|
|
194
|
-
}
|
|
@@ -1,248 +0,0 @@
|
|
|
1
|
-
syntax = "proto3";
|
|
2
|
-
|
|
3
|
-
package flyteidl.admin;
|
|
4
|
-
option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
|
|
5
|
-
|
|
6
|
-
import "flyteidl/admin/common.proto";
|
|
7
|
-
import "flyteidl/core/execution.proto";
|
|
8
|
-
import "flyteidl/core/catalog.proto";
|
|
9
|
-
import "flyteidl/core/compiler.proto";
|
|
10
|
-
import "flyteidl/core/identifier.proto";
|
|
11
|
-
import "flyteidl/core/literals.proto";
|
|
12
|
-
import "google/protobuf/timestamp.proto";
|
|
13
|
-
import "google/protobuf/duration.proto";
|
|
14
|
-
|
|
15
|
-
// A message used to fetch a single node execution entity.
|
|
16
|
-
// See :ref:`ref_flyteidl.admin.NodeExecution` for more details
|
|
17
|
-
message NodeExecutionGetRequest {
|
|
18
|
-
|
|
19
|
-
// Uniquely identifies an individual node execution.
|
|
20
|
-
// +required
|
|
21
|
-
core.NodeExecutionIdentifier id = 1;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
// Represents a request structure to retrieve a list of node execution entities.
|
|
25
|
-
// See :ref:`ref_flyteidl.admin.NodeExecution` for more details
|
|
26
|
-
message NodeExecutionListRequest {
|
|
27
|
-
// Indicates the workflow execution to filter by.
|
|
28
|
-
// +required
|
|
29
|
-
core.WorkflowExecutionIdentifier workflow_execution_id = 1;
|
|
30
|
-
|
|
31
|
-
// Indicates the number of resources to be returned.
|
|
32
|
-
// +required
|
|
33
|
-
uint32 limit = 2;
|
|
34
|
-
|
|
35
|
-
// In the case of multiple pages of results, the, server-provided token can be used to fetch the next page
|
|
36
|
-
// in a query.
|
|
37
|
-
// +optional
|
|
38
|
-
|
|
39
|
-
string token = 3;
|
|
40
|
-
// Indicates a list of filters passed as string.
|
|
41
|
-
// More info on constructing filters : <Link>
|
|
42
|
-
// +optional
|
|
43
|
-
string filters = 4;
|
|
44
|
-
|
|
45
|
-
// Sort ordering.
|
|
46
|
-
// +optional
|
|
47
|
-
Sort sort_by = 5;
|
|
48
|
-
|
|
49
|
-
// Unique identifier of the parent node in the execution
|
|
50
|
-
// +optional
|
|
51
|
-
string unique_parent_id = 6;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
// Represents a request structure to retrieve a list of node execution entities launched by a specific task.
|
|
55
|
-
// This can arise when a task yields a subworkflow.
|
|
56
|
-
message NodeExecutionForTaskListRequest {
|
|
57
|
-
// Indicates the node execution to filter by.
|
|
58
|
-
// +required
|
|
59
|
-
core.TaskExecutionIdentifier task_execution_id = 1;
|
|
60
|
-
|
|
61
|
-
// Indicates the number of resources to be returned.
|
|
62
|
-
// +required
|
|
63
|
-
uint32 limit = 2;
|
|
64
|
-
|
|
65
|
-
// In the case of multiple pages of results, the, server-provided token can be used to fetch the next page
|
|
66
|
-
// in a query.
|
|
67
|
-
// +optional
|
|
68
|
-
string token = 3;
|
|
69
|
-
|
|
70
|
-
// Indicates a list of filters passed as string.
|
|
71
|
-
// More info on constructing filters : <Link>
|
|
72
|
-
// +optional
|
|
73
|
-
string filters = 4;
|
|
74
|
-
|
|
75
|
-
// Sort ordering.
|
|
76
|
-
// +optional
|
|
77
|
-
Sort sort_by = 5;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
// Encapsulates all details for a single node execution entity.
|
|
81
|
-
// A node represents a component in the overall workflow graph. A node launch a task, multiple tasks, an entire nested
|
|
82
|
-
// sub-workflow, or even a separate child-workflow execution.
|
|
83
|
-
// The same task can be called repeatedly in a single workflow but each node is unique.
|
|
84
|
-
message NodeExecution {
|
|
85
|
-
|
|
86
|
-
// Uniquely identifies an individual node execution.
|
|
87
|
-
core.NodeExecutionIdentifier id = 1;
|
|
88
|
-
|
|
89
|
-
// Path to remote data store where input blob is stored.
|
|
90
|
-
string input_uri = 2;
|
|
91
|
-
|
|
92
|
-
// Computed results associated with this node execution.
|
|
93
|
-
NodeExecutionClosure closure = 3;
|
|
94
|
-
|
|
95
|
-
// Metadata for Node Execution
|
|
96
|
-
NodeExecutionMetaData metadata = 4;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
// Represents additional attributes related to a Node Execution
|
|
100
|
-
message NodeExecutionMetaData {
|
|
101
|
-
// Node executions are grouped depending on retries of the parent
|
|
102
|
-
// Retry group is unique within the context of a parent node.
|
|
103
|
-
string retry_group = 1;
|
|
104
|
-
|
|
105
|
-
// Boolean flag indicating if the node has child nodes under it
|
|
106
|
-
// This can be true when a node contains a dynamic workflow which then produces
|
|
107
|
-
// child nodes.
|
|
108
|
-
bool is_parent_node = 2;
|
|
109
|
-
|
|
110
|
-
// Node id of the node in the original workflow
|
|
111
|
-
// This maps to value of WorkflowTemplate.nodes[X].id
|
|
112
|
-
string spec_node_id = 3;
|
|
113
|
-
|
|
114
|
-
// Boolean flag indicating if the node has contains a dynamic workflow which then produces child nodes.
|
|
115
|
-
// This is to distinguish between subworkflows and dynamic workflows which can both have is_parent_node as true.
|
|
116
|
-
bool is_dynamic = 4;
|
|
117
|
-
|
|
118
|
-
// Boolean flag indicating if the node is an array node. This is intended to uniquely identify
|
|
119
|
-
// array nodes from other nodes which can have is_parent_node as true.
|
|
120
|
-
bool is_array = 5;
|
|
121
|
-
|
|
122
|
-
// Whether this node is an eager node.
|
|
123
|
-
bool is_eager = 6;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
// Request structure to retrieve a list of node execution entities.
|
|
127
|
-
// See :ref:`ref_flyteidl.admin.NodeExecution` for more details
|
|
128
|
-
message NodeExecutionList {
|
|
129
|
-
repeated NodeExecution node_executions = 1;
|
|
130
|
-
|
|
131
|
-
// In the case of multiple pages of results, the server-provided token can be used to fetch the next page
|
|
132
|
-
// in a query. If there are no more results, this value will be empty.
|
|
133
|
-
string token = 2;
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
// Container for node execution details and results.
|
|
137
|
-
message NodeExecutionClosure {
|
|
138
|
-
// Only a node in a terminal state will have a non-empty output_result.
|
|
139
|
-
oneof output_result {
|
|
140
|
-
// Links to a remotely stored, serialized core.LiteralMap of node execution outputs.
|
|
141
|
-
// DEPRECATED. Use GetNodeExecutionData to fetch output data instead.
|
|
142
|
-
string output_uri = 1 [deprecated = true];
|
|
143
|
-
|
|
144
|
-
// Error information for the Node
|
|
145
|
-
core.ExecutionError error = 2;
|
|
146
|
-
|
|
147
|
-
// Raw output data produced by this node execution.
|
|
148
|
-
// DEPRECATED. Use GetNodeExecutionData to fetch output data instead.
|
|
149
|
-
core.LiteralMap output_data = 10 [deprecated = true];
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
// The last recorded phase for this node execution.
|
|
153
|
-
core.NodeExecution.Phase phase = 3;
|
|
154
|
-
|
|
155
|
-
// Time at which the node execution began running.
|
|
156
|
-
google.protobuf.Timestamp started_at = 4;
|
|
157
|
-
|
|
158
|
-
// The amount of time the node execution spent running.
|
|
159
|
-
google.protobuf.Duration duration = 5;
|
|
160
|
-
|
|
161
|
-
// Time at which the node execution was created.
|
|
162
|
-
google.protobuf.Timestamp created_at = 6;
|
|
163
|
-
|
|
164
|
-
// Time at which the node execution was last updated.
|
|
165
|
-
google.protobuf.Timestamp updated_at = 7;
|
|
166
|
-
|
|
167
|
-
// Store metadata for what the node launched.
|
|
168
|
-
// for ex: if this is a workflow node, we store information for the launched workflow.
|
|
169
|
-
oneof target_metadata {
|
|
170
|
-
WorkflowNodeMetadata workflow_node_metadata = 8;
|
|
171
|
-
TaskNodeMetadata task_node_metadata = 9;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
// String location uniquely identifying where the deck HTML file is.
|
|
175
|
-
// NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
|
|
176
|
-
string deck_uri = 11;
|
|
177
|
-
|
|
178
|
-
// dynamic_job_spec_uri is the location of the DynamicJobSpec proto message for a DynamicWorkflow. This is required
|
|
179
|
-
// to correctly recover partially completed executions where the subworkflow has already been compiled.
|
|
180
|
-
string dynamic_job_spec_uri = 12;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
// Metadata for a WorkflowNode
|
|
184
|
-
message WorkflowNodeMetadata {
|
|
185
|
-
// The identifier for a workflow execution launched by a node.
|
|
186
|
-
core.WorkflowExecutionIdentifier executionId = 1;
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
// Metadata for the case in which the node is a TaskNode
|
|
190
|
-
message TaskNodeMetadata {
|
|
191
|
-
// Captures the status of caching for this execution.
|
|
192
|
-
core.CatalogCacheStatus cache_status = 1;
|
|
193
|
-
// This structure carries the catalog artifact information
|
|
194
|
-
core.CatalogMetadata catalog_key = 2;
|
|
195
|
-
// The latest checkpoint location
|
|
196
|
-
string checkpoint_uri = 4;
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
// For dynamic workflow nodes we capture information about the dynamic workflow definition that gets generated.
|
|
200
|
-
message DynamicWorkflowNodeMetadata {
|
|
201
|
-
// id represents the unique identifier of the workflow.
|
|
202
|
-
core.Identifier id = 1;
|
|
203
|
-
|
|
204
|
-
// Represents the compiled representation of the embedded dynamic workflow.
|
|
205
|
-
core.CompiledWorkflowClosure compiled_workflow = 2;
|
|
206
|
-
|
|
207
|
-
// dynamic_job_spec_uri is the location of the DynamicJobSpec proto message for this DynamicWorkflow. This is
|
|
208
|
-
// required to correctly recover partially completed executions where the subworkflow has already been compiled.
|
|
209
|
-
string dynamic_job_spec_uri = 3;
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
// Request structure to fetch inputs and output for a node execution.
|
|
213
|
-
// By default, these are not returned in :ref:`ref_flyteidl.admin.NodeExecutionGetRequest`
|
|
214
|
-
message NodeExecutionGetDataRequest {
|
|
215
|
-
// The identifier of the node execution for which to fetch inputs and outputs.
|
|
216
|
-
core.NodeExecutionIdentifier id = 1;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
// Response structure for NodeExecutionGetDataRequest which contains inputs and outputs for a node execution.
|
|
220
|
-
message NodeExecutionGetDataResponse {
|
|
221
|
-
// Signed url to fetch a core.LiteralMap of node execution inputs.
|
|
222
|
-
// Deprecated: Please use full_inputs instead.
|
|
223
|
-
UrlBlob inputs = 1 [deprecated = true];
|
|
224
|
-
|
|
225
|
-
// Signed url to fetch a core.LiteralMap of node execution outputs.
|
|
226
|
-
// Deprecated: Please use full_outputs instead.
|
|
227
|
-
UrlBlob outputs = 2 [deprecated = true];
|
|
228
|
-
|
|
229
|
-
// Full_inputs will only be populated if they are under a configured size threshold.
|
|
230
|
-
core.LiteralMap full_inputs = 3;
|
|
231
|
-
|
|
232
|
-
// Full_outputs will only be populated if they are under a configured size threshold.
|
|
233
|
-
core.LiteralMap full_outputs = 4;
|
|
234
|
-
|
|
235
|
-
// Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here.
|
|
236
|
-
DynamicWorkflowNodeMetadata dynamic_workflow = 16;
|
|
237
|
-
|
|
238
|
-
FlyteURLs flyte_urls = 17;
|
|
239
|
-
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
message GetDynamicNodeWorkflowRequest {
|
|
243
|
-
core.NodeExecutionIdentifier id = 1;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
message DynamicNodeWorkflowResponse {
|
|
247
|
-
core.CompiledWorkflowClosure compiled_workflow = 1;
|
|
248
|
-
}
|