Update Propeller architecture documentation

docs/concepts/component_architecture/flytepropeller_architecture.rst

@@ -15,13 +15,20 @@ Introduction
 A Flyte :ref:`workflow <divedeep-workflows>` is represented as a Directed Acyclic Graph (DAG) of interconnected Nodes. Flyte supports a robust collection of Node types to ensure diverse functionality.
 
 - ``TaskNodes`` support a plugin system to externally add system integrations.
-- Control flow can be altered during runtime using ``BranchNodes``, which prune downstream evaluation paths based on input. 
+- ``BranchNodes`` allow altering the control flow during runtime; pruning downstream evaluation paths based on input. 
 - ``DynamicNodes`` add nodes to the DAG.
 - ``WorkflowNodes`` allow embedding workflows within each other.
 
-FlytePropeller is responsible for scheduling and tracking execution of Flyte workflows. It is implemented using a K8s controller and adheres to the established K8s design principles. In this scheme, resources are periodically evaluated and the goal is to transition from the observed state to a requested state.
+FlytePropeller is responsible for scheduling and tracking execution of Flyte workflows. It is implemented using a K8s controller that follows the reconciler pattern. 
 
-In our case, workflows are the resources and they are iteratively evaluated to transition from the current state to success. During each loop, the current workflow state is established as the phase of workflow nodes and subsequent tasks, and FlytePropeller performs operations to transition this state to success. The operations may include scheduling (or rescheduling) node executions, evaluating dynamic or branch nodes, etc. These design decisions ensure that FlytePropeller can scale to manage a large number of concurrent workflows without performance degradation.
+.. image:: https://raw.githubusercontent.com/flyteorg/static-resources/main/common/reconciler-pattern.png
+
+In this scheme, resources are periodically evaluated and the goal is to transition from the observed state to a requested state.
+
+In our case, workflows are the resources, whose desired stated (*workflow definition*) is expressed using Flyte's SDK.  Workflows are iteratively evaluated to transition from the current state to success. During each evaluation loop, the current workflow state is established as the `phase of workflow nodes <https://docs.flyte.org/en/latest/protos/docs/core/core.html#workflowexecution-phase>`__  and subsequent tasks, and FlytePropeller performs operations to transition this state to success. 
+The operations may include scheduling (or rescheduling) node executions, evaluating dynamic or branch nodes, etc. 
+
+By using a simple yet robust mechanism, FlytePropeller can scale to manage a large number of concurrent workflows without significant performance degradation.
 
 This document attempts to break down the FlytePropeller architecture by tracking workflow life cycle through each internal component. Below is a high-level illustration of the FlytePropeller architecture and a flow chart of each component's responsibilities during FlyteWorkflow execution.
 
@@ -30,12 +37,98 @@ This document attempts to break down the FlytePropeller architecture by tracking
 Components
 ==========
 
+
+FlyteAdmin is the common entry point, where initialization of FlyteWorkflow Custom Resources may be triggered by user workflow definition executions, automatic relaunches, or periodically scheduled workflow definition executions.
+
 FlyteWorkflow CRD / K8s Integration
 -----------------------------------
 
