diff --git a/docs/source/gen/flytectl_create_execution.rst b/docs/source/gen/flytectl_create_execution.rst index 022e22dff5..7cac61bbd2 100644 --- a/docs/source/gen/flytectl_create_execution.rst +++ b/docs/source/gen/flytectl_create_execution.rst @@ -140,6 +140,7 @@ Options :: + --dryRun execute command without making any modifications. --execFile string file for the execution params.If not specified defaults to <_name>.execution_spec.yaml -h, --help help for execution --iamRoleARN string iam role ARN AuthRole for launching execution. diff --git a/docs/source/gen/flytectl_create_project.rst b/docs/source/gen/flytectl_create_project.rst index f5b287a2fa..f1e8a47194 100644 --- a/docs/source/gen/flytectl_create_project.rst +++ b/docs/source/gen/flytectl_create_project.rst @@ -41,6 +41,7 @@ Options :: --description string description for the project specified as argument. + --dryRun execute command without making any modifications. --file string file for the project definition. -h, --help help for project --id string id for the project specified as argument. diff --git a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst index 770ea699ca..5e80a706d1 100644 --- a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst @@ -57,6 +57,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for cluster-resource-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_delete_execution-cluster-label.rst b/docs/source/gen/flytectl_delete_execution-cluster-label.rst index 918da73e88..488a732b58 100644 --- a/docs/source/gen/flytectl_delete_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_delete_execution-cluster-label.rst @@ -55,6 +55,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for execution-cluster-label Options inherited from parent commands diff --git a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst index 7c1e2eb8f6..671eed2879 100644 --- a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst @@ -59,6 +59,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for execution-queue-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_delete_execution.rst b/docs/source/gen/flytectl_delete_execution.rst index 6f5f2d8e5f..11ebaa66fd 100644 --- a/docs/source/gen/flytectl_delete_execution.rst +++ b/docs/source/gen/flytectl_delete_execution.rst @@ -64,7 +64,8 @@ Options :: - -h, --help help for execution + --dryRun execute command without making any modifications. + -h, --help help for execution Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/gen/flytectl_delete_plugin-override.rst b/docs/source/gen/flytectl_delete_plugin-override.rst index c04b0e1fe3..2328ff9e12 100644 --- a/docs/source/gen/flytectl_delete_plugin-override.rst +++ b/docs/source/gen/flytectl_delete_plugin-override.rst @@ -60,6 +60,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for plugin-override Options inherited from parent commands diff --git a/docs/source/gen/flytectl_delete_task-resource-attribute.rst b/docs/source/gen/flytectl_delete_task-resource-attribute.rst index f0ff59cfbc..544712992f 100644 --- a/docs/source/gen/flytectl_delete_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_task-resource-attribute.rst @@ -60,6 +60,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for task-resource-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_delete_workflow-execution-config.rst b/docs/source/gen/flytectl_delete_workflow-execution-config.rst index ffb2333bd1..a97fcc811c 100644 --- a/docs/source/gen/flytectl_delete_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_delete_workflow-execution-config.rst @@ -55,6 +55,7 @@ Options :: --attrFile string attribute file name to be used for delete attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for workflow-execution-config Options inherited from parent commands diff --git a/docs/source/gen/flytectl_register_examples.rst b/docs/source/gen/flytectl_register_examples.rst index a9b5943d56..f21135aa5b 100644 --- a/docs/source/gen/flytectl_register_examples.rst +++ b/docs/source/gen/flytectl_register_examples.rst @@ -31,6 +31,7 @@ Options --archive pass in archive file either an http link or local path. --assumableIamRole string custom assumable iam auth role to register launch plans with. --continueOnError continue on error when registering files. + --dryRun execute command without making any modifications. -h, --help help for examples --k8ServiceAccount string custom kubernetes service account auth role to register launch plans with. --outputLocationPrefix string custom output location prefix for offloaded types (files/schemas). diff --git a/docs/source/gen/flytectl_register_files.rst b/docs/source/gen/flytectl_register_files.rst index 83447baa09..962d7cfaae 100644 --- a/docs/source/gen/flytectl_register_files.rst +++ b/docs/source/gen/flytectl_register_files.rst @@ -95,6 +95,7 @@ Options --archive pass in archive file either an http link or local path. --assumableIamRole string custom assumable iam auth role to register launch plans with. --continueOnError continue on error when registering files. + --dryRun execute command without making any modifications. -h, --help help for files --k8ServiceAccount string custom kubernetes service account auth role to register launch plans with. --outputLocationPrefix string custom output location prefix for offloaded types (files/schemas). diff --git a/docs/source/gen/flytectl_sandbox_start.rst b/docs/source/gen/flytectl_sandbox_start.rst index ed340e35d3..00de94c676 100644 --- a/docs/source/gen/flytectl_sandbox_start.rst +++ b/docs/source/gen/flytectl_sandbox_start.rst @@ -22,7 +22,7 @@ Mount your source code repository inside sandbox bin/flytectl sandbox start --source=$HOME/flyteorg/flytesnacks -Run specific version of flyte, Only available after v0.14.0+ +Run specific version of flyte, Only available after v0.13.0+ :: bin/flytectl sandbox start --version=v0.14.0 diff --git a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst index b3a5886a32..9f1ca738f9 100644 --- a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst @@ -62,6 +62,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for cluster-resource-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_execution-cluster-label.rst b/docs/source/gen/flytectl_update_execution-cluster-label.rst index 043be798c5..4fca7a3a9f 100644 --- a/docs/source/gen/flytectl_update_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_update_execution-cluster-label.rst @@ -55,6 +55,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for execution-cluster-label Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_execution-queue-attribute.rst b/docs/source/gen/flytectl_update_execution-queue-attribute.rst index 66539e7561..ae9db9b656 100644 --- a/docs/source/gen/flytectl_update_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_update_execution-queue-attribute.rst @@ -66,6 +66,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for execution-queue-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_launchplan.rst b/docs/source/gen/flytectl_update_launchplan.rst index ae54382190..5ad0814622 100644 --- a/docs/source/gen/flytectl_update_launchplan.rst +++ b/docs/source/gen/flytectl_update_launchplan.rst @@ -40,6 +40,7 @@ Options --activate activate the named entity. --archive archive named entity. --description string description of the named entity. + --dryRun execute command without making any modifications. -h, --help help for launchplan Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_plugin-override.rst b/docs/source/gen/flytectl_update_plugin-override.rst index 1ee6a87f8d..3056208c60 100644 --- a/docs/source/gen/flytectl_update_plugin-override.rst +++ b/docs/source/gen/flytectl_update_plugin-override.rst @@ -68,6 +68,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for plugin-override Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_project.rst b/docs/source/gen/flytectl_update_project.rst index dccc3a9efc..abbaaca825 100644 --- a/docs/source/gen/flytectl_update_project.rst +++ b/docs/source/gen/flytectl_update_project.rst @@ -54,6 +54,7 @@ Options --activateProject Activates the project specified as argument. --archiveProject Archives the project specified as argument. + --dryRun execute command without making any modifications. -h, --help help for project Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_task-resource-attribute.rst b/docs/source/gen/flytectl_update_task-resource-attribute.rst index bd02a91ad5..182c3cdf3f 100644 --- a/docs/source/gen/flytectl_update_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_task-resource-attribute.rst @@ -68,6 +68,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for task-resource-attribute Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_task.rst b/docs/source/gen/flytectl_update_task.rst index ee60852b58..786d17ff96 100644 --- a/docs/source/gen/flytectl_update_task.rst +++ b/docs/source/gen/flytectl_update_task.rst @@ -40,6 +40,7 @@ Options --activate activate the named entity. --archive archive named entity. --description string description of the named entity. + --dryRun execute command without making any modifications. -h, --help help for task Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_workflow-execution-config.rst b/docs/source/gen/flytectl_update_workflow-execution-config.rst index ed6856f395..cf66feece0 100644 --- a/docs/source/gen/flytectl_update_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_update_workflow-execution-config.rst @@ -58,6 +58,7 @@ Options :: --attrFile string attribute file name to be used for updating attribute for the resource type. + --dryRun execute command without making any modifications. -h, --help help for workflow-execution-config Options inherited from parent commands diff --git a/docs/source/gen/flytectl_update_workflow.rst b/docs/source/gen/flytectl_update_workflow.rst index 204e00b614..c717ba53e1 100644 --- a/docs/source/gen/flytectl_update_workflow.rst +++ b/docs/source/gen/flytectl_update_workflow.rst @@ -40,6 +40,7 @@ Options --activate activate the named entity. --archive archive named entity. --description string description of the named entity. + --dryRun execute command without making any modifications. -h, --help help for workflow Options inherited from parent commands diff --git a/docs/source/gen/flytectl_upgrade.rst b/docs/source/gen/flytectl_upgrade.rst index e102c6b901..63379360f4 100644 --- a/docs/source/gen/flytectl_upgrade.rst +++ b/docs/source/gen/flytectl_upgrade.rst @@ -15,6 +15,8 @@ Upgrade flytectl bin/flytectl upgrade +Note: Please use upgrade with sudo, Without sudo it will cause permission issue + Rollback flytectl binary ::