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: update Flyte sandbox configuration and documentation #4729

Merged

Conversation

jasonlai1218
Copy link
Contributor

@jasonlai1218 jasonlai1218 commented Jan 15, 2024

Tracking issue

Why are the changes needed?

Currently, official documentation does not provide instructions on how to use Helm to deploy Flyte sandbox on a Kubernetes cluster and configure the Spark plugin.

What changes were proposed in this pull request?

  • Add instructions for setting up Flyte sandbox in the Kubernetes plugin documentation
  • Provide example YAML files for configuring Spark in Flyte sandbox
  • Update the values-override.yaml file for Flyte sandbox configuration
  • Fix the incorrect command by changing kubectl get pods -n --all-namespaces to kubectl get pods -n <namespace>.

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

- Add instructions for setting up Flyte sandbox in the Kubernetes plugin documentation
- Provide example YAML files for configuring Spark in Flyte sandbox
- Update the values-override.yaml file for Flyte sandbox configuration

Signed-off-by: jason.lai <[email protected]>
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 15, 2024
@davidmirror-ops davidmirror-ops self-requested a review January 15, 2024 19:17
docs/deployment/plugins/k8s/index.rst Outdated Show resolved Hide resolved
metadata:
name: spark-role
namespace: "{{ namespace }}"
rules:
Copy link
Contributor

Choose a reason for hiding this comment

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

One of the tests is complaining about a list being out of range. Not sure if it's a matter of indentation.

Also, this is the Role I've been using with flyte-core on EKS:

https://github.com/flyteorg/flyte/pull/4670/files#diff-5e363febf4c9f8a60b6f884277d82eb90f1d76e1f2a5b14037133c1c9ff36adeR574-R601

docs/deployment/plugins/k8s/index.rst Show resolved Hide resolved
Copy link

codecov bot commented Jan 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bcb7abe) 58.33% compared to head (846c680) 58.53%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4729      +/-   ##
==========================================
+ Coverage   58.33%   58.53%   +0.20%     
==========================================
  Files         626      625       -1     
  Lines       53938    53669     -269     
==========================================
- Hits        31465    31417      -48     
+ Misses      19949    19737     -212     
+ Partials     2524     2515       -9     
Flag Coverage Δ
unittests 58.53% <ø> (+0.20%) ⬆️

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.

jasonlai1218 and others added 2 commits January 16, 2024 22:43
- Change the link to the `flyte-sandbox Helm chart` in the documentation

Signed-off-by: jason.lai <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
@Future-Outlier Future-Outlier self-assigned this Jan 21, 2024
Future-Outlier and others added 6 commits January 21, 2024 11:33
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
- Added a new section for spinning up a cluster
- Added a new tab for Flyte sandbox in the documentation

Signed-off-by: jason.lai <[email protected]>
Co-authored-by: Samhita Alla <[email protected]>
Signed-off-by: David Espejo <[email protected]>
Copy link
Contributor

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

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

While I haven't tried it using this method (I mean, using the flyte-sandbox Helm chart instead of flytectl demo start) I see the values reflect what's expected for that chart.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 25, 2024
Copy link
Member

@Future-Outlier Future-Outlier left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your effort!

@davidmirror-ops
Copy link
Contributor

@jasonlai1218 Thanks so much!
BTW, consider signing up for the community raffle, this contribution will give you points!

@davidmirror-ops davidmirror-ops merged commit 6a46e3c into flyteorg:master Jan 26, 2024
45 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:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants