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: improve cross-links for scheduler preemption #25203

Merged
merged 1 commit into from
Feb 25, 2025
Merged

Conversation

tgross
Copy link
Member

@tgross tgross commented Feb 24, 2025

Fix a broken link from the preemption concepts docs to the relevant API. Also include a link to the relevant command.

Ref: #25038
Preview link: https://nomad-m6t6tq8jc-hashicorp.vercel.app/nomad/docs/concepts/scheduling/preemption#details

Fix a broken link from the preemption concepts docs to the relevant API. Also
include a link to the relevant command.

Ref: #25038
@tgross tgross added theme/docs Documentation issues and enhancements theme/scheduling theme/website nomadproject.io infrastructure issues and enhancements backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.9.x backport to 1.9.x release line backport/1.7.x backport to 1.7.x release line backport/ent/1.7.x+ent Changes are backported to 1.7.x+ent backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/1.8.x backport to 1.8.x release line and removed theme/website nomadproject.io infrastructure issues and enhancements labels Feb 24, 2025
@tgross tgross marked this pull request as ready for review February 24, 2025 21:40
@tgross tgross requested review from a team as code owners February 24, 2025 21:40
@tgross tgross requested a review from aimeeu February 24, 2025 21:40
Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

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

Thanks Tim!

@EugenKon
Copy link

EugenKon commented Feb 25, 2025

Hi. I am not so experienced, thus I'll highlight parts that are not so clear for me:

Preemption is enabled by default for system jobs. Operators can use the scheduler config API endpoint to disable preemption.

The link above has nothing about scheduler. We need to click two pages deeper to find interested information. It would be better to put direct link to the information for scheduler config: https://developer.hashicorp.com/nomad/docs/commands/operator/scheduler/set-config

https://developer.hashicorp.com/nomad/docs/commands/operator/scheduler/set-config#preempt-system-scheduler

Please note, that this part does not say that this scheduler is enabled by default. But this part https://developer.hashicorp.com/nomad/docs/concepts/scheduling/preemption#details mentions that: Preemption is enabled by default for system jobs. (I am not sure about that it is enabled by default. If that was true, then I had not met situation when Nomad client is without system jobs: #25061)

As you commented here It looks like system jobs do not have enabled by default preemption.

https://developer.hashicorp.com/nomad/docs/concepts/scheduling/preemption#details

It would be worth to extend this example to show that if preemption for service jobs was not enabled it will not preempt other jobs.

Thanks.

@tgross
Copy link
Member Author

tgross commented Feb 25, 2025

The link above has nothing about scheduler. We need to click two pages deeper to find interested information. It would be better to put direct link to the information for scheduler config: https://developer.hashicorp.com/nomad/docs/commands/operator/scheduler/set-config

Please note, that this part does not say that this scheduler is enabled by default. But this part https://developer.hashicorp.com/nomad/docs/concepts/scheduling/preemption#details mentions that: Preemption is enabled by default for system jobs.

That's literally what this PR does, mate. Look at the diff or the preview:

Screenshot at 2025-02-25 08-51-55

@EugenKon
Copy link

@tgross I checked the diff, but that format was not so clear. preview link helped. Thanks.

But this still does not documents that this option is enabled by default: https://developer.hashicorp.com/nomad/docs/commands/operator/scheduler/set-config#preempt-system-scheduler

  1. Example also was not updated.

tgross added a commit that referenced this pull request Feb 25, 2025
Fix a broken link from the preemption concepts docs to the relevant API. Also include a link to the relevant command.

Ref: #25038
tgross added a commit that referenced this pull request Feb 25, 2025
… (#25207)

Fix a broken link from the preemption concepts docs to the relevant API. Also include a link to the relevant command.

Ref: #25038

Co-authored-by: Tim Gross <[email protected]>
@EugenKon
Copy link

@tgross Broken link about schedulers: https://developer.hashicorp.com/nomad/docs/configuration/server#default_scheduler_config

image

Also it would be nice to have a full list of possible values that could be configured here: https://developer.hashicorp.com/nomad/docs/configuration/server#enabled_schedulers

@tgross
Copy link
Member Author

tgross commented Feb 25, 2025

@EugenKon PRs welcome

@EugenKon
Copy link

So all is actually is not default value:

https://developer.hashicorp.com/nomad/docs/configuration/server#enabled_schedulers
image

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.7.x+ent Changes are backported to 1.7.x+ent backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.7.x backport to 1.7.x release line backport/1.8.x backport to 1.8.x release line backport/1.9.x backport to 1.9.x release line theme/docs Documentation issues and enhancements theme/scheduling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants