diff --git a/rsts/community/contribute/index.rst b/rsts/community/contribute/index.rst deleted file mode 100644 index 94b2763ae9..0000000000 --- a/rsts/community/contribute/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _community_contribute: - -###################### -Contributor Handbook -###################### - -.. toctree:: - :caption: contribute - :maxdepth: 1 - :name: communitycontributetoc - - docs diff --git a/rsts/community/contribute/docs.rst b/rsts/community/docs.rst similarity index 100% rename from rsts/community/contribute/docs.rst rename to rsts/community/docs.rst diff --git a/rsts/community/index.rst b/rsts/community/index.rst index a97bdf0430..6fbb8e96b5 100644 --- a/rsts/community/index.rst +++ b/rsts/community/index.rst @@ -1,8 +1,8 @@ .. _community: -##################################### -Community, Roadmap, and Contributions -##################################### +########## +Community +########## Flyte is an ambitious open source project and would not be possible without an amazing community. We are a completely open community and we vouch to treat @@ -13,12 +13,9 @@ so please join us on the - `Email `_ - `Twitter `_ +We love contributions, so please contribute to + - docs + - examples + - new plugins or plugin ideas + - just feedback in general -.. toctree:: - :caption: Be nice! - :maxdepth: 1 - :name: communityinnertoc - - contribute/index - roadmap - compare diff --git a/rsts/faq/index.rst b/rsts/faq/index.rst index dabcfd1c62..2c0141919e 100644 --- a/rsts/faq/index.rst +++ b/rsts/faq/index.rst @@ -6,7 +6,6 @@ FAQs .. toctree:: - :caption: Questions :maxdepth: 2 :name: faqstoc diff --git a/rsts/howto/index.rst b/rsts/howto/index.rst index 3be8c53bb1..d263773c33 100644 --- a/rsts/howto/index.rst +++ b/rsts/howto/index.rst @@ -6,11 +6,10 @@ How Do I...? .. toctree:: :maxdepth: 1 - :caption: How To Guides :name: howtoguidestoc install_sdk - sandbox/index + sandbox flytecli new_project execute_single_task diff --git a/rsts/howto/sandbox.rst b/rsts/howto/sandbox.rst new file mode 100644 index 0000000000..dab5eedb8a --- /dev/null +++ b/rsts/howto/sandbox.rst @@ -0,0 +1,73 @@ +.. _howto_sandbox: + +################################ +How do I try out/install Flyte? +################################ + + +********************** +What is Flyte Sandbox? +********************** +Flyte can be run using a Kubernetes cluster only. This installs all the dependencies as kubernetes deployments. We call this a Sandbox deployment. Flyte sandbox can be deployed by simply applying a kubernetes YAML. + +.. note:: + + #. A Sandbox deployment takes over the entire cluster + #. It needs special cluster roles that will need access to create namespaces, pods etc + #. The sandbox deployment is not suitable for production environments. For an in-depth overview of how to productionize your flyte deployment, checkout the :ref:`howto_productionize`. + + +********************************************************* +Deploy Flyte Sandbox environment locally - on your laptop +********************************************************* + +Flyte Sandbox deployment can be run locally on your laptop. This will allow only some of the functionality, but is great to get started with. +Refer to :ref:`tutorials-getting-started-run-on-flyte`. + + +.. _howto-sandbox-dedicated-k8s-cluster: + +****************************************************************** +Deploy Flyte Sandbox environment to a dedicated kubernetes cluster +****************************************************************** + +Cluster Requirements +==================== + +Ensure you have kubernetes up and running on your choice of cloud provider: + +- `AWS EKS `_ (Amazon) +- `GCP GKE `_ (Google) +- `Azure AKS `_ (Microsoft) + +If you can access your cluster with ``kubectl cluster-info``, you're ready to deploy Flyte. + + +Deployment +========== + +We'll proceed like with :ref:`locally hosted flyte ` with deploying the sandbox +Flyte configuration on your remote cluster. + +.. warning:: + The sandbox deployment is not suitable for production environments. For an in-depth overview of how to productionize your flyte deployment, checkout the :ref:`howto_productionize`. + +#. The Flyte sandbox can be deployed with a single command :: + + kubectl create -f https://raw.githubusercontent.com/lyft/flyte/master/deployment/sandbox/flyte_generated.yaml + + +#. You can now port-forward (or if you have load-balancer enabled then get an LB) to connect to remote FlyteConsole, as follows:: + + kubectl port-forward svc/envoy 30081:80 + + +#. Open console http://localhost:30081/console. + +*************************************************************** +Deploy Flyte Sandbox environment to a shared kubernetes cluster +*************************************************************** + +The goal here is to deploy to an existing Kubernetes cluster - within one namespace only. This would allow multiple Flyte clusters to run within one K8s cluster. + +.. caution:: coming soon! \ No newline at end of file diff --git a/rsts/howto/sandbox/index.rst b/rsts/howto/sandbox/index.rst deleted file mode 100644 index e0947632a7..0000000000 --- a/rsts/howto/sandbox/index.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _howto_sandbox: - -######################## -How do I try out Flyte? -######################## - -********************** -What is Flyte Sandbox? -********************** - -********************************************************* -Deploy Flyte Sandbox environment locally - on your laptop -********************************************************* - - -.. _howto-sandbox-dedicated-k8s-cluster: - -****************************************************************** -Deploy Flyte Sandbox environment to a dedicated kubernetes cluster -****************************************************************** - -Cluster Requirements -==================== - -Ensure you have kubernetes up and running on your choice of cloud provider: - -- `AWS EKS `_ (Amazon) -- `GCP GKE `_ (Google) -- `Azure AKS `_ (Microsoft) - -If you can access your cluster with ``kubectl cluster-info``, you're ready to deploy Flyte. - - -Deployment -========== - -We'll proceed like with :ref:`locally hosted flyte ` with deploying the sandbox -Flyte configuration on your remote cluster. - -.. warning:: - The sandbox deployment is not suitable for production environments. - -For an in-depth overview of how to productionize your flyte deployment, checkout the :ref:`how to ` - -The Flyte sandbox can be deployed with a single command :: - - kubectl create -f https://raw.githubusercontent.com/lyft/flyte/master/deployment/sandbox/flyte_generated.yaml - - -*************************************************************** -Deploy Flyte Sandbox environment to a shared kubernetes cluster -*************************************************************** diff --git a/rsts/index.rst b/rsts/index.rst index 36b343f8c8..125b3ea50d 100644 --- a/rsts/index.rst +++ b/rsts/index.rst @@ -8,17 +8,19 @@ Welcome to the documentation hub for Flyte. .. toctree:: :maxdepth: 1 - :caption: Take off with Flyte + :caption: Get started with Flyte :name: tutorialstoc - tutorials/index - plugins/index + tutorials/first_example + tutorials/run_on_flyte + tutorials/learn .. toctree:: :caption: How to Guides :maxdepth: 1 :name: howtotoc + plugins/index howto/index faq/index @@ -36,4 +38,7 @@ Welcome to the documentation hub for Flyte. :name: roadmaptoc community/index + community/docs + community/roadmap + community/compare diff --git a/rsts/plugins/index.rst b/rsts/plugins/index.rst index 02e941fe71..c47b125ef0 100644 --- a/rsts/plugins/index.rst +++ b/rsts/plugins/index.rst @@ -1,12 +1,13 @@ .. _plugins: -######## -Plugins -######## +#################### +Available Plugins +#################### + +Following is a list of maintained plugins for Flyte and guides on how to install / use them. .. toctree:: - :maxdepth: 2 - :caption: Available Plugins + :maxdepth: 1 :name: pluginstoc spark_k8s diff --git a/rsts/reference/index.rst b/rsts/reference/index.rst index d59a33d844..32281a70c4 100644 --- a/rsts/reference/index.rst +++ b/rsts/reference/index.rst @@ -1,8 +1,8 @@ .. _reference: -############################### -Reference -############################### +################################# +API, CLI and Component Reference +################################# .. toctree:: diff --git a/rsts/tutorials/first_example.rst b/rsts/tutorials/first_example.rst index daaedd2f2a..f59d8c95bc 100644 --- a/rsts/tutorials/first_example.rst +++ b/rsts/tutorials/first_example.rst @@ -1,8 +1,8 @@ .. _tutorials-getting-started-first-example: -########################### -Writing Your First Workflow -########################### +###################################### +Write your first Flyte workflow +###################################### By the end of this getting started guide you'll be familiar with how easy it is to author a Flyte workflow and run it locally. @@ -50,6 +50,4 @@ Similarly, you can call this workflow and iterate locally before moving on to register it with Flyte. -.. note:: - - Every invocation of a Flyte workflow requires specifying keyword args. +.. tip:: Every invocation of a Flyte workflow requires specifying keyword args. diff --git a/rsts/tutorials/index.rst b/rsts/tutorials/index.rst deleted file mode 100644 index eea28f7599..0000000000 --- a/rsts/tutorials/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _tutorials: - -############################## -Getting Started and Tutorials -############################## - -.. toctree:: - :maxdepth: 1 - :caption: Flyte Tutorials - :name: tutorialsecstoc - - first_example - run_flyte_laptop - Learn by example - Flytekit Python diff --git a/rsts/tutorials/learn.rst b/rsts/tutorials/learn.rst new file mode 100644 index 0000000000..1a87c3adff --- /dev/null +++ b/rsts/tutorials/learn.rst @@ -0,0 +1,10 @@ +.. _tutorials-learn: + +########################### +Learn Flytekit by Example +########################### + +Flytekit implements a programming model for Flyte in (python and Java). The best way to see the capabilities of Flyte is to try out Flytekit. + +`Learn by example - Flytekit Python `_ +========================================================================================= diff --git a/rsts/tutorials/run_flyte_laptop.rst b/rsts/tutorials/run_on_flyte.rst similarity index 91% rename from rsts/tutorials/run_flyte_laptop.rst rename to rsts/tutorials/run_on_flyte.rst index 42b43214e2..075a2d1e86 100644 --- a/rsts/tutorials/run_flyte_laptop.rst +++ b/rsts/tutorials/run_on_flyte.rst @@ -1,15 +1,15 @@ -.. _tutorials-getting-started-flyte-laptop: +.. _tutorials-getting-started-run-on-flyte: -################################## -Run Your Workflow on a Local Flyte -################################## +###################################### +Run Your Workflow on a Flyte Backend +###################################### ************************ Installing Flyte Locally ************************ This guide will walk you through a quick installation of Flyte on your laptop and then how to register and execute your -workflows against this deployment. +workflows against this deployment. (The tabs below have an option to install Flyte on a cloud provider as well) .. rubric:: Estimated time to complete: 5 minutes. @@ -21,7 +21,7 @@ Prerequisites brew install kubectl #. If running locally ensure you have docker installed - as explained `here `_ -#. If you prefer to run the Flyte test cluster on a cloud environment like `AWS EKS `_, `Google GKE `__, then follow the instructions for hosted Flyte below. +#. If you prefer to run the Flyte test cluster on a cloud environment like `AWS EKS `_, `Google GKE `__, then follow the instructions in a tab below. The rest of it is mostly the same. Steps ====== @@ -70,7 +70,7 @@ Steps Coming soon - .. tab:: Hosted Flyte + .. tab:: Install Flyte in EKS/GKE etc Refer to the :ref:`howto-sandbox-dedicated-k8s-cluster` guide.