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]Document clarifying notes about the data lifecycle #5922

Conversation

popojk
Copy link
Contributor

@popojk popojk commented Oct 27, 2024

Tracking issue

Closes #4683

Why are the changes needed?

  1. The Understand How Flyte Handles Data doc is lacking information about deleting raw data in storage service such as s3 and gcs.
  2. Some example code in the doc is incorrect. The workflow called a function 'task_read_and_shuffle_file', but the function is not defined in example code.

What changes were proposed in this pull request?

  1. Add information about raw data deletion in the doc.
  2. Fix example code.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All commits are signed-off.

Docs link

https://flyte--5922.org.readthedocs.build/en/5922/user_guide/concepts/main_concepts/data_management.html

Flyte does not offer a direct function to delete raw data stored in external datastores like ``S3`` or ``GCS``. However, you can manage deletion by configuring a lifecycle policy within your datastore service.

If caching is enabled in your Flyte ``task``, ensure that the ``max-cache-age`` is set to be shorter than the lifecycle policy in your datastore to prevent potential data inconsistency issues.

Practical Example
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure how this example connects with the content immediately above. This is an example of data movement, which is good, so maybe it would be better placed at the beginning of the page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @davidmirror-ops , I think you are right. The example section in this PR is indeed more relevant to data movement. To reduce ambiguity, I’ve moved the example section directly below the data movement section and relocated the Own Datastores section to the bottom of the page. Let me know if you have any further suggestions, thanks! doc-link

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (1279740) to head (18719e2).
Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5922      +/-   ##
==========================================
+ Coverage   36.53%   36.84%   +0.31%     
==========================================
  Files        1249     1309      +60     
  Lines      128230   130994    +2764     
==========================================
+ Hits        46847    48268    +1421     
- Misses      77346    78536    +1190     
- Partials     4037     4190     +153     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (?)
unittests-flyteadmin 54.10% <ø> (-0.04%) ⬇️
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (ø)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.02% <ø> (+0.01%) ⬆️
unittests-flytestdlib 55.41% <ø> (ø)

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.

@davidmirror-ops davidmirror-ops merged commit 6b81b16 into flyteorg:master Oct 31, 2024
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Docs] document clarifying notes about the data lifecycle
3 participants