From ef0e4352b6a90d34ff3fecb75c83735ca11e363c Mon Sep 17 00:00:00 2001 From: pmahindrakar-oss Date: Tue, 4 Jan 2022 20:39:54 +0530 Subject: [PATCH] Linked configurable options for flytectl config.yaml (#251) * Linked configurable options for flytectl config.yaml Signed-off-by: Prafulla Mahindrakar * Incorporated feedback Signed-off-by: Prafulla Mahindrakar * Incorporated feedback Signed-off-by: Prafulla Mahindrakar --- flytectl/docs/source/cluster-resource-attribute.rst | 5 +---- flytectl/docs/source/execution-cluster-label.rst | 5 +---- flytectl/docs/source/execution.rst | 5 +---- flytectl/docs/source/index.rst | 7 ++++++- flytectl/docs/source/launchplan.rst | 5 ++--- flytectl/docs/source/plugin-override.rst | 5 +---- flytectl/docs/source/sandbox.rst | 6 +----- flytectl/docs/source/task-resource-attribute.rst | 5 +---- flytectl/docs/source/task.rst | 2 +- flytectl/docs/source/workflow.rst | 4 ++-- 10 files changed, 17 insertions(+), 32 deletions(-) diff --git a/flytectl/docs/source/cluster-resource-attribute.rst b/flytectl/docs/source/cluster-resource-attribute.rst index 4b655f8dfa..c4b89458c8 100644 --- a/flytectl/docs/source/cluster-resource-attribute.rst +++ b/flytectl/docs/source/cluster-resource-attribute.rst @@ -1,5 +1,5 @@ Cluster resource attribute ------- +-------------------------- It specifies the actions to be performed on the 'cluster-resource-attribute'. .. toctree:: @@ -9,6 +9,3 @@ It specifies the actions to be performed on the 'cluster-resource-attribute'. gen/flytectl_get_cluster-resource-attribute gen/flytectl_delete_cluster-resource-attribute gen/flytectl_update_cluster-resource-attribute - gen/flytectl_get_cluster-resource-attribute - gen/flytectl_delete_cluster-resource-attribute - gen/flytectl_update_cluster-resource-attribute diff --git a/flytectl/docs/source/execution-cluster-label.rst b/flytectl/docs/source/execution-cluster-label.rst index 8bd483f17e..2a27e87e52 100644 --- a/flytectl/docs/source/execution-cluster-label.rst +++ b/flytectl/docs/source/execution-cluster-label.rst @@ -1,5 +1,5 @@ Execution cluster label ------- +----------------------- It specifies the actions to be performed on the resource 'execution-cluster-label'. .. toctree:: @@ -9,6 +9,3 @@ It specifies the actions to be performed on the resource 'execution-cluster-labe gen/flytectl_get_execution-cluster-label gen/flytectl_update_execution-cluster-label gen/flytectl_delete_execution-cluster-label - gen/flytectl_get_execution-cluster-label - gen/flytectl_update_execution-cluster-label - gen/flytectl_delete_execution-cluster-label diff --git a/flytectl/docs/source/execution.rst b/flytectl/docs/source/execution.rst index 717c697db8..4e3d1cbff3 100644 --- a/flytectl/docs/source/execution.rst +++ b/flytectl/docs/source/execution.rst @@ -1,5 +1,5 @@ Execution ------- +--------- It specifies the actions to be performed on the resource 'execution'. .. toctree:: @@ -9,6 +9,3 @@ It specifies the actions to be performed on the resource 'execution'. gen/flytectl_create_execution gen/flytectl_get_execution gen/flytectl_delete_execution - gen/flytectl_create_execution - gen/flytectl_get_execution - gen/flytectl_delete_execution diff --git a/flytectl/docs/source/index.rst b/flytectl/docs/source/index.rst index 47dcb78db1..2c59eaa031 100644 --- a/flytectl/docs/source/index.rst +++ b/flytectl/docs/source/index.rst @@ -48,7 +48,11 @@ on command-line. The following configuration is useful to setup. Basic Configuration -------------------- -Flytectl configuration +For full list of configurable options available can be found by running ``flytectl --help`` and can be alternately be found `here `__ + +.. NOTE:: + + Currently, the Project ``-p``, Domain ``-d``, and Output ``-o`` flags cannot be used in config file .. tabbed:: Local Flyte Sandbox @@ -141,6 +145,7 @@ Flytectl configuration :hidden: Install and Configure + gen/flytectl verbs nouns contribute diff --git a/flytectl/docs/source/launchplan.rst b/flytectl/docs/source/launchplan.rst index f469b98563..7755b8eaba 100644 --- a/flytectl/docs/source/launchplan.rst +++ b/flytectl/docs/source/launchplan.rst @@ -1,5 +1,5 @@ Launchplan ------- +---------- It specifies the actions to be performed on the resource 'launchplan'. .. toctree:: @@ -8,5 +8,4 @@ It specifies the actions to be performed on the resource 'launchplan'. gen/flytectl_get_launchplan gen/flytectl_update_launchplan - gen/flytectl_get_launchplan - gen/flytectl_update_launchplan + gen/flytectl_update_launchplan-meta diff --git a/flytectl/docs/source/plugin-override.rst b/flytectl/docs/source/plugin-override.rst index 6e77ceb748..ed016543c5 100644 --- a/flytectl/docs/source/plugin-override.rst +++ b/flytectl/docs/source/plugin-override.rst @@ -1,5 +1,5 @@ Plugin override ------- +--------------- It specifies the actions to be performed on the resource 'plugin-override'. .. toctree:: @@ -9,6 +9,3 @@ It specifies the actions to be performed on the resource 'plugin-override'. gen/flytectl_get_plugin-override gen/flytectl_update_plugin-override gen/flytectl_delete_plugin-override - gen/flytectl_get_plugin-override - gen/flytectl_update_plugin-override - gen/flytectl_delete_plugin-override diff --git a/flytectl/docs/source/sandbox.rst b/flytectl/docs/source/sandbox.rst index a0fb7b21d8..e6de8cafa5 100644 --- a/flytectl/docs/source/sandbox.rst +++ b/flytectl/docs/source/sandbox.rst @@ -1,5 +1,5 @@ Sandbox ------- +------- It specifies the actions to be performed on the resource 'sandbox'. .. toctree:: @@ -10,7 +10,3 @@ It specifies the actions to be performed on the resource 'sandbox'. gen/flytectl_sandbox_status gen/flytectl_sandbox_teardown gen/flytectl_sandbox_exec - gen/flytectl_sandbox_start - gen/flytectl_sandbox_status - gen/flytectl_sandbox_teardown - gen/flytectl_sandbox_exec diff --git a/flytectl/docs/source/task-resource-attribute.rst b/flytectl/docs/source/task-resource-attribute.rst index ee827b775b..3a4c0d5e8d 100644 --- a/flytectl/docs/source/task-resource-attribute.rst +++ b/flytectl/docs/source/task-resource-attribute.rst @@ -1,5 +1,5 @@ Task resource attribute ------- +----------------------- It specifies the actions to be performed on the resource 'task-resource-attribute'. .. toctree:: @@ -9,7 +9,4 @@ It specifies the actions to be performed on the resource 'task-resource-attribut gen/flytectl_get_task-resource-attribute gen/flytectl_update_task-resource-attribute gen/flytectl_delete_task-resource-attribute - gen/flytectl_get_task-resource-attribute - gen/flytectl_update_task-resource-attribute - gen/flytectl_delete_task-resource-attribute diff --git a/flytectl/docs/source/task.rst b/flytectl/docs/source/task.rst index 2b19b358d5..14f1c58f41 100644 --- a/flytectl/docs/source/task.rst +++ b/flytectl/docs/source/task.rst @@ -7,4 +7,4 @@ It specifies the actions to be performed on the resource 'task'. :caption: Task gen/flytectl_get_task - gen/flytectl_get_task + gen/flytectl_update_task-meta diff --git a/flytectl/docs/source/workflow.rst b/flytectl/docs/source/workflow.rst index e77bb0f92c..91332dc281 100644 --- a/flytectl/docs/source/workflow.rst +++ b/flytectl/docs/source/workflow.rst @@ -1,5 +1,5 @@ Workflow ------- +-------- It specifies the actions to be performed on the resource 'workflow'. .. toctree:: @@ -7,4 +7,4 @@ It specifies the actions to be performed on the resource 'workflow'. :caption: Workflow gen/flytectl_get_workflow - gen/flytectl_get_workflow + gen/flytectl_update_workflow-meta