Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI Reference Docs #532

Conversation

github-actions[bot]
Copy link
Contributor

Update all the CLI reference documentation


Updates CLI reference documentation files

updates docs/reference/policy-server-cli.md file

1 file(s) updated with "---\nsidebar_label: Policy Server CLI Reference\nsidebar_position: 121\ntitle: Policy Server CLI\ndescription: Policy Server CLI reference documentation\nkeywords: [cli, reference, policy-server]\ndoc-persona: [kubewarden-operator]\ndoc-type: [reference]\ndoc-topic: [operator-manual]\n---\n# Command-Line Help for `policy-server`\n\nThis document contains the help content for the `policy-server` command-line program.\n\n**Command Overview:**\n\n* [`policy-server`↴](#policy-server)\n* [`policy-server docs`↴](#policy-server-docs)\n\n## `policy-server`\n\n\n\n**Usage:** `policy-server [OPTIONS] [COMMAND]`\n\n###### **Subcommands:**\n\n* `docs` — Generates the markdown documentation for policy-server commands\n\n###### **Options:**\n\n* `--addr <BIND_ADDRESS>` — Bind against ADDRESS\n\n Default value: `0.0.0.0`\n* `--always-accept-admission-reviews-on-namespace <NAMESPACE>` — Always accept AdmissionReviews that target the given namespace\n* `--cert-file <CERT_FILE>` — Path to an X.509 certificate file for HTTPS\n\n Default value: ``\n* `--daemon` — If set, runs policy-server in detached mode as a daemon\n* `--daemon-pid-file <DAEMON-PID-FILE>` — Path to the PID file, used only when running in daemon mode\n\n Default value: `policy-server.pid`\n* `--daemon-stderr-file <DAEMON-STDERR-FILE>` — Path to the file holding stderr, used only when running in daemon mode\n* `--daemon-stdout-file <DAEMON-STDOUT-FILE>` — Path to the file holding stdout, used only when running in daemon mode\n* `--disable-timeout-protection` — Disable policy timeout protection\n* `--docker-config-json-path <DOCKER_CONFIG>` — Path to a Docker config.json-like path. Can be used to indicate registry authentication details\n* `--enable-metrics` — Enable metrics\n* `--enable-pprof` — Enable pprof profiling\n* `--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.\n* `--key-file <KEY_FILE>` — Path to an X.509 private key file for HTTPS\n\n Default value: ``\n* `--log-fmt <LOG_FMT>` — Log output format\n\n Default value: `text`\n\n Possible values: `text`, `json`, `otlp`\n\n* `--log-level <LOG_LEVEL>` — Log level\n\n Default value: `info`\n\n Possible values: `trace`, `debug`, `info`, `warn`, `error`\n\n* `--log-no-color` — Disable colored output for logs\n* `--policies <POLICIES_FILE>` — YAML file holding the policies to be loaded and their settings\n\n Default value: `policies.yml`\n* `--policies-download-dir <POLICIES_DOWNLOAD_DIR>` — Download path for the policies\n\n Default value: `.`\n* `--policy-timeout <MAXIMUM_EXECUTION_TIME_SECONDS>` — Interrupt policy evaluation after the given time\n\n Default value: `2`\n* `--port <PORT>` — Listen on PORT\n\n Default value: `3000`\n* `--sigstore-cache-dir <SIGSTORE_CACHE_DIR>` — Directory used to cache sigstore data\n\n Default value: `sigstore-data`\n* `--sources-path <SOURCES_PATH>` — YAML file holding source information (https, registry insecure hosts, custom CA's...)\n* `--verification-path <VERIFICATION_CONFIG_PATH>` — YAML file holding verification information (URIs, keys, annotations...)\n* `--workers <WORKERS_NUMBER>` — Number of worker threads to create\n\n\n\n## `policy-server docs`\n\nGenerates the markdown documentation for policy-server commands\n\n**Usage:** `policy-server docs --output <FILE>`\n\n###### **Options:**\n\n* `-o`, `--output <FILE>` — path where the documentation file will be stored\n\n\n\n<hr/>\n\n<small><i>\n This document was generated automatically by\n <a href=\"https://crates.io/crates/clap-markdown\"><code>clap-markdown</code></a>.\n</i></small>\n": * docs/reference/policy-server-cli.md

GitHub Action workflow link
Updatecli logo

Created automatically by Updatecli

Options:

Most of Updatecli configuration is done via its manifest(s).

  • If you close this pull request, Updatecli will automatically reopen it, the next time it runs.
  • If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.

Feel free to report any issues at github.com/updatecli/updatecli.
If you find this tool useful, do not hesitate to star our GitHub repository as a sign of appreciation, and/or to tell us directly on our chat!

Signed-off-by: Kubewarden bot <cncf-kubewarden-maintainers@lists.cncf.io>
@github-actions github-actions bot requested a review from a team as a code owner January 29, 2025 13:17
@github-actions github-actions bot added area/documentation Improvements or additions to documentation kind/chore labels Jan 29, 2025
Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for docs-kubewarden-io ready!

Name Link
🔨 Latest commit 1e021d8
🔍 Latest deploy log https://app.netlify.com/sites/docs-kubewarden-io/deploys/679a2a826567ca0009012556
😎 Deploy Preview https://deploy-preview-532--docs-kubewarden-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@viccuad viccuad merged commit f047e66 into main Jan 29, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/chore
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant