:orphan:

.. _remoteaccess:

Remote Access
-------------

Flyte provides multiple ways of creating, registering, and inspecting Flyte backend
entities. The main entities include Flyte tasks, workflows, launchplans, as well as
their associated execution entities (for more details, see :ref:`divedeep`). This section
of the user guide covers the different ways that you can programmatically control these
entities to perform operations like registering tasks, workflows, and launchplans, or
inspecting and debugging tasks/workflows that are running on a remote backend.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Creates project to be used as a home for the flyte resources of tasks and workflows. Refer to t...">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_register_project_thumb.png
    :alt: Creating a New Project

  :ref:`sphx_glr_auto_remote_access_register_project.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating a New Project</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Flytectl ========">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_remote_task_thumb.png
    :alt: Running a Task

  :ref:`sphx_glr_auto_remote_access_remote_task.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Running a Task</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Workflows on their own are not runnable directly. However, a launchplan is always bound to a wo...">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_remote_workflow_thumb.png
    :alt: Running a Workflow

  :ref:`sphx_glr_auto_remote_access_remote_workflow.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Running a Workflow</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Flytectl ========">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_remote_launchplan_thumb.png
    :alt: Running a Launchplan

  :ref:`sphx_glr_auto_remote_access_remote_launchplan.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Running a Launchplan</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Flytectl ========">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_inspecting_executions_thumb.png
    :alt: Inspecting Workflow and Task Executions

  :ref:`sphx_glr_auto_remote_access_inspecting_executions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Inspecting Workflow and Task Executions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The inspection of task and workflow execution would provide you log links to debug things furth...">

.. only:: html

  .. image:: /auto/remote_access/images/thumb/sphx_glr_debugging_workflows_tasks_thumb.png
    :alt: Debugging Workflow and Task Executions

  :ref:`sphx_glr_auto_remote_access_debugging_workflows_tasks.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Debugging Workflow and Task Executions</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto/remote_access/register_project
   /auto/remote_access/remote_task
   /auto/remote_access/remote_workflow
   /auto/remote_access/remote_launchplan
   /auto/remote_access/inspecting_executions
   /auto/remote_access/debugging_workflows_tasks


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: remote_access_python.zip </auto/remote_access/remote_access_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: remote_access_jupyter.zip </auto/remote_access/remote_access_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_