# kube-bench: evaluate a benchmark configuration



Evaluate a benchmark configuration.



## 1. Run the example



[Download the kube-bench example](https://www.security.run/docs/examples/kube-bench.zip). Extract it, install `httpx`, set your API URL and token, then run `python client.py`. The client uploads the included inputs, submits the command, and saves the result under `results/RUN_ID`.



## 2. Check the result



Read report.json for the selected example node checks. Supply your own configuration for a real benchmark.



Read the native exit code and cleanup status printed by the client. [Read results and save reports](https://www.security.run/docs/visibility.html) explains the returned files.



## 3. Use your own inputs



Edit `example.json` to change the command arguments, requested outputs or deadline. Replace the files under `inputs/` with your own data, keeping the staged paths aligned with the command. The client creates the artifact IDs for you; illustrative IDs shown here must not be copied into a live request.



### Files used by this example



- `cfg/config.yaml`

- `cfg/fixture/config.yaml`

- `cfg/fixture/node.yaml`

- `kubelet.service`



The example uses supplied files or the disposable execution environment. Nothing from the environment carries into a later run unless you request and reuse its output.



Qualified version: `0.16.0`. Commands: `kube-bench`.



- Bundled benchmark configurations are under /opt/tool/cfg; host/cluster probes require compatible target access.



Inspect `GET /v1/tools/kube-bench` for the current installed version and readiness. The published snapshot has 2 functional case(s), plus timeout and cancellation checks. These examples demonstrate the native path; other flags and inputs are supported within the tool’s runtime limits.

## Command submitted by the example

```json
{
  "tool": "kube-bench",
  "timeout_seconds": 90,
  "invocation": {
    "args": [
      "run",
      "--benchmark",
      "fixture",
      "--targets",
      "node",
      "--config-dir",
      "cfg",
      "--json",
      "--outputfile",
      "report.json"
    ],
    "outputs": [
      "report.json"
    ],
    "success_exit_codes": [
      0
    ],
    "executable": "kube-bench",
    "files": [
      {
        "path": "cfg/config.yaml",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      },
      {
        "path": "cfg/fixture/config.yaml",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      },
      {
        "path": "cfg/fixture/node.yaml",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      },
      {
        "path": "kubelet.service",
        "artifact_id": "artifact_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "executable": false
      }
    ]
  }
}
```