Skip to content

Commit

Permalink
Update documentation (flyteorg#128)
Browse files Browse the repository at this point in the history
Signed-off-by: Flyte-Bot <[email protected]>

Co-authored-by: pmahindrakar-oss <[email protected]>
  • Loading branch information
2 people authored and robert-ulbrich-mercedes-benz committed Jul 2, 2024
1 parent ade4184 commit de57be1
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion flytectl/docs/source/gen/flytectl_get_execution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,31 @@ Retrieves all the execution within project and domain in json format.

bin/flytectl get execution -p flytesnacks -d development -o json


Get more details for the execution using --details flag which shows node executions along with task executions on them. Default view is tree view and TABLE format is not supported on this view

::

bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details

Using yaml view for the details. In this view only node details are available. For task details pass --nodeId flag

::

bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details -o yaml

Using --nodeId flag to get task executions on a specific node. Use the nodeId attribute from node details view

::

bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodId n0

Task execution view is also available in yaml/json format. Below example shows yaml

::

bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodId n0 -o yaml

Usage


Expand All @@ -57,11 +82,13 @@ Options

::

--details gets node execution details. Only applicable for single execution name i.e get execution name --details
--filter.asc Specifies the sorting order. By default flytectl sort result in descending order
--filter.field-selector string Specifies the Field selector
--filter.limit int32 Specifies the limit (default 100)
--filter.sort-by string Specifies which field to sort result by
--filter.sort-by string Specifies which field to sort results (default "created_at")
-h, --help help for execution
--nodeId string get task executions for given node name.

Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit de57be1

Please sign in to comment.