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

Update K8s plugin config docs #5070

Merged

Conversation

davidmirror-ops
Copy link
Contributor

Tracking issue

Closes #5065

Why are the changes needed?

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

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

Related PRs

Docs link

davidmirror-ops added 2 commits March 18, 2024 14:09
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 18, 2024
@davidmirror-ops davidmirror-ops marked this pull request as draft March 18, 2024 19:11
@davidmirror-ops davidmirror-ops changed the title [WIP] 5065 spark config docs [WIP] Update K8s plugin config docs Mar 18, 2024
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.10%. Comparing base (ba59258) to head (5396ccd).
Report is 72 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5070      +/-   ##
==========================================
+ Coverage   59.00%   59.10%   +0.10%     
==========================================
  Files         645      645              
  Lines       55542    55574      +32     
==========================================
+ Hits        32770    32846      +76     
+ Misses      20181    20135      -46     
- Partials     2591     2593       +2     
Flag Coverage Δ
unittests 59.10% <ø> (+0.10%) ⬆️

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.

@neverett
Copy link
Contributor

@davidmirror-ops OK if i review this now or would you like me to wait until it's marked as ready for review and not draft?

Signed-off-by: davidmirror-ops <david espejo@union.ai>
@davidmirror-ops
Copy link
Contributor Author

@neverett Thanks Nikki, it's still a WIP. This page has several outdated/incorrect/missing sections. Once it's ready for review you can through your magic :)

davidmirror-ops added 18 commits March 19, 2024 13:09
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
@davidmirror-ops davidmirror-ops marked this pull request as ready for review March 22, 2024 21:13
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Mar 22, 2024
@davidmirror-ops davidmirror-ops changed the title [WIP] Update K8s plugin config docs Update K8s plugin config docs Mar 26, 2024
davidmirror-ops added 2 commits March 26, 2024 07:00
Signed-off-by: davidmirror-ops <david espejo@union.ai>
Signed-off-by: davidmirror-ops <david espejo@union.ai>
@davidmirror-ops
Copy link
Contributor Author

@neverett ready for review :)

neverett
neverett previously approved these changes Mar 28, 2024
Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

A few small suggestions, otherwise LGTM!

- kind: ServiceAccount
name: spark
namespace: "{{ namespace }}"
This guide help you configure the Flyte plugins that provision resources on Kubernetes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This guide help you configure the Flyte plugins that provision resources on Kubernetes.
This guide will help you configure the Flyte plugins that provision resources on Kubernetes.


See :ref:`deployment-configuration-general` for more information about Pod templates in Flyte.
You can set the scheduler name in the Pod template passed to the ``@task`` decorator. However, to prevent the
two different schedulers from competing for resources, it is recommended to set the scheduler name in the pod template
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
two different schedulers from competing for resources, it is recommended to set the scheduler name in the pod template
two different schedulers from competing for resources, we recommend setting the scheduler name in the pod template


2. (Optional) The Spark operator supports Kubernetes ResourceQuota enforcement. If you plan to use it,
set `per-Task resource requests <https://docs.flyte.org/en/latest/user_guide/productionizing/customizing_task_resources.html#customizing-task-resources>`__ that fit into the quota for each project-namespace. A Task without resource requests
or limits will be rejected by the K8s scheduler as described `in the docs <https://kubernetes.io/docs/concepts/policy/resource-quotas/>`__.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
or limits will be rejected by the K8s scheduler as described `in the docs <https://kubernetes.io/docs/concepts/policy/resource-quotas/>`__.
or limits will be rejected by the K8s scheduler as described `in the Kubernetes docs <https://kubernetes.io/docs/concepts/policy/resource-quotas/>`__.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 28, 2024
Signed-off-by: davidmirror-ops <david espejo@union.ai>
@davidmirror-ops davidmirror-ops merged commit a78025a into flyteorg:master Apr 1, 2024
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Update Spark config documentation
2 participants