Skip to content

Add docker plugin config option image_pull_timeout value for default timeout#25489

Merged
allisonlarson merged 3 commits intomainfrom
f-add-docker-plugin-image_pull_timeout
Mar 24, 2025
Merged

Add docker plugin config option image_pull_timeout value for default timeout#25489
allisonlarson merged 3 commits intomainfrom
f-add-docker-plugin-image_pull_timeout

Conversation

@allisonlarson
Copy link
Copy Markdown
Contributor

Description

Adds a docker plugin config option for setting a default image_pull_timeout for all tasks. This can be overridden by the task config option, if a different timeout is desired. The default timeout remains at 5m.

Also adds the value to the docs.

Testing & Reproduction steps

Links

Fixes #25057

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.

@allisonlarson allisonlarson force-pushed the f-add-docker-plugin-image_pull_timeout branch from 8d379ac to 6a440a0 Compare March 21, 2025 22:32
@aimeeu aimeeu added theme/docs Documentation issues and enhancements backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.9.x labels Mar 24, 2025
Copy link
Copy Markdown
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 for updating the docs! I left a nit style guide suggestion. Nomad content has a lot of future tense, but I'm slowly changing that to present tense. I put the most important style guidance into our team-nomad docs.md file so you don't have to wade through the existing Education and Eng style guides.

Comment thread website/content/docs/drivers/docker.mdx Outdated
tgross
tgross previously approved these changes Mar 24, 2025
Copy link
Copy Markdown
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

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

LGTM!

Because this is a user-facing change we want a changelog entry. There's a makefile target make cl which runs a little "wizard" in the shell to generate a changelog snippet; all the snippets for a given version get combined with automation during the release process.

@allisonlarson allisonlarson force-pushed the f-add-docker-plugin-image_pull_timeout branch from 6a440a0 to 8c2bce8 Compare March 24, 2025 18:20
@tgross tgross removed the backport/website This will backport PR changes to `stable-website` && the latest release-branch label Mar 24, 2025
Copy link
Copy Markdown
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

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

LGTM!

I've removed the backport/website label because we don't want docs changes for unreleased new features to ship immediately. Edit: and the backport/1.9.x label as the next scheduled release is the 1.10 GA so this, as a new feature, will ship in 1.10 but not 1.9.x

@allisonlarson allisonlarson merged commit d1d8945 into main Mar 24, 2025
39 checks passed
@allisonlarson allisonlarson deleted the f-add-docker-plugin-image_pull_timeout branch March 24, 2025 20:03
@github-actions
Copy link
Copy Markdown

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jul 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

theme/docs Documentation issues and enhancements theme/driver/docker type/enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker task driver plugin options: support image_pull_timeout flag

3 participants