# desired.json (/docs/reference/desired)



The file the host watches at `paths.desired_state_file` and applies on every change. It declares
which apps run on the host, on which volumes, and how they are reached.
[Deploy an app](/docs/getting-started/deploy-an-app) is the guide; this page lists every field.
A file the host cannot parse is rejected as a whole, and `reported.json` says why.

An editor validates and autocompletes the file when it names the schema:

```json
{
  "$schema": "https://raw.githubusercontent.com/ilbertt/nibrunner/main/crates/protocol/schema/desired.schema.json",
  "hostId": "host-1"
}
```

Schema: [desired.schema.json](https://raw.githubusercontent.com/ilbertt/nibrunner/main/crates/protocol/schema/desired.schema.json)

## HostDesiredState [#hostdesiredstate]

What one host should be running. The daemon watches this document at the path its `paths.desired_state_file` names and converges on every change to it.

| Name                                                                                  | Type                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span id="hostdesiredstate-hostId" className="scroll-mt-28">`hostId`</span>           | [HostId](#hostid)                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
| <span id="hostdesiredstate-revision" className="scroll-mt-28">`revision`</span>       | [Revision](#revision)                            | What whoever wrote this document calls this version of it, carried back in the report as `acceptedRevision`. Nothing on the host reads it: it is not ordered and not checked against the one before it, so a document may name any version it likes. Required, so that a control plane can always ask which of its own versions a host is on — and so a host answering with one nobody wrote is impossible. |
| <span id="hostdesiredstate-volumes" className="scroll-mt-28">`volumes`</span>         | array of [DesiredVolume](#desiredvolume)         |                                                                                                                                                                                                                                                                                                                                                                                                             |
| <span id="hostdesiredstate-instances" className="scroll-mt-28">`instances`</span>     | array of [DesiredInstance](#desiredinstance)     |                                                                                                                                                                                                                                                                                                                                                                                                             |
| <span id="hostdesiredstate-checkpoints" className="scroll-mt-28">`checkpoints`</span> | array of [DesiredCheckpoint](#desiredcheckpoint) |                                                                                                                                                                                                                                                                                                                                                                                                             |
| <span id="hostdesiredstate-exports" className="scroll-mt-28">`exports`</span>         | array of [DesiredExport](#desiredexport)         |                                                                                                                                                                                                                                                                                                                                                                                                             |

## HostId [#hostid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## Revision [#revision]

between 1 and 128 printable characters, without spaces

string, matching `^[\x21-\x7e]{1,128}$`

## DesiredVolume [#desiredvolume]

| Name                                                                                                  | Type                                        | Description                            |
| ----------------------------------------------------------------------------------------------------- | ------------------------------------------- | -------------------------------------- |
| <span id="desiredvolume-volumeId" className="scroll-mt-28">`volumeId`</span>                          | [VolumeId](#volumeid)                       |                                        |
| <span id="desiredvolume-appId" className="scroll-mt-28">`appId`</span>                                | [AppId](#appid)                             |                                        |
| <span id="desiredvolume-sizeBytes" className="scroll-mt-28">`sizeBytes`</span>                        | integer, at least 0                         |                                        |
| <span id="desiredvolume-desiredState" className="scroll-mt-28">`desiredState`</span>                  | [DesiredPresence](#desiredpresence)         |                                        |
| <span id="desiredvolume-initialContents" className="scroll-mt-28">`initialContents`</span> *optional* | [InitialContents](#initialcontents) \| null | Absent for a volume that starts empty. |

## DesiredInstance [#desiredinstance]

| Name                                                                                                | Type                                                 | Description                                                                                                                                                                        |
| --------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span id="desiredinstance-appId" className="scroll-mt-28">`appId`</span>                            | [AppId](#appid)                                      |                                                                                                                                                                                    |
| <span id="desiredinstance-deploymentId" className="scroll-mt-28">`deploymentId`</span>              | [DeploymentId](#deploymentid)                        | A running instance is replaced when this changes, and only then: a new layer or config under the same `deploymentId` is not picked up.                                             |
| <span id="desiredinstance-volumeId" className="scroll-mt-28">`volumeId`</span>                      | [VolumeId](#volumeid)                                | One of this document's `volumes`, mounted in the guest as the app's data directory.                                                                                                |
| <span id="desiredinstance-desiredState" className="scroll-mt-28">`desiredState`</span>              | [DesiredInstanceState](#desiredinstancestate)        |                                                                                                                                                                                    |
| <span id="desiredinstance-layers" className="scroll-mt-28">`layers`</span>                          | array of [DesiredLayer](#desiredlayer), 1 to 8 items | The root filesystem, bottom layer first. At least one; at most `MAX_LAYERS`.                                                                                                       |
| <span id="desiredinstance-config" className="scroll-mt-28">`config`</span>                          | [AppConfig](#appconfig)                              |                                                                                                                                                                                    |
| <span id="desiredinstance-hostnames" className="scroll-mt-28">`hostnames`</span>                    | array of [AppHostname](#apphostname)                 | What the HTTP proxy routes to this app's `httpPort`. Empty for an app nothing outside needs to reach by name.                                                                      |
| <span id="desiredinstance-access" className="scroll-mt-28">`access`</span>                          | [AccessPolicy](#accesspolicy)                        | The access policy for every HTTP hostname.                                                                                                                                         |
| <span id="desiredinstance-activation" className="scroll-mt-28">`activation`</span> *optional*       | [ActivationPolicy](#activationpolicy) \| null        | What puts this instance to sleep and what tells the host it is ready. A `sleepWhen` other than `never` is refused on anything but an `on-request` instance.                        |
| <span id="desiredinstance-idleTimeoutMs" className="scroll-mt-28">`idleTimeoutMs`</span> *optional* | [IdleTimeoutMs](#idletimeoutms) \| null              | How long an `on-request` instance stays up after its last request before it sleeps: the older spelling of `activation.sleepWhen`, refused beside it. 300000 when neither is named. |

## DesiredCheckpoint [#desiredcheckpoint]

| Name                                                                                     | Type                                | Description |
| ---------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
| <span id="desiredcheckpoint-checkpointId" className="scroll-mt-28">`checkpointId`</span> | [CheckpointId](#checkpointid)       |             |
| <span id="desiredcheckpoint-volumeId" className="scroll-mt-28">`volumeId`</span>         | [VolumeId](#volumeid)               |             |
| <span id="desiredcheckpoint-desiredState" className="scroll-mt-28">`desiredState`</span> | [DesiredPresence](#desiredpresence) |             |

## DesiredExport [#desiredexport]

| Name                                                                                          | Type                                            | Description |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
| <span id="desiredexport-exportId" className="scroll-mt-28">`exportId`</span>                  | [ExportId](#exportid)                           |             |
| <span id="desiredexport-appId" className="scroll-mt-28">`appId`</span>                        | [AppId](#appid)                                 |             |
| <span id="desiredexport-volumeId" className="scroll-mt-28">`volumeId`</span>                  | [VolumeId](#volumeid)                           |             |
| <span id="desiredexport-objectKey" className="scroll-mt-28">`objectKey`</span>                | [ObjectKey](#objectkey)                         |             |
| <span id="desiredexport-format" className="scroll-mt-28">`format`</span>                      | [ExportFormat](#exportformat)                   |             |
| <span id="desiredexport-desiredState" className="scroll-mt-28">`desiredState`</span>          | [DesiredPresence](#desiredpresence)             |             |
| <span id="desiredexport-environment" className="scroll-mt-28">`environment`</span> *optional* | [TenantEnvironment](#tenantenvironment) \| null |             |

## VolumeId [#volumeid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## AppId [#appid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## DesiredPresence [#desiredpresence]

One of `"present"`, `"absent"`.

## InitialContents [#initialcontents]

What a volume holds before its app has written a byte: an archive in the store — a tar, gzipped or not, or a zip — unpacked under `destinationPath` in the app's root as the volume is formatted. That happens once, so this is read once: a volume already formatted is its app's, and a change here does nothing to it.

| Name                                                                                         | Type                          | Description                                                                                                                                                                   |
| -------------------------------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span id="initialcontents-digest" className="scroll-mt-28">`digest`</span>                   | [Sha256Digest](#sha256digest) |                                                                                                                                                                               |
| <span id="initialcontents-objectKey" className="scroll-mt-28">`objectKey`</span>             | [ObjectKey](#objectkey)       | Where the object lives in the store.                                                                                                                                          |
| <span id="initialcontents-destinationPath" className="scroll-mt-28">`destinationPath`</span> | [GuestPath](#guestpath)       | The directory the archive's entries land under, as the app sees it. Made if no layer holds it, and given — with everything unpacked into it — to the uid the program runs as. |

## DeploymentId [#deploymentid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## DesiredInstanceState [#desiredinstancestate]

The whole of an instance's activation policy.

| Value          | Description                                                                                                                                                |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `"running"`    | Keeps the microVM up.                                                                                                                                      |
| `"on-request"` | Brings the microVM up for the first deploy and for every request that finds it asleep, and lets it sleep again once it has been quiet for `idleTimeoutMs`. |
| `"stopped"`    | Takes the microVM down and leaves the app reachable enough to say so.                                                                                      |

## DesiredLayer [#desiredlayer]

One read-only layer of the root filesystem an instance boots into. Layers stack in the order the document lists them, first at the bottom, and the app's volume is stacked writable over all of them. The kind says what the object is, and so what the host does with it.

One of the following, told apart by `kind`:

### oci [#oci]

An OCI image for Linux x86\_64, from an artifact-store archive or public registry. Its image configuration does not replace the instance's explicit command or guest account.

| Name                                                       | Type    | Description |
| ---------------------------------------------------------- | ------- | ----------- |
| <span id="oci-kind" className="scroll-mt-28">`kind`</span> | `"oci"` |             |

### filesystem [#filesystem]

A squashfs or ext4 image, attached as it was uploaded.

| Name                                                                        | Type                          | Description                          |
| --------------------------------------------------------------------------- | ----------------------------- | ------------------------------------ |
| <span id="filesystem-kind" className="scroll-mt-28">`kind`</span>           | `"filesystem"`                |                                      |
| <span id="filesystem-digest" className="scroll-mt-28">`digest`</span>       | [Sha256Digest](#sha256digest) |                                      |
| <span id="filesystem-objectKey" className="scroll-mt-28">`objectKey`</span> | [ObjectKey](#objectkey)       | Where the object lives in the store. |

### executable [#executable]

One program, packed into an image at `destinationPath` and run the way this host has always run one: by the guest's own init, with the app's arguments and environment.

| Name                                                                                    | Type                              | Description                          |
| --------------------------------------------------------------------------------------- | --------------------------------- | ------------------------------------ |
| <span id="executable-kind" className="scroll-mt-28">`kind`</span>                       | `"executable"`                    |                                      |
| <span id="executable-digest" className="scroll-mt-28">`digest`</span>                   | [Sha256Digest](#sha256digest)     |                                      |
| <span id="executable-objectKey" className="scroll-mt-28">`objectKey`</span>             | [ObjectKey](#objectkey)           | Where the object lives in the store. |
| <span id="executable-destinationPath" className="scroll-mt-28">`destinationPath`</span> | [ExecutablePath](#executablepath) |                                      |

## AppConfig [#appconfig]

| Name                                                                               | Type                                    | Description                                                                                       |
| ---------------------------------------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------- |
| <span id="appconfig-httpPort" className="scroll-mt-28">`httpPort`</span>           | [HttpPort](#httpport)                   | The guest port the HTTP proxy sends this app's hostnames to, and the one the health check probes. |
| <span id="appconfig-command" className="scroll-mt-28">`command`</span>             | [Command](#command)                     |                                                                                                   |
| <span id="appconfig-resources" className="scroll-mt-28">`resources`</span>         | [InstanceResources](#instanceresources) |                                                                                                   |
| <span id="appconfig-healthCheck" className="scroll-mt-28">`healthCheck`</span>     | [HealthCheck](#healthcheck)             |                                                                                                   |
| <span id="appconfig-restartPolicy" className="scroll-mt-28">`restartPolicy`</span> | [RestartPolicy](#restartpolicy)         |                                                                                                   |
| <span id="appconfig-ports" className="scroll-mt-28">`ports`</span> *optional*      | array of [InstancePort](#instanceport)  | What this app answers on besides `httpPort`, if anything.                                         |

## AppHostname [#apphostname]

| Name                                                                       | Type                                | Description |
| -------------------------------------------------------------------------- | ----------------------------------- | ----------- |
| <span id="apphostname-hostname" className="scroll-mt-28">`hostname`</span> | [Hostname](#hostname)               |             |
| <span id="apphostname-kind" className="scroll-mt-28">`kind`</span>         | [AppHostnameKind](#apphostnamekind) |             |

## AccessPolicy [#accesspolicy]

One of the following, told apart by `kind`:

### public [#public]

| Name                                                          | Type       | Description |
| ------------------------------------------------------------- | ---------- | ----------- |
| <span id="public-kind" className="scroll-mt-28">`kind`</span> | `"public"` |             |

### jwt [#jwt]

| Name                                                                   | Type                              | Description                                         |
| ---------------------------------------------------------------------- | --------------------------------- | --------------------------------------------------- |
| <span id="jwt-kind" className="scroll-mt-28">`kind`</span>             | `"jwt"`                           |                                                     |
| <span id="jwt-token" className="scroll-mt-28">`token`</span>           | [JwtTokenSource](#jwttokensource) |                                                     |
| <span id="jwt-issuer" className="scroll-mt-28">`issuer`</span>         | string                            |                                                     |
| <span id="jwt-audiences" className="scroll-mt-28">`audiences`</span>   | array of string                   |                                                     |
| <span id="jwt-algorithm" className="scroll-mt-28">`algorithm`</span>   | [JwtAlgorithm](#jwtalgorithm)     |                                                     |
| <span id="jwt-publicKeys" className="scroll-mt-28">`publicKeys`</span> | [JwtPublicKeys](#jwtpublickeys)   | Supplied PEM public keys or an HTTPS JWKS endpoint. |

## ActivationPolicy [#activationpolicy]

| Name                                                                              | Type                        | Description |
| --------------------------------------------------------------------------------- | --------------------------- | ----------- |
| <span id="activationpolicy-sleepWhen" className="scroll-mt-28">`sleepWhen`</span> | [SleepPolicy](#sleeppolicy) |             |

## IdleTimeoutMs [#idletimeoutms]

integer, 60000 to 86400000

## CheckpointId [#checkpointid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## ExportId [#exportid]

an identifier

string, matching `^[A-Za-z0-9][A-Za-z0-9_-]{0,62}$`

## ObjectKey [#objectkey]

between 1 and 1024 characters

string, 1 to 1024 characters

## ExportFormat [#exportformat]

One of `"tar-gzip"`, `"directory"`.

## TenantEnvironment [#tenantenvironment]

map of [TenantValue](#tenantvalue), keys matching `^[A-Za-z_][A-Za-z0-9_]*$`

## Sha256Digest [#sha256digest]

a lowercase hex sha-256

string, matching `^[0-9a-f]{64}$`

## GuestPath [#guestpath]

a guest path

string, at most 4096 characters, matching `^/$|^(/(?!\.\.?(/|$))[^/\\"'\x00-\x1f]+)+$`

## StoredObject [#storedobject]

An object in the store the host's `artifacts.store_url` names, checked against `digest` before anything is made from it. The digest is the whole of what is checked: a `sizeBytes` beside it, which a document used to carry, is read past.

| Name                                                                          | Type                          | Description                          |
| ----------------------------------------------------------------------------- | ----------------------------- | ------------------------------------ |
| <span id="storedobject-digest" className="scroll-mt-28">`digest`</span>       | [Sha256Digest](#sha256digest) |                                      |
| <span id="storedobject-objectKey" className="scroll-mt-28">`objectKey`</span> | [ObjectKey](#objectkey)       | Where the object lives in the store. |

## OciRepository [#ocirepository]

a lowercase registry hostname and repository path, without a scheme, tag or digest

string, at most 255 characters, matching `^(localhost|[a-z0-9]+([.-][a-z0-9]+)*\.[a-z0-9]+(-[a-z0-9]+)*)(:[0-9]{1,5})?(/[a-z0-9]([a-z0-9._-]*[a-z0-9])?)+$`

## ExecutablePath [#executablepath]

an absolute path to a file other than /sbin/init

string, at most 4096 characters, matching `^/$|^(/(?!\.\.?(/|$))[^/\\"'\x00-\x1f]+)+$`

## HttpPort [#httpport]

integer, 1 to 65535

## Command [#command]

What the guest runs once its root is stacked, as uid 65534: `program` with `args`, in `workingDirectory`, with `environment`. The working directory is made if it is not there, given to that uid, and is where the program's persistent state lives, because everything under the root persists on the volume and nowhere else is the program's to write.

| Name                                                                                   | Type                                    | Description |
| -------------------------------------------------------------------------------------- | --------------------------------------- | ----------- |
| <span id="command-program" className="scroll-mt-28">`program`</span>                   | [GuestPath](#guestpath)                 |             |
| <span id="command-args" className="scroll-mt-28">`args`</span>                         | [TenantArguments](#tenantarguments)     |             |
| <span id="command-workingDirectory" className="scroll-mt-28">`workingDirectory`</span> | [GuestPath](#guestpath)                 |             |
| <span id="command-environment" className="scroll-mt-28">`environment`</span>           | [TenantEnvironment](#tenantenvironment) |             |

## InstanceResources [#instanceresources]

| Name                                                                               | Type                | Description |
| ---------------------------------------------------------------------------------- | ------------------- | ----------- |
| <span id="instanceresources-vcpuCount" className="scroll-mt-28">`vcpuCount`</span> | integer, at least 0 |             |
| <span id="instanceresources-memoryMib" className="scroll-mt-28">`memoryMib`</span> | integer, at least 0 |             |

## HealthCheck [#healthcheck]

What tells this host an instance is well — and so what a wake waits for before it hands the caller on, and what the instance's liveness is read from after that. Named in every document: a default would be a kind nobody chose, and the one that looks obvious lies. A TCP connect is answered by the guest kernel's accept queue whether or not the process behind it will ever read the request, so a program that has stopped answering passes it for as long as it lives.

One of the following, told apart by `kind`:

### http [#http]

`path`, requested on `httpPort`, answers 2xx.

| Name                                                                                    | Type                | Description |
| --------------------------------------------------------------------------------------- | ------------------- | ----------- |
| <span id="http-kind" className="scroll-mt-28">`kind`</span>                             | `"http"`            |             |
| <span id="http-path" className="scroll-mt-28">`path`</span>                             | string              |             |
| <span id="http-intervalMs" className="scroll-mt-28">`intervalMs`</span>                 | integer, at least 0 |             |
| <span id="http-timeoutMs" className="scroll-mt-28">`timeoutMs`</span>                   | integer, at least 0 |             |
| <span id="http-gracePeriodMs" className="scroll-mt-28">`gracePeriodMs`</span>           | integer, at least 0 |             |
| <span id="http-healthyThreshold" className="scroll-mt-28">`healthyThreshold`</span>     | integer, at least 0 |             |
| <span id="http-unhealthyThreshold" className="scroll-mt-28">`unhealthyThreshold`</span> | integer, at least 0 |             |

### tcp [#tcp]

A connection to `httpPort` is accepted. Only that — for a port that does not speak HTTP.

| Name                                                                                   | Type                | Description |
| -------------------------------------------------------------------------------------- | ------------------- | ----------- |
| <span id="tcp-kind" className="scroll-mt-28">`kind`</span>                             | `"tcp"`             |             |
| <span id="tcp-intervalMs" className="scroll-mt-28">`intervalMs`</span>                 | integer, at least 0 |             |
| <span id="tcp-timeoutMs" className="scroll-mt-28">`timeoutMs`</span>                   | integer, at least 0 |             |
| <span id="tcp-gracePeriodMs" className="scroll-mt-28">`gracePeriodMs`</span>           | integer, at least 0 |             |
| <span id="tcp-healthyThreshold" className="scroll-mt-28">`healthyThreshold`</span>     | integer, at least 0 |             |
| <span id="tcp-unhealthyThreshold" className="scroll-mt-28">`unhealthyThreshold`</span> | integer, at least 0 |             |

### boot-completed [#boot-completed]

The microVM is up and `httpPort` has accepted a connection once: the tenant is listening. That is all it is asked, and only until it answers — a guest this host did not build answers no path it was not told about — so its liveness after that is the microVM being up.

| Name                                                                  | Type               | Description |
| --------------------------------------------------------------------- | ------------------ | ----------- |
| <span id="boot-completed-kind" className="scroll-mt-28">`kind`</span> | `"boot-completed"` |             |

## RestartPolicy [#restartpolicy]

| Name                                                                                         | Type                | Description |
| -------------------------------------------------------------------------------------------- | ------------------- | ----------- |
| <span id="restartpolicy-maxRestarts" className="scroll-mt-28">`maxRestarts`</span>           | integer, at least 0 |             |
| <span id="restartpolicy-initialBackoffMs" className="scroll-mt-28">`initialBackoffMs`</span> | integer, at least 0 |             |
| <span id="restartpolicy-maxBackoffMs" className="scroll-mt-28">`maxBackoffMs`</span>         | integer, at least 0 |             |
| <span id="restartpolicy-backoffFactor" className="scroll-mt-28">`backoffFactor`</span>       | number              |             |
| <span id="restartpolicy-resetAfterMs" className="scroll-mt-28">`resetAfterMs`</span>         | integer, at least 0 |             |

## InstancePort [#instanceport]

A port a guest answers on beside its HTTP one, carried to it unread.

It carries whatever arrives, tcp or udp: a port is a port, the relay in front of a host forwards both for every one in its range, and a guest that listens on only one of them answers the other with a port-unreachable the way any host would.

| Name                                                                          | Type                    | Description |
| ----------------------------------------------------------------------------- | ----------------------- | ----------- |
| <span id="instanceport-name" className="scroll-mt-28">`name`</span>           | [PortName](#portname)   |             |
| <span id="instanceport-guestPort" className="scroll-mt-28">`guestPort`</span> | [GuestPort](#guestport) |             |

## Hostname [#hostname]

a hostname

string, at most 253 characters, matching `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)+$`

## AppHostnameKind [#apphostnamekind]

One of `"platform"`, `"custom"`.

## JwtTokenSource [#jwttokensource]

| Name                                                                      | Type                              | Description |
| ------------------------------------------------------------------------- | --------------------------------- | ----------- |
| <span id="jwttokensource-header" className="scroll-mt-28">`header`</span> | string                            |             |
| <span id="jwttokensource-format" className="scroll-mt-28">`format`</span> | [JwtTokenFormat](#jwttokenformat) |             |

## JwtAlgorithm [#jwtalgorithm]

One of `"RS256"`, `"ES256"`, `"EdDSA"`.

## JwtPublicKeys [#jwtpublickeys]

array of string | object

## SleepPolicy [#sleeppolicy]

What puts a running microVM back to sleep. Only an `on-request` instance may carry one that fires: nothing else on this host would wake it again, and the next reconcile pass would bring it straight back up.

One of the following, told apart by `kind`:

### never [#never]

| Name                                                         | Type      | Description |
| ------------------------------------------------------------ | --------- | ----------- |
| <span id="never-kind" className="scroll-mt-28">`kind`</span> | `"never"` |             |

### traffic-idle [#traffic-idle]

| Name                                                                          | Type                            | Description |
| ----------------------------------------------------------------------------- | ------------------------------- | ----------- |
| <span id="traffic-idle-kind" className="scroll-mt-28">`kind`</span>           | `"traffic-idle"`                |             |
| <span id="traffic-idle-timeoutMs" className="scroll-mt-28">`timeoutMs`</span> | [IdleTimeoutMs](#idletimeoutms) |             |

### max-lifetime [#max-lifetime]

| Name                                                                  | Type                            | Description |
| --------------------------------------------------------------------- | ------------------------------- | ----------- |
| <span id="max-lifetime-kind" className="scroll-mt-28">`kind`</span>   | `"max-lifetime"`                |             |
| <span id="max-lifetime-ttlMs" className="scroll-mt-28">`ttlMs`</span> | [MaxLifetimeMs](#maxlifetimems) |             |

## TenantValue [#tenantvalue]

Only complete `${NAME}` references are filled in for NAME in NIBRUN\_HOSTNAME, NIBRUN\_HTTP\_PORT. Bare names, incomplete references and other dollar signs remain literal; complete references to unknown `NIBRUN_` names are refused.

string, at most 32768 characters

## TenantArguments [#tenantarguments]

The arguments the binary is started with.

array of string, at most 4096 characters, at most 64 items

## PortName [#portname]

lowercase letters, digits and dashes, starting with a letter

string, matching `^[a-z][a-z0-9-]{0,15}$`

## GuestPort [#guestport]

integer, 1 to 65535

## JwtTokenFormat [#jwttokenformat]

One of `"raw"`, `"bearer"`.

## MaxLifetimeMs [#maxlifetimems]

integer, 60000 to 604800000
