From de57be10d1ff42c03b3625023e683289e35e1338 Mon Sep 17 00:00:00 2001 From: Flyte Bot Date: Fri, 2 Jul 2021 13:56:56 -0700 Subject: [PATCH] Update documentation (#128) Signed-off-by: Flyte-Bot Co-authored-by: pmahindrakar-oss --- .../source/gen/flytectl_get_execution.rst | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/flytectl/docs/source/gen/flytectl_get_execution.rst b/flytectl/docs/source/gen/flytectl_get_execution.rst index 77249157ce..174ba88661 100644 --- a/flytectl/docs/source/gen/flytectl_get_execution.rst +++ b/flytectl/docs/source/gen/flytectl_get_execution.rst @@ -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 @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~