-Workflows in Flyte are maintained as Custom Resource Definitions (CRDs) in Kubernetes, which are stored in the backing etcd cluster. Each execution of a workflow definition results in the creation of a new FlyteWorkflow CR (Custom Resource) which maintains a state for the entirety of processing. CRDs provide variable definitions to describe both resource specifications (spec) and status (status). The FlyteWorkflow CRD uses the spec subsection to detail the workflow DAG, embodying node dependencies, etc. The status subsection tracks workflow metadata including overall workflow status, node/task phases, status/phase transition timestamps, etc.
+Workflows in Flyte are maintained as `Custom Resource Definitions (CRDs) <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`__  in Kubernetes, which are stored in the backing ``etcd`` key-value store. Each workflow execution results in the creation of a new ``flyteworkflow`` CR (Custom Resource) which maintains its state for the duration of the execution. CRDs provide variable definitions to describe both resource specifications (``spec``) and status (``status``). The ``flyteworkflow`` CRD uses the ``spec`` subsection to detail the workflow DAG, embodying node dependencies, etc. 
+
+**Example**
+
+1. Execute an `example workflow <https://docs.flyte.org/en/latest/core_use_cases/machine_learning.html#machine-learning>`__ on a remote Flyte cluster:
+
+.. code-block:: bash 
+
+   pyflyte run --remote example.py training_workflow --hyperparameters '{"C": 0.4}'
+
+2. Verify there's a new Custom Resource on the ``flytesnacks-development`` namespace (this is, the workflow belongs to the ``flytesnacks`` project and the ``development`` domain):
+
+.. code-block:: bash 
+
+   kubectl get flyteworkflows.flyte.lyft.com -n flytesnacks-development
+
+Example output:
+
+.. code-block:: bash 
+
+   NAME                   AGE
+   f7616dc75400f43e6920   3h42m 
+
+3. Describe the contents of the Custom Resource, for example the ``spec`` section:
+
+.. code-block:: bash 
+
+   kubectl describe flyteworkflows.flyte.lyft.com f7616dc75400f43e6920 -n flytesnacks-development  
+
+.. code-block:: json 
+
+    "spec": {
+        "connections": {
+            "n0": [
+                "n1"
+            ],
+            "n1": [
+                "n2"
+            ],
+            "n2": [
+                "end-node"
+            ],
+            "start-node": [
+                "n0",
+                "n2"
+            ]
+        },
+
+The status subsection tracks workflow metadata including overall workflow status, node/task phases, status/phase transition timestamps, etc.
+
+.. code-block:: json 
+
+    "status": {
+        "dataDir": "gs://flyteontf-gcp-data-116223838137/metadata/propeller/flytesnacks-development-f7616dc75400f43e6920",
+        "defVersion": 1,
+        "lastUpdatedAt": "2024-03-26T16:22:16Z",
+        "nodeStatus": {
+            "end-node": {
+                "phase": 5,
+                "stoppedAt": "2024-03-26T16:22:16Z"
+            },
+            "n0": {
+                "phase": 5,
+                "stoppedAt": "2024-03-26T16:21:46Z"
+            },
+            "n1": {
+                "phase": 5,
+                "stoppedAt": "2024-03-26T16:22:02Z"
+            },
+            "n2": {
+                "phase": 5,
+                "stoppedAt": "2024-03-26T16:22:16Z"
+            },
+            "start-node": {
+                "phase": 5,
+                "stoppedAt": "2024-03-26T16:20:39Z"
+            }
+        },
+
+
+K8s exposes a powerful controller/operator API that enables entities to track creation/updates over a specific resource type. FlytePropeller uses this API to track FlyteWorkflows, meaning every time an instance of the ``flyteworkflow`` CR is created/updated, the FlytePropeller instance is notified. 
+
+.. note::
+
+    Manual creation of ``flyteworkflow`` CRs, without the intervention of ``flyteadmin``, is possible but not supported as the resulting resource will have limited visibility and usability.
 
-K8s exposes a powerful controller/operator API that enables entities to track creation/updates over a specific resource type. FlytePropeller uses this API to track FlyteWorkflows, meaning every time an instance of the FlyteWorkflow CR is created/updated, the FlytePropeller instance is notified. FlyteAdmin is the common entry point, where initialization of FlyteWorkflow CRs may be triggered by user workflow definition executions, automatic relaunches, or periodically scheduled workflow definition executions. However, it is conceivable to manually create FlyteWorkflow CRs, but this will have limited visibility and usability.
 
 WorkQueue/WorkerPool
 ----------------------
@@ -45,12 +138,12 @@ FlytePropeller supports concurrent execution of multiple, unique workflows using
 The WorkQueue is a FIFO queue storing workflow ID strings that require a lookup to retrieve the FlyteWorkflow CR to ensure up-to-date status. A workflow may be added to the queue in a variety of circumstances:
 
 #. A new FlyteWorkflow CR is created or an existing instance is updated
-#. The K8s Informer resyncs the FlyteWorkflow periodically (necessary to detect workflow timeouts and ensure liveness)
+#. The K8s Informer detects a workflow timeout or failed liveness check during its periodic resync operation on the FlyteWorkflow. 
 #. A FlytePropeller worker experiences an error during a processing loop
 #. The WorkflowExecutor observes a completed downstream node
-#. A NodeHandler observes state change and explicitly enqueues its owner (For example, K8s pod informer observes completion of a task)
+#. A NodeHandler observes state change and explicitly enqueues its owner. (For example, K8s pod informer observes completion of a task.)
 
-The WorkerPool is implemented as a collection of goroutines, one for each worker. Using this lightweight construct, FlytePropeller can scale to 1000s of workers on a single CPU. Workers continually poll the WorkQueue for workflows. On success, the workflow is executed (passed to WorkflowExecutor).
+The WorkerPool is implemented as a collection of ``goroutines``, one for each worker. Using this lightweight construct, FlytePropeller can scale to 1000s of workers on a single CPU. Workers continually poll the WorkQueue for workflows. On success, the workflow is passed to the WorkflowExecutor.
 
 WorkflowExecutor
 ----------------
@@ -60,7 +153,15 @@ The WorkflowExecutor is responsible for handling high-level workflow operations.
 NodeExecutor
 ------------
 
-The NodeExecutor is executed on a single node, beginning with the workflow's start node. It traverses the workflow using a visitor pattern with a modified depth-first search (DFS), evaluating each node along the path. A few examples of node evaluation based on phase: successful nodes are skipped, unevaluated nodes are queued for processing, and failed nodes may be reattempted up to a configurable threshold. There are many configurable parameters to tune evaluation criteria including max parallelism which restricts the number of nodes which may be scheduled concurrently. Additionally, nodes may be retried to ensure recoverability on failure.  
+The NodeExecutor is executed on a single node, beginning with the workflow's start node. It traverses the workflow using a visitor pattern with a modified depth-first search (DFS), evaluating each node along the path. A few examples of node evaluation based on phase include: 
+
+* Successful nodes are skipped
+* Unevaluated nodes are queued for processing
+* Failed nodes may be reattempted up to a configurable threshold. 
+
+There are many configurable parameters to tune evaluation criteria including max parallelism which restricts the number of nodes which may be scheduled concurrently. Additionally, nodes may be retried to ensure recoverability on failure.
+
+Go to the `Optimizing Performance <https://docs.flyte.org/en/latest/deployment/configuration/performance.html#optimizing-performance>`__ section for more information on how to tune Propeller parameters.  
 
 The NodeExecutor is also responsible for linking data readers/writers to facilitate data transfer between node executions. The data transfer process occurs automatically within Flyte, using efficient K8s events rather than a polling listener pattern which incurs more overhead. Relatively small amounts of data may be passed between nodes inline, but it is more common to pass data URLs to backing storage. A component of this is writing to and checking the data cache, which facilitates the reuse of previously completed evaluations.
 
@@ -73,7 +174,7 @@ FlytePropeller includes a robust collection of NodeHandlers to support diverse e
 
   1. **Pod Task**: Create a pod in the Kubernetes cluster, execute the task, and then delete the pod.
 
-  2. **K8s Operator Backend Plugin**: Install a specific Kubernetes Operator (e.g., Spark, Ray, and Kubeflow) in the cluster, create pods by the Kubernetes Operator, execute the task, and then delete the pods.
+  2. **K8s Operator Backend Plugin**: Install a specific Kubernetes Operator (e.g., Spark, Ray, or Kubeflow) in the cluster, create pods by the Kubernetes Operator, execute the task, and then delete the pods.
 
   3. **Web API Task**: Send REST/gRPC requests to a server and return the response.
      Note: The Web API Task will not start a pod.
@@ -91,6 +192,8 @@ It should be noted that the WorkflowExecutor, NodeExecutor, and TaskHandlers sen
 FlytePlugins
 ------------
 
-Here is an overview architecture of FlytePlugins:
+Every operation that Propeller performs makes use of a plugin. The following diagram describe the different types of plugins available for Propeller and an example operation when using the Spark integration:
 
 .. image:: https://raw.githubusercontent.com/flyteorg/static-resources/main/flyte/concepts/architecture/flytepropeller_plugins_architecture.png
+
+