Skip to content

Docs: improve resource usage documentation #294

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

Closed
adwk67 opened this issue Oct 13, 2023 · 0 comments · Fixed by #297
Closed

Docs: improve resource usage documentation #294

adwk67 opened this issue Oct 13, 2023 · 0 comments · Fixed by #297
Assignees

Comments

@adwk67
Copy link
Member

adwk67 commented Oct 13, 2023

As a user I want to have documentation that clearly descrbes what is and is not set with regard to pod resources. Specifically, the different combations that are possible:

  • setting everything via spark.conf
  • setting everything via resources
  • differences between job/driver/executor and when cores/min is ignored.

For example, looking at the resources test here and the corresponding assert here it should be shown how the resulting values are arrived at:

Driver

yaml:

resources:
  cpu:
    min: 250m
    max: 500m
  memory:
    limit: 512Mi

pod:

resources:
  limits:
    cpu: "1"
    memory: 1Gi
  requests:
    cpu: "1"
    memory: 1Gi
Executor

yaml:

resources:
  cpu:
    min: 250m
    max: 1000m
  memory:
    limit: 1024Mi

pod:

resources:
  limits:
    cpu: "1"
    memory: 1Gi
  requests:
    cpu: "1"
    memory: 1Gi
Job

yaml:

resources:
  cpu:
    min: 250m
    max: 500m
  memory:
    limit: 512Mi

plus the yamls for driver/executor...

pod:

- args:
  - /stackable/spark/bin/spark-submit 
  ...
    --conf "spark.driver.cores=1" 
    --conf "spark.driver.memory=640m" 
    --conf "spark.executor.cores=1" 
    --conf "spark.executor.memory=640m" 
    --conf "spark.kubernetes.driver.limit.cores=1" 
    --conf "spark.kubernetes.driver.limit.memory=1024m"
    --conf "spark.kubernetes.driver.request.cores=1" 
    --conf "spark.kubernetes.driver.request.memory=1024m"
    --conf "spark.kubernetes.executor.limit.cores=1" 
    --conf "spark.kubernetes.executor.limit.memory=1024m"
    --conf "spark.kubernetes.executor.request.cores=1" 
    --conf "spark.kubernetes.executor.request.memory=1024m"
    --conf "spark.kubernetes.memoryOverheadFactor=0.0"
resources:
  limits:
    cpu: 400m
    memory: 512Mi
  requests:
    cpu: 100m
    memory: 512Mi
@sbernauer sbernauer moved this from Next to Refinement: In Progress in Stackable Engineering Oct 16, 2023
@adwk67 adwk67 moved this from Refinement: In Progress to Development: In Progress in Stackable Engineering Oct 17, 2023
@adwk67 adwk67 changed the title Improve resource usage documentation Docs: improve resource usage documentation Oct 17, 2023
@adwk67 adwk67 moved this from Development: In Progress to Development: Waiting for Review in Stackable Engineering Oct 17, 2023
@sbernauer sbernauer moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Oct 19, 2023
@adwk67 adwk67 moved this from Development: In Review to Development: Done in Stackable Engineering Oct 19, 2023
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants