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

Conflicting documentation about disconnect block #24702

Closed
markasoftware-aqtc opened this issue Dec 17, 2024 · 3 comments
Closed

Conflicting documentation about disconnect block #24702

markasoftware-aqtc opened this issue Dec 17, 2024 · 3 comments
Assignees
Labels
hcc/jira stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/docs Documentation issues and enhancements theme/edge type/bug

Comments

@markasoftware-aqtc
Copy link

The example here: https://developer.hashicorp.com/nomad/docs/job-specification/disconnect shows the lost_after and stop_after parameters of the disconnect block being used together. However, the documentation for the lost_after parameter then says "This setting cannot be used with stop_after.". However, the documentation for stop_after says "Setting stop_after shorter than lost_after and replace = false at the same time is not permitted and will cause a validation error, because this would lead to a state where no allocations can be scheduled." which once again implies that stop_after and lost_after can be used together.

The documentation should be clarified as to whether stop_after and lost_after can be used together.

@tgross
Copy link
Member

tgross commented Dec 17, 2024

Hi @markasoftware-aqtc! I just checked the code. The docs are wrong in a couple ways for sure:

  • Using stop_after and lost_after together is definitely invalid. It will return the error "Disconnect cannot be configured with both lost_after and stop_after"
  • The stop_after field is actually named stop_on_client_after!

I suspect the design changed slightly along the way and we missed updating the docs to match. I'll mark this to get fixed.

@tgross tgross added the theme/docs Documentation issues and enhancements label Dec 17, 2024
@tgross tgross moved this from Needs Triage to Needs Roadmapping in Nomad - Community Issues Triage Dec 17, 2024
@tgross tgross added hcc/jira theme/edge stage/accepted Confirmed, and intend to work on. No timeline committment though. labels Dec 17, 2024
@aimeeu aimeeu self-assigned this Dec 18, 2024
@aimeeu
Copy link
Contributor

aimeeu commented Dec 18, 2024

@tgross I created an internal ticket for this and will address it this week.

@aimeeu
Copy link
Contributor

aimeeu commented Dec 19, 2024

fix has been published

@aimeeu aimeeu closed this as completed Dec 19, 2024
@github-project-automation github-project-automation bot moved this from Needs Roadmapping to Done in Nomad - Community Issues Triage Dec 19, 2024
aimeeu added a commit that referenced this issue Dec 19, 2024
* change stop_after to stop_on_client_after

CE-800  GH #24702

* Move disconnect entry to correct alphabetical place in nav
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hcc/jira stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/docs Documentation issues and enhancements theme/edge type/bug
Projects
Development

No branches or pull requests

3 participants