Repository navigation
feat: update dcos about runners - #171
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented configuration does not match the inspected product implementation, and the timeout guidance overstates its guarantees.
2 open findings
What changed in this PR
Updates Semaphore UI’s runner documentation across English and ten translations.
Changes:
- Changes the documented polling default to 5 seconds.
- Adds connection-timeout configuration and troubleshooting guidance.
- Separates job polling from progress reporting and heartbeats.
| File | Description |
|---|---|
| i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Chinese configuration reference updates. |
| i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Chinese polling and timeout guidance. |
| i18n/sr/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Serbian configuration reference updates. |
| i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Serbian polling and timeout guidance. |
| i18n/ru/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Russian configuration reference updates. |
| i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Russian polling and timeout guidance. |
| i18n/pt/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Portuguese configuration reference updates. |
| i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Portuguese polling and timeout guidance. |
| i18n/ko/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Korean configuration reference updates. |
| i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Korean polling and timeout guidance. |
| i18n/ja/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Japanese configuration reference updates. |
| i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Japanese polling and timeout guidance. |
| i18n/it/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Italian configuration reference updates. |
| i18n/it/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Italian polling and timeout guidance. |
| i18n/fr/docusaurus-plugin-content-docs/current/reference/cli/runners.md | French configuration reference updates. |
| i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/runners.md | French polling and timeout guidance. |
| i18n/es/docusaurus-plugin-content-docs/current/reference/cli/runners.md | Spanish configuration reference updates. |
| i18n/es/docusaurus-plugin-content-docs/current/admin-guide/runners.md | Spanish polling and timeout guidance. |
| i18n/de/docusaurus-plugin-content-docs/current/reference/cli/runners.md | German configuration reference updates. |
| i18n/de/docusaurus-plugin-content-docs/current/admin-guide/runners.md | German polling and timeout guidance. |
| docs/reference/configuration.md | Updates generated runner configuration entries. |
| docs/reference/cli/runners.md | Updates polling default and adds timeout option. |
| docs/admin-guide/runners.md | Explains polling, heartbeats, and timeout configuration. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | `runner.check_interval_seconds`<br />`SEMAPHORE_RUNNER_CHECK_INTERVAL_SECONDS` | integer<br />Default: `5` | How often the runner polls the server for new jobs. Plain int, not time.Duration, for env-binding simplicity. | | ||
| | `runner.connection.server_ca_cert_file`<br />`SEMAPHORE_RUNNER_SERVER_CA_CERT_FILE` | string | PEM bundle used to verify the Semaphore server's certificate, in addition to the system trust store. Set this when the server uses a self-signed or internal-CA cert. | | ||
| | `runner.connection.skip_tls_verify`<br />`SEMAPHORE_RUNNER_SKIP_TLS_VERIFY` | boolean | Disables server certificate verification entirely. This is insecure (vulnerable to MITM) — use only for testing. | | ||
| | `runner.connection.timeout_seconds`<br />`SEMAPHORE_RUNNER_CONNECTION_TIMEOUT_SECONDS` | integer<br />Default: `3` | Bounds how long a runner→server request may wait for the server to answer: the TCP connect, the TLS handshake and the wait for the response headers each get this budget. Without it a server that accepts the connection but never replies freezes the runner's poll loop — and with it the heartbeat — until the OS gives up. Uploading the request body is deliberately not bounded, so a large log batch on a slow link is not cut off. Plain int, not time.Duration, for env-binding simplicity. | |
Comment on lines
+201
to
+202
| The default is 3 seconds. Keep it below `check_interval_seconds` so a stuck | ||
| request cannot outlive the poll cycle that started it. Raise it when the runner |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.