|
| 1 | +# Command-Line Help for `policy-server` |
| 2 | + |
| 3 | +This document contains the help content for the `policy-server` command-line program. |
| 4 | + |
| 5 | +**Command Overview:** |
| 6 | + |
| 7 | +* [`policy-server`↴](#policy-server) |
| 8 | +* [`policy-server docs`↴](#policy-server-docs) |
| 9 | + |
| 10 | +## `policy-server` |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +**Usage:** `policy-server [OPTIONS] [COMMAND]` |
| 15 | + |
| 16 | +###### **Subcommands:** |
| 17 | + |
| 18 | +* `docs` — Generates the markdown documentation for policy-server commands |
| 19 | + |
| 20 | +###### **Options:** |
| 21 | + |
| 22 | +* `--addr <BIND_ADDRESS>` — Bind against ADDRESS |
| 23 | + |
| 24 | + Default value: `0.0.0.0` |
| 25 | +* `--always-accept-admission-reviews-on-namespace <NAMESPACE>` — Always accept AdmissionReviews that target the given namespace |
| 26 | +* `--cert-file <CERT_FILE>` — Path to an X.509 certificate file for HTTPS |
| 27 | + |
| 28 | + Default value: `` |
| 29 | +* `--daemon` — If set, runs policy-server in detached mode as a daemon |
| 30 | +* `--daemon-pid-file <DAEMON-PID-FILE>` — Path to the PID file, used only when running in daemon mode |
| 31 | + |
| 32 | + Default value: `policy-server.pid` |
| 33 | +* `--daemon-stderr-file <DAEMON-STDERR-FILE>` — Path to the file holding stderr, used only when running in daemon mode |
| 34 | +* `--daemon-stdout-file <DAEMON-STDOUT-FILE>` — Path to the file holding stdout, used only when running in daemon mode |
| 35 | +* `--disable-timeout-protection` — Disable policy timeout protection |
| 36 | +* `--docker-config-json-path <DOCKER_CONFIG>` — Path to a Docker config.json-like path. Can be used to indicate registry authentication details |
| 37 | +* `--enable-metrics` — Enable metrics |
| 38 | +* `--enable-pprof` — Enable pprof profiling |
| 39 | +* `--ignore-kubernetes-connection-failure` — Do not exit with an error if the Kubernetes connection fails. This will cause context-aware policies to break when there's no connection with Kubernetes. |
| 40 | +* `--key-file <KEY_FILE>` — Path to an X.509 private key file for HTTPS |
| 41 | + |
| 42 | + Default value: `` |
| 43 | +* `--log-fmt <LOG_FMT>` — Log output format |
| 44 | + |
| 45 | + Default value: `text` |
| 46 | + |
| 47 | + Possible values: `text`, `json`, `otlp` |
| 48 | + |
| 49 | +* `--log-level <LOG_LEVEL>` — Log level |
| 50 | + |
| 51 | + Default value: `info` |
| 52 | + |
| 53 | + Possible values: `trace`, `debug`, `info`, `warn`, `error` |
| 54 | + |
| 55 | +* `--log-no-color` — Disable colored output for logs |
| 56 | +* `--policies <POLICIES_FILE>` — YAML file holding the policies to be loaded and their settings |
| 57 | + |
| 58 | + Default value: `policies.yml` |
| 59 | +* `--policies-download-dir <POLICIES_DOWNLOAD_DIR>` — Download path for the policies |
| 60 | + |
| 61 | + Default value: `.` |
| 62 | +* `--policy-timeout <MAXIMUM_EXECUTION_TIME_SECONDS>` — Interrupt policy evaluation after the given time |
| 63 | + |
| 64 | + Default value: `2` |
| 65 | +* `--port <PORT>` — Listen on PORT |
| 66 | + |
| 67 | + Default value: `3000` |
| 68 | +* `--sigstore-cache-dir <SIGSTORE_CACHE_DIR>` — Directory used to cache sigstore data |
| 69 | + |
| 70 | + Default value: `sigstore-data` |
| 71 | +* `--sources-path <SOURCES_PATH>` — YAML file holding source information (https, registry insecure hosts, custom CA's...) |
| 72 | +* `--verification-path <VERIFICATION_CONFIG_PATH>` — YAML file holding verification information (URIs, keys, annotations...) |
| 73 | +* `--workers <WORKERS_NUMBER>` — Number of worker threads to create |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +## `policy-server docs` |
| 78 | + |
| 79 | +Generates the markdown documentation for policy-server commands |
| 80 | + |
| 81 | +**Usage:** `policy-server docs --output <FILE>` |
| 82 | + |
| 83 | +###### **Options:** |
| 84 | + |
| 85 | +* `-o`, `--output <FILE>` — path where the documentation file will be stored |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +<hr/> |
| 90 | + |
| 91 | +<small><i> |
| 92 | + This document was generated automatically by |
| 93 | + <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>. |
| 94 | +</i></small> |
0 commit comments