Skip to content

To disable wait_for_services_timeout use -1 not 0

Harsh Chouraria requested to merge hchouraria-docs-runner-docker-wait-for-services-timeout into main

What does this MR do?

The documentation for wait_for_services_timeout states that setting it to 0 will disable the waiting.

However, based on the current implementation at https://gitlab.com/gitlab-org/gitlab-runner/blob/01e50620fb2e404d076eae19afde77dd192356f2/executors/docker/docker.go#L465-471 that does not appear to be the case anymore.

This behavior was changed, perhaps accidentally, during this refactor commit from 6 years ago: b46be266

In the current implementation setting it to 0 will cause it to silently fall back to the default of 30 seconds.

This change updates the document to suggest a negative number as the method to disable it, which fits with the current config check logic.

Related issues

Customer tickets (internal links):

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Harsh Chouraria

Merge request reports