From 0e76e7a80c035c8d78ea45d14c99ea400eac3aae Mon Sep 17 00:00:00 2001 From: Flyte Bot Date: Tue, 21 Sep 2021 10:37:07 -0700 Subject: [PATCH] Update documentation (#175) Signed-off-by: Flyte-Bot Co-authored-by: pmahindrakar-oss --- flytectl/docs/source/gen/flytectl_register_examples.rst | 8 +++++++- flytectl/docs/source/gen/flytectl_register_files.rst | 3 ++- flytectl/docs/source/gen/flytectl_sandbox_exec.rst | 4 +--- flytectl/docs/source/gen/flytectl_sandbox_start.rst | 8 +++++--- 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/flytectl/docs/source/gen/flytectl_register_examples.rst b/flytectl/docs/source/gen/flytectl_register_examples.rst index f21135aa5bc..e5fd09cfe00 100644 --- a/flytectl/docs/source/gen/flytectl_register_examples.rst +++ b/flytectl/docs/source/gen/flytectl_register_examples.rst @@ -15,7 +15,12 @@ Registers all latest flytesnacks example bin/flytectl register examples -d development -p flytesnacks +Registers specific release of flytesnacks example +:: + bin/flytectl register examples -d development -p flytesnacks v0.2.176 + +Note: register command automatically override the version with release version Usage @@ -33,7 +38,8 @@ Options --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. + --k8ServiceAccount string deprecated. Please use --K8sServiceAccount + --k8sServiceAccount string custom kubernetes service account auth role to register launch plans with. --outputLocationPrefix string custom output location prefix for offloaded types (files/schemas). --sourceUploadPath string Location for source code in storage. --version string version of the entity to be registered with flyte. (default "v1") diff --git a/flytectl/docs/source/gen/flytectl_register_files.rst b/flytectl/docs/source/gen/flytectl_register_files.rst index 962d7cfaae7..cb261211773 100644 --- a/flytectl/docs/source/gen/flytectl_register_files.rst +++ b/flytectl/docs/source/gen/flytectl_register_files.rst @@ -97,7 +97,8 @@ Options --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. + --k8ServiceAccount string deprecated. Please use --K8sServiceAccount + --k8sServiceAccount string custom kubernetes service account auth role to register launch plans with. --outputLocationPrefix string custom output location prefix for offloaded types (files/schemas). --sourceUploadPath string Location for source code in storage. --version string version of the entity to be registered with flyte. (default "v1") diff --git a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst index 2f8b53cc81b..bd9c0ec4e96 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst @@ -26,9 +26,7 @@ Options :: - -h, --help help for exec - --source string Path of your source code - --version string Version of flyte + -h, --help help for exec Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/flytectl/docs/source/gen/flytectl_sandbox_start.rst b/flytectl/docs/source/gen/flytectl_sandbox_start.rst index 00de94c6764..bc96eb1ade8 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_start.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_start.rst @@ -22,11 +22,13 @@ Mount your source code repository inside sandbox bin/flytectl sandbox start --source=$HOME/flyteorg/flytesnacks -Run specific version of flyte, Only available after v0.13.0+ +Run specific version of flyte. flytectl sandbox only support flyte version available in Github release https://github.com/flyteorg/flyte/tags :: bin/flytectl sandbox start --version=v0.14.0 +Note: Flytectl sandbox will only work for v0.10.0+ + Usage @@ -40,8 +42,8 @@ Options :: -h, --help help for start - --source string Path of your source code - --version string Version of flyte + --source string Path of your source code + --version string Version of flyte. Only support v0.10.0+ flyte release Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~