Skip to content

Commit

Permalink
Add system metadata to execution metadata (flyteorg#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
katrogan authored Mar 12, 2020
1 parent 0d232a7 commit 2ee8973
Show file tree
Hide file tree
Showing 22 changed files with 2,384 additions and 213 deletions.
491 changes: 445 additions & 46 deletions gen/pb-cpp/flyteidl/admin/execution.pb.cc

Large diffs are not rendered by default.

260 changes: 252 additions & 8 deletions gen/pb-cpp/flyteidl/admin/execution.pb.h

Large diffs are not rendered by default.

231 changes: 143 additions & 88 deletions gen/pb-go/flyteidl/admin/execution.pb.go

Large diffs are not rendered by default.

77 changes: 77 additions & 0 deletions gen/pb-go/flyteidl/admin/execution.pb.validate.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions gen/pb-go/flyteidl/service/admin.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -3001,6 +3001,10 @@
"reference_execution": {
"$ref": "#/definitions/coreWorkflowExecutionIdentifier",
"description": "Optional, a reference workflow execution related to this execution.\nIn the case of a relaunch, this references the original workflow execution."
},
"system_metadata": {
"$ref": "#/definitions/adminSystemMetadata",
"description": "Optional, platform-specific metadata about the execution.\nIn this the future this may be gated behind an ACL or some sort of authorization."
}
},
"description": "Represents attributes about an execution which are not required to launch the execution but are useful to record.\nThese attributes are assigned at launch time and do not change."
Expand Down Expand Up @@ -3731,6 +3735,16 @@
},
"description": "Species sort ordering in a list request."
},
"adminSystemMetadata": {
"type": "object",
"properties": {
"execution_cluster": {
"type": "string",
"description": "Which execution cluster this execution ran on."
}
},
"description": "Represents system rather than user-facing metadata about an execution."
},
"adminTask": {
"type": "object",
"properties": {
Expand Down
1 change: 1 addition & 0 deletions gen/pb-go/flyteidl/service/flyteadmin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
- [AdminSchedule](docs/AdminSchedule.md)
- [AdminSlackNotification](docs/AdminSlackNotification.md)
- [AdminSort](docs/AdminSort.md)
- [AdminSystemMetadata](docs/AdminSystemMetadata.md)
- [AdminTask](docs/AdminTask.md)
- [AdminTaskClosure](docs/AdminTaskClosure.md)
- [AdminTaskCreateRequest](docs/AdminTaskCreateRequest.md)
Expand Down
23 changes: 23 additions & 0 deletions gen/pb-go/flyteidl/service/flyteadmin/api/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2562,6 +2562,8 @@ definitions:
project: "project"
scheduled_at: "2000-01-23T04:56:07.000+00:00"
nesting: 0
system_metadata:
execution_cluster: "execution_cluster"
disable_all: true
inputs:
literals: {}
Expand Down Expand Up @@ -2856,6 +2858,8 @@ definitions:
project: "project"
scheduled_at: "2000-01-23T04:56:07.000+00:00"
nesting: 0
system_metadata:
execution_cluster: "execution_cluster"
disable_all: true
inputs:
literals: {}
Expand Down Expand Up @@ -2981,6 +2985,8 @@ definitions:
project: "project"
scheduled_at: "2000-01-23T04:56:07.000+00:00"
nesting: 0
system_metadata:
execution_cluster: "execution_cluster"
disable_all: true
inputs:
literals: {}
Expand Down Expand Up @@ -3053,6 +3059,10 @@ definitions:
description: "Optional, a reference workflow execution related to this execution.\n\
In the case of a relaunch, this references the original workflow execution."
$ref: "#/definitions/coreWorkflowExecutionIdentifier"
system_metadata:
description: "Optional, platform-specific metadata about the execution.\n\
In this the future this may be gated behind an ACL or some sort of authorization."
$ref: "#/definitions/adminSystemMetadata"
description: "Represents attributes about an execution which are not required\
\ to launch the execution but are useful to record.\nThese attributes are assigned\
\ at launch time and do not change."
Expand All @@ -3071,6 +3081,8 @@ definitions:
project: "project"
scheduled_at: "2000-01-23T04:56:07.000+00:00"
nesting: 0
system_metadata:
execution_cluster: "execution_cluster"
adminExecutionQueueAttributes:
type: "object"
properties:
Expand Down Expand Up @@ -3149,6 +3161,8 @@ definitions:
project: "project"
scheduled_at: "2000-01-23T04:56:07.000+00:00"
nesting: 0
system_metadata:
execution_cluster: "execution_cluster"
disable_all: true
inputs:
literals: {}
Expand Down Expand Up @@ -5089,6 +5103,15 @@ definitions:
title: "Indicates the direction to apply sort key for response values.\n+optional"
$ref: "#/definitions/SortDirection"
description: "Species sort ordering in a list request."
adminSystemMetadata:
type: "object"
properties:
execution_cluster:
type: "string"
description: "Which execution cluster this execution ran on."
description: "Represents system rather than user-facing metadata about an execution."
example:
execution_cluster: "execution_cluster"
adminTask:
type: "object"
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,6 @@ type AdminExecutionMetadata struct {
ParentNodeExecution *CoreNodeExecutionIdentifier `json:"parent_node_execution,omitempty"`
// Optional, a reference workflow execution related to this execution. In the case of a relaunch, this references the original workflow execution.
ReferenceExecution *CoreWorkflowExecutionIdentifier `json:"reference_execution,omitempty"`
// Optional, platform-specific metadata about the execution. In this the future this may be gated behind an ACL or some sort of authorization.
SystemMetadata *AdminSystemMetadata `json:"system_metadata,omitempty"`
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* flyteidl/service/admin.proto
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: version not set
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
*/

package flyteadmin

// Represents system rather than user-facing metadata about an execution.
type AdminSystemMetadata struct {
// Which execution cluster this execution ran on.
ExecutionCluster string `json:"execution_cluster,omitempty"`
}
4 changes: 2 additions & 2 deletions gen/pb-go/flyteidl/service/openapi.go

Large diffs are not rendered by default.

Loading

0 comments on commit 2ee8973

Please sign in to comment.