Skip to content

Commit 23af193

Browse files
authored
adding docs for task agent caching (#9436)
* adding docs for task agent caching * missing CIRCLECI_RUNNER_ prefix
1 parent cee64fb commit 23af193

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

jekyll/_cci2/machine-runner-3-configuration-reference.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,20 @@ runner:
257257
mode: single-task
258258
```
259259

260+
[#cache-task-agent]
261+
=== `runner.cache_task_agent`
262+
263+
`$CIRCLECI_RUNNER_CACHE_TASK_AGENT`
264+
265+
When set to true, machine runner will not clear the task-agent cache when the agent shuts down. On startup the machine agent will check for an already downloaded task agent and will use that task-agent unless there is a newer version of task-agent available for download. This feature is off by default. This may be particularly useful for Windows which relies on `single-task` mode.
266+
267+
Example:
268+
269+
```yaml
270+
runner:
271+
cache_task_agent: true
272+
```
273+
260274
[#runner-max-run-time]
261275
=== `runner.max_run_time`
262276

0 commit comments

Comments
 (0)