Skip to content

docs(config-reference): regenerate for NativeLink v1.6.6 #2709

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.

Sign up for GitHub

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+1,568 −9
Open

docs(config-reference): regenerate for NativeLink v1.6.6 #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions web/apps/docs/content/docs/reference/nativelink-config/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ full: true
---

{/* AUTOGENERATED — do not edit by hand.
Source: nativelink-config @ v1.6.5 (0943380b)
Source: nativelink-config @ v1.6.6 (a21edb0f)
Regenerate from web/: bun --filter @nativelink/docs gen:config-reference */}

<ConfigVersionSwitcher />

This is the canonical NativeLink configuration reference for **v1.6.5**.
This is the canonical NativeLink configuration reference for **v1.6.6**.
It is autogenerated from the Rust config crate
([`nativelink-config/src`](https://github.com/TraceMachina/nativelink/tree/v1.6.5/nativelink-config/src)) via the `build-schema` binary, so
([`nativelink-config/src`](https://github.com/TraceMachina/nativelink/tree/v1.6.6/nativelink-config/src)) via the `build-schema` binary, so
it can never drift from what the binary actually deserializes.

## Top-level fields
Expand Down Expand Up @@ -943,6 +943,7 @@ Configuration for `ExperimentalMongoDB` store.
| `client_action_timeout_s` | integer (uint64) | — | 60 seconds | Mark operations as completed with error if no client has updated them within this duration. |
| `worker_timeout_s` | integer (uint64) | — | 5 seconds | Remove workers from pool once the worker has not responded in this amount of time in seconds. |
| `max_action_executing_timeout_s` | integer (uint64) | — | 0 (disabled) | Maximum time (seconds) an action can stay in Executing state without any worker update before being timed out and re-queued. This applies regardless of worker keepalive status, catching cases where a worker is alive (sending keepalives) but stuck on a specific action. Set to 0 to disable (relies only on `worker_timeout_s`). |
| `unacknowledged_kill_timeout_s` | integer (uint64) | — | 60 seconds | Evict a worker that has not reported back on an operation it was told to kill within this many seconds. A healthy worker acknowledges a kill in moments; one that cannot is wedged, and its keepalives would otherwise keep `worker_timeout_s` from ever firing while the dead operation holds its slot. Eviction requeues the worker's other operations. |
| `max_job_retries` | integer (uint) | — | 3 | If a job returns an internal error or times out this many times when attempting to run on a worker the scheduler will return the last error to the client. Jobs will be retried and this configuration is to help prevent one rogue job from infinitely retrying and taking up a lot of resources when the task itself is the one causing the server to go into a bad state. |
| `allocation_strategy` | [WorkerAllocationStrategy](#workerallocationstrategy) | — | `"least_recently_used"` | The strategy used to assign workers jobs. |
| `experimental_backend` | [ExperimentalSimpleSchedulerBackend](#experimentalsimpleschedulerbackend) | — | memory | The storage backend to use for the scheduler. |
Expand Down Expand Up @@ -1379,6 +1380,8 @@ If a property is found, then replace it with another one.
| Field | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `scheduler` | string | Yes | — | The scheduler name referenced in the `schedulers` map in the main config. |
| `disable_kill_revoked_operations` | boolean | — | false (the sweep runs) | Disable the periodic sweep that tells workers to kill operations the scheduler no longer has executing on them (for example because every client disconnected before the action finished). With the sweep disabled such orphaned actions run to completion and still warm the action cache, which can be preferable for deployments with long or expensive actions whose clients merely retry. |
| `kill_revoked_operations_interval_s` | integer (uint64) | — | 5 (0 uses the default) | How often, in seconds, the scheduler checks for operations that are still running on a worker but are no longer executing according to the state manager, and tells the worker to kill them. Each pass costs one state-manager lookup per running operation, so store-backed deployments with many concurrent actions may want a longer interval. |

## BepConfig

Expand Down Expand Up @@ -1543,6 +1546,6 @@ specified.

If anything here disagrees with the binary, the source wins:

- [`stores.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.5/nativelink-config/src/stores.rs)
- [`cas_server.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.5/nativelink-config/src/cas_server.rs)
- [`schedulers.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.5/nativelink-config/src/schedulers.rs)
- [`stores.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.6/nativelink-config/src/stores.rs)
- [`cas_server.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.6/nativelink-config/src/cas_server.rs)
- [`schedulers.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.6/nativelink-config/src/schedulers.rs)
Loading