Skip to content

Commit

Permalink
documentation revamp
Browse files Browse the repository at this point in the history
Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>

Update Tutorials Link

Docs staging (#933)

* dark theme updates (#883)

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>

* Release automation addedd for flyte definition  (#835)

* wip: added script for release automation

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: added manual github workflow

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added release workflow

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: fix e2e testcase

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: small fixes

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: revert version in kustomize

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: revert kustomize changes

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added generated kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* update latest version of component

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added generated kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: added message input in workflow

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: remove release automation from kustomize command

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip:  generate kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: revert webhook and build kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* updated release workflow

Signed-off-by: yuvraj <evalsocket@gmail.com>

* fix typo

Signed-off-by: yuvraj <evalsocket@gmail.com>

* Milestone 0.12.0 (#888)

* Update Flyte Components

Signed-off-by: Flyte-Bot <admin@flyte.org>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* update endtoend to flytekit 0.17

Signed-off-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* empty changelog

Signed-off-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* Update ChangeLog

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* before pull from flyte-bot-update-releases

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

Co-authored-by: EngHabu <EngHabu@users.noreply.github.com>
Co-authored-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Co-authored-by: HackMD <no-reply@hackmd.io>

* Update index.rst (#884)

* Update index.rst

Add Flyte users to Who's Using Flyte and Meet Flyte.

* Update rsts/index.rst

Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>

* Update index.rst

Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>

* Dashboard updates (#886)

* Adding additional metrics in Flyteadmin dashboard

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Flytepropeller metrics added

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Added queue metrics

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated name

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Add init container that will pre-create buckets in minio (#905)

* Add init container that will pre-create buckets in minio

Signed-off-by: Jeev B <jeev.balakrishnan@freenome.com>

* move minio tag override to overlay

Signed-off-by: Jeev B <jeev.balakrishnan@freenome.com>

* Add LF AI & Data Logo to README (#902)

* Explaining the state machine used by FlytePropeller and Flyte (#903)

* Explaining the state machine used by FlytePropeller and Flyte

 - this document helps to explain the various states a workflow, node
and task transitions through.
 - TODO add a small table that helps users understand what a state in
the UI represents

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated docs (addressed comments)

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* comments addressed - image for nodes improved

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Fix default eks storage config (#907)

* Fix default eks storage config

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* kustomize

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* bump

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* Restructured Flyte Docs

Signed-off-by: samhita-alla <aallasamhita@gmail.com>

* Added Tutorials in the main section

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

* Docs Restructure

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
Co-authored-by: Yuvraj <10830562+evalsocket@users.noreply.github.com>
Co-authored-by: Flyte Bot <admin@flyte.org>
Co-authored-by: EngHabu <EngHabu@users.noreply.github.com>
Co-authored-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Co-authored-by: HackMD <no-reply@hackmd.io>
Co-authored-by: SandraGH5 <80421934+SandraGH5@users.noreply.github.com>
Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>
Co-authored-by: Jeev B <jeevb@users.noreply.github.com>
Co-authored-by: Haytham Abuelfutuh <haytham@afutuh.com>

Docs staging (#950)

* dark theme updates (#883)

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>

* Release automation addedd for flyte definition  (#835)

* wip: added script for release automation

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: added manual github workflow

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added release workflow

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: fix e2e testcase

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: small fixes

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: revert version in kustomize

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: revert kustomize changes

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added generated kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* update latest version of component

Signed-off-by: Yuvraj <yuvraj.yad001@gmail.com>

* wip: added generated kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: added message input in workflow

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: remove release automation from kustomize command

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip:  generate kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* wip: revert webhook and build kustomize output

Signed-off-by: yuvraj <evalsocket@gmail.com>

* updated release workflow

Signed-off-by: yuvraj <evalsocket@gmail.com>

* fix typo

Signed-off-by: yuvraj <evalsocket@gmail.com>

* Milestone 0.12.0 (#888)

* Update Flyte Components

Signed-off-by: Flyte-Bot <admin@flyte.org>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* update endtoend to flytekit 0.17

Signed-off-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* empty changelog

Signed-off-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* Update ChangeLog

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* before pull from flyte-bot-update-releases

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

Co-authored-by: EngHabu <EngHabu@users.noreply.github.com>
Co-authored-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Co-authored-by: HackMD <no-reply@hackmd.io>

* Update index.rst (#884)

* Update index.rst

Add Flyte users to Who's Using Flyte and Meet Flyte.

* Update rsts/index.rst

Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>

* Update index.rst

Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>

* Dashboard updates (#886)

* Adding additional metrics in Flyteadmin dashboard

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Flytepropeller metrics added

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Added queue metrics

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated name

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Add init container that will pre-create buckets in minio (#905)

* Add init container that will pre-create buckets in minio

Signed-off-by: Jeev B <jeev.balakrishnan@freenome.com>

* move minio tag override to overlay

Signed-off-by: Jeev B <jeev.balakrishnan@freenome.com>

* Add LF AI & Data Logo to README (#902)

* Explaining the state machine used by FlytePropeller and Flyte (#903)

* Explaining the state machine used by FlytePropeller and Flyte

 - this document helps to explain the various states a workflow, node
and task transitions through.
 - TODO add a small table that helps users understand what a state in
the UI represents

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* updated docs (addressed comments)

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* comments addressed - image for nodes improved

Signed-off-by: Ketan Umare <ketan.umare@gmail.com>

* Fix default eks storage config (#907)

* Fix default eks storage config

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* kustomize

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* bump

Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>

* Restructured Flyte Docs

Signed-off-by: samhita-alla <aallasamhita@gmail.com>

* Added Tutorials in the main section

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

* Docs Restructure

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

* Docs Staging

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
Co-authored-by: Yuvraj <10830562+evalsocket@users.noreply.github.com>
Co-authored-by: Flyte Bot <admin@flyte.org>
Co-authored-by: EngHabu <EngHabu@users.noreply.github.com>
Co-authored-by: wild-endeavor <wild-endeavor@users.noreply.github.com>
Co-authored-by: HackMD <no-reply@hackmd.io>
Co-authored-by: SandraGH5 <80421934+SandraGH5@users.noreply.github.com>
Co-authored-by: Ketan Umare <16888709+kumare3@users.noreply.github.com>
Co-authored-by: Jeev B <jeevb@users.noreply.github.com>
Co-authored-by: Haytham Abuelfutuh <haytham@afutuh.com>

use custom flyte furo theme, re-organize TOC

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>

remove fontawesome

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>

remove custom.css

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>
  • Loading branch information
samhita-alla authored and cosmicBboy committed Apr 29, 2021
1 parent 6117b64 commit d36b511
Show file tree
Hide file tree
Showing 47 changed files with 203 additions and 469 deletions.
2 changes: 1 addition & 1 deletion doc-requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
furo
git+git://github.com/flyteorg/furo@main
readthedocs-sphinx-search
sphinx
sphinx-prompt
Expand Down
10 changes: 5 additions & 5 deletions doc-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
#
alabaster==0.7.12
# via sphinx
astroid==2.5.2
astroid==2.5.6
# via sphinx-autoapi
babel==2.9.0
babel==2.9.1
# via sphinx
beautifulsoup4==4.9.3
# via
Expand All @@ -20,7 +20,7 @@ chardet==4.0.0
# via requests
docutils==0.16
# via sphinx
furo==2021.3.20b30
git+git://github.com/flyteorg/furo@main
# via -r doc-requirements.in
idna==2.10
# via requests
Expand Down Expand Up @@ -59,7 +59,7 @@ snowballstemmer==2.1.0
# via sphinx
soupsieve==2.2.1
# via beautifulsoup4
sphinx-autoapi==1.7.0
sphinx-autoapi==1.8.1
# via -r doc-requirements.in
sphinx-code-include==1.1.1
# via -r doc-requirements.in
Expand All @@ -71,7 +71,7 @@ sphinx-prompt==1.4.0
# via -r doc-requirements.in
sphinx-tabs==2.1.0
# via -r doc-requirements.in
sphinx==3.5.3
sphinx==3.5.4
# via
# -r doc-requirements.in
# furo
Expand Down
91 changes: 0 additions & 91 deletions rsts/_static/custom.css

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions rsts/concepts/basics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _basics:

######
Basics
######

.. CAUTION::

Coming soon 🛠

.. toctree::
:maxdepth: 1
:name: Basics

flyte_ui
flyte_cli
deployment_options
glossary
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions rsts/concepts/control_plane.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
################
Control Plane
################

.. toctree::
:maxdepth: 1

projects
domains
admin
admin_service
registration
console
15 changes: 15 additions & 0 deletions rsts/concepts/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _divedeep:

############################
Core Concepts & Architecture
############################

.. toctree::
:maxdepth: 1
:name: Concepts & Architecture

overview
tasks
workflows_nodes
launchplans_schedules
architecture
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
.. _community_compare:

###################################
Compare Flyte to other products
Deployment options (Local & Remote)
###################################

.. CAUTION::

Coming soon 🛠
Coming soon 🛠
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions rsts/concepts/execution_time.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
######################
Execution Time Details
######################

.. toctree::
:maxdepth: 1

executions
state_machine
execution_timeline
observability
dynamic_spec
catalog
customizable_resources
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions rsts/concepts/flyte_cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
##############
Flyte CLI
##############

.. CAUTION::

Coming soon 🛠
7 changes: 7 additions & 0 deletions rsts/concepts/flyte_ui.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#################
Flyte UI
#################

.. CAUTION::

Coming soon 🛠
12 changes: 12 additions & 0 deletions rsts/concepts/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
############
Glossary
############

.. glossary::

Memoization
Memoization ensures that a method doesn't run for the same inputs more than once by keeping a record of the results for the given inputs.

.. CAUTION::

Coming soon 🛠
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
78 changes: 78 additions & 0 deletions rsts/concepts/state_machine.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. _divedeep-state-machine:

#################################################
Understanding the State Transition in a workflow
#################################################

High Level Overview of how a Workflow progresses to Success
============================================================

.. image:: https://mermaid.ink/img/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBSZWFkeVxuICAgIFJlYWR5IC0tPiBSdW5uaW5nXG4gICAgUnVubmluZyAtLT4gU3VjY2Vzc1xuXG4gICAgc3RhdGUgUnVubmluZyB7XG4gICAgICBbKl0gLS0-IE5vZGVRdWV1ZWRcbiAgICAgIE5vZGVRdWV1ZWQgLS0-IE5vZGVSdW5uaW5nXG4gICAgICBOb2RlUnVubmluZyAtLT4gTm9kZVN1Y2Nlc3NcblxuICAgICAgc3RhdGUgTm9kZVJ1bm5pbmcge1xuICAgICAgICBbKl0gLS0-IFRhc2tRdWV1ZWRcbiAgICAgICAgVGFza1F1ZXVlZCAtLT4gVGFza1J1bm5pbmdcbiAgICAgICAgVGFza1J1bm5pbmcgLS0-IFRhc2tTdWNjZXNzXG4gICAgICB9XG4gICAgfVxuXG4iLCJtZXJtYWlkIjp7fSwidXBkYXRlRWRpdG9yIjpmYWxzZX0
:alt: Happy case for a workflow with one node and one task.

This State diagram illustrates an extremely high level, simplistic view of the state transitions that a Workflow, with a single node and one task will go through as the observer observes success.

The following section explains in detail the various observable (and some hidden) states for a workflow, node and tasks state transitions.


Workflow States
================

.. image:: https://mermaid.ink/img/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBBYm9ydGVkIDogT24gc3lzdGVtIGVycm9ycyBtb3JlIHRoYW4gdGhyZXNob2xkXG4gICAgWypdIC0tPiBSZWFkeVxuICAgIFJlYWR5IC0tPiBSdW5uaW5nIDogV3JpdGUgaW5wdXRzIHRvIHdvcmtmbG93XG4gICAgUnVubmluZyAtLT4gUnVubmluZyA6IE9uIHN5c3RlbSBlcnJvclxuICAgIFJ1bm5pbmcgLS0-IFN1Y2NlZWRpbmcgOiBPbiBhbGwgTm9kZXMgU3VjY2Vzc1xuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRlZCA6IE9uIHN1Y2Nlc3NmdWwgZXZlbnQgc2VuZCB0byBBZG1pblxuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRpbmcgOiBPbiBzeXN0ZW0gZXJyb3JcbiAgICBSZWFkeSAtLT4gRmFpbGluZyA6IE9uIHByZWNvbmRpdGlvbiBmYWlsdXJlXG4gICAgUnVubmluZyAtLT4gRmFpbGluZyA6IE9uIGFueSBOb2RlIEZhaWx1cmVcbiAgICBSZWFkeSAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgUnVubmluZyAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgU3VjY2VlZGluZyAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG5cbiAgICBGYWlsaW5nIC0tPiBIYW5kbGVGYWlsdXJlTm9kZSA6IElmIEZhaWx1cmUgbm9kZSBleGlzdHNcbiAgICBGYWlsaW5nIC0tPiBBYm9ydGVkIDogT24gdXNlciBpbml0aWF0ZWQgYWJvcnRcbiAgICBIYW5kbGVGYWlsdXJlTm9kZSAtLT4gRmFpbGVkIDogT24gY29tcGxldGluZyBmYWlsdXJlIG5vZGVcbiAgICBIYW5kbGVGYWlsdXJlTm9kZSAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgRmFpbGluZyAtLT4gRmFpbGVkIDogT24gc3VjY2Vzc2Z1bCBzZW5kIG9mIEZhaWx1cmUgbm9kZVxuICAgICIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ
:alt: The State diagram above illustrates the various states through which a workflow transitions. This is the core finite state machine (FSM) of a Workflow.

The State diagram above illustrates the various states through which a Workflow transitions. This is the core Finite state machine of a Workflow.

A Workflow always starts in the Ready State and ends either in Failed, Succeeded or Aborted state.
Any system error within a state causes a retry on that state. These retries are capped by system retries and will eventually lead to an Aborted state.

Every transition between states is recorded in Flyteadmin using :std:ref:`gen/pb-protodoc/flyteidl/event/event.proto:flyteidl.event.workflowexecutionevent`

The phases in the above state diagram are captured in the Admin database as specified here :std:ref:`api_enum_flyteidl.core.workflowexecution.phase` and are sent as part of the Execution Event.

The state machine specification for the illustration can be found `here <https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBBYm9ydGVkIDogT24gc3lzdGVtIGVycm9ycyBtb3JlIHRoYW4gdGhyZXNob2xkXG4gICAgWypdIC0tPiBSZWFkeVxuICAgIFJlYWR5IC0tPiBSdW5uaW5nIDogV3JpdGUgaW5wdXRzIHRvIHdvcmtmbG93XG4gICAgUnVubmluZyAtLT4gUnVubmluZyA6IE9uIHN5c3RlbSBlcnJvclxuICAgIFJ1bm5pbmcgLS0-IFN1Y2NlZWRpbmcgOiBPbiBhbGwgTm9kZXMgU3VjY2Vzc1xuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRlZCA6IE9uIHN1Y2Nlc3NmdWwgZXZlbnQgc2VuZCB0byBBZG1pblxuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRpbmcgOiBPbiBzeXN0ZW0gZXJyb3JcbiAgICBSZWFkeSAtLT4gRmFpbGluZyA6IE9uIHByZWNvbmRpdGlvbiBmYWlsdXJlXG4gICAgUnVubmluZyAtLT4gRmFpbGluZyA6IE9uIGFueSBOb2RlIEZhaWx1cmVcbiAgICBSZWFkeSAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgUnVubmluZyAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgU3VjY2VlZGluZyAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG5cbiAgICBGYWlsaW5nIC0tPiBIYW5kbGVGYWlsdXJlTm9kZSA6IElmIEZhaWx1cmUgbm9kZSBleGlzdHNcbiAgICBGYWlsaW5nIC0tPiBBYm9ydGVkIDogT24gdXNlciBpbml0aWF0ZWQgYWJvcnRcbiAgICBIYW5kbGVGYWlsdXJlTm9kZSAtLT4gRmFpbGVkIDogT24gY29tcGxldGluZyBmYWlsdXJlIG5vZGVcbiAgICBIYW5kbGVGYWlsdXJlTm9kZSAtLT4gQWJvcnRlZCA6IE9uIHVzZXIgaW5pdGlhdGVkIGFib3J0XG4gICAgRmFpbGluZyAtLT4gRmFpbGVkIDogT24gc3VjY2Vzc2Z1bCBzZW5kIG9mIEZhaWx1cmUgbm9kZVxuICAgICIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ>`_


Node States
================

.. image:: https://mermaid.ink/img/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBOb3RZZXRTdGFydGVkXG4gICAgWypdIC0tPiBBYm9ydGVkIDogV2lsbCBzdG9wIHRoZSBub2RlIGV4ZWN1dGlvblxuICAgIE5vdFlldFN0YXJ0ZWQgLS0-IFF1ZXVlZCA6IElmIGFsbCB1cHN0cmVhbSBub2RlcyBhcmUgcmVhZHkgaS5lLCBpbnB1dHMgYXJlIHJlYWR5XG4gICAgTm90WWV0U3RhcnRlZCAtLT4gU2tpcHBlZCA6IElmIHRoZSBicmFuY2ggd2FzIG5vdCB0YWtlblxuICAgIFF1ZXVlZCAtLT4gUnVubmluZyA6IFN0YXJ0IHRhc2sgZXhlY3V0aW9uIC0gYXR0ZW1wdCAwXG4gICAgUnVubmluZyAtLT4gVGltaW5nT3V0IDogSWYgdGFzayB0aW1lb3V0IGhhcyBlbGFwc2VkIGFuZCByZXRyeV9hdHRlbXB0cyA-PSBtYXhfcmV0cmllc1xuICAgIFRpbWluZ091dCAtLT4gVGltZWRPdXQgOiBJdCB0b3RhbCBub2RlIHRpbWVvdXQgaGFzIGVsYXBzZWRcbiAgICBSdW5uaW5nIC0tPiBSZXRyeWFibGVGYWlsdXJlIDogb24gcmV0cnlhYmxlIGZhaWx1cmVcbiAgICBSZXRyeWFibGVGYWlsdXJlIC0tPiBSdW5uaW5nIDogaWYgcmV0cnlfYXR0ZW1wdHMgPCBtYXhfcmV0cmllc1xuICAgIFJldHJ5YWJsZUZhaWx1cmUgLS0-IEZhaWxpbmcgOiByZXRyeV9hdHRlbXB0cyA-PSBtYXhfcmV0cmllc1xuICAgIEZhaWxpbmcgLS0-IEZhaWxlZFxuICAgIFJ1bm5pbmcgLS0-IFN1Y2NlZWRpbmcgOiBJbnRlcm5hbCBzdGF0ZVxuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRlZCA6IFVzZXIgb2JzZXJ2ZXMgdGhlIHRhc2sgYXMgc3VjY2VlZGVkXG4gICAgU3VjY2VlZGVkIC0tPiBbKl1cbiAgICBGYWlsZWQgLS0-IFsqXVxuIiwibWVybWFpZCI6e30sInVwZGF0ZUVkaXRvciI6ZmFsc2V9
:alt: The State diagram above illustrates the various states through which a Node transitions. This is the core FSM for a Node.

The state diagram above illustrates the various states through which a Node transitions. This is the core FSM for a Node.
From a user's point of view, a Workflow simply consists of a sequence of tasks. But to Flyte, a Workflow internally creates a meta entity called a

Once a Workflow enters a ``Running`` state, it triggers the phantom ``start node`` of the workflow. The Start node is always the entry node of any workflow. The start node starts executing all its child-nodes using a modified DepthFirst Search algorithm recursively.

Nodes can be of different types, as follows, but all the nodes traverse through the same transitions

#. Start Node - Only exists during the execution and is not modeled in the core spec
#. :std:ref:`gen/pb-protodoc/flyteidl/core/workflow.proto:flyteidl.core.tasknode`
#. :std:ref:`gen/pb-protodoc/flyteidl/core/workflow.proto:flyteidl.core.branchnode`
#. :std:ref:`gen/pb-protodoc/flyteidl/core/workflow.proto:flyteidl.core.workflownode`
#. Dynamic node - which is just a task node that does not return outputs, but futures.
#. End Node - only exists during the execution and is not modeled in the core spec

Every transition between states is recorded in Flyteadmin using :std:ref:`gen/pb-protodoc/flyteidl/event/event.proto:flyteidl.event.nodeexecutionevent`

Every NodeExecutionEvent can have one of the :std:ref:`api_enum_flyteidl.core.nodeexecution.phase`

.. note:: TODO add explanation for each phase

The state machine specification for the illustration can be found `here <https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBOb3RZZXRTdGFydGVkXG4gICAgWypdIC0tPiBBYm9ydGVkIDogV2lsbCBzdG9wIHRoZSBub2RlIGV4ZWN1dGlvblxuICAgIE5vdFlldFN0YXJ0ZWQgLS0-IFF1ZXVlZCA6IElmIGFsbCB1cHN0cmVhbSBub2RlcyBhcmUgcmVhZHkgaS5lLCBpbnB1dHMgYXJlIHJlYWR5XG4gICAgTm90WWV0U3RhcnRlZCAtLT4gU2tpcHBlZCA6IElmIHRoZSBicmFuY2ggd2FzIG5vdCB0YWtlblxuICAgIFF1ZXVlZCAtLT4gUnVubmluZyA6IFN0YXJ0IHRhc2sgZXhlY3V0aW9uIC0gYXR0ZW1wdCAwXG4gICAgUnVubmluZyAtLT4gVGltaW5nT3V0IDogSWYgdGFzayB0aW1lb3V0IGhhcyBlbGFwc2VkIGFuZCByZXRyeV9hdHRlbXB0cyA-PSBtYXhfcmV0cmllc1xuICAgIFRpbWluZ091dCAtLT4gVGltZWRPdXQgOiBJdCB0b3RhbCBub2RlIHRpbWVvdXQgaGFzIGVsYXBzZWRcbiAgICBSdW5uaW5nIC0tPiBSZXRyeWFibGVGYWlsdXJlIDogb24gcmV0cnlhYmxlIGZhaWx1cmVcbiAgICBSZXRyeWFibGVGYWlsdXJlIC0tPiBSdW5uaW5nIDogaWYgcmV0cnlfYXR0ZW1wdHMgPCBtYXhfcmV0cmllc1xuICAgIFJldHJ5YWJsZUZhaWx1cmUgLS0-IEZhaWxpbmcgOiByZXRyeV9hdHRlbXB0cyA-PSBtYXhfcmV0cmllc1xuICAgIEZhaWxpbmcgLS0-IEZhaWxlZFxuICAgIFJ1bm5pbmcgLS0-IFN1Y2NlZWRpbmcgOiBJbnRlcm5hbCBzdGF0ZVxuICAgIFN1Y2NlZWRpbmcgLS0-IFN1Y2NlZWRlZCA6IFVzZXIgb2JzZXJ2ZXMgdGhlIHRhc2sgYXMgc3VjY2VlZGVkXG4gICAgU3VjY2VlZGVkIC0tPiBbKl1cbiAgICBGYWlsZWQgLS0-IFsqXVxuIiwibWVybWFpZCI6e30sInVwZGF0ZUVkaXRvciI6ZmFsc2V9>`_

Task States
================

.. image:: https://mermaid.ink/img/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBOb3RSZWFkeVxuICAgIFsqXSAtLT4gQWJvcnRlZCA6IEFib3J0ZWQgYnkgTm9kZUhhbmRsZXIgLSB0aW1lb3V0cywgZXh0cmVuYWwgYWJvcnQsIGV0Y1xuICAgIE5vdFJlYWR5IC0tPiBXYWl0aW5nRm9yUmVzb3VyY2VzIDogQmxvY2tlZCBvbiByZXNvdXJjZSBxdW90YSBvciByZXNvdXJjZSBwb29sIChvcHRpb25hbClcbiAgICBXYWl0aW5nRm9yUmVzb3VyY2VzIC0tPiBRdWV1ZWQgOiBIYXMgYmVlbiBzdWJtaXR0ZWQsIGJ1dCBoYXMgbm90IHN0YXJ0ZWQgKG9wdGlvbmFsKVxuICAgIFF1ZXVlZCAtLT4gSW5pdGlhbGl6aW5nIDogUHJlc3RhcnQgaW5pdGlhbGl6YXRpb24gKG9wdGlvbmFsKVxuICAgIEluaXRpYWxpemluZyAtLT4gUnVubmluZyA6IEFjdHVhbCBleGVjdXRpb24gb2YgdXNlciBjb2RlIGhhcyBzdGFydGVkXG4gICAgUnVubmluZyAtLT4gU3VjY2VzcyA6IFN1Y2Nlc3NmdWwgZXhlY3V0aW9uXG4gICAgUnVubmluZyAtLT4gUmV0cnlhYmxlRmFpbHVyZSA6IEZhaWxlZCB3aXRoIGEgcmV0cnlhYmxlIGVycm9yXG4gICAgUnVubmluZyAtLT4gUGVybWFuZW50RmFpbHVyZSA6IFVucmVjb3ZlcmFibGUgZmFpbHVyZSwgd2lsbCBzdG9wIGFsbCBleGVjdXRpb25cbiAgICBTdWNjZXNzIC0tPiBbKl1cbiAgICBSZXRyeWFibGVGYWlsdXJlIC0tPiBbKl1cbiAgICBQZXJtYW5lbnRGYWlsdXJlIC0tPiBbKl1cbiIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ
:alt: The State diagram above illustrates the various states through which a Task transitions. This is the core FSM for any Task in Flyte.

The State diagram above illustrates the various states through which a Task transitions.

Every transition between states is recorded in Flyteadmin using :std:ref:`gen/pb-protodoc/flyteidl/event/event.proto:flyteidl.event.taskexecutionevent`

Every TaskExecutionEvent can have one of the :std:ref:`api_enum_flyteidl.core.taskexecution.phase`

.. note:: TODO add explanation for each phase

The state machine specification for the illustration can be found `here <https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBOb3RSZWFkeVxuICAgIFsqXSAtLT4gQWJvcnRlZCA6IEFib3J0ZWQgYnkgTm9kZUhhbmRsZXIgLSB0aW1lb3V0cywgZXh0cmVuYWwgYWJvcnQsIGV0Y1xuICAgIE5vdFJlYWR5IC0tPiBXYWl0aW5nRm9yUmVzb3VyY2VzIDogQmxvY2tlZCBvbiByZXNvdXJjZSBxdW90YSBvciByZXNvdXJjZSBwb29sIChvcHRpb25hbClcbiAgICBXYWl0aW5nRm9yUmVzb3VyY2VzIC0tPiBRdWV1ZWQgOiBIYXMgYmVlbiBzdWJtaXR0ZWQsIGJ1dCBoYXMgbm90IHN0YXJ0ZWQgKG9wdGlvbmFsKVxuICAgIFF1ZXVlZCAtLT4gSW5pdGlhbGl6aW5nIDogUHJlc3RhcnQgaW5pdGlhbGl6YXRpb24gKG9wdGlvbmFsKVxuICAgIEluaXRpYWxpemluZyAtLT4gUnVubmluZyA6IEFjdHVhbCBleGVjdXRpb24gb2YgdXNlciBjb2RlIGhhcyBzdGFydGVkXG4gICAgUnVubmluZyAtLT4gU3VjY2VzcyA6IFN1Y2Nlc3NmdWwgZXhlY3V0aW9uXG4gICAgUnVubmluZyAtLT4gUmV0cnlhYmxlRmFpbHVyZSA6IEZhaWxlZCB3aXRoIGEgcmV0cnlhYmxlIGVycm9yXG4gICAgUnVubmluZyAtLT4gUGVybWFuZW50RmFpbHVyZSA6IFVucmVjb3ZlcmFibGUgZmFpbHVyZSwgd2lsbCBzdG9wIGFsbCBleGVjdXRpb25cbiAgICBTdWNjZXNzIC0tPiBbKl1cbiAgICBSZXRyeWFibGVGYWlsdXJlIC0tPiBbKl1cbiAgICBQZXJtYW5lbnRGYWlsdXJlIC0tPiBbKl1cbiIsIm1lcm1haWQiOnt9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ>`_
File renamed without changes.
File renamed without changes.
4 changes: 0 additions & 4 deletions rsts/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,6 @@
pygments_style = "tango"
pygments_dark_style = "native"

html_css_files = [
"custom.css",
]

html_theme_options = {
"light_css_variables": {
"color-brand-primary": "#4300c9",
Expand Down
Loading

0 comments on commit d36b511

Please sign in to comment.