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

[flytepropeller][flyteadmin] Streaming Decks V2 #6053

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Future-Outlier
Copy link
Member

@Future-Outlier Future-Outlier commented Nov 27, 2024

Tracking issue

#5574

Why are the changes needed?

To enhance user visibility into Flyte Decks at different stages of workflow execution (running, failing, and succeeding), enabling better debugging and analysis.

What changes were proposed in this pull request?

  1. Deck URI Integration: Ensure the Deck URI is included in Propeller at all task execution times.
  2. flyte deck lifecycle
    (1) When the Flytekit task pod publishes the Deck, Propeller updates the Deck URI in the node event.
    (2) The Admin retrieves the Deck URI from the node event.
    (3) The console gets the deck by admin's data proxy

How was this patch tested?

  1. unit test and remote execution.

Setup process

single binary.

flyte: this branch
flytekit: flyteorg/flytekit#2779
flyteconsole: flyteorg/flyteconsole#890

Screenshots

RUNNING AND SUCCEED

Screen.Recording.2024-11-28.at.10.04.09.AM.mov

FAILED

Screen.Recording.2024-11-28.at.10.06.21.AM.mov

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

follow up questions

  1. should we support Abort phase for the streaming deck?

should we support EPhaseAbort in this file?

https://github.com/flyteorg/flyte/blob/b3330ba4430538f91ae9fc7d868a29a2e96db8bd/flytepropeller/pkg/controller/nodes/handler/transition_info.go

  1. how can we support the auto-refresh UX?

Future-Outlier and others added 2 commits November 27, 2024 23:36
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Yi Cheng <[email protected]>
Co-authored-by: pingsutw  <[email protected]>
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

Attention: Patch coverage is 51.02041% with 24 lines in your changes missing coverage. Please review.

Project coverage is 37.09%. Comparing base (ab04192) to head (4b4f6bd).

Files with missing lines Patch % Lines
...lytepropeller/pkg/controller/nodes/task/handler.go 50.00% 19 Missing and 5 partials ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6053   +/-   ##
=======================================
  Coverage   37.08%   37.09%           
=======================================
  Files        1318     1318           
  Lines      132284   132307   +23     
=======================================
+ Hits        49062    49073   +11     
- Misses      78950    78960   +10     
- Partials     4272     4274    +2     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.10% <100.00%> (+<0.01%) ⬆️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.33% <ø> (ø)
unittests-flyteidl 7.23% <ø> (ø)
unittests-flyteplugins 53.73% <ø> (ø)
unittests-flytepropeller 42.62% <50.00%> (-0.01%) ⬇️
unittests-flytestdlib 57.59% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Future-Outlier <[email protected]>
switch pluginTrns.pInfo.Phase() {
case pluginCore.PhaseSuccess:
// This is to prevent the console from potentially checking the deck URI that does not exist if in final phase(PhaseSuccess).
err = pluginTrns.RemoveNonexistentDeckURI(ctx, tCtx)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this do a head call on the deck URI for every task that succeeds? Two thoughts here:
(1) does the flyteadmin merge algorithm then remove the deckURI from the execution metadata?
(2) this is incurring a 20-30ms performance degredation to every task execution

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will take a look tmr, thank you!!!

Copy link
Member Author

@Future-Outlier Future-Outlier Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this do a head call on the deck URI for every task that succeeds?

yes it will do a head call by RemoteFileOutputReader

func (r RemoteFileOutputReader) DeckExists(ctx context.Context) (bool, error) {
md, err := r.store.Head(ctx, r.outPath.GetDeckPath())
if err != nil {
return false, err
}
return md.Exists(), nil
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how do you know the performance degradation?
did you use grafana or other performance tools?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does the flyteadmin merge algorithm then remove the deckURI from the execution metadata?

flyteadmin will set the deckURI in the execution metadata to nil if the propeller removes it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Future-Outlier
Copy link
Member Author

Future-Outlier commented Nov 27, 2024

How to test it?

  1. start a new sandbox
flytectl demo start --image futureoutlier/streaming-deck:1128 --force
  1. checkout streaming deck flytekit branch
cd flytekit
gh pr checkout 2779
  1. run a failure task (show deck after it failed)
from flytekit import ImageSpec, task, workflow
from flytekit.deck import Deck

flytekit_hash = "fc5578f74c7193245c051d1470c61f0f14619217"
flytekit = f"git+https://github.com/flyteorg/flytekit.git@{flytekit_hash}"

# Define custom image for the task
custom_image = ImageSpec(packages=[flytekit],
                            apt_packages=["git"],
                            registry="localhost:30000",
                         )
@task(enable_deck=True, container_image=custom_image)
def t_deck():
    import time
    """
    1st deck only show timeline deck
    2nd will show
    """
    for i in range(2):
        Deck.publish()
        time.sleep(10)
        raise Exception("This is an exception")


@workflow
def wf():
    t_deck()

if __name__ == "__main__":
    from flytekit.clis.sdk_in_container import pyflyte
    from click.testing import CliRunner
    import os

    runner = CliRunner()
    path = os.path.realpath(__file__)

    result = runner.invoke(pyflyte.main,
                           ["run", "--remote", path,"wf"])
    #  "--remote",
    print("Remote Execution: ", result.output)

@EngHabu
Copy link
Contributor

EngHabu commented Nov 28, 2024

Mind adding screenshots for the rendered deck and refresh to the PR description?

@Future-Outlier
Copy link
Member Author

Mind adding screenshots for the rendered deck and refresh to the PR description?

Yes no problem

@Future-Outlier
Copy link
Member Author

Mind adding screenshots for the rendered deck and refresh to the PR description?

its provided!
#6053 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants