From c593bc5d47107a9cf2b30c69b8f8f01452e3bc52 Mon Sep 17 00:00:00 2001 From: Flyte Bot Date: Thu, 8 Jul 2021 16:45:44 -0700 Subject: [PATCH] Update documentation (#133) Signed-off-by: Flyte-Bot Co-authored-by: pmahindrakar-oss --- flytectl/docs/source/gen/flytectl.rst | 2 +- flytectl/docs/source/gen/flytectl_sandbox.rst | 23 +++++++++++++++---- .../docs/source/gen/flytectl_sandbox_exec.rst | 6 ++--- .../source/gen/flytectl_sandbox_start.rst | 12 ++++++---- .../source/gen/flytectl_sandbox_status.rst | 2 +- .../source/gen/flytectl_sandbox_teardown.rst | 4 ++-- 6 files changed, 32 insertions(+), 17 deletions(-) diff --git a/flytectl/docs/source/gen/flytectl.rst b/flytectl/docs/source/gen/flytectl.rst index a2317e1182..e11b06d619 100644 --- a/flytectl/docs/source/gen/flytectl.rst +++ b/flytectl/docs/source/gen/flytectl.rst @@ -31,7 +31,7 @@ SEE ALSO * :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 testing flyte sandbox. +* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. * :doc:`flytectl_update` - Used for updating flyte resources eg: project. * :doc:`flytectl_version` - Used for fetching flyte version diff --git a/flytectl/docs/source/gen/flytectl_sandbox.rst b/flytectl/docs/source/gen/flytectl_sandbox.rst index 6c0e229781..313bbf85b2 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox.rst @@ -3,23 +3,36 @@ flytectl sandbox ---------------- -Used for testing flyte sandbox. +Used for sandbox interactions like start/teardown/status/exec. Synopsis ~~~~~~~~ -Example Create sandbox cluster. +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. + +Create sandbox cluster. :: bin/flytectl sandbox start -Example Remove sandbox cluster. +Remove sandbox cluster. :: bin/flytectl sandbox teardown + + +Check status of sandbox container. +:: + + bin/flytectl sandbox status + +Execute command inside sandbox container. +:: + + bin/flytectl sandbox exec -- pwd Options @@ -43,8 +56,8 @@ SEE ALSO ~~~~~~~~ * :doc:`flytectl` - flyetcl CLI tool -* :doc:`flytectl_sandbox_exec` - Execute any command in sandbox -* :doc:`flytectl_sandbox_start` - Start the flyte sandbox +* :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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst index 2822ad5c34..9fbb77971c 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst @@ -3,14 +3,14 @@ flytectl sandbox exec --------------------- -Execute any command in sandbox +Execute non-interactive command inside the sandbox container Synopsis ~~~~~~~~ -Execute command will Will run non-interactive commands and return immediately with the output. +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 :: bin/flytectl sandbox exec -- ls -al @@ -42,5 +42,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for testing flyte sandbox. +* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/flytectl/docs/source/gen/flytectl_sandbox_start.rst b/flytectl/docs/source/gen/flytectl_sandbox_start.rst index d96f6cab80..21b02b2161 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_start.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_start.rst @@ -3,22 +3,24 @@ flytectl sandbox start ---------------------- -Start the flyte sandbox +Start the flyte sandbox cluster Synopsis ~~~~~~~~ -Start will run the flyte sandbox cluster inside a docker container and setup the config that is required +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. + +Start sandbox cluster without any source code :: bin/flytectl sandbox start -Mount your flytesnacks repository code inside sandbox +Mount your source code repository inside sandbox :: - bin/flytectl sandbox start --sourcesPath=$HOME/flyteorg/flytesnacks + bin/flytectl sandbox start --source=$HOME/flyteorg/flytesnacks Usage @@ -48,5 +50,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for testing flyte sandbox. +* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/flytectl/docs/source/gen/flytectl_sandbox_status.rst b/flytectl/docs/source/gen/flytectl_sandbox_status.rst index 0f85f86437..6295dff615 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_status.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_status.rst @@ -44,5 +44,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for testing flyte sandbox. +* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec. diff --git a/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst b/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst index 2b7f63cb25..bc41b259eb 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst @@ -10,7 +10,7 @@ Synopsis -Teardown will remove docker container and all the flyte config +Teardown will remove sandbox cluster and all the flyte config created by sandbox start :: bin/flytectl sandbox teardown @@ -43,5 +43,5 @@ Options inherited from parent commands SEE ALSO ~~~~~~~~ -* :doc:`flytectl_sandbox` - Used for testing flyte sandbox. +* :doc:`flytectl_sandbox` - Used for sandbox interactions like start/teardown/status/exec.