From c29fbec0a39aa8be2d14d40f3e04139101f0a0e3 Mon Sep 17 00:00:00 2001 From: SmritiSatyanV <94349093+SmritiSatyanV@users.noreply.github.com> Date: Fri, 10 Dec 2021 10:46:15 +0530 Subject: [PATCH] Created separate rst files for every resource (noun) (#230) * Update nouns.rst * removed html links Created separate rst file for each noun and referenced it in the nouns.rst file. * Update verbs.rst * Deleted newly added rst files error with codecov, so deleted the newly added rst files. * Delete verbs.rst * Created separate rst files for every resource * Changes to files in cmd folder * Update create_test.go * cmd folders * Update cmd/create/execution.go Co-authored-by: Samhita Alla * Added verbs.rst * changes to cmd folder files /bin removed, * Update based on review * Update cmd/create/project.go Co-authored-by: Samhita Alla * Update cmd/create/create.go Co-authored-by: Samhita Alla * Update cmd/create/create_test.go Co-authored-by: Samhita Alla * Update cmd/delete/delete.go Co-authored-by: Samhita Alla * Update cmd/delete/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla * Update cmd/delete/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla * Changes to delete - matchable_plugin_override * Changes to .go files in cmd * Changed flytesnack to Flytesnack * Creates to create * Update cmd/get/launch_plan.go Co-authored-by: Samhita Alla * Changed 'launchplan' to 'launch plan' * Update cmd/register/examples.go Co-authored-by: Samhita Alla * Update cmd/register/examples.go Co-authored-by: Samhita Alla * Update cmd/register/examples.go Co-authored-by: Samhita Alla * Update cmd/register/files.go Co-authored-by: Samhita Alla * Update cmd/register/register.go Co-authored-by: Samhita Alla * Update cmd/register/register_test.go Co-authored-by: Samhita Alla * Update cmd/sandbox/sandbox.go Co-authored-by: Samhita Alla * Update cmd/sandbox/start.go Co-authored-by: Samhita Alla * Update cmd/sandbox/start.go Co-authored-by: Samhita Alla * Update cmd/sandbox/status.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_execution_cluster_label.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_execution_queue_attribute.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_plugin_override.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_workflow_execution_config.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_workflow_execution_config.go Co-authored-by: Samhita Alla * Update cmd/update/update.go Co-authored-by: Samhita Alla * Update cmd/upgrade/upgrade.go Co-authored-by: Samhita Alla * Update cmd/upgrade/upgrade.go Co-authored-by: Samhita Alla * Update cmd/version/version.go Co-authored-by: Samhita Alla * Update cmd/update/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla * Update cmd/update/update.go Co-authored-by: Samhita Alla * Resolved changes * Changed 'delte' to 'delete' * Updated rst files Created rst files for every noun, and linked the associated verbs with it * Trial * Removed the extra whitespace * Changed 'delte' to 'delete' Co-authored-by: Samhita Alla --- cmd/completion.go | 2 +- cmd/completion_test.go | 6 +- cmd/configuration/configuration.go | 18 +++--- cmd/create/create.go | 10 +-- cmd/create/create_test.go | 2 +- cmd/create/execution.go | 26 ++++---- cmd/create/project.go | 8 +-- cmd/delete/delete.go | 8 +-- cmd/delete/execution.go | 21 +++---- .../matchable_cluster_resource_attribute.go | 19 +++--- .../matchable_execution_cluster_label.go | 15 +++-- .../matchable_execution_cluster_label_test.go | 4 +- .../matchable_execution_queue_attribute.go | 17 +++-- cmd/delete/matchable_plugin_override.go | 20 +++--- .../matchable_task_resource_attribute.go | 19 +++--- .../matchable_workflow_execution_config.go | 19 +++--- cmd/get/execution.go | 34 +++++----- cmd/get/get.go | 4 +- cmd/get/get_test.go | 2 +- cmd/get/launch_plan.go | 28 ++++----- .../matchable_cluster_resource_attribute.go | 20 +++--- cmd/get/matchable_execution_cluster_label.go | 19 +++--- .../matchable_execution_queue_attribute.go | 18 +++--- cmd/get/matchable_plugin_override.go | 20 +++--- cmd/get/matchable_task_resource_attribute.go | 18 +++--- .../matchable_workflow_execution_config.go | 21 +++---- cmd/get/project.go | 26 ++++---- cmd/get/task.go | 40 ++++++------ cmd/get/workflow.go | 30 ++++----- cmd/register/examples.go | 12 ++-- cmd/register/files.go | 54 ++++++++-------- cmd/register/register.go | 8 +-- cmd/register/register_test.go | 6 +- cmd/root.go | 6 +- cmd/sandbox/exec.go | 4 +- cmd/sandbox/sandbox.go | 18 +++--- cmd/sandbox/start.go | 14 ++--- cmd/sandbox/status.go | 7 +-- cmd/sandbox/teardown.go | 6 +- cmd/update/launch_plan.go | 6 +- cmd/update/launch_plan_meta.go | 8 +-- .../matchable_cluster_resource_attribute.go | 18 +++--- .../matchable_execution_cluster_label.go | 14 ++--- .../matchable_execution_queue_attribute.go | 18 +++--- cmd/update/matchable_plugin_override.go | 14 ++--- .../matchable_task_resource_attribute.go | 18 +++--- .../matchable_workflow_execution_config.go | 16 ++--- cmd/update/project.go | 24 +++---- cmd/update/task_meta.go | 8 +-- cmd/update/update.go | 10 +-- cmd/update/workflow_meta.go | 8 +-- cmd/upgrade/upgrade.go | 14 ++--- cmd/upgrade/upgrade_test.go | 6 +- cmd/version/version.go | 6 +- cmd/version/version_test.go | 6 +- docs/source/cluster-resource-attribute.rst | 9 +++ docs/source/config.rst | 10 +++ docs/source/examples.rst | 8 +++ docs/source/execution-cluster-label.rst | 10 +++ docs/source/execution-queue-attribute.rst | 10 +++ docs/source/execution.rst | 10 +++ docs/source/files.rst | 10 +++ docs/source/gen/flytectl.rst | 30 ++++----- docs/source/gen/flytectl_completion.rst | 10 +-- docs/source/gen/flytectl_config.rst | 12 ++-- docs/source/gen/flytectl_config_discover.rst | 8 +-- docs/source/gen/flytectl_config_init.rst | 24 +++---- docs/source/gen/flytectl_config_validate.rst | 8 +-- docs/source/gen/flytectl_create.rst | 16 ++--- docs/source/gen/flytectl_create_execution.rst | 34 +++++----- docs/source/gen/flytectl_create_project.rst | 16 ++--- docs/source/gen/flytectl_delete.rst | 26 ++++---- ...ectl_delete_cluster-resource-attribute.rst | 27 ++++---- ...lytectl_delete_execution-cluster-label.rst | 23 ++++--- ...tectl_delete_execution-queue-attribute.rst | 25 ++++---- docs/source/gen/flytectl_delete_execution.rst | 27 ++++---- .../gen/flytectl_delete_plugin-override.rst | 28 ++++----- ...lytectl_delete_task-resource-attribute.rst | 27 ++++---- ...tectl_delete_workflow-execution-config.rst | 27 ++++---- docs/source/gen/flytectl_get.rst | 32 +++++----- ...lytectl_get_cluster-resource-attribute.rst | 28 ++++----- .../flytectl_get_execution-cluster-label.rst | 27 ++++---- ...flytectl_get_execution-queue-attribute.rst | 26 ++++---- docs/source/gen/flytectl_get_execution.rst | 42 ++++++------- docs/source/gen/flytectl_get_launchplan.rst | 36 +++++------ .../gen/flytectl_get_plugin-override.rst | 28 ++++----- docs/source/gen/flytectl_get_project.rst | 34 +++++----- .../flytectl_get_task-resource-attribute.rst | 26 ++++---- docs/source/gen/flytectl_get_task.rst | 48 +++++++------- ...flytectl_get_workflow-execution-config.rst | 29 +++++---- docs/source/gen/flytectl_get_workflow.rst | 38 ++++++------ docs/source/gen/flytectl_register.rst | 18 +++--- .../source/gen/flytectl_register_examples.rst | 20 +++--- docs/source/gen/flytectl_register_files.rst | 62 +++++++++---------- docs/source/gen/flytectl_sandbox.rst | 32 +++++----- docs/source/gen/flytectl_sandbox_exec.rst | 12 ++-- docs/source/gen/flytectl_sandbox_start.rst | 22 +++---- docs/source/gen/flytectl_sandbox_status.rst | 15 +++-- docs/source/gen/flytectl_sandbox_teardown.rst | 14 ++--- docs/source/gen/flytectl_update.rst | 38 ++++++------ ...ectl_update_cluster-resource-attribute.rst | 26 ++++---- ...lytectl_update_execution-cluster-label.rst | 22 +++---- ...tectl_update_execution-queue-attribute.rst | 26 ++++---- .../gen/flytectl_update_launchplan-meta.rst | 16 ++--- .../source/gen/flytectl_update_launchplan.rst | 14 ++--- .../gen/flytectl_update_plugin-override.rst | 22 +++---- docs/source/gen/flytectl_update_project.rst | 32 +++++----- docs/source/gen/flytectl_update_task-meta.rst | 16 ++--- ...lytectl_update_task-resource-attribute.rst | 26 ++++---- ...tectl_update_workflow-execution-config.rst | 24 +++---- .../gen/flytectl_update_workflow-meta.rst | 16 ++--- docs/source/gen/flytectl_upgrade.rst | 22 +++---- docs/source/gen/flytectl_version.rst | 14 ++--- docs/source/launchplan.rst | 9 +++ docs/source/nouns.rst | 60 ++++++------------ docs/source/plugin-override.rst | 10 +++ docs/source/project.rst | 10 +++ docs/source/sandbox.rst | 11 ++++ docs/source/task-resource-attribute.rst | 11 ++++ docs/source/task.rst | 8 +++ docs/source/verbs.rst | 22 +++---- docs/source/workflow-execution-config.rst | 10 +++ docs/source/workflow.rst | 8 +++ pkg/configutil/configutil.go | 8 +-- pkg/util/util_test.go | 14 ++--- proposal/README.md | 10 +-- 126 files changed, 1225 insertions(+), 1127 deletions(-) create mode 100644 docs/source/cluster-resource-attribute.rst create mode 100644 docs/source/config.rst create mode 100644 docs/source/examples.rst create mode 100644 docs/source/execution-cluster-label.rst create mode 100644 docs/source/execution-queue-attribute.rst create mode 100644 docs/source/execution.rst create mode 100644 docs/source/files.rst create mode 100644 docs/source/launchplan.rst create mode 100644 docs/source/plugin-override.rst create mode 100644 docs/source/project.rst create mode 100644 docs/source/sandbox.rst create mode 100644 docs/source/task-resource-attribute.rst create mode 100644 docs/source/task.rst create mode 100644 docs/source/workflow-execution-config.rst create mode 100644 docs/source/workflow.rst diff --git a/cmd/completion.go b/cmd/completion.go index 7c705c2e00..ceeb07643a 100644 --- a/cmd/completion.go +++ b/cmd/completion.go @@ -40,7 +40,7 @@ Bash: Zsh: # If shell completion is not already enabled in your environment, - # you will need to enable it. You can execute the following once: + # you will need to enable it. You can execute the following once: $ echo "autoload -U compinit; compinit" >> ~/.zshrc diff --git a/cmd/completion_test.go b/cmd/completion_test.go index 3fd8ae01b1..71eab97dc9 100644 --- a/cmd/completion_test.go +++ b/cmd/completion_test.go @@ -9,9 +9,9 @@ import ( func TestCompletionCmdIntegration(t *testing.T) { rootCmd := &cobra.Command{ - Long: "flytectl is CLI tool written in go to interact with flyteadmin service", - Short: "flyetcl CLI tool", - Use: "flytectl", + Long: "FlyteCTL is CLI tool written in go to interact with Flyteadmin service", + Short: "FlyteCTL CLI tool", + Use: "FlyteCTL", DisableAutoGenTag: true, } diff --git a/cmd/configuration/configuration.go b/cmd/configuration/configuration.go index e47ff2ff81..cbf0b8bf36 100644 --- a/cmd/configuration/configuration.go +++ b/cmd/configuration/configuration.go @@ -22,27 +22,27 @@ import ( "github.com/spf13/cobra" ) -// Long descriptions are whitespace sensitive when generating docs using sphinx. +// Long descriptions are whitespace sensitive when generating docs using Sphinx. const ( - initCmdShort = `Generates flytectl config file in the user's home directory.` - initCmdLong = `Creates a flytectl config file in flyte directory i.e ~/.flyte + initCmdShort = `Generates FlyteCTL config file in the user's home directory.` + initCmdLong = `Creates a FlyteCTL config file in Flyte directory i.e ~/.flyte -Generate sandbox config. Flyte Sandbox is a fully standalone minimal environment for running Flyte. Read more about sandbox https://docs.flyte.org/en/latest/deployment/sandbox.html +Generates sandbox config. Flyte Sandbox is a fully standalone minimal environment for running Flyte. Read more about sandbox https://docs.flyte.org/en/latest/deployment/sandbox.html :: - bin/flytectl configuration config + flytectl configuration config -Generate remote cluster config. Read more about the remote deployment https://docs.flyte.org/en/latest/deployment/index.html +Generates remote cluster config. Read more about the remote deployment https://docs.flyte.org/en/latest/deployment/index.html :: - bin/flytectl configuration config --host=flyte.myexample.com + flytectl configuration config --host=flyte.myexample.com -Generate flytectl config with a storage provider +Generates FlyteCTL config with a storage provider :: - bin/flytectl configuration config --host=flyte.myexample.com --storage + flytectl configuration config --host=flyte.myexample.com --storage ` ) diff --git a/cmd/create/create.go b/cmd/create/create.go index 5868b91c97..54ad53cf22 100644 --- a/cmd/create/create.go +++ b/cmd/create/create.go @@ -6,18 +6,18 @@ import ( "github.com/spf13/cobra" ) -// Long descriptions are whitespace sensitive when generating docs using sphinx. +// Long descriptions are whitespace sensitive when generating docs using Sphinx. const ( - createCmdShort = `Used for creating various flyte resources including tasks/workflows/launchplans/executions/project.` + createCmdShort = `Create various Flyte resources including tasks/workflows/launchplans/executions/project.` createCmdLong = ` -Example create. +Create Flyte resource; if a project: :: - bin/flytectl create project --file project.yaml + flytectl create project --file project.yaml ` ) -// RemoteCreateCommand will return create flyte resource commands +// RemoteCreateCommand will return create Flyte resource commands func RemoteCreateCommand() *cobra.Command { createCmd := &cobra.Command{ Use: "create", diff --git a/cmd/create/create_test.go b/cmd/create/create_test.go index d2e4711a31..a33201cf12 100644 --- a/cmd/create/create_test.go +++ b/cmd/create/create_test.go @@ -27,7 +27,7 @@ var tearDownAndVerify = testutils.TearDownAndVerify func TestCreateCommand(t *testing.T) { createCommand := RemoteCreateCommand() assert.Equal(t, createCommand.Use, "create") - assert.Equal(t, createCommand.Short, "Used for creating various flyte resources including tasks/workflows/launchplans/executions/project.") + assert.Equal(t, createCommand.Short, "Create various Flyte resources including tasks/workflows/launchplans/executions/project.") assert.Equal(t, len(createCommand.Commands()), 2) cmdNouns := createCommand.Commands() // Sort by Use value. diff --git a/cmd/create/execution.go b/cmd/create/execution.go index bbb7d77d9e..263046389e 100644 --- a/cmd/create/execution.go +++ b/cmd/create/execution.go @@ -13,22 +13,22 @@ import ( const ( executionShort = "Create execution resources" executionLong = ` -Create the executions for given workflow/task in a project and domain. +Creates executions for a given workflow/task in a project and domain. -There are three steps in generating an execution. +There are three steps in generating an execution: - Generate the execution spec file using the get command. - Update the inputs for the execution if needed. - Run the execution by passing in the generated yaml file. -The spec file should be generated first and then run the execution using the spec file. -You can reference the flytectl get task for more details +The spec file should be generated first and then, the execution should be run using the spec file. +You can reference the FlyteCTL get task for more details. :: flytectl get tasks -d development -p flytectldemo core.advanced.run_merge_sort.merge --version v2 --execFile execution_spec.yaml -The generated file would look similar to this +The generated file would look similar to this: .. code-block:: yaml @@ -65,35 +65,35 @@ The generated file can be modified to change the input values. task: core.advanced.run_merge_sort.merge version: "v2" -And then can be passed through the command line. -Notice the source and target domain/projects can be different. -The root project and domain flags of -p and -d should point to task/launch plans project/domain. +It can then be passed through the command line. +Notice that the source and target domain/projects can be different. +The root project and domain flags of -p and -d should point to the task/launch plans project/domain. :: flytectl create execution --execFile execution_spec.yaml -p flytectldemo -d development --targetProject flytesnacks -Also an execution can be relaunched by passing in current execution id. +Also, an execution can be relaunched by passing in the current execution id. :: flytectl create execution --relaunch ffb31066a0f8b4d52b77 -p flytectldemo -d development -An execution can be recovered, that is recreated from the last known failure point for a previously-run workflow execution. +An execution can be recovered, i.e., recreated from the last known failure point for previously-run workflow execution. See :ref:` + "`ref_flyteidl.admin.ExecutionRecoverRequest`" + ` for more details. :: flytectl create execution --recover ffb31066a0f8b4d52b77 -p flytectldemo -d development -Generic data types are also supported for execution in similar way.Following is sample of how the inputs need to be specified while creating the execution. -As usual the spec file should be generated first and then run the execution using the spec file. +Generic data types are also supported for execution in a similar manner. Following is a sample of how the inputs need to be specified while creating the execution. +The spec file should be generated first and then, the execution should be run using the spec file. :: flytectl get task -d development -p flytectldemo core.type_system.custom_objects.add --execFile adddatanum.yaml -The generated file would look similar to this. Here you can see empty values dumped for generic data type x and y. +The generated file would look similar to this. Here, empty values have been dumped for generic data type x and y. :: diff --git a/cmd/create/project.go b/cmd/create/project.go index 06c039c529..dec5a7322d 100644 --- a/cmd/create/project.go +++ b/cmd/create/project.go @@ -15,16 +15,16 @@ import ( const ( projectShort = "Create project resources" projectLong = ` -Create the projects.(project,projects can be used interchangeably in these commands) +Create projects.(project/projects can be used interchangeably in these commands) :: - bin/flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte + flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte -Create Project by definition file. Note: The name shouldn't contain any whitespace characters' +Create a project by definition file. Note: The name shouldn't contain any whitespace characters. :: - bin/flytectl create project --file project.yaml + flytectl create project --file project.yaml .. code-block:: yaml diff --git a/cmd/delete/delete.go b/cmd/delete/delete.go index 9a489abb65..14969e9aeb 100644 --- a/cmd/delete/delete.go +++ b/cmd/delete/delete.go @@ -13,14 +13,14 @@ import ( "github.com/spf13/cobra" ) -// Long descriptions are whitespace sensitive when generating docs using sphinx. +// Long descriptions are whitespace sensitive when generating docs using Sphinx. const ( - deleteCmdShort = `Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project.` + deleteCmdShort = `Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project.` deleteCmdLong = ` -Example Delete executions. +Delete a resource; if an execution: :: - bin/flytectl delete execution kxd1i72850 -d development -p flytesnacks + flytectl delete execution kxd1i72850 -d development -p flytesnacks ` ) diff --git a/cmd/delete/execution.go b/cmd/delete/execution.go index 4b41181852..12a0e268fc 100644 --- a/cmd/delete/execution.go +++ b/cmd/delete/execution.go @@ -11,42 +11,41 @@ import ( "github.com/flyteorg/flytestdlib/logger" ) -// Long descriptions are whitespace sensitive when generating docs using sphinx. +// Long descriptions are whitespace sensitive when generating docs using Sphinx. const ( execCmdShort = `Terminate/Delete execution resources.` execCmdLong = ` Terminate executions.(execution,executions can be used interchangeably in these commands) -Task executions can be aborted only if they are in non-terminal state i.e if they are FAILED,ABORTED or SUCCEEDED then -calling terminate on them has no effect. +Task executions can be aborted only if they are in non-terminal state. If they are FAILED, ABORTED or SUCCEEDED, calling terminate on them has no effect. -Terminate a single execution with its name +Terminate a single execution with its name: :: - bin/flytectl delete execution c6a51x2l9e -d development -p flytesnacks + flytectl delete execution c6a51x2l9e -d development -p flytesnacks -You can get executions to check its state. +Get executions to check its state: :: - bin/flytectl get execution -d development -p flytesnacks + flytectl get execution -d development -p flytesnacks ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | NAME (7) | WORKFLOW NAME | TYPE | PHASE | STARTED | ELAPSED TIME | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | c6a51x2l9e | recipes.core.basic.lp.go_greet | WORKFLOW | ABORTED | 2021-02-17T08:13:04.680476300Z | 15.540361300s | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- -Terminate multiple executions with there names +Terminate multiple executions with their names: :: - bin/flytectl delete execution eeam9s8sny p4wv4hwgc4 -d development -p flytesnacks + flytectl delete execution eeam9s8sny p4wv4hwgc4 -d development -p flytesnacks -Similarly you can get executions to find the state of previously terminated executions. +Get executions to find the state of previously terminated executions: :: - bin/flytectl get execution -d development -p flytesnacks + flytectl get execution -d development -p flytesnacks ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | NAME (7) | WORKFLOW NAME | TYPE | PHASE | STARTED | ELAPSED TIME | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- diff --git a/cmd/delete/matchable_cluster_resource_attribute.go b/cmd/delete/matchable_cluster_resource_attribute.go index c6f71fec35..8b4b6fb4dc 100644 --- a/cmd/delete/matchable_cluster_resource_attribute.go +++ b/cmd/delete/matchable_cluster_resource_attribute.go @@ -11,21 +11,20 @@ import ( ) const ( - clusterResourceAttributesShort = "Deletes matchable resources of cluster attributes" + clusterResourceAttributesShort = "Delete matchable resources of cluster attributes" clusterResourceAttributesLong = ` -Deletes cluster resource attributes for given project and domain combination or additionally with workflow name. +Deletes cluster resource attributes for the given project and domain combination or additionally with workflow name. -Deletes cluster resource attribute for project and domain -Here the command delete cluster resource attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete cluster-resource-attribute -p flytectldemo -d development -Deletes cluster resource attribute using config file which was used for creating it. -Here the command deletes cluster resource attributes from the config file cra.yaml -Attributes are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of cra.yaml which will use the project domain and workflow name for deleting the resource +Deletes cluster resource attribute using config file which was used to create it. +Here, the config file is written to cra.yaml. +Attributes are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of cra.yaml: :: @@ -40,8 +39,8 @@ eg: content of cra.yaml which will use the project domain and workflow name for foo: "bar" buzz: "lightyear" -Deletes cluster resource attribute for a workflow -Here the command deletes cluster resource attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes cluster resource attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/delete/matchable_execution_cluster_label.go b/cmd/delete/matchable_execution_cluster_label.go index 4149b5e18b..e8ed9c04ae 100644 --- a/cmd/delete/matchable_execution_cluster_label.go +++ b/cmd/delete/matchable_execution_cluster_label.go @@ -11,21 +11,20 @@ import ( ) const ( - executionClusterLabelShort = "Deletes matchable resources of execution cluster label" + executionClusterLabelShort = "Delete matchable resources of execution cluster label" executionClusterLabelLong = ` Deletes execution cluster label for given project and domain combination or additionally with workflow name. -Deletes execution cluster label for project and domain -Here the command delete execution cluster label for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete execution-cluster-label -p flytectldemo -d development Deletes execution cluster label using config file which was used for creating it. -Here the command deletes execution cluster label from the config file ecl.yaml -Value is optional in the file as its unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of ecl.yaml which will use the project domain and workflow name for deleting the resource +Here, the config file is written to ecl.yaml. +Value is optional in the file as it is unread during the delete command but it can be kept since the same file can be used for get, update or delete commands. +e.g., content of ecl.yaml: :: @@ -38,8 +37,8 @@ eg: content of ecl.yaml which will use the project domain and workflow name for project: flytectldemo value: foo -Deletes execution cluster label for a workflow -Here the command deletes execution cluster label for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes execution cluster label for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/delete/matchable_execution_cluster_label_test.go b/cmd/delete/matchable_execution_cluster_label_test.go index fe90153dbf..834e5afb66 100644 --- a/cmd/delete/matchable_execution_cluster_label_test.go +++ b/cmd/delete/matchable_execution_cluster_label_test.go @@ -40,10 +40,10 @@ func TestDeleteExecutionClusterLabels(t *testing.T) { deleteExecutionClusterLabelSetup() // No args implying project domain attribute deletion u.DeleterExt.OnDeleteProjectDomainAttributesMatch(mock.Anything, mock.Anything, mock.Anything, - mock.Anything).Return(fmt.Errorf("failed to delte project domain attributes")) + mock.Anything).Return(fmt.Errorf("failed to delete project domain attributes")) err = deleteExecutionClusterLabel(ctx, args, cmdCtx) assert.NotNil(t, err) - assert.Equal(t, fmt.Errorf("failed to delte project domain attributes"), err) + assert.Equal(t, fmt.Errorf("failed to delete project domain attributes"), err) u.DeleterExt.AssertCalled(t, "DeleteProjectDomainAttributes", ctx, config.GetConfig().Project, config.GetConfig().Domain, admin.MatchableResource_EXECUTION_CLUSTER_LABEL) }) diff --git a/cmd/delete/matchable_execution_queue_attribute.go b/cmd/delete/matchable_execution_queue_attribute.go index 6bc5a47aae..d3b77a62c5 100644 --- a/cmd/delete/matchable_execution_queue_attribute.go +++ b/cmd/delete/matchable_execution_queue_attribute.go @@ -11,21 +11,20 @@ import ( ) const ( - executionQueueAttributesShort = "Deletes matchable resources of execution queue attributes" + executionQueueAttributesShort = "Delete matchable resources of execution queue attributes" executionQueueAttributesLong = ` -Deletes execution queue attributes for given project and domain combination or additionally with workflow name. +Deletes execution queue attributes for the given project and domain combination or additionally with workflow name. -Deletes execution queue attribute for project and domain -Here the command delete execution queue attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete execution-queue-attribute -p flytectldemo -d development Deletes execution queue attribute using config file which was used for creating it. -Here the command deletes execution queue attributes from the config file era.yaml -Tags are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of era.yaml which will use the project domain and workflow name for deleting the resource +Here, the config file is written to era.yaml. +Value is optional in the file as it is unread during the delete command but it can be kept since the same file can be used for get, update or delete commands. +e.g., content of era.yaml: :: @@ -42,8 +41,8 @@ eg: content of era.yaml which will use the project domain and workflow name for - buzz - lightyear -Deletes execution queue attribute for a workflow -Here the command deletes the execution queue attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes execution queue attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/delete/matchable_plugin_override.go b/cmd/delete/matchable_plugin_override.go index edbe826a82..80b46b35db 100644 --- a/cmd/delete/matchable_plugin_override.go +++ b/cmd/delete/matchable_plugin_override.go @@ -11,22 +11,20 @@ import ( ) const ( - pluginOverrideShort = "Deletes matchable resources of plugin overrides" + pluginOverrideShort = "Delete matchable resources of plugin overrides" pluginOverrideLong = ` -Deletes plugin override for given project and domain combination or additionally with workflow name. +Deletes plugin override for the given project and domain combination or additionally with workflow name. -Deletes plugin override for project and domain -Here the command deletes plugin override for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete plugin-override -p flytectldemo -d development -Deletes plugin override using config file which was used for creating it. -Here the command deletes plugin overrides from the config file po.yaml -Overrides are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of po.yaml which will use the project domain and workflow name for deleting the resource - +Deletes plugin override using config file which was used to create it. +Here, the config file is written to po.yaml. +Overrides are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of po.yaml: :: flytectl delete plugin-override --attrFile po.yaml @@ -43,8 +41,8 @@ eg: content of po.yaml which will use the project domain and workflow name for - plugin_override2 missing_plugin_behavior: 1 # Behavior when no specified plugin_id has an associated handler. 0 : FAIL , 1: DEFAULT -Deletes plugin override for a workflow -Here the command deletes the plugin override for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes plugin override for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/delete/matchable_task_resource_attribute.go b/cmd/delete/matchable_task_resource_attribute.go index 01af86bb6d..90cd11e48f 100644 --- a/cmd/delete/matchable_task_resource_attribute.go +++ b/cmd/delete/matchable_task_resource_attribute.go @@ -11,21 +11,20 @@ import ( ) const ( - taskResourceAttributesShort = "Deletes matchable resources of task attributes" + taskResourceAttributesShort = "Delete matchable resources of task attributes" taskResourceAttributesLong = ` -Deletes task resource attributes for given project,domain combination or additionally with workflow name. +Deletes task resource attributes for the given project and domain combination, or additionally with workflow name. -Deletes task resource attribute for project and domain -Here the command delete task resource attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete task-resource-attribute -p flytectldemo -d development -Deletes task resource attribute using config file which was used for creating it. -Here the command deletes task resource attributes from the config file tra.yaml -defaults/limits are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of tra.yaml which will use the project domain and workflow name for deleting the resource +Deletes task resource attribute using config file which was used to create it. +Here, the config file is written to tra.yaml. +The defaults/limits are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of tra.yaml: :: @@ -43,8 +42,8 @@ eg: content of tra.yaml which will use the project domain and workflow name for cpu: "2" memory: "450Mi" -Deletes task resource attribute for a workflow -Here the command deletes task resource attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes task resource attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/delete/matchable_workflow_execution_config.go b/cmd/delete/matchable_workflow_execution_config.go index fb9d6d5c6b..ee9b612712 100644 --- a/cmd/delete/matchable_workflow_execution_config.go +++ b/cmd/delete/matchable_workflow_execution_config.go @@ -12,21 +12,20 @@ import ( ) const ( - workflowExecutionConfigShort = "Deletes matchable resources of workflow execution config" + workflowExecutionConfigShort = "Delete matchable resources of workflow execution config" workflowExecutionConfigLong = ` -Deletes workflow execution config for given project and domain combination or additionally with workflow name. +Deletes workflow execution config for the given project and domain combination or additionally with workflow name. -Deletes workflow execution config label for project and domain -Here the command delete workflow execution config for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete workflow-execution-config -p flytectldemo -d development -Deletes workflow execution config using config file which was used for creating it. -Here the command deletes workflow execution config from the config file wec.yaml -Max_parallelism is optional in the file as its unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of wec.yaml which will use the project domain and workflow name for deleting the resource +Deletes workflow execution config using config file which was used to create it. +Here, the config file is written to wec.yaml. +Max_parallelism is optional in the file as it is unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of wec.yaml: :: @@ -39,8 +38,8 @@ eg: content of wec.yaml which will use the project domain and workflow name for project: flytectldemo max_parallelism: 5 -Deletes workflow execution config for a workflow -Here the command deletes workflow execution config for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes workflow execution config for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: diff --git a/cmd/get/execution.go b/cmd/get/execution.go index 3cda9d4925..3dcf3f34ae 100644 --- a/cmd/get/execution.go +++ b/cmd/get/execution.go @@ -15,67 +15,67 @@ import ( ) const ( - executionShort = "Gets execution resources" + executionShort = "Get execution resources" executionLong = ` -Retrieve all executions within the project and domain (execution, executions can be used interchangeably). +Retrieve all executions within the project and domain (execution, executions can be used interchangeably): :: - bin/flytectl get execution -p flytesnacks -d development + flytectl get execution -p flytesnacks -d development -Retrieves executions by name within the project and domain. +Retrieve executions by name within the project and domain: :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r + flytectl get execution -p flytesnacks -d development oeh94k9r2r -Retrieves all the executions with filters. +Retrieve all the executions with filters: :: - bin/flytectl get execution -p flytesnacks -d development --filter.fieldSelector="execution.phase in (FAILED;SUCCEEDED),execution.duration<200" + flytectl get execution -p flytesnacks -d development --filter.fieldSelector="execution.phase in (FAILED;SUCCEEDED),execution.duration<200" -Retrieve executions as per the specified limit and sorting parameters. +Retrieve executions as per the specified limit and sorting parameters: :: - bin/flytectl get execution -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get execution -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieve executions within the project and domain in YAML format. +Retrieve executions within the project and domain in YAML format: :: - bin/flytectl get execution -p flytesnacks -d development -o yaml + flytectl get execution -p flytesnacks -d development -o yaml -Retrieve executions within the project and domain in JSON format. +Retrieve executions within the project and domain in JSON format: :: - bin/flytectl get execution -p flytesnacks -d development -o json + flytectl get execution -p flytesnacks -d development -o json Get more details of the execution using the --details flag, which shows node and task executions. The default view is a tree view, and the TABLE view format is not supported on this view. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details + flytectl get execution -p flytesnacks -d development oeh94k9r2r --details Fetch execution details in YAML format. In this view, only node details are available. For task, send the --nodeID flag. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details -o yaml + flytectl get execution -p flytesnacks -d development oeh94k9r2r --details -o yaml Fetch task executions on a specific node using the --nodeID flag. Use the nodeID attribute given by the node details view. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodeID n0 + flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodeID n0 Task execution view is also available in YAML/JSON format. The following example showcases YAML, where the output also contains input and output data of each node. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodID n0 -o yaml + flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodID n0 -o yaml Usage ` diff --git a/cmd/get/get.go b/cmd/get/get.go index e6b750e2f5..181444afec 100644 --- a/cmd/get/get.go +++ b/cmd/get/get.go @@ -19,9 +19,9 @@ import ( // Long descriptions are whitespace sensitive when generating docs using sphinx. const ( - getCmdShort = `Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project.` + getCmdShort = `Fetch various Flyte resources including tasks/workflows/launchplans/executions/project.` getCmdLong = ` -Example get projects. +For project, it is: :: flytectl get project diff --git a/cmd/get/get_test.go b/cmd/get/get_test.go index c6bce31c54..bf22c762f1 100644 --- a/cmd/get/get_test.go +++ b/cmd/get/get_test.go @@ -40,7 +40,7 @@ const ( func TestCreateGetCommand(t *testing.T) { getCommand := CreateGetCommand() assert.Equal(t, getCommand.Use, "get") - assert.Equal(t, getCommand.Short, "Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project.") + assert.Equal(t, getCommand.Short, "Fetch various Flyte resources including tasks/workflows/launchplans/executions/project.") fmt.Println(getCommand.Commands()) assert.Equal(t, len(getCommand.Commands()), 11) cmdNouns := getCommand.Commands() diff --git a/cmd/get/launch_plan.go b/cmd/get/launch_plan.go index 79aa4822b3..531504d41c 100644 --- a/cmd/get/launch_plan.go +++ b/cmd/get/launch_plan.go @@ -14,62 +14,62 @@ import ( ) const ( - launchPlanShort = "Gets launch plan resources" + launchPlanShort = "Get launch plan resources" launchPlanLong = ` -Retrieve all launch plans within the project and domain (launchplan, launchplans can be used interchangeably). +Retrieve all launch plans within the project and domain (launch plan, launch plans can be used interchangeably): :: flytectl get launchplan -p flytesnacks -d development - Retrieve a launch plan by name within the project and domain. + Retrieve a launch plan by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet -Retrieve the latest version of the task by name within the project and domain. +Retrieve the latest version of the task by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet --latest -Retrieves a particular version of the launch plan by name within the project and domain. +Retrieve a particular version of the launch plan by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet --version v2 -Retrieves all the launch plans with filters. +Retrieve all the launch plans with filters: :: - bin/flytectl get launchplan -p flytesnacks -d development --filter.fieldSelector="name=core.basic.lp.go_greet" + flytectl get launchplan -p flytesnacks -d development --filter.fieldSelector="name=core.basic.lp.go_greet" -Retrieves launch plans entity search across all versions with filters. +Retrieve launch plans entity search across all versions with filters: :: - bin/flytectl get launchplan -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="version=v1" + flytectl get launchplan -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="version=v1" -Retrieves all the launch plans with limit and sorting. +Retrieve all the launch plans with limit and sorting: :: - bin/flytectl get launchplan -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get launchplan -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all launch plans within the project and domain in YAML format. +Retrieve all launch plans within the project and domain in YAML format: :: flytectl get launchplan -p flytesnacks -d development -o yaml -Retrieves all launch plans the within the project and domain in JSON format. +Retrieve all launch plans the within the project and domain in JSON format: :: flytectl get launchplan -p flytesnacks -d development -o json -Retrieve a launch plan within the project and domain as per a version and generate the execution spec file; the file can be used to launch the execution using the 'create execution' command. +Retrieve a launch plan within the project and domain as per a version and generate the execution spec file; the file can be used to launch the execution using the 'create execution' command: :: diff --git a/cmd/get/matchable_cluster_resource_attribute.go b/cmd/get/matchable_cluster_resource_attribute.go index 7750a30ee2..9682ec271d 100644 --- a/cmd/get/matchable_cluster_resource_attribute.go +++ b/cmd/get/matchable_cluster_resource_attribute.go @@ -11,35 +11,35 @@ import ( ) const ( - clusterResourceAttributesShort = "Gets matchable resources of cluster resource attributes." + clusterResourceAttributesShort = "Get matchable resources of cluster resource attributes." clusterResourceAttributesLong = ` -Retrieve cluster resource attributes for the given project and domain. -Here, the command gets cluster resource attributes for the project flytectldemo and development domain. +Retrieves cluster resource attributes for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get cluster-resource-attribute -p flytectldemo -d development -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","attributes":{"buzz":"lightyear","foo":"bar"}} -Retrieve cluster resource attributes for the given project, domain, and workflow. -Here, the command gets cluster resource attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves cluster resource attributes for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort': :: flytectl get cluster-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","attributes":{"buzz":"lightyear","foo":"bar"}} -Writes the cluster resource attributes to a file. If there are no cluster resource attributes,the command throws an error. -Here, the command gets the task resource attributes and writes the config file to cra.yaml file. -eg: content of cra.yaml +Writes the cluster resource attributes to a file. If there are no cluster resource attributes, the command throws an error. +Here, the config file is written to cra.yaml file: +e.g., content of cra.yaml :: diff --git a/cmd/get/matchable_execution_cluster_label.go b/cmd/get/matchable_execution_cluster_label.go index 8a5227d736..a8ebb50514 100644 --- a/cmd/get/matchable_execution_cluster_label.go +++ b/cmd/get/matchable_execution_cluster_label.go @@ -11,37 +11,36 @@ import ( ) const ( - executionClusterLabelShort = "Gets matchable resources of execution cluster label." + executionClusterLabelShort = "Get matchable resources of execution cluster label." executionClusterLabelLong = ` -// Retrieves the execution cluster label for a given project and domain, combination or additionally with workflow name. +Retrieves the execution cluster label for a given project and domain, combination or additionally with workflow name. -Retrieve the execution cluster label for the given project and domain. -Here the command get execution cluster label for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl get execution-cluster-label -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","value":"foo"} Retrieve the execution cluster label for the given project, domain and workflow. -Here, the command gets the execution cluster label for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get execution-cluster-label -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","value":"foo"} -Writes the execution cluster label to a file. If there is no execution cluster label, command throws an error. -Here, the command gets the execution cluster label and writes the config file to ecl.yaml file. -eg: content of ecl.yaml +Write the execution cluster label to a file. If there is no execution cluster label, the command throws an error. +Here, the config file is written to ecl.yaml, +e.g., content of ecl.yaml: :: diff --git a/cmd/get/matchable_execution_queue_attribute.go b/cmd/get/matchable_execution_queue_attribute.go index 0fea10ee56..34b73c139e 100644 --- a/cmd/get/matchable_execution_queue_attribute.go +++ b/cmd/get/matchable_execution_queue_attribute.go @@ -11,35 +11,35 @@ import ( ) const ( - executionQueueAttributesShort = "Gets matchable resources of execution queue attributes" + executionQueueAttributesShort = "Get matchable resources of execution queue attributes" executionQueueAttributesLong = ` -Retrieve the execution queue attribute for the given project and domain. -Here, the command gets execution queue attributes for the project flytectldemo and development domain. +Retrieves the execution queue attribute for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get execution-queue-attribute -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","tags":["foo", "bar"]} -Retrieve the execution queue attribute for the given project, domain, and workflow. -Here, the command gets execution queue attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves the execution queue attribute for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get execution-queue-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","tags":["foo", "bar"]} Write the execution queue attribute to a file. If there are no execution queue attributes, the command throws an error. -Here, the command gets the execution queue attributes and writes the config to era.yaml file. -e.g. : content of era.yaml +Here, the config file is written to era.yaml, +e.g., content of era.yaml: :: diff --git a/cmd/get/matchable_plugin_override.go b/cmd/get/matchable_plugin_override.go index 8c8f5986dc..eb8e0fdd0c 100644 --- a/cmd/get/matchable_plugin_override.go +++ b/cmd/get/matchable_plugin_override.go @@ -11,16 +11,16 @@ import ( ) const ( - pluginOverrideShort = "Gets matchable resources of plugin override" + pluginOverrideShort = "Get matchable resources of plugin override" pluginOverrideLong = ` -Retrieve the plugin overrides for the given project and domain. -Here, the command gets the plugin overrides for the project flytectldemo and development domain. +Retrieves the plugin override for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get plugin-override -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json @@ -34,14 +34,14 @@ e.g. : output from the command }] } -Retrieves the plugin overrides for project, domain and workflow -Here the command gets the plugin overrides for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort +Retrieves the plugin override for the given project, domain and workflow. +For project flytectldemo, development domain and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get plugin-override -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command: .. code-block:: json @@ -56,9 +56,9 @@ e.g. : output from the command }] } -Writing the plugin overrides to a file. If there are no plugin overrides, command would return an error. -Here the command gets plugin overrides and writes the config file to po.yaml -eg: content of po.yaml +Write plugin overrides to a file. If there are no plugin overrides, the command returns an error. +Here, the config file is written to po.yaml, +e.g., content of po.yaml: :: diff --git a/cmd/get/matchable_task_resource_attribute.go b/cmd/get/matchable_task_resource_attribute.go index 2c27bb6f46..6636976350 100644 --- a/cmd/get/matchable_task_resource_attribute.go +++ b/cmd/get/matchable_task_resource_attribute.go @@ -11,27 +11,27 @@ import ( ) const ( - taskResourceAttributesShort = "Gets matchable resources of task attributes" + taskResourceAttributesShort = "Get matchable resources of task attributes" taskResourceAttributesLong = ` -Retrieve task resource attributes for the given project and domain. -Here, the command gets the task resource attributes for the project flytectldemo and development domain. +Retrieves task resource attributes for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get task-resource-attribute -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command: .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"","defaults":{"cpu":"1","memory":"150Mi"},"limits":{"cpu":"2","memory":"450Mi"}} -Retrieve task resource attributes for the given project, domain, and workflow. -Here, the command gets task resource attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves task resource attributes for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get task-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command: .. code-block:: json @@ -39,8 +39,8 @@ e.g. : output from the command Write the task resource attributes to a file. If there are no task resource attributes, a file would be populated with the basic data. -Here the command gets task resource attributes and writes the config file to tra.yaml -e.g. : content of tra.yaml +Here, the config file is written to tra.yaml, +e.g., content of tra.yaml: :: diff --git a/cmd/get/matchable_workflow_execution_config.go b/cmd/get/matchable_workflow_execution_config.go index 1afbc4324f..afb1d3b0f8 100644 --- a/cmd/get/matchable_workflow_execution_config.go +++ b/cmd/get/matchable_workflow_execution_config.go @@ -12,18 +12,17 @@ import ( ) const ( - workflowExecutionConfigShort = "Gets matchable resources of workflow execution config" + workflowExecutionConfigShort = "Get matchable resources of workflow execution config" workflowExecutionConfigLong = ` -Retrieves workflow execution config for given project and domain combination or additionally with workflow name. +Retrieves workflow execution config for the given project and domain combination or additionally with workflow name. -Retrieves workflow execution config for project and domain -Here the command get workflow execution config for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl get workflow-execution-config -p flytectldemo -d development -eg : output from the command +e.g., output from the command .. code-block:: json @@ -33,14 +32,14 @@ eg : output from the command "max_parallelism": 5 } -Retrieves workflow execution config for project and domain and workflow -Here the command get workflow execution config for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Retrieves workflow execution config for the project, domain and workflow. +For project flytectldemo, development domain and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get workflow-execution-config -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json @@ -51,9 +50,9 @@ eg : output from the command "max_parallelism": 5 } -Writing the workflow execution config to a file. If there are no workflow execution config, command would return an error. -Here the command gets workflow execution config and writes the config file to wec.yaml -eg: content of wec.yaml +Writing the workflow execution config to a file. If there are no workflow execution config, the command would return an error. +Here, the config file is written to wec.yaml, +e.g., content of wec.yaml: :: diff --git a/cmd/get/project.go b/cmd/get/project.go index 10148a1c07..4912d4b5fc 100644 --- a/cmd/get/project.go +++ b/cmd/get/project.go @@ -15,40 +15,40 @@ import ( ) const ( - projectShort = "Gets project resources" + projectShort = "Get project resources" projectLong = ` -Retrieves all the projects.(project,projects can be used interchangeably in these commands) +Retrieve all the projects. (project,projects can be used interchangeably in these commands): :: - bin/flytectl get project + flytectl get project -Retrieves project by name +Retrieve project by name: :: - bin/flytectl get project flytesnacks + flytectl get project flytesnacks -Retrieves all the projects with filters. +Retrieve all the projects with filters: :: - bin/flytectl get project --filter.fieldSelector="project.name=flytesnacks" + flytectl get project --filter.fieldSelector="project.name=flytesnacks" -Retrieves all the projects with limit and sorting. +Retrieve all the projects with limit and sorting: :: - bin/flytectl get project --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get project --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the projects in yaml format +Retrieve all the projects in yaml format: :: - bin/flytectl get project -o yaml + flytectl get project -o yaml -Retrieves all the projects in json format +Retrieve all the projects in json format: :: - bin/flytectl get project -o json + flytectl get project -o json Usage ` diff --git a/cmd/get/task.go b/cmd/get/task.go index 63b490ae82..c1f103dea4 100644 --- a/cmd/get/task.go +++ b/cmd/get/task.go @@ -14,64 +14,64 @@ import ( ) const ( - taskShort = "Gets task resources" + taskShort = "Get task resources" taskLong = ` -Retrieves all the task within project and domain.(task,tasks can be used interchangeably in these commands) +Retrieve all the tasks within project and domain(task,tasks can be used interchangeably in these commands): :: - bin/flytectl get task -p flytesnacks -d development + flytectl get task -p flytesnacks -d development -Retrieves task by name within project and domain. +Retrieve task by name within project and domain: :: - bin/flytectl task -p flytesnacks -d development core.basic.lp.greet + flytectl task -p flytesnacks -d development core.basic.lp.greet -Retrieves latest version of task by name within project and domain. +Retrieve latest version of task by name within project and domain: :: flytectl get task -p flytesnacks -d development core.basic.lp.greet --latest -Retrieves particular version of task by name within project and domain. +Retrieve particular version of task by name within project and domain: :: flytectl get task -p flytesnacks -d development core.basic.lp.greet --version v2 -Retrieves all the tasks with filters. +Retrieve all the tasks with filters: :: - bin/flytectl get task -p flytesnacks -d development --filter.fieldSelector="task.name=k8s_spark.pyspark_pi.print_every_time,task.version=v1" + flytectl get task -p flytesnacks -d development --filter.fieldSelector="task.name=k8s_spark.pyspark_pi.print_every_time,task.version=v1" -Retrieve a specific task with filters. +Retrieve a specific task with filters: :: - bin/flytectl get task -p flytesnacks -d development k8s_spark.pyspark_pi.print_every_time --filter.fieldSelector="task.version=v1,created_at>=2021-05-24T21:43:12.325335Z" + flytectl get task -p flytesnacks -d development k8s_spark.pyspark_pi.print_every_time --filter.fieldSelector="task.version=v1,created_at>=2021-05-24T21:43:12.325335Z" -Retrieves all the task with limit and sorting. +Retrieve all the tasks with limit and sorting: :: - bin/flytectl get -p flytesnacks -d development task --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get -p flytesnacks -d development task --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the tasks within project and domain in yaml format. +Retrieve all the tasks within project and domain in yaml format: :: - bin/flytectl get task -p flytesnacks -d development -o yaml + flytectl get task -p flytesnacks -d development -o yaml -Retrieves all the tasks within project and domain in json format. +Retrieve all the tasks within project and domain in json format: :: - bin/flytectl get task -p flytesnacks -d development -o json + flytectl get task -p flytesnacks -d development -o json -Retrieves a tasks within project and domain for a version and generate the execution spec file for it to be used for launching the execution using create execution. +Retrieve tasks within project and domain for a version and generate the execution spec file for it to be used for launching the execution using create execution: :: - bin/flytectl get tasks -d development -p flytesnacks core.advanced.run_merge_sort.merge --execFile execution_spec.yaml --version v2 + flytectl get tasks -d development -p flytesnacks core.advanced.run_merge_sort.merge --execFile execution_spec.yaml --version v2 -The generated file would look similar to this +The generated file would look similar to this: .. code-block:: yaml diff --git a/cmd/get/workflow.go b/cmd/get/workflow.go index 2670b7f10d..0b80e652e3 100644 --- a/cmd/get/workflow.go +++ b/cmd/get/workflow.go @@ -16,65 +16,65 @@ import ( ) const ( - workflowShort = "Gets workflow resources" + workflowShort = "Get workflow resources" workflowLong = ` -Retrieves all the workflows within project and domain.(workflow,workflows can be used interchangeably in these commands) +Retrieve all the workflows within project and domain (workflow,workflows can be used interchangeably in these commands): :: flytectl get workflow -p flytesnacks -d development -Retrieves workflow by name within project and domain. +Retrieve workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet -Retrieves latest version of workflow by name within project and domain. +Retrieve latest version of workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet --latest -Retrieves particular version of workflow by name within project and domain. +Retrieve particular version of workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet --version v2 -Retrieves all the workflows with filters. +Retrieve all the workflows with filters: :: - bin/flytectl get workflow -p flytesnacks -d development --filter.fieldSelector="workflow.name=k8s_spark.dataframe_passing.my_smart_schema" + flytectl get workflow -p flytesnacks -d development --filter.fieldSelector="workflow.name=k8s_spark.dataframe_passing.my_smart_schema" -Retrieve specific workflow with filters. +Retrieve specific workflow with filters: :: - bin/flytectl get workflow -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="workflow.version=v1" + flytectl get workflow -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="workflow.version=v1" -Retrieves all the workflows with limit and sorting. +Retrieve all the workflows with limit and sorting: :: - bin/flytectl get -p flytesnacks -d development workflow --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get -p flytesnacks -d development workflow --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the workflow within project and domain in yaml format. +Retrieve all the workflows within project and domain in yaml format: :: flytectl get workflow -p flytesnacks -d development -o yaml -Retrieves all the workflow within project and domain in json format. +Retrieve all the workflow within project and domain in json format: :: flytectl get workflow -p flytesnacks -d development -o json -Visualize the graph for a workflow within project and domain in dot format. +Visualize the graph for a workflow within project and domain in dot format: :: flytectl get workflow -p flytesnacks -d development core.flyte_basics.basic_workflow.my_wf --latest -o dot -Visualize the graph for a workflow within project and domain in a dot content render. +Visualize the graph for a workflow within project and domain in a dot content render: :: diff --git a/cmd/register/examples.go b/cmd/register/examples.go index 3e1b805554..c27ca67409 100644 --- a/cmd/register/examples.go +++ b/cmd/register/examples.go @@ -13,19 +13,19 @@ import ( ) const ( - registerExampleShort = "Registers flytesnack example" + registerExampleShort = "Register Flytesnacks example" registerExampleLong = ` -Registers all latest flytesnacks example +Register all latest Flytesnacks examples: :: - bin/flytectl register examples -d development -p flytesnacks + flytectl register examples -d development -p flytesnacks -Registers specific release of flytesnacks example +Register specific release of Flytesnacks examples: :: - bin/flytectl register examples -d development -p flytesnacks --version v0.2.176 + flytectl register examples -d development -p flytesnacks --version v0.2.176 -Note: register command automatically override the version with release version +Note: The register command automatically override the version with release version Usage ` ) diff --git a/cmd/register/files.go b/cmd/register/files.go index d1b16a18b3..b2801d53ef 100644 --- a/cmd/register/files.go +++ b/cmd/register/files.go @@ -14,77 +14,77 @@ import ( ) const ( - registerFilesShort = "Registers file resources" + registerFilesShort = "Register file resources" registerFilesLong = ` Registers all the serialized protobuf files including tasks, workflows and launchplans with default v1 version. -If there are already registered entities with v1 version then the command will fail immediately on the first such encounter. +If previously registered entities with v1 version are present, the command will fail immediately on the first such encounter. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks + flytectl register file _pb_output/* -d development -p flytesnacks -There is no difference between registration and fast registration, In fast registration, the input provided by the user is fast serialized proto that is generated by pyflyte. If Flytectl finds any source code in users's input then it will consider registration as fast registration. Flytectl finds input file by searching an archive file whose name starts with fast and has .tar.gz extension When the user runs pyflyte with --fast flag then pyflyte creates serialize proto and it also archive create source code archive file in the same directory. -SourceUploadPath is an optional flag. By default, flytectl will create SourceUploadPath from your storage config. In case of s3 flytectl will upload code base in s3://{{DEFINE_BUCKET_IN_STORAGE_CONFIG}}/fast/{{VERSION}}-fast{{MD5_CREATED_BY_PYFLYTE}.tar.gz}. +There is no difference between registration and fast registration. In fast registration, the input provided by the user is fast serialized proto that is generated by pyflyte. If FlyteCTL finds any source code in users' input, it considers the registration as fast registration. FlyteCTL finds input file by searching an archive file whose name starts with fast and has .tar.gz extension. When the user runs pyflyte with --fast flag then pyflyte creates serialize proto and it also creates source code archive file in the same directory. +SourceUploadPath is an optional flag. By default, FlyteCTL will create SourceUploadPath from your storage config. In case of s3 FlyteCTL will upload code base in s3://{{DEFINE_BUCKET_IN_STORAGE_CONFIG}}/fast/{{VERSION}}-fast{{MD5_CREATED_BY_PYFLYTE}.tar.gz}. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 -In case of fast registration, If the SourceUploadPath flag is defined then In this case flytectl will not use the default directory for uploading the source code, it will override the destination path on the registration +In case of fast registration, if the SourceUploadPath flag is defined, FlyteCTL will not use the default directory to upload the source code. Instead, it will override the destination path on the registration. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 --SourceUploadPath="s3://dummy/fast" + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 --SourceUploadPath="s3://dummy/fast" -Using archive file.Currently supported are .tgz and .tar extension files and can be local or remote file served through http/https. -Use --archive flag. +Using archive file. Currently supported extensions are .tgz and .tar. They can be local or remote files served through http/https. +Use --archive flag: :: - bin/flytectl register files http://localhost:8080/_pb_output.tar -d development -p flytesnacks --archive + flytectl register files http://localhost:8080/_pb_output.tar -d development -p flytesnacks --archive -Using local tgz file. +Using local tgz file: :: - bin/flytectl register files _pb_output.tgz -d development -p flytesnacks --archive + flytectl register files _pb_output.tgz -d development -p flytesnacks --archive -If you want to continue executing registration on other files ignoring the errors including version conflicts then pass in the continueOnError flag. +If you wish to continue executing registration on other files by ignoring the errors including the version conflicts, then send the continueOnError flag: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -Using short format of continueOnError flag +Using short format of continueOnError flag: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -Overriding the default version v1 using version string. +Override the default version v1 using version string: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 -Change the o/p format has not effect on registration. The O/p is currently available only in table format. +Changing the o/p format has no effect on the registration. The O/p is currently available only in table format: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -o yaml + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -o yaml -Override IamRole during registration. +Override IamRole during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -i "arn:aws:iam::123456789:role/dummy" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -i "arn:aws:iam::123456789:role/dummy" -Override Kubernetes service account during registration. +Override Kubernetes service account during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -k "kubernetes-service-account" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -k "kubernetes-service-account" -Override Output location prefix during registration. +Override Output location prefix during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -l "s3://dummy/prefix" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -l "s3://dummy/prefix" Usage ` diff --git a/cmd/register/register.go b/cmd/register/register.go index ccc95a5127..469a3811a9 100644 --- a/cmd/register/register.go +++ b/cmd/register/register.go @@ -9,12 +9,12 @@ import ( // Long descriptions are whitespace sensitive when generating docs using sphinx. const ( - registerCmdShort = "Registers tasks/workflows/launchplans from list of generated serialized files." + registerCmdShort = "Register tasks/workflows/launchplans from a list of generated serialized files." registercmdLong = ` Takes input files as serialized versions of the tasks/workflows/launchplans and registers them with flyteadmin. -Currently these input files are protobuf files generated as output from flytekit serialize. -Project & Domain are mandatory fields to be passed for registration and an optional version which defaults to v1 -If the entities are already registered with flyte for the same version then registration would fail. +Currently, these input files are protobuf files generated as output from Flytekit serialize. +Project & Domain are mandatory fields to be passed for registration and an optional version which defaults to v1. +If the entities are already registered with Flyte for the same version, the registration would fail. ` ) diff --git a/cmd/register/register_test.go b/cmd/register/register_test.go index 33f48dddd3..cf3b725fcd 100644 --- a/cmd/register/register_test.go +++ b/cmd/register/register_test.go @@ -27,7 +27,7 @@ var setup = u.Setup func TestRegisterCommand(t *testing.T) { registerCommand := RemoteRegisterCommand() assert.Equal(t, registerCommand.Use, "register") - assert.Equal(t, registerCommand.Short, "Registers tasks/workflows/launchplans from list of generated serialized files.") + assert.Equal(t, registerCommand.Short, "Register tasks/workflows/launchplans from a list of generated serialized files.") fmt.Println(registerCommand.Commands()) assert.Equal(t, len(registerCommand.Commands()), 2) cmdNouns := registerCommand.Commands() @@ -38,9 +38,9 @@ func TestRegisterCommand(t *testing.T) { assert.Equal(t, cmdNouns[0].Use, "examples") assert.Equal(t, cmdNouns[0].Aliases, []string{"example", "flytesnack", "flytesnacks"}) - assert.Equal(t, cmdNouns[0].Short, "Registers flytesnack example") + assert.Equal(t, cmdNouns[0].Short, "Register Flytesnacks example") assert.Equal(t, cmdNouns[1].Use, "files") assert.Equal(t, cmdNouns[1].Aliases, []string{"file"}) - assert.Equal(t, cmdNouns[1].Short, "Registers file resources") + assert.Equal(t, cmdNouns[1].Short, "Register file resources") } diff --git a/cmd/root.go b/cmd/root.go index 5da86063ce..98c646c37a 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -42,9 +42,9 @@ const ( func newRootCmd() *cobra.Command { rootCmd := &cobra.Command{ PersistentPreRunE: initConfig, - Long: "flytectl is CLI tool written in go to interact with flyteadmin service", - Short: "flyetcl CLI tool", - Use: "flytectl", + Long: "FlyteCTL is CLI tool written in go to interact with Flyteadmin service", + Short: "FlyteCTL CLI tool", + Use: "FlyteCTL", DisableAutoGenTag: true, } diff --git a/cmd/sandbox/exec.go b/cmd/sandbox/exec.go index bc42048a86..98f584aa64 100644 --- a/cmd/sandbox/exec.go +++ b/cmd/sandbox/exec.go @@ -11,10 +11,10 @@ import ( const ( execShort = "Execute non-interactive command inside the sandbox container" execLong = ` -Execute command will run non-interactive command inside the sandbox container and return immediately with the output.By default flytectl exec in /root directory inside the sandbox container +Runs non-interactive command inside the Sandbox container and immediately returns the output. By default, flytectl exec is present in /root directory inside the Sandbox container. :: - bin/flytectl sandbox exec -- ls -al + flytectl sandbox exec -- ls -al Usage` ) diff --git a/cmd/sandbox/sandbox.go b/cmd/sandbox/sandbox.go index b269f378be..ea639fa4a4 100644 --- a/cmd/sandbox/sandbox.go +++ b/cmd/sandbox/sandbox.go @@ -10,29 +10,29 @@ import ( const ( sandboxShort = `Used for sandbox interactions like start/teardown/status/exec.` sandboxLong = ` -The Flyte Sandbox is a fully standalone minimal environment for running Flyte. provides a simplified way of running flyte-sandbox as a single Docker container running locally. +The Flyte Sandbox is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte sandbox as a single Docker container locally. -Create sandbox cluster. +Create sandbox cluster: :: - bin/flytectl sandbox start + flytectl sandbox start -Remove sandbox cluster. +Remove sandbox cluster: :: - bin/flytectl sandbox teardown + flytectl sandbox teardown -Check status of sandbox container. +Check status of sandbox container: :: - bin/flytectl sandbox status + flytectl sandbox status -Execute command inside sandbox container. +Execute command inside sandbox container: :: - bin/flytectl sandbox exec -- pwd + flytectl sandbox exec -- pwd ` ) diff --git a/cmd/sandbox/start.go b/cmd/sandbox/start.go index 720b6f1a1d..73f1a083be 100644 --- a/cmd/sandbox/start.go +++ b/cmd/sandbox/start.go @@ -32,32 +32,32 @@ import ( const ( startShort = "Start the flyte sandbox cluster" startLong = ` -The Flyte Sandbox is a fully standalone minimal environment for running Flyte. provides a simplified way of running flyte-sandbox as a single Docker container running locally. +The Flyte Sandbox is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte sandbox as a single Docker container locally. -Start sandbox cluster without any source code +Start sandbox cluster without any source code: :: flytectl sandbox start -Mount your source code repository inside sandbox +Mount your source code repository inside sandbox: :: flytectl sandbox start --source=$HOME/flyteorg/flytesnacks -Run specific version of flyte. flytectl sandbox only support flyte version available in Github release https://github.com/flyteorg/flyte/tags +Run specific version of Flyte. FlyteCTL sandbox only supports Flyte version available in the Github release, https://github.com/flyteorg/flyte/tags. :: flytectl sandbox start --version=v0.14.0 -Note: Flytectl sandbox is only supported for Flyte versions > v0.10.0 +Note: FlyteCTL sandbox is only supported for Flyte versions > v0.10.0 -Specify a Flyte Sandbox compliant image with the registry. This is useful, in case you want to use an image from your registry. +Specify a Flyte Sandbox compliant image with the registry. This is useful in case you want to use an image from your registry. :: flytectl sandbox start --image docker.io/my-override:latest -Specify a Flyte Sandbox image pull policy. Possible pull policy values are Always, IfNotPresent, or Never +Specify a Flyte Sandbox image pull policy. Possible pull policy values are Always, IfNotPresent, or Never: :: flytectl sandbox start --image docker.io/my-override:latest --imagePullPolicy Always diff --git a/cmd/sandbox/status.go b/cmd/sandbox/status.go index c9493b4509..bff5230c11 100644 --- a/cmd/sandbox/status.go +++ b/cmd/sandbox/status.go @@ -10,15 +10,14 @@ import ( ) const ( - statusShort = "Get the status of the sandbox environment." + statusShort = "Get status of the sandbox environment." statusLong = ` -Status will retrieve the status of the Sandbox environment. Currently FlyteSandbox runs as a local docker container. -This will return the docker status for this container +Retrieve the status of the Sandbox environment. Currently, Flyte Sandbox runs as a local Docker container. Usage :: - bin/flytectl sandbox status + flytectl sandbox status ` ) diff --git a/cmd/sandbox/teardown.go b/cmd/sandbox/teardown.go index 544880b997..3d42e7c7c5 100644 --- a/cmd/sandbox/teardown.go +++ b/cmd/sandbox/teardown.go @@ -15,12 +15,12 @@ import ( ) const ( - teardownShort = "Teardown will cleanup the sandbox environment" + teardownShort = "Teardown cleans up the sandbox environment" teardownLong = ` -Teardown will remove sandbox cluster and all the flyte config created by sandbox start +Teardown removes Sandbox cluster and all the Flyte config created by sandbox start: :: - bin/flytectl sandbox teardown + flytectl sandbox teardown Usage diff --git a/cmd/update/launch_plan.go b/cmd/update/launch_plan.go index a9dd059c5c..0c2a3267dd 100644 --- a/cmd/update/launch_plan.go +++ b/cmd/update/launch_plan.go @@ -14,14 +14,14 @@ import ( ) const ( - updateLPShort = "Updates launch plan status" + updateLPShort = "Update launch plan status" updateLPLong = ` -Activating launchplan activates the scheduled job associated with it +Activating launch plan activates the scheduled job associated with it: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --version v1 --activate -Archiving launchplan deschedules any scheduled job associated with it +Archiving launch plan deschedules any scheduled job associated with it: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --version v1 --archive diff --git a/cmd/update/launch_plan_meta.go b/cmd/update/launch_plan_meta.go index 00cd9bef36..d2a9678667 100644 --- a/cmd/update/launch_plan_meta.go +++ b/cmd/update/launch_plan_meta.go @@ -11,19 +11,19 @@ import ( ) const ( - updateLPMetaShort = "Updates launch plan metadata" + updateLPMetaShort = "Update launch plan metadata" updateLPMetaLong = ` -Following command updates the description on the launchplan. +Update the description on the launch plan: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --description "Mergesort example" -Archiving launchplan named entity is not supported and would throw an error. +Archiving launch plan named entity is not supported and would throw an error: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive -Activating launchplan named entity would be a noop. +Activating launch plan named entity would be a noop: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate diff --git a/cmd/update/matchable_cluster_resource_attribute.go b/cmd/update/matchable_cluster_resource_attribute.go index 4938245a3b..2e8f2a2077 100644 --- a/cmd/update/matchable_cluster_resource_attribute.go +++ b/cmd/update/matchable_cluster_resource_attribute.go @@ -10,13 +10,13 @@ import ( ) const ( - clusterResourceAttributesShort = "Updates matchable resources of cluster attributes" + clusterResourceAttributesShort = "Update matchable resources of cluster attributes" clusterResourceAttributesLong = ` Updates cluster resource attributes for given project and domain combination or additionally with workflow name. -Updating to the cluster resource attribute is only available from a generated file. See the get section for generating this file. -Here the command updates takes the input for cluster resource attributes from the config file cra.yaml -eg: content of cra.yaml +Updating to the cluster resource attribute is only available from a generated file. See the get section to generate this file. +It takes input for cluster resource attributes from the config file cra.yaml, +e.g., content of cra.yaml: .. code-block:: yaml @@ -30,12 +30,12 @@ eg: content of cra.yaml flytectl update cluster-resource-attribute --attrFile cra.yaml -Updating cluster resource attribute for project and domain and workflow combination. This will take precedence over any other +Updates cluster resource attribute for project and domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values -Refer to get cluster-resource-attribute section on how to generate this file -Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute that is already set and then update it to have new values. +Refer to get cluster-resource-attribute section on how to generate this file. +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/matchable_execution_cluster_label.go b/cmd/update/matchable_execution_cluster_label.go index e9c6c62e5a..2c03815468 100644 --- a/cmd/update/matchable_execution_cluster_label.go +++ b/cmd/update/matchable_execution_cluster_label.go @@ -10,13 +10,13 @@ import ( ) const ( - executionClusterLabelShort = "Updates matchable resources of execution cluster label" + executionClusterLabelShort = "Update matchable resources of execution cluster label" executionClusterLabelLong = ` -Updates execution cluster label for given project and domain combination or additionally with workflow name. +Updates execution cluster label for the given project and domain combination or additionally with workflow name. -Updating to the execution cluster label is only available from a generated file. See the get section for generating this file. -Here the command updates takes the input for execution cluster label from the config file ecl.yaml -eg: content of ecl.yaml +Updating to the execution cluster label is only available from a generated file. See the get section to generate this file. +It takes input for execution cluster label from the config file ecl.yaml +e.g., content of ecl.yaml: .. code-block:: yaml @@ -28,9 +28,9 @@ eg: content of ecl.yaml flytectl update execution-cluster-label --attrFile ecl.yaml -Updating execution cluster label for project and domain and workflow combination. This will take precedence over any other +Updates execution cluster label for project, domain and workflow combination. This will take precedence over any other execution cluster label defined at project domain level. -Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/matchable_execution_queue_attribute.go b/cmd/update/matchable_execution_queue_attribute.go index 6c09f9d7b0..4d85146680 100644 --- a/cmd/update/matchable_execution_queue_attribute.go +++ b/cmd/update/matchable_execution_queue_attribute.go @@ -10,16 +10,16 @@ import ( ) const ( - executionQueueAttributesShort = "Updates matchable resources of execution queue attributes" + executionQueueAttributesShort = "Update matchable resources of execution queue attributes" executionQueueAttributesLong = ` -Updates execution queue attributes for given project and domain combination or additionally with workflow name. +Updates execution queue attributes for the given project and domain combination or additionally with workflow name. -Updating to the execution queue attribute is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values +Updating the execution queue attribute is only available from a generated file. See the get section for generating this file. +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute that is already set and then update it to have new values. Refer to get execution-queue-attribute section on how to generate this file -Here the command updates takes the input for execution queue attributes from the config file era.yaml -eg: content of era.yaml +It takes input for execution queue attributes from the config file era.yaml, +e.g., content of era.yaml: .. code-block:: yaml @@ -35,9 +35,9 @@ eg: content of era.yaml flytectl update execution-queue-attribute --attrFile era.yaml -Updating execution queue attribute for project and domain and workflow combination. This will take precedence over any other +Updates execution queue attribute for project, domain and workflow combination. This will take precedence over any other execution queue attribute defined at project domain level. -Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/matchable_plugin_override.go b/cmd/update/matchable_plugin_override.go index 065f2d7070..2dfca66113 100644 --- a/cmd/update/matchable_plugin_override.go +++ b/cmd/update/matchable_plugin_override.go @@ -10,16 +10,16 @@ import ( ) const ( - pluginOverrideShort = "Updates matchable resources of plugin overrides" + pluginOverrideShort = "Update matchable resources of plugin overrides" pluginOverrideLong = ` Updates plugin overrides for given project and domain combination or additionally with workflow name. Updating to the plugin override is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing plugins overrides on custom project and domain and workflow combination. -Would be preferable to do get and generate an plugin override file if there is an existing override already set and then update it to have new values +This will completely overwrite any existing plugins overrides on custom project, domain and workflow combination. +It is preferable to do get and generate a plugin override file if there is an existing override already set and then update it to have new values. Refer to get plugin-override section on how to generate this file -Here the command updates takes the input for plugin overrides from the config file po.yaml -eg: content of po.yaml +It takes input for plugin overrides from the config file po.yaml, +e.g., content of po.yaml: .. code-block:: yaml @@ -36,9 +36,9 @@ eg: content of po.yaml flytectl update plugin-override --attrFile po.yaml -Updating plugin override for project and domain and workflow combination. This will take precedence over any other +Updates plugin override for project, domain and workflow combination. This will take precedence over any other plugin overrides defined at project domain level. -Update the plugin overrides for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/matchable_task_resource_attribute.go b/cmd/update/matchable_task_resource_attribute.go index bebd96929b..f7bb45ce67 100644 --- a/cmd/update/matchable_task_resource_attribute.go +++ b/cmd/update/matchable_task_resource_attribute.go @@ -10,16 +10,16 @@ import ( ) const ( - taskResourceAttributesShort = "Updates matchable resources of task attributes" + taskResourceAttributesShort = "Update matchable resources of task attributes" taskResourceAttributesLong = ` -Updates task resource attributes for given project and domain combination or additionally with workflow name. +Updates task resource attributes for the given project and domain combination or additionally with workflow name. Updating the task resource attribute is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values -Refer to get task-resource-attribute section on how to generate this file -Here the command updates takes the input for task resource attributes from the config file tra.yaml -eg: content of tra.yaml +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values. +Refer to get task-resource-attribute section on how to generate this file. +It takes input for task resource attributes from the config file tra.yaml, +e.g., content of tra.yaml: .. code-block:: yaml @@ -36,9 +36,9 @@ eg: content of tra.yaml flytectl update task-resource-attribute --attrFile tra.yaml -Updating task resource attribute for project and domain and workflow combination. This will take precedence over any other +Updates task resource attribute for project, domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/matchable_workflow_execution_config.go b/cmd/update/matchable_workflow_execution_config.go index 07b684ec5b..740685ef2b 100644 --- a/cmd/update/matchable_workflow_execution_config.go +++ b/cmd/update/matchable_workflow_execution_config.go @@ -11,16 +11,16 @@ import ( ) const ( - workflowExecutionConfigShort = "Updates matchable resources of workflow execution config" + workflowExecutionConfigShort = "Update matchable resources of workflow execution config" workflowExecutionConfigLong = ` Updates workflow execution config for given project and domain combination or additionally with workflow name. Updating the workflow execution config is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination execution config. -Would be preferable to do get and generate an config file if there is an existing execution config already set and then update it to have new values -Refer to get workflow-execution-config section on how to generate this file -Here the command updates takes the input for workflow execution config from the config file wec.yaml -eg: content of wec.yaml +This will completely overwrite any existing custom project and domain and workflow combination execution config. +It is preferable to do get and generate a config file if there is an existing execution config already set and then update it to have new values. +Refer to get workflow-execution-config section on how to generate this file. +It takes input for workflow execution config from the config file wec.yaml, +e.g., content of wec.yaml: .. code-block:: yaml @@ -32,9 +32,9 @@ eg: content of wec.yaml flytectl update workflow-execution-config --attrFile wec.yaml -Updating workflow execution config for project and domain and workflow combination. This will take precedence over any other +Updates workflow execution config for project, domain and workflow combination. This will take precedence over any other execution config defined at project domain level. -Update the workflow execution config for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml diff --git a/cmd/update/project.go b/cmd/update/project.go index abc54a6d36..330afe395c 100644 --- a/cmd/update/project.go +++ b/cmd/update/project.go @@ -22,37 +22,37 @@ type ProjectConfig struct { } const ( - projectShort = "Updates project resources" + projectShort = "Update project resources" projectLong = ` -Updates the project according the flags passed. Allows you to archive or activate a project. -Activates project named flytesnacks. +Updates the project according to the flags passed. Allows you to archive or activate a project. +Activate project flytesnacks: :: - bin/flytectl update project -p flytesnacks --activateProject + flytectl update project -p flytesnacks --activateProject -Archives project named flytesnacks. +Archive project flytesnacks: :: - bin/flytectl update project -p flytesnacks --archiveProject + flytectl update project -p flytesnacks --archiveProject -Incorrect usage when passing both archive and activate. +Incorrect usage when passing both archive and activate: :: - bin/flytectl update project flytesnacks --archiveProject --activateProject + flytectl update project flytesnacks --archiveProject --activateProject -Incorrect usage when passing unknown-project. +Incorrect usage when passing unknown-project: :: - bin/flytectl update project unknown-project --archiveProject + flytectl update project unknown-project --archiveProject -Incorrect usage when passing valid project using -p option. +Incorrect usage when passing valid project using -p option: :: - bin/flytectl update project unknown-project --archiveProject -p known-project + flytectl update project unknown-project --archiveProject -p known-project Usage ` diff --git a/cmd/update/task_meta.go b/cmd/update/task_meta.go index e38cdff16b..8c599710b2 100644 --- a/cmd/update/task_meta.go +++ b/cmd/update/task_meta.go @@ -11,19 +11,19 @@ import ( ) const ( - updateTaskShort = "Updates task metadata" + updateTaskShort = "Update task metadata" updateTaskLong = ` -Following command updates the description on the task. +Updates the description on the task: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --description "Merge sort example" -Archiving task named entity is not supported and would throw an error. +Archiving task named entity is not supported and would throw an error: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --archive -Activating task named entity would be a noop as archiving is not possible. +Activating task named entity would be a noop since archiving is not possible: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --activate diff --git a/cmd/update/update.go b/cmd/update/update.go index c1a721b704..60603a7dbe 100644 --- a/cmd/update/update.go +++ b/cmd/update/update.go @@ -16,14 +16,14 @@ import ( // Long descriptions are whitespace sensitive when generating docs using sphinx. const ( updateUse = "update" - updateShort = `Used for updating flyte resources eg: project.` + updateShort = `Update Flyte resources e.g., project.` updatecmdLong = ` -Currently this command only provides subcommands to update project. -Takes input project which need to be archived or unarchived. Name of the project to be updated is mandatory field. -Example update project to activate it. +Currently, this command only provides subcommands to update project. +Takes input project that needs to be archived or unarchived. Name of the project to be updated is a mandatory field. +To update a project: :: - bin/flytectl update project -p flytesnacks --activateProject + flytectl update project -p flytesnacks --activateProject ` ) diff --git a/cmd/update/workflow_meta.go b/cmd/update/workflow_meta.go index 9e67796208..af4cb3fe7d 100644 --- a/cmd/update/workflow_meta.go +++ b/cmd/update/workflow_meta.go @@ -11,19 +11,19 @@ import ( ) const ( - updateWorkflowShort = "Updates workflow metadata" + updateWorkflowShort = "Update workflow metadata" updateWorkflowLong = ` -Following command updates the description on the workflow. +Updates the description on the workflow: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --description "Mergesort workflow example" -Archiving workflow named entity would cause this to disapper from flyteconsole UI. +Archiving workflow named entity would cause this to disapper from flyteconsole UI: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive -Activating workflow named entity +Activate workflow named entity: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate diff --git a/cmd/upgrade/upgrade.go b/cmd/upgrade/upgrade.go index d32d587252..7fdd6d5f82 100644 --- a/cmd/upgrade/upgrade.go +++ b/cmd/upgrade/upgrade.go @@ -25,21 +25,21 @@ type Goos string // Long descriptions are whitespace sensitive when generating docs using sphinx. const ( - upgradeCmdShort = `Used for upgrade/rollback flyte version` + upgradeCmdShort = `Upgrade/rollback to a Flyte version` upgradeCmdLong = ` -Upgrade flytectl +For FlyteCTL, it is: :: - bin/flytectl upgrade + flytectl upgrade -Note: Please use upgrade with sudo, Without sudo it will cause permission issue +Note: Please use upgrade with sudo. Without sudo it will cause permission issue. -Rollback flytectl binary +Rollback flytectl binary: :: - bin/flytectl upgrade rollback + flytectl upgrade rollback -Note: Upgrade is not available on windows +Note: Upgrade is not available on windows. ` rollBackSubCommand = "rollback" ) diff --git a/cmd/upgrade/upgrade_test.go b/cmd/upgrade/upgrade_test.go index 213b02afdc..17584822a7 100644 --- a/cmd/upgrade/upgrade_test.go +++ b/cmd/upgrade/upgrade_test.go @@ -27,9 +27,9 @@ var ( func TestUpgradeCommand(t *testing.T) { rootCmd := &cobra.Command{ - Long: "flytectl is CLI tool written in go to interact with flyteadmin service", - Short: "flyetcl CLI tool", - Use: "flytectl", + Long: "FlyteCTL is CLI tool written in go to interact with flyteadmin service", + Short: "FlyteCTL CLI tool", + Use: "FlyteCTL", DisableAutoGenTag: true, } upgradeCmd := SelfUpgrade(rootCmd) diff --git a/cmd/version/version.go b/cmd/version/version.go index 14a6d0bc4c..f52dd27407 100644 --- a/cmd/version/version.go +++ b/cmd/version/version.go @@ -19,12 +19,12 @@ import ( // Long descriptions are whitespace sensitive when generating docs using sphinx. const ( - versionCmdShort = `Used for fetching flyte version` + versionCmdShort = `Fetch Flyte version` versionCmdLong = ` -Example version. +For FlyteCTL version, it is: :: - bin/flytectl version + flytectl version ` flytectlAppName = "flytectl" controlPlanAppName = "controlPlane" diff --git a/cmd/version/version_test.go b/cmd/version/version_test.go index cd9065258f..2b83ff9403 100644 --- a/cmd/version/version_test.go +++ b/cmd/version/version_test.go @@ -31,9 +31,9 @@ var ( func TestVersionCommand(t *testing.T) { rootCmd := &cobra.Command{ - Long: "flytectl is CLI tool written in go to interact with flyteadmin service", - Short: "flyetcl CLI tool", - Use: "flytectl", + Long: "FlyteCTL is CLI tool written in go to interact with Flyteadmin service", + Short: "FlyteCTL CLI tool", + Use: "FlyteCTL", DisableAutoGenTag: true, } versionCommand := GetVersionCommand(rootCmd) diff --git a/docs/source/cluster-resource-attribute.rst b/docs/source/cluster-resource-attribute.rst new file mode 100644 index 0000000000..bfbd2b0ffa --- /dev/null +++ b/docs/source/cluster-resource-attribute.rst @@ -0,0 +1,9 @@ +Cluster resource attribute +------ +.. toctree:: + :maxdepth: 1 + :caption: Cluster resource attribute + + gen/FlyteCTL_get_cluster-resource-attribute + gen/FlyteCTL_delete_cluster-resource-attribute + gen/FlyteCTL_update_cluster-resource-attribute diff --git a/docs/source/config.rst b/docs/source/config.rst new file mode 100644 index 0000000000..bf112114f8 --- /dev/null +++ b/docs/source/config.rst @@ -0,0 +1,10 @@ +Config +------ + +.. toctree:: + :maxdepth: 1 + :caption: Config + + gen/FlyteCTL_config_validate + gen/FlyteCTL_config_init + gen/flytectl_config_discover diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 0000000000..a854e2349b --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,8 @@ +Examples +------ +.. toctree:: + :maxdepth: 1 + :caption: Examples + + + gen/FlyteCTL_register_examples \ No newline at end of file diff --git a/docs/source/execution-cluster-label.rst b/docs/source/execution-cluster-label.rst new file mode 100644 index 0000000000..e0dae2adbc --- /dev/null +++ b/docs/source/execution-cluster-label.rst @@ -0,0 +1,10 @@ +Execution cluster label +------ + +.. toctree:: + :maxdepth: 1 + :caption: Execution cluster label + + gen/FlyteCTL_get_execution-cluster-label + gen/FlyteCTL_update_execution-cluster-label + gen/FlyteCTL_delete_execution-cluster-label \ No newline at end of file diff --git a/docs/source/execution-queue-attribute.rst b/docs/source/execution-queue-attribute.rst new file mode 100644 index 0000000000..92ba2502c0 --- /dev/null +++ b/docs/source/execution-queue-attribute.rst @@ -0,0 +1,10 @@ +Execution queue attribute +------ + +.. toctree:: + :maxdepth: 1 + :caption: Execution queue attribute + + gen/FlyteCTL_get_execution-queue-attribute + gen/FlyteCTL_delete_execution-queue-attribute + gen/FlyteCTL_update_execution-queue-attribute \ No newline at end of file diff --git a/docs/source/execution.rst b/docs/source/execution.rst new file mode 100644 index 0000000000..b7857e7103 --- /dev/null +++ b/docs/source/execution.rst @@ -0,0 +1,10 @@ +Execution +------ + +.. toctree:: + :maxdepth: 1 + :caption: Execution + + gen/FlyteCTL_create_execution + gen/FlyteCTL_get_execution + gen/FlyteCTL_delete_execution \ No newline at end of file diff --git a/docs/source/files.rst b/docs/source/files.rst new file mode 100644 index 0000000000..b7216fbcae --- /dev/null +++ b/docs/source/files.rst @@ -0,0 +1,10 @@ +Files +------ + +.. toctree:: + :maxdepth: 1 + :caption: Files + + gen/FlyteCTL_register_files + +Note: It allows the user to register local files diff --git a/docs/source/gen/flytectl.rst b/docs/source/gen/flytectl.rst index d56aa0fca5..d11e9d5bbf 100644 --- a/docs/source/gen/flytectl.rst +++ b/docs/source/gen/flytectl.rst @@ -1,15 +1,15 @@ -.. _flytectl: +.. _FlyteCTL: -flytectl +FlyteCTL -------- -flyetcl CLI tool +FlyteCTL CLI tool Synopsis ~~~~~~~~ -flytectl is CLI tool written in go to interact with flyteadmin service +FlyteCTL is CLI tool written in go to interact with Flyteadmin service Options ~~~~~~~ @@ -33,7 +33,7 @@ Options --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. -c, --config string config file (default is $HOME/.flyte/config.yaml) -d, --domain string Specifies the Flyte project's domain. - -h, --help help for flytectl + -h, --help help for FlyteCTL --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 4) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. @@ -59,14 +59,14 @@ Options SEE ALSO ~~~~~~~~ -* :doc:`flytectl_completion` - Generate completion script -* :doc:`flytectl_config` - Runs various config commands, look at the help of this command to get a list of available commands.. -* :doc:`flytectl_create` - Used for creating various flyte resources including tasks/workflows/launchplans/executions/project. -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. -* :doc:`flytectl_register` - Registers tasks/workflows/launchplans from list of generated serialized files. -* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. -* :doc:`flytectl_upgrade` - Used for upgrade/rollback flyte version -* :doc:`flytectl_version` - Used for fetching flyte version +* :doc:`FlyteCTL_completion` - Generate completion script +* :doc:`FlyteCTL_config` - Runs various config commands, look at the help of this command to get a list of available commands.. +* :doc:`FlyteCTL_create` - Create various Flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_register` - Register tasks/workflows/launchplans from a list of generated serialized files. +* :doc:`FlyteCTL_sandbox` - Used for sandbox interactions like start/teardown/status/exec. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. +* :doc:`FlyteCTL_upgrade` - Upgrade/rollback to a Flyte version +* :doc:`FlyteCTL_version` - Fetch Flyte version diff --git a/docs/source/gen/flytectl_completion.rst b/docs/source/gen/flytectl_completion.rst index 24271d7b12..1e4ed90351 100644 --- a/docs/source/gen/flytectl_completion.rst +++ b/docs/source/gen/flytectl_completion.rst @@ -1,6 +1,6 @@ -.. _flytectl_completion: +.. _FlyteCTL_completion: -flytectl completion +FlyteCTL completion ------------------- Generate completion script @@ -24,7 +24,7 @@ Bash: Zsh: # If shell completion is not already enabled in your environment, - # you will need to enable it. You can execute the following once: + # you will need to enable it. You can execute the following once: $ echo "autoload -U compinit; compinit" >> ~/.zshrc @@ -51,7 +51,7 @@ PowerShell: :: - flytectl completion [bash|zsh|fish|powershell] + FlyteCTL completion [bash|zsh|fish|powershell] Options ~~~~~~~ @@ -107,5 +107,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool +* :doc:`FlyteCTL` - FlyteCTL CLI tool diff --git a/docs/source/gen/flytectl_config.rst b/docs/source/gen/flytectl_config.rst index e835ee9fe9..3df3187008 100644 --- a/docs/source/gen/flytectl_config.rst +++ b/docs/source/gen/flytectl_config.rst @@ -1,6 +1,6 @@ -.. _flytectl_config: +.. _FlyteCTL_config: -flytectl config +FlyteCTL config --------------- Runs various config commands, look at the help of this command to get a list of available commands.. @@ -67,8 +67,8 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_config_discover` - Searches for a config in one of the default search paths. -* :doc:`flytectl_config_init` - Generates flytectl config file in the user's home directory. -* :doc:`flytectl_config_validate` - Validates the loaded config. +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_config_discover` - Searches for a config in one of the default search paths. +* :doc:`FlyteCTL_config_init` - Generates FlyteCTL config file in the user's home directory. +* :doc:`FlyteCTL_config_validate` - Validates the loaded config. diff --git a/docs/source/gen/flytectl_config_discover.rst b/docs/source/gen/flytectl_config_discover.rst index 8550321470..a91147e3d4 100644 --- a/docs/source/gen/flytectl_config_discover.rst +++ b/docs/source/gen/flytectl_config_discover.rst @@ -1,6 +1,6 @@ -.. _flytectl_config_discover: +.. _FlyteCTL_config_discover: -flytectl config discover +FlyteCTL config discover ------------------------ Searches for a config in one of the default search paths. @@ -13,7 +13,7 @@ Searches for a config in one of the default search paths. :: - flytectl config discover [flags] + FlyteCTL config discover [flags] Options ~~~~~~~ @@ -71,5 +71,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_config` - Runs various config commands, look at the help of this command to get a list of available commands.. +* :doc:`FlyteCTL_config` - Runs various config commands, look at the help of this command to get a list of available commands.. diff --git a/docs/source/gen/flytectl_config_init.rst b/docs/source/gen/flytectl_config_init.rst index 30b4eb404f..3ba2564ca2 100644 --- a/docs/source/gen/flytectl_config_init.rst +++ b/docs/source/gen/flytectl_config_init.rst @@ -1,37 +1,37 @@ -.. _flytectl_config_init: +.. _FlyteCTL_config_init: -flytectl config init +FlyteCTL config init -------------------- -Generates flytectl config file in the user's home directory. +Generates FlyteCTL config file in the user's home directory. Synopsis ~~~~~~~~ -Creates a flytectl config file in flyte directory i.e ~/.flyte +Creates a FlyteCTL config file in Flyte directory i.e ~/.flyte -Generate sandbox config. Flyte Sandbox is a fully standalone minimal environment for running Flyte. Read more about sandbox https://docs.flyte.org/en/latest/deployment/sandbox.html +Generates sandbox config. Flyte Sandbox is a fully standalone minimal environment for running Flyte. Read more about sandbox https://docs.flyte.org/en/latest/deployment/sandbox.html :: - bin/flytectl configuration config + flytectl configuration config -Generate remote cluster config. Read more about the remote deployment https://docs.flyte.org/en/latest/deployment/index.html +Generates remote cluster config. Read more about the remote deployment https://docs.flyte.org/en/latest/deployment/index.html :: - bin/flytectl configuration config --host=flyte.myexample.com + flytectl configuration config --host=flyte.myexample.com -Generate flytectl config with a storage provider +Generates FlyteCTL config with a storage provider :: - bin/flytectl configuration config --host=flyte.myexample.com --storage + flytectl configuration config --host=flyte.myexample.com --storage :: - flytectl config init [flags] + FlyteCTL config init [flags] Options ~~~~~~~ @@ -92,5 +92,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_config` - Runs various config commands, look at the help of this command to get a list of available commands.. +* :doc:`FlyteCTL_config` - Runs various config commands, look at the help of this command to get a list of available commands.. diff --git a/docs/source/gen/flytectl_config_validate.rst b/docs/source/gen/flytectl_config_validate.rst index 51a3a7e443..461e625269 100644 --- a/docs/source/gen/flytectl_config_validate.rst +++ b/docs/source/gen/flytectl_config_validate.rst @@ -1,6 +1,6 @@ -.. _flytectl_config_validate: +.. _FlyteCTL_config_validate: -flytectl config validate +FlyteCTL config validate ------------------------ Validates the loaded config. @@ -13,7 +13,7 @@ Validates the loaded config. :: - flytectl config validate [flags] + FlyteCTL config validate [flags] Options ~~~~~~~ @@ -73,5 +73,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_config` - Runs various config commands, look at the help of this command to get a list of available commands.. +* :doc:`FlyteCTL_config` - Runs various config commands, look at the help of this command to get a list of available commands.. diff --git a/docs/source/gen/flytectl_create.rst b/docs/source/gen/flytectl_create.rst index de2f4a89d4..d389ea2c0d 100644 --- a/docs/source/gen/flytectl_create.rst +++ b/docs/source/gen/flytectl_create.rst @@ -1,19 +1,19 @@ -.. _flytectl_create: +.. _FlyteCTL_create: -flytectl create +FlyteCTL create --------------- -Used for creating various flyte resources including tasks/workflows/launchplans/executions/project. +Create various Flyte resources including tasks/workflows/launchplans/executions/project. Synopsis ~~~~~~~~ -Example create. +Create Flyte resource; if a project: :: - bin/flytectl create project --file project.yaml + flytectl create project --file project.yaml Options @@ -70,7 +70,7 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_create_execution` - Create execution resources -* :doc:`flytectl_create_project` - Create project resources +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_create_execution` - Create execution resources +* :doc:`FlyteCTL_create_project` - Create project resources diff --git a/docs/source/gen/flytectl_create_execution.rst b/docs/source/gen/flytectl_create_execution.rst index 2838ecdd5c..2d502a4209 100644 --- a/docs/source/gen/flytectl_create_execution.rst +++ b/docs/source/gen/flytectl_create_execution.rst @@ -1,6 +1,6 @@ -.. _flytectl_create_execution: +.. _FlyteCTL_create_execution: -flytectl create execution +FlyteCTL create execution ------------------------- Create execution resources @@ -10,22 +10,22 @@ Synopsis -Create the executions for given workflow/task in a project and domain. +Creates executions for a given workflow/task in a project and domain. -There are three steps in generating an execution. +There are three steps in generating an execution: - Generate the execution spec file using the get command. - Update the inputs for the execution if needed. - Run the execution by passing in the generated yaml file. -The spec file should be generated first and then run the execution using the spec file. -You can reference the flytectl get task for more details +The spec file should be generated first and then, the execution should be run using the spec file. +You can reference the FlyteCTL get task for more details. :: flytectl get tasks -d development -p flytectldemo core.advanced.run_merge_sort.merge --version v2 --execFile execution_spec.yaml -The generated file would look similar to this +The generated file would look similar to this: .. code-block:: yaml @@ -62,35 +62,35 @@ The generated file can be modified to change the input values. task: core.advanced.run_merge_sort.merge version: "v2" -And then can be passed through the command line. -Notice the source and target domain/projects can be different. -The root project and domain flags of -p and -d should point to task/launch plans project/domain. +It can then be passed through the command line. +Notice that the source and target domain/projects can be different. +The root project and domain flags of -p and -d should point to the task/launch plans project/domain. :: flytectl create execution --execFile execution_spec.yaml -p flytectldemo -d development --targetProject flytesnacks -Also an execution can be relaunched by passing in current execution id. +Also, an execution can be relaunched by passing in the current execution id. :: flytectl create execution --relaunch ffb31066a0f8b4d52b77 -p flytectldemo -d development -An execution can be recovered, that is recreated from the last known failure point for a previously-run workflow execution. +An execution can be recovered, i.e., recreated from the last known failure point for previously-run workflow execution. See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details. :: flytectl create execution --recover ffb31066a0f8b4d52b77 -p flytectldemo -d development -Generic data types are also supported for execution in similar way.Following is sample of how the inputs need to be specified while creating the execution. -As usual the spec file should be generated first and then run the execution using the spec file. +Generic data types are also supported for execution in a similar manner. Following is a sample of how the inputs need to be specified while creating the execution. +The spec file should be generated first and then, the execution should be run using the spec file. :: flytectl get task -d development -p flytectldemo core.type_system.custom_objects.add --execFile adddatanum.yaml -The generated file would look similar to this. Here you can see empty values dumped for generic data type x and y. +The generated file would look similar to this. Here, empty values have been dumped for generic data type x and y. :: @@ -133,7 +133,7 @@ Usage :: - flytectl create execution [flags] + FlyteCTL create execution [flags] Options ~~~~~~~ @@ -200,5 +200,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_create` - Used for creating various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_create` - Create various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_create_project.rst b/docs/source/gen/flytectl_create_project.rst index f1e8a47194..49d244f310 100644 --- a/docs/source/gen/flytectl_create_project.rst +++ b/docs/source/gen/flytectl_create_project.rst @@ -1,6 +1,6 @@ -.. _flytectl_create_project: +.. _FlyteCTL_create_project: -flytectl create project +FlyteCTL create project ----------------------- Create project resources @@ -10,16 +10,16 @@ Synopsis -Create the projects.(project,projects can be used interchangeably in these commands) +Create projects.(project/projects can be used interchangeably in these commands) :: - bin/flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte + flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte -Create Project by definition file. Note: The name shouldn't contain any whitespace characters' +Create a project by definition file. Note: The name shouldn't contain any whitespace characters. :: - bin/flytectl create project --file project.yaml + flytectl create project --file project.yaml .. code-block:: yaml @@ -33,7 +33,7 @@ Create Project by definition file. Note: The name shouldn't contain any whitespa :: - flytectl create project [flags] + FlyteCTL create project [flags] Options ~~~~~~~ @@ -95,5 +95,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_create` - Used for creating various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_create` - Create various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete.rst b/docs/source/gen/flytectl_delete.rst index 0af8199dca..b675158f7a 100644 --- a/docs/source/gen/flytectl_delete.rst +++ b/docs/source/gen/flytectl_delete.rst @@ -1,19 +1,19 @@ -.. _flytectl_delete: +.. _FlyteCTL_delete: -flytectl delete +FlyteCTL delete --------------- -Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. Synopsis ~~~~~~~~ -Example Delete executions. +Delete a resource; if an execution: :: - bin/flytectl delete execution kxd1i72850 -d development -p flytesnacks + flytectl delete execution kxd1i72850 -d development -p flytesnacks Options @@ -70,12 +70,12 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_delete_cluster-resource-attribute` - Deletes matchable resources of cluster attributes -* :doc:`flytectl_delete_execution` - Terminate/Delete execution resources. -* :doc:`flytectl_delete_execution-cluster-label` - Deletes matchable resources of execution cluster label -* :doc:`flytectl_delete_execution-queue-attribute` - Deletes matchable resources of execution queue attributes -* :doc:`flytectl_delete_plugin-override` - Deletes matchable resources of plugin overrides -* :doc:`flytectl_delete_task-resource-attribute` - Deletes matchable resources of task attributes -* :doc:`flytectl_delete_workflow-execution-config` - Deletes matchable resources of workflow execution config +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_delete_cluster-resource-attribute` - Delete matchable resources of cluster attributes +* :doc:`FlyteCTL_delete_execution` - Terminate/Delete execution resources. +* :doc:`FlyteCTL_delete_execution-cluster-label` - Delete matchable resources of execution cluster label +* :doc:`FlyteCTL_delete_execution-queue-attribute` - Delete matchable resources of execution queue attributes +* :doc:`FlyteCTL_delete_plugin-override` - Delete matchable resources of plugin overrides +* :doc:`FlyteCTL_delete_task-resource-attribute` - Delete matchable resources of task attributes +* :doc:`FlyteCTL_delete_workflow-execution-config` - Delete matchable resources of workflow execution config diff --git a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst index 5e80a706d1..80d749a821 100644 --- a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst @@ -1,28 +1,27 @@ -.. _flytectl_delete_cluster-resource-attribute: +.. _FlyteCTL_delete_cluster-resource-attribute: -flytectl delete cluster-resource-attribute +FlyteCTL delete cluster-resource-attribute ------------------------------------------ -Deletes matchable resources of cluster attributes +Delete matchable resources of cluster attributes Synopsis ~~~~~~~~ -Deletes cluster resource attributes for given project and domain combination or additionally with workflow name. +Deletes cluster resource attributes for the given project and domain combination or additionally with workflow name. -Deletes cluster resource attribute for project and domain -Here the command delete cluster resource attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete cluster-resource-attribute -p flytectldemo -d development -Deletes cluster resource attribute using config file which was used for creating it. -Here the command deletes cluster resource attributes from the config file cra.yaml -Attributes are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of cra.yaml which will use the project domain and workflow name for deleting the resource +Deletes cluster resource attribute using config file which was used to create it. +Here, the config file is written to cra.yaml. +Attributes are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of cra.yaml: :: @@ -37,8 +36,8 @@ eg: content of cra.yaml which will use the project domain and workflow name for foo: "bar" buzz: "lightyear" -Deletes cluster resource attribute for a workflow -Here the command deletes cluster resource attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes cluster resource attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -49,7 +48,7 @@ Usage :: - flytectl delete cluster-resource-attribute [flags] + FlyteCTL delete cluster-resource-attribute [flags] Options ~~~~~~~ @@ -107,5 +106,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_execution-cluster-label.rst b/docs/source/gen/flytectl_delete_execution-cluster-label.rst index 488a732b58..1938d47b4a 100644 --- a/docs/source/gen/flytectl_delete_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_delete_execution-cluster-label.rst @@ -1,9 +1,9 @@ -.. _flytectl_delete_execution-cluster-label: +.. _FlyteCTL_delete_execution-cluster-label: -flytectl delete execution-cluster-label +FlyteCTL delete execution-cluster-label --------------------------------------- -Deletes matchable resources of execution cluster label +Delete matchable resources of execution cluster label Synopsis ~~~~~~~~ @@ -12,17 +12,16 @@ Synopsis Deletes execution cluster label for given project and domain combination or additionally with workflow name. -Deletes execution cluster label for project and domain -Here the command delete execution cluster label for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete execution-cluster-label -p flytectldemo -d development Deletes execution cluster label using config file which was used for creating it. -Here the command deletes execution cluster label from the config file ecl.yaml -Value is optional in the file as its unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of ecl.yaml which will use the project domain and workflow name for deleting the resource +Here, the config file is written to ecl.yaml. +Value is optional in the file as it is unread during the delete command but it can be kept since the same file can be used for get, update or delete commands. +e.g., content of ecl.yaml: :: @@ -35,8 +34,8 @@ eg: content of ecl.yaml which will use the project domain and workflow name for project: flytectldemo value: foo -Deletes execution cluster label for a workflow -Here the command deletes execution cluster label for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes execution cluster label for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -47,7 +46,7 @@ Usage :: - flytectl delete execution-cluster-label [flags] + FlyteCTL delete execution-cluster-label [flags] Options ~~~~~~~ @@ -105,5 +104,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst index 671eed2879..3f84f50441 100644 --- a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst @@ -1,28 +1,27 @@ -.. _flytectl_delete_execution-queue-attribute: +.. _FlyteCTL_delete_execution-queue-attribute: -flytectl delete execution-queue-attribute +FlyteCTL delete execution-queue-attribute ----------------------------------------- -Deletes matchable resources of execution queue attributes +Delete matchable resources of execution queue attributes Synopsis ~~~~~~~~ -Deletes execution queue attributes for given project and domain combination or additionally with workflow name. +Deletes execution queue attributes for the given project and domain combination or additionally with workflow name. -Deletes execution queue attribute for project and domain -Here the command delete execution queue attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete execution-queue-attribute -p flytectldemo -d development Deletes execution queue attribute using config file which was used for creating it. -Here the command deletes execution queue attributes from the config file era.yaml -Tags are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of era.yaml which will use the project domain and workflow name for deleting the resource +Here, the config file is written to era.yaml. +Value is optional in the file as it is unread during the delete command but it can be kept since the same file can be used for get, update or delete commands. +e.g., content of era.yaml: :: @@ -39,8 +38,8 @@ eg: content of era.yaml which will use the project domain and workflow name for - buzz - lightyear -Deletes execution queue attribute for a workflow -Here the command deletes the execution queue attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes execution queue attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -51,7 +50,7 @@ Usage :: - flytectl delete execution-queue-attribute [flags] + FlyteCTL delete execution-queue-attribute [flags] Options ~~~~~~~ @@ -109,5 +108,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_execution.rst b/docs/source/gen/flytectl_delete_execution.rst index 11ebaa66fd..d84c5d3b55 100644 --- a/docs/source/gen/flytectl_delete_execution.rst +++ b/docs/source/gen/flytectl_delete_execution.rst @@ -1,6 +1,6 @@ -.. _flytectl_delete_execution: +.. _FlyteCTL_delete_execution: -flytectl delete execution +FlyteCTL delete execution ------------------------- Terminate/Delete execution resources. @@ -12,36 +12,35 @@ Synopsis Terminate executions.(execution,executions can be used interchangeably in these commands) -Task executions can be aborted only if they are in non-terminal state i.e if they are FAILED,ABORTED or SUCCEEDED then -calling terminate on them has no effect. +Task executions can be aborted only if they are in non-terminal state. If they are FAILED, ABORTED or SUCCEEDED, calling terminate on them has no effect. -Terminate a single execution with its name +Terminate a single execution with its name: :: - bin/flytectl delete execution c6a51x2l9e -d development -p flytesnacks + flytectl delete execution c6a51x2l9e -d development -p flytesnacks -You can get executions to check its state. +Get executions to check its state: :: - bin/flytectl get execution -d development -p flytesnacks + flytectl get execution -d development -p flytesnacks ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | NAME (7) | WORKFLOW NAME | TYPE | PHASE | STARTED | ELAPSED TIME | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | c6a51x2l9e | recipes.core.basic.lp.go_greet | WORKFLOW | ABORTED | 2021-02-17T08:13:04.680476300Z | 15.540361300s | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- -Terminate multiple executions with there names +Terminate multiple executions with their names: :: - bin/flytectl delete execution eeam9s8sny p4wv4hwgc4 -d development -p flytesnacks + flytectl delete execution eeam9s8sny p4wv4hwgc4 -d development -p flytesnacks -Similarly you can get executions to find the state of previously terminated executions. +Get executions to find the state of previously terminated executions: :: - bin/flytectl get execution -d development -p flytesnacks + flytectl get execution -d development -p flytesnacks ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- | NAME (7) | WORKFLOW NAME | TYPE | PHASE | STARTED | ELAPSED TIME | ------------ ------------------------------------------------------------------------- ---------- ----------- -------------------------------- --------------- @@ -57,7 +56,7 @@ Usage :: - flytectl delete execution [flags] + FlyteCTL delete execution [flags] Options ~~~~~~~ @@ -114,5 +113,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_plugin-override.rst b/docs/source/gen/flytectl_delete_plugin-override.rst index 2328ff9e12..baa2d4355c 100644 --- a/docs/source/gen/flytectl_delete_plugin-override.rst +++ b/docs/source/gen/flytectl_delete_plugin-override.rst @@ -1,29 +1,27 @@ -.. _flytectl_delete_plugin-override: +.. _FlyteCTL_delete_plugin-override: -flytectl delete plugin-override +FlyteCTL delete plugin-override ------------------------------- -Deletes matchable resources of plugin overrides +Delete matchable resources of plugin overrides Synopsis ~~~~~~~~ -Deletes plugin override for given project and domain combination or additionally with workflow name. +Deletes plugin override for the given project and domain combination or additionally with workflow name. -Deletes plugin override for project and domain -Here the command deletes plugin override for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete plugin-override -p flytectldemo -d development -Deletes plugin override using config file which was used for creating it. -Here the command deletes plugin overrides from the config file po.yaml -Overrides are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of po.yaml which will use the project domain and workflow name for deleting the resource - +Deletes plugin override using config file which was used to create it. +Here, the config file is written to po.yaml. +Overrides are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of po.yaml: :: flytectl delete plugin-override --attrFile po.yaml @@ -40,8 +38,8 @@ eg: content of po.yaml which will use the project domain and workflow name for - plugin_override2 missing_plugin_behavior: 1 # Behavior when no specified plugin_id has an associated handler. 0 : FAIL , 1: DEFAULT -Deletes plugin override for a workflow -Here the command deletes the plugin override for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes plugin override for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -52,7 +50,7 @@ Usage :: - flytectl delete plugin-override [flags] + FlyteCTL delete plugin-override [flags] Options ~~~~~~~ @@ -110,5 +108,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_task-resource-attribute.rst b/docs/source/gen/flytectl_delete_task-resource-attribute.rst index 544712992f..1800977e0f 100644 --- a/docs/source/gen/flytectl_delete_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_task-resource-attribute.rst @@ -1,28 +1,27 @@ -.. _flytectl_delete_task-resource-attribute: +.. _FlyteCTL_delete_task-resource-attribute: -flytectl delete task-resource-attribute +FlyteCTL delete task-resource-attribute --------------------------------------- -Deletes matchable resources of task attributes +Delete matchable resources of task attributes Synopsis ~~~~~~~~ -Deletes task resource attributes for given project,domain combination or additionally with workflow name. +Deletes task resource attributes for the given project and domain combination, or additionally with workflow name. -Deletes task resource attribute for project and domain -Here the command delete task resource attributes for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete task-resource-attribute -p flytectldemo -d development -Deletes task resource attribute using config file which was used for creating it. -Here the command deletes task resource attributes from the config file tra.yaml -defaults/limits are optional in the file as they are unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of tra.yaml which will use the project domain and workflow name for deleting the resource +Deletes task resource attribute using config file which was used to create it. +Here, the config file is written to tra.yaml. +The defaults/limits are optional in the file as they are unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of tra.yaml: :: @@ -40,8 +39,8 @@ eg: content of tra.yaml which will use the project domain and workflow name for cpu: "2" memory: "450Mi" -Deletes task resource attribute for a workflow -Here the command deletes task resource attributes for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes task resource attribute for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -52,7 +51,7 @@ Usage :: - flytectl delete task-resource-attribute [flags] + FlyteCTL delete task-resource-attribute [flags] Options ~~~~~~~ @@ -110,5 +109,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_delete_workflow-execution-config.rst b/docs/source/gen/flytectl_delete_workflow-execution-config.rst index a97fcc811c..5d23c0547b 100644 --- a/docs/source/gen/flytectl_delete_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_delete_workflow-execution-config.rst @@ -1,28 +1,27 @@ -.. _flytectl_delete_workflow-execution-config: +.. _FlyteCTL_delete_workflow-execution-config: -flytectl delete workflow-execution-config +FlyteCTL delete workflow-execution-config ----------------------------------------- -Deletes matchable resources of workflow execution config +Delete matchable resources of workflow execution config Synopsis ~~~~~~~~ -Deletes workflow execution config for given project and domain combination or additionally with workflow name. +Deletes workflow execution config for the given project and domain combination or additionally with workflow name. -Deletes workflow execution config label for project and domain -Here the command delete workflow execution config for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl delete workflow-execution-config -p flytectldemo -d development -Deletes workflow execution config using config file which was used for creating it. -Here the command deletes workflow execution config from the config file wec.yaml -Max_parallelism is optional in the file as its unread during the delete command but can be kept as the same file can be used for get, update or delete -eg: content of wec.yaml which will use the project domain and workflow name for deleting the resource +Deletes workflow execution config using config file which was used to create it. +Here, the config file is written to wec.yaml. +Max_parallelism is optional in the file as it is unread during the delete command but can be kept since the same file can be used for get, update or delete commands. +e.g., content of wec.yaml: :: @@ -35,8 +34,8 @@ eg: content of wec.yaml which will use the project domain and workflow name for project: flytectldemo max_parallelism: 5 -Deletes workflow execution config for a workflow -Here the command deletes workflow execution config for a workflow core.control_flow.run_merge_sort.merge_sort +Deletes workflow execution config for a workflow. +For the workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: @@ -47,7 +46,7 @@ Usage :: - flytectl delete workflow-execution-config [flags] + FlyteCTL delete workflow-execution-config [flags] Options ~~~~~~~ @@ -105,5 +104,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_delete` - Terminate/delete various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get.rst b/docs/source/gen/flytectl_get.rst index 386cee0808..d27ae935a2 100644 --- a/docs/source/gen/flytectl_get.rst +++ b/docs/source/gen/flytectl_get.rst @@ -1,16 +1,16 @@ -.. _flytectl_get: +.. _FlyteCTL_get: -flytectl get +FlyteCTL get ------------ -Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. Synopsis ~~~~~~~~ -Example get projects. +For project, it is: :: flytectl get project @@ -70,16 +70,16 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_get_cluster-resource-attribute` - Gets matchable resources of cluster resource attributes. -* :doc:`flytectl_get_execution` - Gets execution resources -* :doc:`flytectl_get_execution-cluster-label` - Gets matchable resources of execution cluster label. -* :doc:`flytectl_get_execution-queue-attribute` - Gets matchable resources of execution queue attributes -* :doc:`flytectl_get_launchplan` - Gets launch plan resources -* :doc:`flytectl_get_plugin-override` - Gets matchable resources of plugin override -* :doc:`flytectl_get_project` - Gets project resources -* :doc:`flytectl_get_task` - Gets task resources -* :doc:`flytectl_get_task-resource-attribute` - Gets matchable resources of task attributes -* :doc:`flytectl_get_workflow` - Gets workflow resources -* :doc:`flytectl_get_workflow-execution-config` - Gets matchable resources of workflow execution config +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_get_cluster-resource-attribute` - Get matchable resources of cluster resource attributes. +* :doc:`FlyteCTL_get_execution` - Get execution resources +* :doc:`FlyteCTL_get_execution-cluster-label` - Get matchable resources of execution cluster label. +* :doc:`FlyteCTL_get_execution-queue-attribute` - Get matchable resources of execution queue attributes +* :doc:`FlyteCTL_get_launchplan` - Get launch plan resources +* :doc:`FlyteCTL_get_plugin-override` - Get matchable resources of plugin override +* :doc:`FlyteCTL_get_project` - Get project resources +* :doc:`FlyteCTL_get_task` - Get task resources +* :doc:`FlyteCTL_get_task-resource-attribute` - Get matchable resources of task attributes +* :doc:`FlyteCTL_get_workflow` - Get workflow resources +* :doc:`FlyteCTL_get_workflow-execution-config` - Get matchable resources of workflow execution config diff --git a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst index ea44a874bd..059cfe64a5 100644 --- a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst @@ -1,42 +1,42 @@ -.. _flytectl_get_cluster-resource-attribute: +.. _FlyteCTL_get_cluster-resource-attribute: -flytectl get cluster-resource-attribute +FlyteCTL get cluster-resource-attribute --------------------------------------- -Gets matchable resources of cluster resource attributes. +Get matchable resources of cluster resource attributes. Synopsis ~~~~~~~~ -Retrieve cluster resource attributes for the given project and domain. -Here, the command gets cluster resource attributes for the project flytectldemo and development domain. +Retrieves cluster resource attributes for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get cluster-resource-attribute -p flytectldemo -d development -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","attributes":{"buzz":"lightyear","foo":"bar"}} -Retrieve cluster resource attributes for the given project, domain, and workflow. -Here, the command gets cluster resource attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves cluster resource attributes for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort': :: flytectl get cluster-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","attributes":{"buzz":"lightyear","foo":"bar"}} -Writes the cluster resource attributes to a file. If there are no cluster resource attributes,the command throws an error. -Here, the command gets the task resource attributes and writes the config file to cra.yaml file. -eg: content of cra.yaml +Writes the cluster resource attributes to a file. If there are no cluster resource attributes, the command throws an error. +Here, the config file is written to cra.yaml file: +e.g., content of cra.yaml :: @@ -56,7 +56,7 @@ Usage :: - flytectl get cluster-resource-attribute [flags] + FlyteCTL get cluster-resource-attribute [flags] Options ~~~~~~~ @@ -113,5 +113,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_execution-cluster-label.rst b/docs/source/gen/flytectl_get_execution-cluster-label.rst index e25ecb4e84..1db5d7980c 100644 --- a/docs/source/gen/flytectl_get_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_get_execution-cluster-label.rst @@ -1,44 +1,43 @@ -.. _flytectl_get_execution-cluster-label: +.. _FlyteCTL_get_execution-cluster-label: -flytectl get execution-cluster-label +FlyteCTL get execution-cluster-label ------------------------------------ -Gets matchable resources of execution cluster label. +Get matchable resources of execution cluster label. Synopsis ~~~~~~~~ -// Retrieves the execution cluster label for a given project and domain, combination or additionally with workflow name. +Retrieves the execution cluster label for a given project and domain, combination or additionally with workflow name. -Retrieve the execution cluster label for the given project and domain. -Here the command get execution cluster label for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl get execution-cluster-label -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","value":"foo"} Retrieve the execution cluster label for the given project, domain and workflow. -Here, the command gets the execution cluster label for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get execution-cluster-label -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","value":"foo"} -Writes the execution cluster label to a file. If there is no execution cluster label, command throws an error. -Here, the command gets the execution cluster label and writes the config file to ecl.yaml file. -eg: content of ecl.yaml +Write the execution cluster label to a file. If there is no execution cluster label, the command throws an error. +Here, the config file is written to ecl.yaml, +e.g., content of ecl.yaml: :: @@ -56,7 +55,7 @@ Usage :: - flytectl get execution-cluster-label [flags] + FlyteCTL get execution-cluster-label [flags] Options ~~~~~~~ @@ -113,5 +112,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_execution-queue-attribute.rst b/docs/source/gen/flytectl_get_execution-queue-attribute.rst index 04f8d0b24b..e56c92e39e 100644 --- a/docs/source/gen/flytectl_get_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_get_execution-queue-attribute.rst @@ -1,42 +1,42 @@ -.. _flytectl_get_execution-queue-attribute: +.. _FlyteCTL_get_execution-queue-attribute: -flytectl get execution-queue-attribute +FlyteCTL get execution-queue-attribute -------------------------------------- -Gets matchable resources of execution queue attributes +Get matchable resources of execution queue attributes Synopsis ~~~~~~~~ -Retrieve the execution queue attribute for the given project and domain. -Here, the command gets execution queue attributes for the project flytectldemo and development domain. +Retrieves the execution queue attribute for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get execution-queue-attribute -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","tags":["foo", "bar"]} -Retrieve the execution queue attribute for the given project, domain, and workflow. -Here, the command gets execution queue attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves the execution queue attribute for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get execution-queue-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"core.control_flow.run_merge_sort.merge_sort","tags":["foo", "bar"]} Write the execution queue attribute to a file. If there are no execution queue attributes, the command throws an error. -Here, the command gets the execution queue attributes and writes the config to era.yaml file. -e.g. : content of era.yaml +Here, the config file is written to era.yaml, +e.g., content of era.yaml: :: @@ -58,7 +58,7 @@ Usage :: - flytectl get execution-queue-attribute [flags] + FlyteCTL get execution-queue-attribute [flags] Options ~~~~~~~ @@ -115,5 +115,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_execution.rst b/docs/source/gen/flytectl_get_execution.rst index 29e0e06706..714a6ddeae 100644 --- a/docs/source/gen/flytectl_get_execution.rst +++ b/docs/source/gen/flytectl_get_execution.rst @@ -1,81 +1,81 @@ -.. _flytectl_get_execution: +.. _FlyteCTL_get_execution: -flytectl get execution +FlyteCTL get execution ---------------------- -Gets execution resources +Get execution resources Synopsis ~~~~~~~~ -Retrieve all executions within the project and domain (execution, executions can be used interchangeably). +Retrieve all executions within the project and domain (execution, executions can be used interchangeably): :: - bin/flytectl get execution -p flytesnacks -d development + flytectl get execution -p flytesnacks -d development -Retrieves executions by name within the project and domain. +Retrieve executions by name within the project and domain: :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r + flytectl get execution -p flytesnacks -d development oeh94k9r2r -Retrieves all the executions with filters. +Retrieve all the executions with filters: :: - bin/flytectl get execution -p flytesnacks -d development --filter.fieldSelector="execution.phase in (FAILED;SUCCEEDED),execution.duration<200" + flytectl get execution -p flytesnacks -d development --filter.fieldSelector="execution.phase in (FAILED;SUCCEEDED),execution.duration<200" -Retrieve executions as per the specified limit and sorting parameters. +Retrieve executions as per the specified limit and sorting parameters: :: - bin/flytectl get execution -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get execution -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieve executions within the project and domain in YAML format. +Retrieve executions within the project and domain in YAML format: :: - bin/flytectl get execution -p flytesnacks -d development -o yaml + flytectl get execution -p flytesnacks -d development -o yaml -Retrieve executions within the project and domain in JSON format. +Retrieve executions within the project and domain in JSON format: :: - bin/flytectl get execution -p flytesnacks -d development -o json + flytectl get execution -p flytesnacks -d development -o json Get more details of the execution using the --details flag, which shows node and task executions. The default view is a tree view, and the TABLE view format is not supported on this view. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details + flytectl get execution -p flytesnacks -d development oeh94k9r2r --details Fetch execution details in YAML format. In this view, only node details are available. For task, send the --nodeID flag. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --details -o yaml + flytectl get execution -p flytesnacks -d development oeh94k9r2r --details -o yaml Fetch task executions on a specific node using the --nodeID flag. Use the nodeID attribute given by the node details view. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodeID n0 + flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodeID n0 Task execution view is also available in YAML/JSON format. The following example showcases YAML, where the output also contains input and output data of each node. :: - bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodID n0 -o yaml + flytectl get execution -p flytesnacks -d development oeh94k9r2r --nodID n0 -o yaml Usage :: - flytectl get execution [flags] + FlyteCTL get execution [flags] Options ~~~~~~~ @@ -137,5 +137,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_launchplan.rst b/docs/source/gen/flytectl_get_launchplan.rst index 2a3c0c1dc3..6d2c4fcafa 100644 --- a/docs/source/gen/flytectl_get_launchplan.rst +++ b/docs/source/gen/flytectl_get_launchplan.rst @@ -1,69 +1,69 @@ -.. _flytectl_get_launchplan: +.. _FlyteCTL_get_launchplan: -flytectl get launchplan +FlyteCTL get launchplan ----------------------- -Gets launch plan resources +Get launch plan resources Synopsis ~~~~~~~~ -Retrieve all launch plans within the project and domain (launchplan, launchplans can be used interchangeably). +Retrieve all launch plans within the project and domain (launch plan, launch plans can be used interchangeably): :: flytectl get launchplan -p flytesnacks -d development - Retrieve a launch plan by name within the project and domain. + Retrieve a launch plan by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet -Retrieve the latest version of the task by name within the project and domain. +Retrieve the latest version of the task by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet --latest -Retrieves a particular version of the launch plan by name within the project and domain. +Retrieve a particular version of the launch plan by name within the project and domain: :: flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet --version v2 -Retrieves all the launch plans with filters. +Retrieve all the launch plans with filters: :: - bin/flytectl get launchplan -p flytesnacks -d development --filter.fieldSelector="name=core.basic.lp.go_greet" + flytectl get launchplan -p flytesnacks -d development --filter.fieldSelector="name=core.basic.lp.go_greet" -Retrieves launch plans entity search across all versions with filters. +Retrieve launch plans entity search across all versions with filters: :: - bin/flytectl get launchplan -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="version=v1" + flytectl get launchplan -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="version=v1" -Retrieves all the launch plans with limit and sorting. +Retrieve all the launch plans with limit and sorting: :: - bin/flytectl get launchplan -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get launchplan -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all launch plans within the project and domain in YAML format. +Retrieve all launch plans within the project and domain in YAML format: :: flytectl get launchplan -p flytesnacks -d development -o yaml -Retrieves all launch plans the within the project and domain in JSON format. +Retrieve all launch plans the within the project and domain in JSON format: :: flytectl get launchplan -p flytesnacks -d development -o json -Retrieve a launch plan within the project and domain as per a version and generate the execution spec file; the file can be used to launch the execution using the 'create execution' command. +Retrieve a launch plan within the project and domain as per a version and generate the execution spec file; the file can be used to launch the execution using the 'create execution' command: :: @@ -92,7 +92,7 @@ Usage :: - flytectl get launchplan [flags] + FlyteCTL get launchplan [flags] Options ~~~~~~~ @@ -155,5 +155,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_plugin-override.rst b/docs/source/gen/flytectl_get_plugin-override.rst index 0c7668510e..30d89032b1 100644 --- a/docs/source/gen/flytectl_get_plugin-override.rst +++ b/docs/source/gen/flytectl_get_plugin-override.rst @@ -1,23 +1,23 @@ -.. _flytectl_get_plugin-override: +.. _FlyteCTL_get_plugin-override: -flytectl get plugin-override +FlyteCTL get plugin-override ---------------------------- -Gets matchable resources of plugin override +Get matchable resources of plugin override Synopsis ~~~~~~~~ -Retrieve the plugin overrides for the given project and domain. -Here, the command gets the plugin overrides for the project flytectldemo and development domain. +Retrieves the plugin override for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get plugin-override -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command .. code-block:: json @@ -31,14 +31,14 @@ e.g. : output from the command }] } -Retrieves the plugin overrides for project, domain and workflow -Here the command gets the plugin overrides for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort +Retrieves the plugin override for the given project, domain and workflow. +For project flytectldemo, development domain and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get plugin-override -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command: .. code-block:: json @@ -53,9 +53,9 @@ e.g. : output from the command }] } -Writing the plugin overrides to a file. If there are no plugin overrides, command would return an error. -Here the command gets plugin overrides and writes the config file to po.yaml -eg: content of po.yaml +Write plugin overrides to a file. If there are no plugin overrides, the command returns an error. +Here, the config file is written to po.yaml, +e.g., content of po.yaml: :: @@ -78,7 +78,7 @@ Usage :: - flytectl get plugin-override [flags] + FlyteCTL get plugin-override [flags] Options ~~~~~~~ @@ -135,5 +135,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_project.rst b/docs/source/gen/flytectl_get_project.rst index ffebba44d6..cad73c12d6 100644 --- a/docs/source/gen/flytectl_get_project.rst +++ b/docs/source/gen/flytectl_get_project.rst @@ -1,54 +1,54 @@ -.. _flytectl_get_project: +.. _FlyteCTL_get_project: -flytectl get project +FlyteCTL get project -------------------- -Gets project resources +Get project resources Synopsis ~~~~~~~~ -Retrieves all the projects.(project,projects can be used interchangeably in these commands) +Retrieve all the projects. (project,projects can be used interchangeably in these commands): :: - bin/flytectl get project + flytectl get project -Retrieves project by name +Retrieve project by name: :: - bin/flytectl get project flytesnacks + flytectl get project flytesnacks -Retrieves all the projects with filters. +Retrieve all the projects with filters: :: - bin/flytectl get project --filter.fieldSelector="project.name=flytesnacks" + flytectl get project --filter.fieldSelector="project.name=flytesnacks" -Retrieves all the projects with limit and sorting. +Retrieve all the projects with limit and sorting: :: - bin/flytectl get project --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get project --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the projects in yaml format +Retrieve all the projects in yaml format: :: - bin/flytectl get project -o yaml + flytectl get project -o yaml -Retrieves all the projects in json format +Retrieve all the projects in json format: :: - bin/flytectl get project -o json + flytectl get project -o json Usage :: - flytectl get project [flags] + FlyteCTL get project [flags] Options ~~~~~~~ @@ -108,5 +108,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_task-resource-attribute.rst b/docs/source/gen/flytectl_get_task-resource-attribute.rst index 1122ce6411..384345cd0c 100644 --- a/docs/source/gen/flytectl_get_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_task-resource-attribute.rst @@ -1,34 +1,34 @@ -.. _flytectl_get_task-resource-attribute: +.. _FlyteCTL_get_task-resource-attribute: -flytectl get task-resource-attribute +FlyteCTL get task-resource-attribute ------------------------------------ -Gets matchable resources of task attributes +Get matchable resources of task attributes Synopsis ~~~~~~~~ -Retrieve task resource attributes for the given project and domain. -Here, the command gets the task resource attributes for the project flytectldemo and development domain. +Retrieves task resource attributes for the given project and domain. +For project flytectldemo and development domain, it is: :: flytectl get task-resource-attribute -p flytectldemo -d development -e.g. : output from the command +e.g., output from the command: .. code-block:: json {"project":"flytectldemo","domain":"development","workflow":"","defaults":{"cpu":"1","memory":"150Mi"},"limits":{"cpu":"2","memory":"450Mi"}} -Retrieve task resource attributes for the given project, domain, and workflow. -Here, the command gets task resource attributes for the project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort'. +Retrieves task resource attributes for the given project, domain, and workflow. +For project flytectldemo, development domain, and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get task-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -e.g. : output from the command +e.g., output from the command: .. code-block:: json @@ -36,8 +36,8 @@ e.g. : output from the command Write the task resource attributes to a file. If there are no task resource attributes, a file would be populated with the basic data. -Here the command gets task resource attributes and writes the config file to tra.yaml -e.g. : content of tra.yaml +Here, the config file is written to tra.yaml, +e.g., content of tra.yaml: :: @@ -60,7 +60,7 @@ Usage :: - flytectl get task-resource-attribute [flags] + FlyteCTL get task-resource-attribute [flags] Options ~~~~~~~ @@ -117,5 +117,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_task.rst b/docs/source/gen/flytectl_get_task.rst index 38db5a9318..cc76eff200 100644 --- a/docs/source/gen/flytectl_get_task.rst +++ b/docs/source/gen/flytectl_get_task.rst @@ -1,71 +1,71 @@ -.. _flytectl_get_task: +.. _FlyteCTL_get_task: -flytectl get task +FlyteCTL get task ----------------- -Gets task resources +Get task resources Synopsis ~~~~~~~~ -Retrieves all the task within project and domain.(task,tasks can be used interchangeably in these commands) +Retrieve all the tasks within project and domain(task,tasks can be used interchangeably in these commands): :: - bin/flytectl get task -p flytesnacks -d development + flytectl get task -p flytesnacks -d development -Retrieves task by name within project and domain. +Retrieve task by name within project and domain: :: - bin/flytectl task -p flytesnacks -d development core.basic.lp.greet + flytectl task -p flytesnacks -d development core.basic.lp.greet -Retrieves latest version of task by name within project and domain. +Retrieve latest version of task by name within project and domain: :: flytectl get task -p flytesnacks -d development core.basic.lp.greet --latest -Retrieves particular version of task by name within project and domain. +Retrieve particular version of task by name within project and domain: :: flytectl get task -p flytesnacks -d development core.basic.lp.greet --version v2 -Retrieves all the tasks with filters. +Retrieve all the tasks with filters: :: - bin/flytectl get task -p flytesnacks -d development --filter.fieldSelector="task.name=k8s_spark.pyspark_pi.print_every_time,task.version=v1" + flytectl get task -p flytesnacks -d development --filter.fieldSelector="task.name=k8s_spark.pyspark_pi.print_every_time,task.version=v1" -Retrieve a specific task with filters. +Retrieve a specific task with filters: :: - bin/flytectl get task -p flytesnacks -d development k8s_spark.pyspark_pi.print_every_time --filter.fieldSelector="task.version=v1,created_at>=2021-05-24T21:43:12.325335Z" + flytectl get task -p flytesnacks -d development k8s_spark.pyspark_pi.print_every_time --filter.fieldSelector="task.version=v1,created_at>=2021-05-24T21:43:12.325335Z" -Retrieves all the task with limit and sorting. +Retrieve all the tasks with limit and sorting: :: - bin/flytectl get -p flytesnacks -d development task --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get -p flytesnacks -d development task --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the tasks within project and domain in yaml format. +Retrieve all the tasks within project and domain in yaml format: :: - bin/flytectl get task -p flytesnacks -d development -o yaml + flytectl get task -p flytesnacks -d development -o yaml -Retrieves all the tasks within project and domain in json format. +Retrieve all the tasks within project and domain in json format: :: - bin/flytectl get task -p flytesnacks -d development -o json + flytectl get task -p flytesnacks -d development -o json -Retrieves a tasks within project and domain for a version and generate the execution spec file for it to be used for launching the execution using create execution. +Retrieve tasks within project and domain for a version and generate the execution spec file for it to be used for launching the execution using create execution: :: - bin/flytectl get tasks -d development -p flytesnacks core.advanced.run_merge_sort.merge --execFile execution_spec.yaml --version v2 + flytectl get tasks -d development -p flytesnacks core.advanced.run_merge_sort.merge --execFile execution_spec.yaml --version v2 -The generated file would look similar to this +The generated file would look similar to this: .. code-block:: yaml @@ -88,7 +88,7 @@ Usage :: - flytectl get task [flags] + FlyteCTL get task [flags] Options ~~~~~~~ @@ -151,5 +151,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_workflow-execution-config.rst b/docs/source/gen/flytectl_get_workflow-execution-config.rst index 1554f40e6a..12acb14f89 100644 --- a/docs/source/gen/flytectl_get_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_get_workflow-execution-config.rst @@ -1,25 +1,24 @@ -.. _flytectl_get_workflow-execution-config: +.. _FlyteCTL_get_workflow-execution-config: -flytectl get workflow-execution-config +FlyteCTL get workflow-execution-config -------------------------------------- -Gets matchable resources of workflow execution config +Get matchable resources of workflow execution config Synopsis ~~~~~~~~ -Retrieves workflow execution config for given project and domain combination or additionally with workflow name. +Retrieves workflow execution config for the given project and domain combination or additionally with workflow name. -Retrieves workflow execution config for project and domain -Here the command get workflow execution config for project flytectldemo and development domain. +For project flytectldemo and development domain, it is: :: flytectl get workflow-execution-config -p flytectldemo -d development -eg : output from the command +e.g., output from the command .. code-block:: json @@ -29,14 +28,14 @@ eg : output from the command "max_parallelism": 5 } -Retrieves workflow execution config for project and domain and workflow -Here the command get workflow execution config for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Retrieves workflow execution config for the project, domain and workflow. +For project flytectldemo, development domain and workflow 'core.control_flow.run_merge_sort.merge_sort', it is: :: flytectl get workflow-execution-config -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort -eg : output from the command +e.g., output from the command .. code-block:: json @@ -47,9 +46,9 @@ eg : output from the command "max_parallelism": 5 } -Writing the workflow execution config to a file. If there are no workflow execution config, command would return an error. -Here the command gets workflow execution config and writes the config file to wec.yaml -eg: content of wec.yaml +Writing the workflow execution config to a file. If there are no workflow execution config, the command would return an error. +Here, the config file is written to wec.yaml, +e.g., content of wec.yaml: :: @@ -67,7 +66,7 @@ Usage :: - flytectl get workflow-execution-config [flags] + FlyteCTL get workflow-execution-config [flags] Options ~~~~~~~ @@ -124,5 +123,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_get_workflow.rst b/docs/source/gen/flytectl_get_workflow.rst index 031274ae61..6edd90c438 100644 --- a/docs/source/gen/flytectl_get_workflow.rst +++ b/docs/source/gen/flytectl_get_workflow.rst @@ -1,72 +1,72 @@ -.. _flytectl_get_workflow: +.. _FlyteCTL_get_workflow: -flytectl get workflow +FlyteCTL get workflow --------------------- -Gets workflow resources +Get workflow resources Synopsis ~~~~~~~~ -Retrieves all the workflows within project and domain.(workflow,workflows can be used interchangeably in these commands) +Retrieve all the workflows within project and domain (workflow,workflows can be used interchangeably in these commands): :: flytectl get workflow -p flytesnacks -d development -Retrieves workflow by name within project and domain. +Retrieve workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet -Retrieves latest version of workflow by name within project and domain. +Retrieve latest version of workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet --latest -Retrieves particular version of workflow by name within project and domain. +Retrieve particular version of workflow by name within project and domain: :: flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet --version v2 -Retrieves all the workflows with filters. +Retrieve all the workflows with filters: :: - bin/flytectl get workflow -p flytesnacks -d development --filter.fieldSelector="workflow.name=k8s_spark.dataframe_passing.my_smart_schema" + flytectl get workflow -p flytesnacks -d development --filter.fieldSelector="workflow.name=k8s_spark.dataframe_passing.my_smart_schema" -Retrieve specific workflow with filters. +Retrieve specific workflow with filters: :: - bin/flytectl get workflow -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="workflow.version=v1" + flytectl get workflow -p flytesnacks -d development k8s_spark.dataframe_passing.my_smart_schema --filter.fieldSelector="workflow.version=v1" -Retrieves all the workflows with limit and sorting. +Retrieve all the workflows with limit and sorting: :: - bin/flytectl get -p flytesnacks -d development workflow --filter.sortBy=created_at --filter.limit=1 --filter.asc + flytectl get -p flytesnacks -d development workflow --filter.sortBy=created_at --filter.limit=1 --filter.asc -Retrieves all the workflow within project and domain in yaml format. +Retrieve all the workflows within project and domain in yaml format: :: flytectl get workflow -p flytesnacks -d development -o yaml -Retrieves all the workflow within project and domain in json format. +Retrieve all the workflow within project and domain in json format: :: flytectl get workflow -p flytesnacks -d development -o json -Visualize the graph for a workflow within project and domain in dot format. +Visualize the graph for a workflow within project and domain in dot format: :: flytectl get workflow -p flytesnacks -d development core.flyte_basics.basic_workflow.my_wf --latest -o dot -Visualize the graph for a workflow within project and domain in a dot content render. +Visualize the graph for a workflow within project and domain in a dot content render: :: @@ -77,7 +77,7 @@ Usage :: - flytectl get workflow [flags] + FlyteCTL get workflow [flags] Options ~~~~~~~ @@ -139,5 +139,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project. +* :doc:`FlyteCTL_get` - Fetch various Flyte resources including tasks/workflows/launchplans/executions/project. diff --git a/docs/source/gen/flytectl_register.rst b/docs/source/gen/flytectl_register.rst index e21ebd27c5..199911f0fd 100644 --- a/docs/source/gen/flytectl_register.rst +++ b/docs/source/gen/flytectl_register.rst @@ -1,9 +1,9 @@ -.. _flytectl_register: +.. _FlyteCTL_register: -flytectl register +FlyteCTL register ----------------- -Registers tasks/workflows/launchplans from list of generated serialized files. +Register tasks/workflows/launchplans from a list of generated serialized files. Synopsis ~~~~~~~~ @@ -11,9 +11,9 @@ Synopsis Takes input files as serialized versions of the tasks/workflows/launchplans and registers them with flyteadmin. -Currently these input files are protobuf files generated as output from flytekit serialize. -Project & Domain are mandatory fields to be passed for registration and an optional version which defaults to v1 -If the entities are already registered with flyte for the same version then registration would fail. +Currently, these input files are protobuf files generated as output from Flytekit serialize. +Project & Domain are mandatory fields to be passed for registration and an optional version which defaults to v1. +If the entities are already registered with Flyte for the same version, the registration would fail. Options @@ -70,7 +70,7 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_register_examples` - Registers flytesnack example -* :doc:`flytectl_register_files` - Registers file resources +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_register_examples` - Register Flytesnacks example +* :doc:`FlyteCTL_register_files` - Register file resources diff --git a/docs/source/gen/flytectl_register_examples.rst b/docs/source/gen/flytectl_register_examples.rst index 8a01a27d65..06ac0bec81 100644 --- a/docs/source/gen/flytectl_register_examples.rst +++ b/docs/source/gen/flytectl_register_examples.rst @@ -1,32 +1,32 @@ -.. _flytectl_register_examples: +.. _FlyteCTL_register_examples: -flytectl register examples +FlyteCTL register examples -------------------------- -Registers flytesnack example +Register Flytesnacks example Synopsis ~~~~~~~~ -Registers all latest flytesnacks example +Register all latest Flytesnacks examples: :: - bin/flytectl register examples -d development -p flytesnacks + flytectl register examples -d development -p flytesnacks -Registers specific release of flytesnacks example +Register specific release of Flytesnacks examples: :: - bin/flytectl register examples -d development -p flytesnacks --version v0.2.176 + flytectl register examples -d development -p flytesnacks --version v0.2.176 -Note: register command automatically override the version with release version +Note: The register command automatically override the version with release version Usage :: - flytectl register examples [flags] + FlyteCTL register examples [flags] Options ~~~~~~~ @@ -91,5 +91,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_register` - Registers tasks/workflows/launchplans from list of generated serialized files. +* :doc:`FlyteCTL_register` - Register tasks/workflows/launchplans from a list of generated serialized files. diff --git a/docs/source/gen/flytectl_register_files.rst b/docs/source/gen/flytectl_register_files.rst index f25b6597fb..b361d481c7 100644 --- a/docs/source/gen/flytectl_register_files.rst +++ b/docs/source/gen/flytectl_register_files.rst @@ -1,9 +1,9 @@ -.. _flytectl_register_files: +.. _FlyteCTL_register_files: -flytectl register files +FlyteCTL register files ----------------------- -Registers file resources +Register file resources Synopsis ~~~~~~~~ @@ -11,81 +11,81 @@ Synopsis Registers all the serialized protobuf files including tasks, workflows and launchplans with default v1 version. -If there are already registered entities with v1 version then the command will fail immediately on the first such encounter. +If previously registered entities with v1 version are present, the command will fail immediately on the first such encounter. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks + flytectl register file _pb_output/* -d development -p flytesnacks -There is no difference between registration and fast registration, In fast registration, the input provided by the user is fast serialized proto that is generated by pyflyte. If Flytectl finds any source code in users's input then it will consider registration as fast registration. Flytectl finds input file by searching an archive file whose name starts with fast and has .tar.gz extension When the user runs pyflyte with --fast flag then pyflyte creates serialize proto and it also archive create source code archive file in the same directory. -SourceUploadPath is an optional flag. By default, flytectl will create SourceUploadPath from your storage config. In case of s3 flytectl will upload code base in s3://{{DEFINE_BUCKET_IN_STORAGE_CONFIG}}/fast/{{VERSION}}-fast{{MD5_CREATED_BY_PYFLYTE}.tar.gz}. +There is no difference between registration and fast registration. In fast registration, the input provided by the user is fast serialized proto that is generated by pyflyte. If FlyteCTL finds any source code in users' input, it considers the registration as fast registration. FlyteCTL finds input file by searching an archive file whose name starts with fast and has .tar.gz extension. When the user runs pyflyte with --fast flag then pyflyte creates serialize proto and it also creates source code archive file in the same directory. +SourceUploadPath is an optional flag. By default, FlyteCTL will create SourceUploadPath from your storage config. In case of s3 FlyteCTL will upload code base in s3://{{DEFINE_BUCKET_IN_STORAGE_CONFIG}}/fast/{{VERSION}}-fast{{MD5_CREATED_BY_PYFLYTE}.tar.gz}. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 -In case of fast registration, If the SourceUploadPath flag is defined then In this case flytectl will not use the default directory for uploading the source code, it will override the destination path on the registration +In case of fast registration, if the SourceUploadPath flag is defined, FlyteCTL will not use the default directory to upload the source code. Instead, it will override the destination path on the registration. :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 --SourceUploadPath="s3://dummy/fast" + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 --SourceUploadPath="s3://dummy/fast" -Using archive file.Currently supported are .tgz and .tar extension files and can be local or remote file served through http/https. -Use --archive flag. +Using archive file. Currently supported extensions are .tgz and .tar. They can be local or remote files served through http/https. +Use --archive flag: :: - bin/flytectl register files http://localhost:8080/_pb_output.tar -d development -p flytesnacks --archive + flytectl register files http://localhost:8080/_pb_output.tar -d development -p flytesnacks --archive -Using local tgz file. +Using local tgz file: :: - bin/flytectl register files _pb_output.tgz -d development -p flytesnacks --archive + flytectl register files _pb_output.tgz -d development -p flytesnacks --archive -If you want to continue executing registration on other files ignoring the errors including version conflicts then pass in the continueOnError flag. +If you wish to continue executing registration on other files by ignoring the errors including the version conflicts, then send the continueOnError flag: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -Using short format of continueOnError flag +Using short format of continueOnError flag: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -Overriding the default version v1 using version string. +Override the default version v1 using version string: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --version v2 + flytectl register file _pb_output/* -d development -p flytesnacks --version v2 -Change the o/p format has not effect on registration. The O/p is currently available only in table format. +Changing the o/p format has no effect on the registration. The O/p is currently available only in table format: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -o yaml + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError -o yaml -Override IamRole during registration. +Override IamRole during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -i "arn:aws:iam::123456789:role/dummy" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -i "arn:aws:iam::123456789:role/dummy" -Override Kubernetes service account during registration. +Override Kubernetes service account during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -k "kubernetes-service-account" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -k "kubernetes-service-account" -Override Output location prefix during registration. +Override Output location prefix during registration: :: - bin/flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -l "s3://dummy/prefix" + flytectl register file _pb_output/* -d development -p flytesnacks --continueOnError --version v2 -l "s3://dummy/prefix" Usage :: - flytectl register files [flags] + FlyteCTL register files [flags] Options ~~~~~~~ @@ -150,5 +150,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_register` - Registers tasks/workflows/launchplans from list of generated serialized files. +* :doc:`FlyteCTL_register` - Register tasks/workflows/launchplans from a list of generated serialized files. diff --git a/docs/source/gen/flytectl_sandbox.rst b/docs/source/gen/flytectl_sandbox.rst index 3b77cb201e..05b115d066 100644 --- a/docs/source/gen/flytectl_sandbox.rst +++ b/docs/source/gen/flytectl_sandbox.rst @@ -1,6 +1,6 @@ -.. _flytectl_sandbox: +.. _FlyteCTL_sandbox: -flytectl sandbox +FlyteCTL sandbox ---------------- Used for sandbox interactions like start/teardown/status/exec. @@ -10,29 +10,29 @@ Synopsis -The Flyte Sandbox is a fully standalone minimal environment for running Flyte. provides a simplified way of running flyte-sandbox as a single Docker container running locally. +The Flyte Sandbox is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte sandbox as a single Docker container locally. -Create sandbox cluster. +Create sandbox cluster: :: - bin/flytectl sandbox start + flytectl sandbox start -Remove sandbox cluster. +Remove sandbox cluster: :: - bin/flytectl sandbox teardown + flytectl sandbox teardown -Check status of sandbox container. +Check status of sandbox container: :: - bin/flytectl sandbox status + flytectl sandbox status -Execute command inside sandbox container. +Execute command inside sandbox container: :: - bin/flytectl sandbox exec -- pwd + flytectl sandbox exec -- pwd Options @@ -89,9 +89,9 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_sandbox_exec` - Execute non-interactive command inside the sandbox container -* :doc:`flytectl_sandbox_start` - Start the flyte sandbox cluster -* :doc:`flytectl_sandbox_status` - Get the status of the sandbox environment. -* :doc:`flytectl_sandbox_teardown` - Teardown will cleanup the sandbox environment +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_sandbox_exec` - Execute non-interactive command inside the sandbox container +* :doc:`FlyteCTL_sandbox_start` - Start the flyte sandbox cluster +* :doc:`FlyteCTL_sandbox_status` - Get status of the sandbox environment. +* :doc:`FlyteCTL_sandbox_teardown` - Teardown cleans up the sandbox environment diff --git a/docs/source/gen/flytectl_sandbox_exec.rst b/docs/source/gen/flytectl_sandbox_exec.rst index bd9c0ec4e9..c89b580c0b 100644 --- a/docs/source/gen/flytectl_sandbox_exec.rst +++ b/docs/source/gen/flytectl_sandbox_exec.rst @@ -1,6 +1,6 @@ -.. _flytectl_sandbox_exec: +.. _FlyteCTL_sandbox_exec: -flytectl sandbox exec +FlyteCTL sandbox exec --------------------- Execute non-interactive command inside the sandbox container @@ -10,16 +10,16 @@ Synopsis -Execute command will run non-interactive command inside the sandbox container and return immediately with the output.By default flytectl exec in /root directory inside the sandbox container +Runs non-interactive command inside the Sandbox container and immediately returns the output. By default, flytectl exec is present in /root directory inside the Sandbox container. :: - bin/flytectl sandbox exec -- ls -al + flytectl sandbox exec -- ls -al Usage :: - flytectl sandbox exec [flags] + FlyteCTL sandbox exec [flags] Options ~~~~~~~ @@ -75,5 +75,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. +* :doc:`FlyteCTL_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/docs/source/gen/flytectl_sandbox_start.rst b/docs/source/gen/flytectl_sandbox_start.rst index 3c48e3ad2b..1b7cd78ed8 100644 --- a/docs/source/gen/flytectl_sandbox_start.rst +++ b/docs/source/gen/flytectl_sandbox_start.rst @@ -1,6 +1,6 @@ -.. _flytectl_sandbox_start: +.. _FlyteCTL_sandbox_start: -flytectl sandbox start +FlyteCTL sandbox start ---------------------- Start the flyte sandbox cluster @@ -10,32 +10,32 @@ Synopsis -The Flyte Sandbox is a fully standalone minimal environment for running Flyte. provides a simplified way of running flyte-sandbox as a single Docker container running locally. +The Flyte Sandbox is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte sandbox as a single Docker container locally. -Start sandbox cluster without any source code +Start sandbox cluster without any source code: :: flytectl sandbox start -Mount your source code repository inside sandbox +Mount your source code repository inside sandbox: :: flytectl sandbox start --source=$HOME/flyteorg/flytesnacks -Run specific version of flyte. flytectl sandbox only support flyte version available in Github release https://github.com/flyteorg/flyte/tags +Run specific version of Flyte. FlyteCTL sandbox only supports Flyte version available in the Github release, https://github.com/flyteorg/flyte/tags. :: flytectl sandbox start --version=v0.14.0 -Note: Flytectl sandbox is only supported for Flyte versions > v0.10.0 +Note: FlyteCTL sandbox is only supported for Flyte versions > v0.10.0 -Specify a Flyte Sandbox compliant image with the registry. This is useful, in case you want to use an image from your registry. +Specify a Flyte Sandbox compliant image with the registry. This is useful in case you want to use an image from your registry. :: flytectl sandbox start --image docker.io/my-override:latest -Specify a Flyte Sandbox image pull policy. Possible pull policy values are Always, IfNotPresent, or Never +Specify a Flyte Sandbox image pull policy. Possible pull policy values are Always, IfNotPresent, or Never: :: flytectl sandbox start --image docker.io/my-override:latest --imagePullPolicy Always @@ -44,7 +44,7 @@ Usage :: - flytectl sandbox start [flags] + FlyteCTL sandbox start [flags] Options ~~~~~~~ @@ -104,5 +104,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. +* :doc:`FlyteCTL_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/docs/source/gen/flytectl_sandbox_status.rst b/docs/source/gen/flytectl_sandbox_status.rst index 017b0e0b0f..b61887f15c 100644 --- a/docs/source/gen/flytectl_sandbox_status.rst +++ b/docs/source/gen/flytectl_sandbox_status.rst @@ -1,28 +1,27 @@ -.. _flytectl_sandbox_status: +.. _FlyteCTL_sandbox_status: -flytectl sandbox status +FlyteCTL sandbox status ----------------------- -Get the status of the sandbox environment. +Get status of the sandbox environment. Synopsis ~~~~~~~~ -Status will retrieve the status of the Sandbox environment. Currently FlyteSandbox runs as a local docker container. -This will return the docker status for this container +Retrieve the status of the Sandbox environment. Currently, Flyte Sandbox runs as a local Docker container. Usage :: - bin/flytectl sandbox status + flytectl sandbox status :: - flytectl sandbox status [flags] + FlyteCTL sandbox status [flags] Options ~~~~~~~ @@ -78,5 +77,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. +* :doc:`FlyteCTL_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/docs/source/gen/flytectl_sandbox_teardown.rst b/docs/source/gen/flytectl_sandbox_teardown.rst index b48d24452f..ca2a13d800 100644 --- a/docs/source/gen/flytectl_sandbox_teardown.rst +++ b/docs/source/gen/flytectl_sandbox_teardown.rst @@ -1,19 +1,19 @@ -.. _flytectl_sandbox_teardown: +.. _FlyteCTL_sandbox_teardown: -flytectl sandbox teardown +FlyteCTL sandbox teardown ------------------------- -Teardown will cleanup the sandbox environment +Teardown cleans up the sandbox environment Synopsis ~~~~~~~~ -Teardown will remove sandbox cluster and all the flyte config created by sandbox start +Teardown removes Sandbox cluster and all the Flyte config created by sandbox start: :: - bin/flytectl sandbox teardown + flytectl sandbox teardown Usage @@ -21,7 +21,7 @@ Usage :: - flytectl sandbox teardown [flags] + FlyteCTL sandbox teardown [flags] Options ~~~~~~~ @@ -77,5 +77,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. +* :doc:`FlyteCTL_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/docs/source/gen/flytectl_update.rst b/docs/source/gen/flytectl_update.rst index cb65073fef..a4276dfa44 100644 --- a/docs/source/gen/flytectl_update.rst +++ b/docs/source/gen/flytectl_update.rst @@ -1,21 +1,21 @@ -.. _flytectl_update: +.. _FlyteCTL_update: -flytectl update +FlyteCTL update --------------- -Used for updating flyte resources eg: project. +Update Flyte resources e.g., project. Synopsis ~~~~~~~~ -Currently this command only provides subcommands to update project. -Takes input project which need to be archived or unarchived. Name of the project to be updated is mandatory field. -Example update project to activate it. +Currently, this command only provides subcommands to update project. +Takes input project that needs to be archived or unarchived. Name of the project to be updated is a mandatory field. +To update a project: :: - bin/flytectl update project -p flytesnacks --activateProject + flytectl update project -p flytesnacks --activateProject Options @@ -72,16 +72,16 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_update_cluster-resource-attribute` - Updates matchable resources of cluster attributes -* :doc:`flytectl_update_execution-cluster-label` - Updates matchable resources of execution cluster label -* :doc:`flytectl_update_execution-queue-attribute` - Updates matchable resources of execution queue attributes -* :doc:`flytectl_update_launchplan` - Updates launch plan status -* :doc:`flytectl_update_launchplan-meta` - Updates launch plan metadata -* :doc:`flytectl_update_plugin-override` - Updates matchable resources of plugin overrides -* :doc:`flytectl_update_project` - Updates project resources -* :doc:`flytectl_update_task-meta` - Updates task metadata -* :doc:`flytectl_update_task-resource-attribute` - Updates matchable resources of task attributes -* :doc:`flytectl_update_workflow-execution-config` - Updates matchable resources of workflow execution config -* :doc:`flytectl_update_workflow-meta` - Updates workflow metadata +* :doc:`FlyteCTL` - FlyteCTL CLI tool +* :doc:`FlyteCTL_update_cluster-resource-attribute` - Update matchable resources of cluster attributes +* :doc:`FlyteCTL_update_execution-cluster-label` - Update matchable resources of execution cluster label +* :doc:`FlyteCTL_update_execution-queue-attribute` - Update matchable resources of execution queue attributes +* :doc:`FlyteCTL_update_launchplan` - Update launch plan status +* :doc:`FlyteCTL_update_launchplan-meta` - Update launch plan metadata +* :doc:`FlyteCTL_update_plugin-override` - Update matchable resources of plugin overrides +* :doc:`FlyteCTL_update_project` - Update project resources +* :doc:`FlyteCTL_update_task-meta` - Update task metadata +* :doc:`FlyteCTL_update_task-resource-attribute` - Update matchable resources of task attributes +* :doc:`FlyteCTL_update_workflow-execution-config` - Update matchable resources of workflow execution config +* :doc:`FlyteCTL_update_workflow-meta` - Update workflow metadata diff --git a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst index 9f1ca738f9..25b31bb004 100644 --- a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst @@ -1,9 +1,9 @@ -.. _flytectl_update_cluster-resource-attribute: +.. _FlyteCTL_update_cluster-resource-attribute: -flytectl update cluster-resource-attribute +FlyteCTL update cluster-resource-attribute ------------------------------------------ -Updates matchable resources of cluster attributes +Update matchable resources of cluster attributes Synopsis ~~~~~~~~ @@ -12,9 +12,9 @@ Synopsis Updates cluster resource attributes for given project and domain combination or additionally with workflow name. -Updating to the cluster resource attribute is only available from a generated file. See the get section for generating this file. -Here the command updates takes the input for cluster resource attributes from the config file cra.yaml -eg: content of cra.yaml +Updating to the cluster resource attribute is only available from a generated file. See the get section to generate this file. +It takes input for cluster resource attributes from the config file cra.yaml, +e.g., content of cra.yaml: .. code-block:: yaml @@ -28,12 +28,12 @@ eg: content of cra.yaml flytectl update cluster-resource-attribute --attrFile cra.yaml -Updating cluster resource attribute for project and domain and workflow combination. This will take precedence over any other +Updates cluster resource attribute for project and domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values -Refer to get cluster-resource-attribute section on how to generate this file -Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute that is already set and then update it to have new values. +Refer to get cluster-resource-attribute section on how to generate this file. +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -54,7 +54,7 @@ Usage :: - flytectl update cluster-resource-attribute [flags] + FlyteCTL update cluster-resource-attribute [flags] Options ~~~~~~~ @@ -112,5 +112,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_execution-cluster-label.rst b/docs/source/gen/flytectl_update_execution-cluster-label.rst index 4fca7a3a9f..6086db5067 100644 --- a/docs/source/gen/flytectl_update_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_update_execution-cluster-label.rst @@ -1,20 +1,20 @@ -.. _flytectl_update_execution-cluster-label: +.. _FlyteCTL_update_execution-cluster-label: -flytectl update execution-cluster-label +FlyteCTL update execution-cluster-label --------------------------------------- -Updates matchable resources of execution cluster label +Update matchable resources of execution cluster label Synopsis ~~~~~~~~ -Updates execution cluster label for given project and domain combination or additionally with workflow name. +Updates execution cluster label for the given project and domain combination or additionally with workflow name. -Updating to the execution cluster label is only available from a generated file. See the get section for generating this file. -Here the command updates takes the input for execution cluster label from the config file ecl.yaml -eg: content of ecl.yaml +Updating to the execution cluster label is only available from a generated file. See the get section to generate this file. +It takes input for execution cluster label from the config file ecl.yaml +e.g., content of ecl.yaml: .. code-block:: yaml @@ -26,9 +26,9 @@ eg: content of ecl.yaml flytectl update execution-cluster-label --attrFile ecl.yaml -Updating execution cluster label for project and domain and workflow combination. This will take precedence over any other +Updates execution cluster label for project, domain and workflow combination. This will take precedence over any other execution cluster label defined at project domain level. -Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -47,7 +47,7 @@ Usage :: - flytectl update execution-cluster-label [flags] + FlyteCTL update execution-cluster-label [flags] Options ~~~~~~~ @@ -105,5 +105,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_execution-queue-attribute.rst b/docs/source/gen/flytectl_update_execution-queue-attribute.rst index ae9db9b656..849b54ab17 100644 --- a/docs/source/gen/flytectl_update_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_update_execution-queue-attribute.rst @@ -1,23 +1,23 @@ -.. _flytectl_update_execution-queue-attribute: +.. _FlyteCTL_update_execution-queue-attribute: -flytectl update execution-queue-attribute +FlyteCTL update execution-queue-attribute ----------------------------------------- -Updates matchable resources of execution queue attributes +Update matchable resources of execution queue attributes Synopsis ~~~~~~~~ -Updates execution queue attributes for given project and domain combination or additionally with workflow name. +Updates execution queue attributes for the given project and domain combination or additionally with workflow name. -Updating to the execution queue attribute is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values +Updating the execution queue attribute is only available from a generated file. See the get section for generating this file. +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute that is already set and then update it to have new values. Refer to get execution-queue-attribute section on how to generate this file -Here the command updates takes the input for execution queue attributes from the config file era.yaml -eg: content of era.yaml +It takes input for execution queue attributes from the config file era.yaml, +e.g., content of era.yaml: .. code-block:: yaml @@ -33,9 +33,9 @@ eg: content of era.yaml flytectl update execution-queue-attribute --attrFile era.yaml -Updating execution queue attribute for project and domain and workflow combination. This will take precedence over any other +Updates execution queue attribute for project, domain and workflow combination. This will take precedence over any other execution queue attribute defined at project domain level. -Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -58,7 +58,7 @@ Usage :: - flytectl update execution-queue-attribute [flags] + FlyteCTL update execution-queue-attribute [flags] Options ~~~~~~~ @@ -116,5 +116,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_launchplan-meta.rst b/docs/source/gen/flytectl_update_launchplan-meta.rst index 14717eb90c..26fa58c7b4 100644 --- a/docs/source/gen/flytectl_update_launchplan-meta.rst +++ b/docs/source/gen/flytectl_update_launchplan-meta.rst @@ -1,26 +1,26 @@ -.. _flytectl_update_launchplan-meta: +.. _FlyteCTL_update_launchplan-meta: -flytectl update launchplan-meta +FlyteCTL update launchplan-meta ------------------------------- -Updates launch plan metadata +Update launch plan metadata Synopsis ~~~~~~~~ -Following command updates the description on the launchplan. +Update the description on the launch plan: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --description "Mergesort example" -Archiving launchplan named entity is not supported and would throw an error. +Archiving launch plan named entity is not supported and would throw an error: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive -Activating launchplan named entity would be a noop. +Activating launch plan named entity would be a noop: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate @@ -30,7 +30,7 @@ Usage :: - flytectl update launchplan-meta [flags] + FlyteCTL update launchplan-meta [flags] Options ~~~~~~~ @@ -90,5 +90,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_launchplan.rst b/docs/source/gen/flytectl_update_launchplan.rst index 41f7995b27..4213143d3a 100644 --- a/docs/source/gen/flytectl_update_launchplan.rst +++ b/docs/source/gen/flytectl_update_launchplan.rst @@ -1,21 +1,21 @@ -.. _flytectl_update_launchplan: +.. _FlyteCTL_update_launchplan: -flytectl update launchplan +FlyteCTL update launchplan -------------------------- -Updates launch plan status +Update launch plan status Synopsis ~~~~~~~~ -Activating launchplan activates the scheduled job associated with it +Activating launch plan activates the scheduled job associated with it: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --version v1 --activate -Archiving launchplan deschedules any scheduled job associated with it +Archiving launch plan deschedules any scheduled job associated with it: :: flytectl update launchplan -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --version v1 --archive @@ -26,7 +26,7 @@ Usage :: - flytectl update launchplan [flags] + FlyteCTL update launchplan [flags] Options ~~~~~~~ @@ -86,5 +86,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_plugin-override.rst b/docs/source/gen/flytectl_update_plugin-override.rst index 3056208c60..33c765d247 100644 --- a/docs/source/gen/flytectl_update_plugin-override.rst +++ b/docs/source/gen/flytectl_update_plugin-override.rst @@ -1,9 +1,9 @@ -.. _flytectl_update_plugin-override: +.. _FlyteCTL_update_plugin-override: -flytectl update plugin-override +FlyteCTL update plugin-override ------------------------------- -Updates matchable resources of plugin overrides +Update matchable resources of plugin overrides Synopsis ~~~~~~~~ @@ -13,11 +13,11 @@ Synopsis Updates plugin overrides for given project and domain combination or additionally with workflow name. Updating to the plugin override is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing plugins overrides on custom project and domain and workflow combination. -Would be preferable to do get and generate an plugin override file if there is an existing override already set and then update it to have new values +This will completely overwrite any existing plugins overrides on custom project, domain and workflow combination. +It is preferable to do get and generate a plugin override file if there is an existing override already set and then update it to have new values. Refer to get plugin-override section on how to generate this file -Here the command updates takes the input for plugin overrides from the config file po.yaml -eg: content of po.yaml +It takes input for plugin overrides from the config file po.yaml, +e.g., content of po.yaml: .. code-block:: yaml @@ -34,9 +34,9 @@ eg: content of po.yaml flytectl update plugin-override --attrFile po.yaml -Updating plugin override for project and domain and workflow combination. This will take precedence over any other +Updates plugin override for project, domain and workflow combination. This will take precedence over any other plugin overrides defined at project domain level. -Update the plugin overrides for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -60,7 +60,7 @@ Usage :: - flytectl update plugin-override [flags] + FlyteCTL update plugin-override [flags] Options ~~~~~~~ @@ -118,5 +118,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_project.rst b/docs/source/gen/flytectl_update_project.rst index abbaaca825..1e13cac8fd 100644 --- a/docs/source/gen/flytectl_update_project.rst +++ b/docs/source/gen/flytectl_update_project.rst @@ -1,51 +1,51 @@ -.. _flytectl_update_project: +.. _FlyteCTL_update_project: -flytectl update project +FlyteCTL update project ----------------------- -Updates project resources +Update project resources Synopsis ~~~~~~~~ -Updates the project according the flags passed. Allows you to archive or activate a project. -Activates project named flytesnacks. +Updates the project according to the flags passed. Allows you to archive or activate a project. +Activate project flytesnacks: :: - bin/flytectl update project -p flytesnacks --activateProject + flytectl update project -p flytesnacks --activateProject -Archives project named flytesnacks. +Archive project flytesnacks: :: - bin/flytectl update project -p flytesnacks --archiveProject + flytectl update project -p flytesnacks --archiveProject -Incorrect usage when passing both archive and activate. +Incorrect usage when passing both archive and activate: :: - bin/flytectl update project flytesnacks --archiveProject --activateProject + flytectl update project flytesnacks --archiveProject --activateProject -Incorrect usage when passing unknown-project. +Incorrect usage when passing unknown-project: :: - bin/flytectl update project unknown-project --archiveProject + flytectl update project unknown-project --archiveProject -Incorrect usage when passing valid project using -p option. +Incorrect usage when passing valid project using -p option: :: - bin/flytectl update project unknown-project --archiveProject -p known-project + flytectl update project unknown-project --archiveProject -p known-project Usage :: - flytectl update project [flags] + FlyteCTL update project [flags] Options ~~~~~~~ @@ -104,5 +104,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_task-meta.rst b/docs/source/gen/flytectl_update_task-meta.rst index f25862a7f9..497f5edf00 100644 --- a/docs/source/gen/flytectl_update_task-meta.rst +++ b/docs/source/gen/flytectl_update_task-meta.rst @@ -1,26 +1,26 @@ -.. _flytectl_update_task-meta: +.. _FlyteCTL_update_task-meta: -flytectl update task-meta +FlyteCTL update task-meta ------------------------- -Updates task metadata +Update task metadata Synopsis ~~~~~~~~ -Following command updates the description on the task. +Updates the description on the task: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --description "Merge sort example" -Archiving task named entity is not supported and would throw an error. +Archiving task named entity is not supported and would throw an error: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --archive -Activating task named entity would be a noop as archiving is not possible. +Activating task named entity would be a noop since archiving is not possible: :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --activate @@ -30,7 +30,7 @@ Usage :: - flytectl update task-meta [flags] + FlyteCTL update task-meta [flags] Options ~~~~~~~ @@ -90,5 +90,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_task-resource-attribute.rst b/docs/source/gen/flytectl_update_task-resource-attribute.rst index 182c3cdf3f..856a267771 100644 --- a/docs/source/gen/flytectl_update_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_task-resource-attribute.rst @@ -1,23 +1,23 @@ -.. _flytectl_update_task-resource-attribute: +.. _FlyteCTL_update_task-resource-attribute: -flytectl update task-resource-attribute +FlyteCTL update task-resource-attribute --------------------------------------- -Updates matchable resources of task attributes +Update matchable resources of task attributes Synopsis ~~~~~~~~ -Updates task resource attributes for given project and domain combination or additionally with workflow name. +Updates task resource attributes for the given project and domain combination or additionally with workflow name. Updating the task resource attribute is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination attributes. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values -Refer to get task-resource-attribute section on how to generate this file -Here the command updates takes the input for task resource attributes from the config file tra.yaml -eg: content of tra.yaml +This will completely overwrite any existing custom project, domain and workflow combination attributes. +It is preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values. +Refer to get task-resource-attribute section on how to generate this file. +It takes input for task resource attributes from the config file tra.yaml, +e.g., content of tra.yaml: .. code-block:: yaml @@ -34,9 +34,9 @@ eg: content of tra.yaml flytectl update task-resource-attribute --attrFile tra.yaml -Updating task resource attribute for project and domain and workflow combination. This will take precedence over any other +Updates task resource attribute for project, domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -60,7 +60,7 @@ Usage :: - flytectl update task-resource-attribute [flags] + FlyteCTL update task-resource-attribute [flags] Options ~~~~~~~ @@ -118,5 +118,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_workflow-execution-config.rst b/docs/source/gen/flytectl_update_workflow-execution-config.rst index cf66feece0..b10ca234a8 100644 --- a/docs/source/gen/flytectl_update_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_update_workflow-execution-config.rst @@ -1,9 +1,9 @@ -.. _flytectl_update_workflow-execution-config: +.. _FlyteCTL_update_workflow-execution-config: -flytectl update workflow-execution-config +FlyteCTL update workflow-execution-config ----------------------------------------- -Updates matchable resources of workflow execution config +Update matchable resources of workflow execution config Synopsis ~~~~~~~~ @@ -13,11 +13,11 @@ Synopsis Updates workflow execution config for given project and domain combination or additionally with workflow name. Updating the workflow execution config is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom project and domain and workflow combination execution config. -Would be preferable to do get and generate an config file if there is an existing execution config already set and then update it to have new values -Refer to get workflow-execution-config section on how to generate this file -Here the command updates takes the input for workflow execution config from the config file wec.yaml -eg: content of wec.yaml +This will completely overwrite any existing custom project and domain and workflow combination execution config. +It is preferable to do get and generate a config file if there is an existing execution config already set and then update it to have new values. +Refer to get workflow-execution-config section on how to generate this file. +It takes input for workflow execution config from the config file wec.yaml, +e.g., content of wec.yaml: .. code-block:: yaml @@ -29,9 +29,9 @@ eg: content of wec.yaml flytectl update workflow-execution-config --attrFile wec.yaml -Updating workflow execution config for project and domain and workflow combination. This will take precedence over any other +Updates workflow execution config for project, domain and workflow combination. This will take precedence over any other execution config defined at project domain level. -Update the workflow execution config for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain +For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo project, development domain, it is: .. code-block:: yaml @@ -50,7 +50,7 @@ Usage :: - flytectl update workflow-execution-config [flags] + FlyteCTL update workflow-execution-config [flags] Options ~~~~~~~ @@ -108,5 +108,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_update_workflow-meta.rst b/docs/source/gen/flytectl_update_workflow-meta.rst index 404dd37b52..1e665e8958 100644 --- a/docs/source/gen/flytectl_update_workflow-meta.rst +++ b/docs/source/gen/flytectl_update_workflow-meta.rst @@ -1,26 +1,26 @@ -.. _flytectl_update_workflow-meta: +.. _FlyteCTL_update_workflow-meta: -flytectl update workflow-meta +FlyteCTL update workflow-meta ----------------------------- -Updates workflow metadata +Update workflow metadata Synopsis ~~~~~~~~ -Following command updates the description on the workflow. +Updates the description on the workflow: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --description "Mergesort workflow example" -Archiving workflow named entity would cause this to disapper from flyteconsole UI. +Archiving workflow named entity would cause this to disapper from flyteconsole UI: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive -Activating workflow named entity +Activate workflow named entity: :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate @@ -30,7 +30,7 @@ Usage :: - flytectl update workflow-meta [flags] + FlyteCTL update workflow-meta [flags] Options ~~~~~~~ @@ -90,5 +90,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_update` - Used for updating flyte resources eg: project. +* :doc:`FlyteCTL_update` - Update Flyte resources e.g., project. diff --git a/docs/source/gen/flytectl_upgrade.rst b/docs/source/gen/flytectl_upgrade.rst index 63379360f4..b44d9c5e36 100644 --- a/docs/source/gen/flytectl_upgrade.rst +++ b/docs/source/gen/flytectl_upgrade.rst @@ -1,33 +1,33 @@ -.. _flytectl_upgrade: +.. _FlyteCTL_upgrade: -flytectl upgrade +FlyteCTL upgrade ---------------- -Used for upgrade/rollback flyte version +Upgrade/rollback to a Flyte version Synopsis ~~~~~~~~ -Upgrade flytectl +For FlyteCTL, it is: :: - bin/flytectl upgrade + flytectl upgrade -Note: Please use upgrade with sudo, Without sudo it will cause permission issue +Note: Please use upgrade with sudo. Without sudo it will cause permission issue. -Rollback flytectl binary +Rollback flytectl binary: :: - bin/flytectl upgrade rollback + flytectl upgrade rollback -Note: Upgrade is not available on windows +Note: Upgrade is not available on windows. :: - flytectl upgrade [flags] + FlyteCTL upgrade [flags] Options ~~~~~~~ @@ -83,5 +83,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool +* :doc:`FlyteCTL` - FlyteCTL CLI tool diff --git a/docs/source/gen/flytectl_version.rst b/docs/source/gen/flytectl_version.rst index 43a1516515..5748697600 100644 --- a/docs/source/gen/flytectl_version.rst +++ b/docs/source/gen/flytectl_version.rst @@ -1,24 +1,24 @@ -.. _flytectl_version: +.. _FlyteCTL_version: -flytectl version +FlyteCTL version ---------------- -Used for fetching flyte version +Fetch Flyte version Synopsis ~~~~~~~~ -Example version. +For FlyteCTL version, it is: :: - bin/flytectl version + flytectl version :: - flytectl version [flags] + FlyteCTL version [flags] Options ~~~~~~~ @@ -74,5 +74,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl` - flyetcl CLI tool +* :doc:`FlyteCTL` - FlyteCTL CLI tool diff --git a/docs/source/launchplan.rst b/docs/source/launchplan.rst new file mode 100644 index 0000000000..6adab05fb8 --- /dev/null +++ b/docs/source/launchplan.rst @@ -0,0 +1,9 @@ +Launchplan +------ + +.. toctree:: + :maxdepth: 1 + :caption: Launchplan + + gen/FlyteCTL_get_launchplan + gen/FlyteCTL_update_launchplan \ No newline at end of file diff --git a/docs/source/nouns.rst b/docs/source/nouns.rst index 0afad1c0c0..df3082ee2a 100644 --- a/docs/source/nouns.rst +++ b/docs/source/nouns.rst @@ -1,48 +1,24 @@ Nouns ------ -Flytectl noun specify the resource on which the action needs to be performed eg: resources like project/workflow/task/execution +Flytectl nouns specify the resource on which the action needs to be performed. +Example of resources include project, workflow, task, execution. .. toctree:: :maxdepth: 1 :caption: Nouns - - gen/flytectl_create_project - gen/flytectl_create_execution - gen/flytectl_get_execution - gen/flytectl_get_project - gen/flytectl_get_workflow - gen/flytectl_get_task - gen/flytectl_get_task-resource-attribute - gen/flytectl_get_cluster-resource-attribute - gen/flytectl_get_execution-cluster-label - gen/flytectl_get_execution-queue-attribute - gen/flytectl_get_plugin-override - gen/flytectl_get_launchplan - gen/flytectl_get_workflow-execution-config - gen/flytectl_update_launchplan - gen/flytectl_update_workflow - gen/flytectl_update_project - gen/flytectl_update_task - gen/flytectl_update_task-resource-attribute - gen/flytectl_update_cluster-resource-attribute - gen/flytectl_update_execution-cluster-label - gen/flytectl_update_execution-queue-attribute - gen/flytectl_update_plugin-override - gen/flytectl_update_workflow-execution-config - gen/flytectl_register_files - gen/flytectl_register_examples - gen/flytectl_delete_execution - gen/flytectl_delete_task-resource-attribute - gen/flytectl_delete_cluster-resource-attribute - gen/flytectl_delete_execution-cluster-label - gen/flytectl_delete_execution-queue-attribute - gen/flytectl_delete_plugin-override - gen/flytectl_delete_workflow-execution-config - gen/flytectl_config_validate - gen/flytectl_config_init - gen/flytectl_config_discover - gen/flytectl_sandbox_start - gen/flytectl_sandbox_status - gen/flytectl_sandbox_teardown - gen/flytectl_sandbox_exec - gen/flytectl_upgrade + + project + execution + workflow + task + task-resource-attribute + cluster-resource-attribute + execution-cluster-label + execution-queue-attribute + plugin-override + launchplan + workflow-execution-config + examples + files + config + sandbox diff --git a/docs/source/plugin-override.rst b/docs/source/plugin-override.rst new file mode 100644 index 0000000000..26ebd9e28d --- /dev/null +++ b/docs/source/plugin-override.rst @@ -0,0 +1,10 @@ +Plugin override +------ + +.. toctree:: + :maxdepth: 1 + :caption: Plugin override + + gen/FlyteCTL_get_plugin-override + gen/FlyteCTL_update_plugin-override + gen/FlyteCTL_delete_plugin-override \ No newline at end of file diff --git a/docs/source/project.rst b/docs/source/project.rst new file mode 100644 index 0000000000..c81e4e785f --- /dev/null +++ b/docs/source/project.rst @@ -0,0 +1,10 @@ +Project +------ + +.. toctree:: + :maxdepth: 1 + :caption: Project + + gen/FlyteCTL_create_project + gen/FlyteCTL_get_project + gen/FlyteCTL_update_project \ No newline at end of file diff --git a/docs/source/sandbox.rst b/docs/source/sandbox.rst new file mode 100644 index 0000000000..8cacd53ac0 --- /dev/null +++ b/docs/source/sandbox.rst @@ -0,0 +1,11 @@ +Sandbox +------ + +.. toctree:: + :maxdepth: 1 + :caption: Sandbox + + gen/FlyteCTL_sandbox_start + gen/FlyteCTL_sandbox_status + gen/FlyteCTL_sandbox_teardown + gen/FlyteCTL_sandbox_exec \ No newline at end of file diff --git a/docs/source/task-resource-attribute.rst b/docs/source/task-resource-attribute.rst new file mode 100644 index 0000000000..95dca187cd --- /dev/null +++ b/docs/source/task-resource-attribute.rst @@ -0,0 +1,11 @@ +Task resource attribute +------ + +.. toctree:: + :maxdepth: 1 + :caption: Task resource attribute + + gen/FlyteCTL_get_task-resource-attribute + gen/FlyteCTL_update_task-resource-attribute + gen/FlyteCTL_delete_task-resource-attribute + diff --git a/docs/source/task.rst b/docs/source/task.rst new file mode 100644 index 0000000000..1cf59495c0 --- /dev/null +++ b/docs/source/task.rst @@ -0,0 +1,8 @@ +Task +------ + +.. toctree:: + :maxdepth: 1 + :caption: Task + + gen/FlyteCTL_get_task \ No newline at end of file diff --git a/docs/source/verbs.rst b/docs/source/verbs.rst index eab243c410..88d4dcefbb 100644 --- a/docs/source/verbs.rst +++ b/docs/source/verbs.rst @@ -1,18 +1,18 @@ Verbs ------ -Flytectl verbs specify the actions to be performed on the resources like create/get/update/delete +Flytectl verbs specify the actions to be performed on the resources. Ex: create, get, update, and delete. .. toctree:: :maxdepth: 1 :caption: Verbs - gen/flytectl_create - gen/flytectl_completion - gen/flytectl_get - gen/flytectl_update - gen/flytectl_delete - gen/flytectl_register - gen/flytectl_config - gen/flytectl_sandbox - gen/flytectl_version - gen/flytectl_upgrade + gen/FlyteCTL_flytectl_create + gen/FlyteCTL_flytectl_completion + gen/FlyteCTL_flytectl_get + gen/FlyteCTL_flytectl_update + gen/FlyteCTL_delete + gen/FlyteCTL_register + gen/FlyteCTL_config + gen/FlyteCTL_sandbox + gen/FlyteCTL_version + gen/FlyteCTL_upgrade diff --git a/docs/source/workflow-execution-config.rst b/docs/source/workflow-execution-config.rst new file mode 100644 index 0000000000..008864872b --- /dev/null +++ b/docs/source/workflow-execution-config.rst @@ -0,0 +1,10 @@ +Workflow execution config +------ + +.. toctree:: + :maxdepth: 1 + :caption: Workflow execution config + + gen/FlyteCTL_get_workflow-execution-config + gen/FlyteCTL_update_workflow-execution-config + gen/FlyteCTL_delete_workflow-execution-config \ No newline at end of file diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst new file mode 100644 index 0000000000..b37dbad28f --- /dev/null +++ b/docs/source/workflow.rst @@ -0,0 +1,8 @@ +Workflow +------ + +.. toctree:: + :maxdepth: 1 + :caption: Workflow + + gen/FlyteCTL_get_workflow \ No newline at end of file diff --git a/pkg/configutil/configutil.go b/pkg/configutil/configutil.go index 44420887a3..c0df7f9b31 100644 --- a/pkg/configutil/configutil.go +++ b/pkg/configutil/configutil.go @@ -65,17 +65,17 @@ func GetSandboxTemplate() string { return AdminConfigTemplate + StorageConfigTemplate } -// GetAWSCloudTemplate return aws flyte config with storage config +// GetAWSCloudTemplate return aws Flyte config with storage config func GetAWSCloudTemplate() string { return AdminConfigTemplate + StorageS3ConfigTemplate } -// GetGoogleCloudTemplate return google flyte config with storage config +// GetGoogleCloudTemplate return google Flyte config with storage config func GetGoogleCloudTemplate() string { return AdminConfigTemplate + StorageGCSConfigTemplate } -// SetupConfig download the flyte sandbox config +// SetupConfig download the Flyte sandbox config func SetupConfig(filename, templateStr string, templateSpec ConfigTemplateSpec) error { tmpl := template.New("config") tmpl, err := tmpl.Parse(templateStr) @@ -90,7 +90,7 @@ func SetupConfig(filename, templateStr string, templateSpec ConfigTemplateSpec) return tmpl.Execute(file, templateSpec) } -// ConfigCleanup will remove the sandbox config from flyte dir +// ConfigCleanup will remove the sandbox config from Flyte dir func ConfigCleanup() error { err := os.Remove(FlytectlConfig) if err != nil { diff --git a/pkg/util/util_test.go b/pkg/util/util_test.go index c123683e86..b97b11804e 100644 --- a/pkg/util/util_test.go +++ b/pkg/util/util_test.go @@ -24,34 +24,34 @@ func TestSetupFlyteDir(t *testing.T) { } func TestIsVersionGreaterThan(t *testing.T) { - t.Run("Compare flytectl version when upgrade available", func(t *testing.T) { + t.Run("Compare FlyteCTL version when upgrade available", func(t *testing.T) { _, err := IsVersionGreaterThan("v1.1.21", testVersion) assert.Nil(t, err) }) - t.Run("Compare flytectl version greater then", func(t *testing.T) { + t.Run("Compare FlyteCTL version greater then", func(t *testing.T) { ok, err := IsVersionGreaterThan("v1.1.21", testVersion) assert.Nil(t, err) assert.Equal(t, true, ok) }) - t.Run("Compare flytectl version greater then for equal value", func(t *testing.T) { + t.Run("Compare FlyteCTL version greater then for equal value", func(t *testing.T) { ok, err := IsVersionGreaterThan(testVersion, testVersion) assert.Nil(t, err) assert.Equal(t, false, ok) }) - t.Run("Compare flytectl version smaller then", func(t *testing.T) { + t.Run("Compare FlyteCTL version smaller then", func(t *testing.T) { ok, err := IsVersionGreaterThan("v0.1.19", testVersion) assert.Nil(t, err) assert.Equal(t, false, ok) }) - t.Run("Compare flytectl version", func(t *testing.T) { + t.Run("Compare FlyteCTL version", func(t *testing.T) { _, err := IsVersionGreaterThan(testVersion, testVersion) assert.Nil(t, err) }) - t.Run("Error in compare flytectl version", func(t *testing.T) { + t.Run("Error in compare FlyteCTL version", func(t *testing.T) { _, err := IsVersionGreaterThan("vvvvvvvv", testVersion) assert.NotNil(t, err) }) - t.Run("Error in compare flytectl version", func(t *testing.T) { + t.Run("Error in compare FlyteCTL version", func(t *testing.T) { _, err := IsVersionGreaterThan(testVersion, "vvvvvvvv") assert.NotNil(t, err) }) diff --git a/proposal/README.md b/proposal/README.md index abbf8c6bfb..f561707b4d 100644 --- a/proposal/README.md +++ b/proposal/README.md @@ -5,8 +5,8 @@ FlyteAdmin. We will start with gRPC endpoint as the client is easily generated a more SDK's in different languages we should support a common way of interacting with the API. This does no mean that some SDK's may provide native ways of interacting with the Admin API (for e.g. flytekit), but the intention is that we will eventually replace **flytekit/flyte-cli** with flytectl exclusively. -We also recommend that the design of flytectl is careful and it could helps us with delivering user features faster without having to rely on the UI. flytectl with follow standard oauth2 for -authentication already supported by flyteAdmin. Moreover, flytectl should be readily available on almost any platform - OSX, Linux and Windows. We will strive to keep it relatively lean and fast. +We also recommend that the design of FlyteCTL is careful and it could helps us with delivering user features faster without having to rely on the UI. FlyteCTL with follow standard oauth2 for +authentication already supported by flyteAdmin. Moreover, FlyteCTL should be readily available on almost any platform - OSX, Linux and Windows. We will strive to keep it relatively lean and fast. # Why One CLI? @@ -24,7 +24,7 @@ As we build multiple SDK's they need a native way of interacting with the API. H - kubectl is a stellar example of a cli done well ## Generating Swagger code -We started exploring this (flytetools)[https://github.com/lyft/flytetools#tools] has some work. We also got approached by the swagger code gen maintainer to see if they can help. +We started exploring this (Flytetools)[https://github.com/lyft/flytetools#tools] has some work. We also got approached by the swagger code gen maintainer to see if they can help. # API @@ -41,7 +41,7 @@ $ flytectl [options] ``` ### base options -- *endpoint* endpoint where flyteadmin is available +- *endpoint* endpoint where Flyteadmin is available - *insecure* use if Oauth is not available - optional *project* project for which we need to retrieve details - optional *domain* domain for which we need to retrieve details @@ -51,7 +51,7 @@ $ flytectl [options] returns the version of the CLI, version of Admin service and version of the Platform that is deployed ### configure -Allows configuring flytectl for your own usage (low pri). Needed for especially storing Auth tokens. +Allows configuring FlyteCTL for your own usage (low pri). Needed for especially storing Auth tokens. ### get/delete Get retrieves a list of resources that is qualified by a further sub-command. for example