From 514375fb72c0db2754591ad62e918014c0c30a1d Mon Sep 17 00:00:00 2001 From: Yuvraj <10830562+evalsocket@users.noreply.github.com> Date: Thu, 27 May 2021 10:03:22 +0530 Subject: [PATCH] Flytectl get started updated (#58) Signed-off-by: yuvraj <evalsocket@gmail.com> --- flytectl/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/flytectl/README.md b/flytectl/README.md index 18d1afe748..b23d3cf373 100644 --- a/flytectl/README.md +++ b/flytectl/README.md @@ -24,7 +24,20 @@ Generating docs locally can be accomplished by running make gendocs from within $ brew tap flyteorg/homebrew-tap $ brew install flytectl ``` +## Get Started +### Create a sandbox cluster +```bash +$ docker run --rm --privileged -p 30081:30081 -p 30082:30082 -p 30084:30084 ghcr.io/flyteorg/flyte-sandbox +``` + +### Register your first workflow + +```bash +# Run Core workflows +$ flytectl register files https://github.com/flyteorg/flytesnacks/releases/download/v0.2.89/flytesnacks-core.tgz -d development -p flytesnacks --archive +# You can find all example at flytesnacks release page https://github.com/flyteorg/flytesnacks/releases/tag/v0.2.89 +``` ## Contributing [Contribution guidelines for this project](docs/CONTRIBUTING.md)