Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Added doc on how to handle a large response when using FlyteRemote.sync #1212

Merged
merged 8 commits into from
Oct 7, 2022
6 changes: 6 additions & 0 deletions docs/source/design/control_plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,12 @@ You can use :meth:`~flytekit.remote.remote.FlyteRemote.sync` to sync the entity
synced_execution = remote.sync(execution, sync_nodes=True)
node_keys = synced_execution.node_executions.keys()

.. note::

During the sync, you may come across ``Received message larger than max (xxx vs. 4194304)`` error if the message size is too large. In that case, edit the ``flyte-admin-base-config`` config map using the command ``kubectl edit cm flyte-admin-base-config -n flyte`` to increase the ``maxMessageSizeBytes`` value. Refer to the :ref:`flyte: <troubleshoot>` in case you've queries about the command's usage.

- To fix this error, edit the flyte-admin-base-config config map to increase ``maxMessageSizeBytes`` value.

``node_executions`` will fetch all the underlying node executions recursively.

To fetch output of a specific node execution:
Expand Down