diff --git a/pages/api-reference/kubernetes/agent-api-reference.md b/pages/api-reference/kubernetes/agent-api-reference.md index a91e95af..2367eb56 100644 --- a/pages/api-reference/kubernetes/agent-api-reference.md +++ b/pages/api-reference/kubernetes/agent-api-reference.md @@ -585,7 +585,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `script` _string_ | | | | +| `script` _string_ | Script is a Lua health-assessment script. The target resource is available as the global `Obj`.
The script must assign a Lua table to the global `healthStatus`; a Lua `return \{ ... \}` is not consumed.
The table uses `status` and an optional `message`, for example: `healthStatus = \{ status = "Healthy", message = "resource is ready" \}`.
Supported/intended status values are `Healthy`, `Degraded`, `Paused`, `Unknown`, `Progressing`, `Suspended`, and `Missing`.
See https://docs.plural.sh/plural-features/continuous-deployment/deployment-operator/custom-health for the full guide. | | | | `group` _string_ | | | Optional: \{\}
| | `version` _string_ | | | Optional: \{\}
| | `kind` _string_ | | | Optional: \{\}
|