Skip to content

Commit

Permalink
Update run_on_flyte.rst (#846)
Browse files Browse the repository at this point in the history
* Update run_on_flyte.rst

* Update run_on_flyte.rst
  • Loading branch information
SandraGH5 authored Mar 19, 2021
1 parent 6d0bb54 commit b6f3d16
Showing 1 changed file with 34 additions and 31 deletions.
65 changes: 34 additions & 31 deletions rsts/getting_started/run_on_flyte.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,22 @@ 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. (The tabs below have an option to install Flyte on a cloud provider as well)
This guide will walk you through:

.. rubric:: Estimated time to complete: 1 minutes.
* A quick installation of Flyte on your device

* How to register and execute your workflows against this deployment.

(The tips below have an option to install Flyte on a cloud provider as well)

.. rubric:: Estimated time: 1 minute

Prerequisites
=============

Make Sure you have followed :ref:`getting-started-firstrun` and have a running docker container and can access FlyteConsole on http://localhost:30081/console.
1. Follow :ref:`getting-started-firstrun`

2. Access FlyteConsole on http://localhost:30081/console

.. tip:: To check if your flyte-sandbox container is running you can run ``docker ps`` and it should show image ``ghcr.io/flyteorg/flyte-sandbox`` running

Expand All @@ -25,50 +32,46 @@ Make Sure you have followed :ref:`getting-started-firstrun` and have a running d
.. _getting-started-run-flyte-laptop:

****************************
Running your Flyte Workflows
Running Your Flyte Workflows
****************************

Registration
============
Registration is the process of shipping your code to Flyte backend. This creates an immutable, versioned record of your code with FlyteAdmin service.

Register your workflows
-----------------------
Register Your Workflows
=======================
Registration is the process of shipping your code to the Flyte backend. This creates an immutable, versioned record of your code with the FlyteAdmin service.

From within root directory of ``flyteexamples`` you created :ref:`previously <getting-started-first-example>`
feel free to make any changes and then register ::
From within root directory of ``flyteexamples`` you previously created with the :ref:`Write Your First Workflow tutorial <getting-started-first-example>`,
feel free to make any changes and then register: ::

FLYTE_AWS_ENDPOINT=http://localhost:30084/ FLYTE_AWS_ACCESS_KEY_ID=minio \
FLYTE_AWS_SECRET_ACCESS_KEY=miniostorage make fast_register


.. tip:: Flyte sandbox uses minio as a substitue for S3/GCS etc, in the first command we port-forwarded it to 30084. If you use s3/gcs or a different port-forward you can drop or change ``FLYTE_AWS_ENDPOINT`` accordingly.
.. tip:: Flyte sandbox uses minio as a substitute for S3/GCS etc. It is port-forwarded in the first command to 30084. If you use S3/GCS or a different port-forward you can drop or change the ``FLYTE_AWS_ENDPOINT`` accordingly.

.. rubric:: Boom! It's that simple.
.. rubric:: It's that simple!

Run your workflows
------------------
Run Your Workflows
==================

Visit the page housing workflows registered for your project (method if you used k3d):
Visit the page housing workflows registered to your project at:
`http://localhost:30081/console/projects/flyteexamples/workflows <http://localhost:30081/console/projects/flyteexamples/workflows>`__
else if you used docker-desktop or something else, then copy paste this URL into the browser and fill in the ``<host:port>``::

http://<host:port>/console/projects/flyteexamples/workflows

Once you have accessed your workflows,

Select your workflow, click the bright purple "Launch Workflow" button in the upper right, update the "name" input
argument as you please, proceed to launch and you'll have triggered an execution!
* Select your workflow
* Click the bright purple "Launch Workflow" button in the upper right
* Update the "name" input argument
* Proceed to launch to trigger an execution

.. note::

After registration Flyte Workflows exist in the FlyteAdmin service and can be triggered using the
- console
After registration, Flyte Workflows exist in the FlyteAdmin service and can be triggered using:
- Console
- Command line
- directly invoking the REST API
- on a schedule
- Directly invoking the REST API
- On a schedule

More on this later

Optionally you can create a new project
----------------------------------------
Refer to :ref:`howto_new_project`.
Create a New Project
--------------------
Visit :ref:`howto_new_project`.

0 comments on commit b6f3d16

Please sign in to comment.