Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions web/apps/docs/content/docs/reference/nativelink-config/index.mdx
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.4 (af3613e3)
Source: nativelink-config @ v1.6.5 (0943380b)
Regenerate from web/: bun --filter @nativelink/docs gen:config-reference */}

<ConfigVersionSwitcher />

This is the canonical NativeLink configuration reference for **v1.6.4**.
This is the canonical NativeLink configuration reference for **v1.6.5**.
It is autogenerated from the Rust config crate
([`nativelink-config/src`](https://github.com/TraceMachina/nativelink/tree/v1.6.4/nativelink-config/src)) via the `build-schema` binary, so
([`nativelink-config/src`](https://github.com/TraceMachina/nativelink/tree/v1.6.5/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 @@ -878,6 +878,7 @@ See [`experimental_cloud_object_store`](#experimental_cloud_object_store-1) for
| `health_check_timeout_ms` | integer (uint64) | — | 4000 (4 seconds) | Per-call ceiling for the `check_health` PING in milliseconds. |
| `read_chunk_size` | integer (uint) | — | 64KiB | The amount of data to read from the Redis server at a time. This is used to limit the amount of memory used when reading large objects from the Redis server as well as limiting the amount of time a single read operation can take. |
| `connection_pool_size` | integer (uint) | — | 3 | The number of connections to keep open to the Redis servers. |
| `key_ttl_s` | integer (uint64) | — | 0 (keys never expire) | Expire keys written by this store after this many seconds. |
| `max_chunk_uploads_per_update` | integer (uint) | — | 10 | The maximum number of upload chunks to allow per update. This is used to limit the amount of memory used when uploading large objects to the Redis server. A good rule of thumb is to think of the data as: `AVAIL_MEMORY / (read_chunk_size * max_chunk_uploads_per_update) = THORETICAL_MAX_CONCURRENT_UPLOADS` (note: it's a good idea to divide `AVAIL_MAX_MEMORY` by ~10 to account for other memory usage) |
| `scan_count` | integer (uint) | — | 10000 | The COUNT value passed when scanning keys in Redis. This is used to hint the amount of work that should be done per response. |
| `retry` | [Retry](#retry) | — | — | Retry configuration to use when a network request fails. |
Expand Down Expand Up @@ -929,6 +930,7 @@ Configuration for `ExperimentalMongoDB` store.
| `platform_properties` | map of string to [WorkerProperty](#workerproperty) | Yes | — | Properties of this worker. This configuration will be sent to the scheduler and used to tell the scheduler to restrict what should be executed on this worker. |
| `additional_environment` | map of string to [EnvironmentSource](#environmentsource) | — | — | An optional mapping of environment names to set for the execution as well as those specified in the action itself. If set, will set each key as an environment variable before executing the job with the value of the environment variable being the value of the property of the action being executed of that name or the fixed value. |
| `directory_cache` | [DirectoryCacheConfig](#directorycacheconfig) | — | — | Optional directory cache configuration for improving performance by caching reconstructed input directories and using hardlinks instead of rebuilding them from CAS for every action. |
| `experimental_active_input_leases` | boolean | — | false (eviction behavior is unchanged) | Optional and experimental: lease every digest in an active action's input Merkle closure in the worker's locally eviction-managed CAS tiers (the `cas_fast_slow_store`'s filesystem-backed stores) until the action has finished cleanup. This prevents `Lost inputs no longer available remotely` failures caused by local fast-tier eviction while inputs are being materialized under cache pressure. |
| `use_namespaces` | boolean | — | False | Whether to use namespaces to isolate the execution. This is only available on Linux. It is highly recommended as it avoids a number of issues with zombie processes and also provides additional hermeticity. If explicitly set to true and it is not supported the worker will exit with an error. |
| `use_mount_namespace` | boolean | — | False | Whether to use a mount namespace to isolate the worker root. This is only available on Linux and when `use_namespaces` is true. It is highly recommended provides additional hermeticity. If explicitly set to true and it is not supported or `use_namespaces` is not set to true the worker will exit with an error. |

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

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

- [`stores.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.4/nativelink-config/src/stores.rs)
- [`cas_server.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.4/nativelink-config/src/cas_server.rs)
- [`schedulers.rs`](https://github.com/TraceMachina/nativelink/tree/v1.6.4/nativelink-config/src/schedulers.rs)
- [`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)
Loading
Loading