OS Manuals

/usr/bin/upwind-agent

Upwind runtime security sensor agent

From upwind-agent 0.131.2-r0 (enterprise-packages), captured 2026-11-08 by running upwind-agent --help (exit 0). permalink

Upwind Agent

Usage:
  upwind-agent [command]

Available Commands:
  agent        agent command
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  readyz       Ready command
  scan         scan an image
  scanner      Run the image scanning agent
  version      print version

Flags:
      --agent-target string                          Endpoint address of the Agent gRPC service. (default "agentgrpc.upwind.io:443")
      --analysis-clusters-endpoint string            API Endpoint for sending analysis reports for clusters.
      --analysis-hosts-endpoint string               API Endpoint for sending analysis reports for hosts.
      --api-host string                              The base URL for the Upwind API that is used by the agent.
      --api-sec-catalog-clusters-endpoint string     API Endpoint for sending api security catalog reports for clusters.
      --api-sec-catalog-hosts-endpoint string        API Endpoint for sending api security catalog reports for hosts.
      --auth-client-id string                        ClientID value supplied by the Upwind Platform to connect agents to the platform. Optional. If supplied, must also supply auth-client-secret.
      --auth-client-secret string                    ClientID value supplied by the Upwind Platform to connect agents to the platform. Required if auth-client-id is set.
      --auth-endpoint string                         The Oauth Endpoint that the Upwind Component access tokens will be generated from.
      --auth-key-cache-expiry duration               The auth key cache expiry. (default 1h0m0s)
      --auth-key-issuer string                       The valid issuer of public keys used for token signature verifications.
      --auth-key-signature-method string             The valid signature method of public keys used for signature verifications.
      --auth-keys-endpoint string                    Endpoint for retrieving public keys used to verify token signatures from the auth server.
      --auth-token-file string                       File location on-disk where an already defined authorization token can be found.
      --backend-timeout duration                     timeout for requests to the upwind backend (default 1m0s)
      --cloud-account-id string                      Set cloud account ID (use if IMDS not available)
      --cloud-provider string                        Set cloud provider name (use if IMDS not available)
      --cluster-dns                                  Route DNS through CoreDNS for cluster service name resolution
      --cluster-dns-addr string                      CoreDNS ClusterIP address (used when cluster-dns is enabled). If empty, looked up from the kube-dns service in kube-system at startup.
      --cluster-name string                          Name of the cluster
      --component-registration-endpoint string       Endpoint for the runtime-component-registry service. When set, runtime components register here instead of monolith.
      --containerd-namespace string                  containerd namespace
      --customresourcedefinitions-watcher            enable watcher for customresourcedefinitions (default true)
      --debug                                        Sets debug mode: dumping of requests to logs
      --debug-metrics-enabled                        Whether to enable the prometheus client for debug metrics
      --disable-ip-resolution                        disable IP resolution
      --docker-container-buffer int                  docker container buffer size (default 5000)
      --docker-container-sync-interval duration      docker container sync interval (default 1h0m0s)
      --docker-evictions-buffer int                  docker entity eviction channel size (default 10000)
      --docker-evictions-delay duration              docker entity eviction delay (default 10m0s)
  -d, --dry-run                                      Sets dry-run mode: logging instead of uploading reports
      --evictions-buffer int                         entity eviction channel size (default 10000)
      --grpc-audience string                         Audience for the token used for GRPC authentication (default "https://agent.upwind.io")
      --heartbeat-host string                        Host to send heartbeats to (default "https://agent.upwind.io")
      --heartbeat-interval duration                  Frequency at which heartbeats should be sent (default 1m0s)
  -h, --help                                         help for upwind-agent
      --host-cm-enabled                              Whether hosts should expect a cluster manager
      --inuse-clusters-endpoint string               API Endpoint for sending inuse events reports for clusters.
      --inuse-hosts-endpoint string                  API Endpoint for sending inuse events reports for hosts.
      --iostats-enabled                              Whether to enable logging iostats
      --jobs-watcher                                 enable watcher for jobs (default true)
      --linux-posture-interval duration              interval between linux posture report generation (default 4h0m0s)
      --linux-posture-startup-delay duration         initial delay until first linux posture report generation (default 2m0s)
      --log-buffer-size int                          size of in-memory log buffer (default 65536)
      --log-expiry duration                          time duration until logs expire (default 10m0s)
      --log-format string                            log format
      --log-level string                             default log level
      --log-upload-endpoint string                   The endpoint we should upload logs to
      --log-uploader                                 whether to enable automatic log uploads
      --log-uploader-backoff-secs int                min seconds between triggered uploads (default 60)
      --log-uploader-hook                            whether to enable automatic log uploads on error or higher logs (default true)
      --log-uploader-hook-level string               level to trigger automatic log upload on (default "error")
      --log-uploader-interval-secs int               log upload interval (default 60)
      --md5-exclusion-endpoint string                API Endpoint for sending/getting md5 exclusions.
      --memstats-enabled                             Whether to enable logging memstats
      --metrics-enabled                              Whether to enable the prometheus client
      --metrics-port string                          Port the prometheus client will listen on (default "9090")
      --network-endpoint string                      API Endpoint for sending network reports.
      --network-endpoint-auth                        Whether to authorize network endpoint requests (default true)
      --network-endpoint-verify                      Whether to verify tokens for network endpoint requests
      --no-cloud-init                                Do not read metadata from local cloud-init data
      --nodes-watcher                                enable watcher for nodes
      --otel-collector                               enable the otel logs collector
      --otel-port string                             port for the otel grpc logs receiver (default "4317")
      --package-scan-endpoint string                 The endpoint we should upload package scan reports to
  -p, --platform string                              Agent platform (k8s, docker, host, auto) (default "auto")
      --pod-buffer int                               pod event channel size (default 5000)
      --pods-watcher                                 enable watcher for pods (default true)
      --posture-endpoint string                      API Endpoint for sending posture reports.
      --pprof                                        Enable pprof
      --private-cidrs string                         comma-separated list of additional CIDRs to treat as private IP ranges
      --process-endpoint string                      API Endpoint for sending process reports.
      --process-events-clusters-endpoint string      API Endpoint for sending process events reports for clusters.
      --process-events-hosts-endpoint string         API Endpoint for sending process events reports for hosts.
      --procfs string                                Host procfs path.
      --registration-host string                     Host to send registration requests to (default "https://agent.upwind.io")
      --replicasets-watcher                          enable watcher for replicasets (default true)
      --report-ingestion-endpoint string             API Endpoint for sending reports to report-ingestion service.
      --reports-service-verify                       Whether to verify tokens for grpc report uploads
      --running-processes-clusters-endpoint string   API Endpoint for sending running processes reports for clusters.
      --running-processes-hosts-endpoint string      API Endpoint for sending running processes reports for hosts.
      --scan-cache-endpoint string                   The endpoint we should query to check if an ImageID has already been scanned.
      --scan-endpoints-verify                        Whether to verify tokens for scan endpoints
      --services-watcher                             enable watcher for services
      --snapshotter string                           containerd snapshotter
      --svc-buffer int                               service event channel size (default 1000)
      --uploader-latency-metric                      enable uploader latency metrics
      --use-report-ingestion                         Route all runtime report uploads to the report-ingestion service (sent as protobuf). Per-report-type endpoint flags override this when explicitly set.
      --zone string                                  Set zone (use if IMDS not available and node label not set

Use "upwind-agent [command] --help" for more information about a command.
Options (89)
OptionDescriptionSource
--agent-target stringEndpoint address of the Agent gRPC service.help
--analysis-clusters-endpoint stringAPI Endpoint for sending analysis reports for clusters.help
--analysis-hosts-endpoint stringAPI Endpoint for sending analysis reports for hosts.help
--api-host stringThe base URL for the Upwind API that is used by the agent.help
--api-sec-catalog-clusters-endpoint stringAPI Endpoint for sending api security catalog reports for clusters.help
--api-sec-catalog-hosts-endpoint stringAPI Endpoint for sending api security catalog reports for hosts.help
--auth-client-id stringClientID value supplied by the Upwind Platform to connect agents to the platform.help
--auth-client-secret stringClientID value supplied by the Upwind Platform to connect agents to the platform.help
--auth-endpoint stringThe Oauth Endpoint that the Upwind Component access tokens will be generated from.help
--auth-key-cache-expiry durationThe auth key cache expiry.help
--auth-key-issuer stringThe valid issuer of public keys used for token signature verifications.help
--auth-key-signature-method stringThe valid signature method of public keys used for signature verifications.help
--auth-keys-endpoint stringEndpoint for retrieving public keys used to verify token signatures from the auth server.help
--auth-token-file stringFile location on-disk where an already defined authorization token can be found.help
--backend-timeout durationtimeout for requests to the upwind backend (default 1m0s)help
--cloud-account-id stringSet cloud account ID (use if IMDS not available)help
--cloud-provider stringSet cloud provider name (use if IMDS not available)help
--cluster-dnsRoute DNS through CoreDNS for cluster service name resolutionhelp
--cluster-dns-addr stringCoreDNS ClusterIP address (used when cluster-dns is enabled).help
--cluster-name stringName of the clusterhelp
--component-registration-endpoint stringEndpoint for the runtime-component-registry service.help
--containerd-namespace stringcontainerd namespacehelp
--customresourcedefinitions-watcherenable watcher for customresourcedefinitions (default true)help
--debugSets debug mode: dumping of requests to logshelp
--debug-metrics-enabledWhether to enable the prometheus client for debug metricshelp
--disable-ip-resolutiondisable IP resolutionhelp
--docker-container-buffer intdocker container buffer size (default 5000)help
--docker-container-sync-interval durationdocker container sync interval (default 1h0m0s)help
--docker-evictions-buffer intdocker entity eviction channel size (default 10000)help
--docker-evictions-delay durationdocker entity eviction delay (default 10m0s)help
-d, --dry-runSets dry-run mode: logging instead of uploading reportshelp
--evictions-buffer intentity eviction channel size (default 10000)help
--grpc-audience stringAudience for the token used for GRPC authentication (default "https://agent.upwind.io")help
--heartbeat-host stringHost to send heartbeats to (default "https://agent.upwind.io")help
--heartbeat-interval durationFrequency at which heartbeats should be sent (default 1m0s)help
-h, --helphelp for upwind-agenthelp
--host-cm-enabledWhether hosts should expect a cluster managerhelp
--inuse-clusters-endpoint stringAPI Endpoint for sending inuse events reports for clusters.help
--inuse-hosts-endpoint stringAPI Endpoint for sending inuse events reports for hosts.help
--iostats-enabledWhether to enable logging iostatshelp
--jobs-watcherenable watcher for jobs (default true)help
--linux-posture-interval durationinterval between linux posture report generation (default 4h0m0s)help
--linux-posture-startup-delay durationinitial delay until first linux posture report generation (default 2m0s)help
--log-buffer-size intsize of in-memory log buffer (default 65536)help
--log-expiry durationtime duration until logs expire (default 10m0s)help
--log-format stringlog formathelp
--log-level stringdefault log levelhelp
--log-upload-endpoint stringThe endpoint we should upload logs tohelp
--log-uploaderwhether to enable automatic log uploadshelp
--log-uploader-backoff-secs intmin seconds between triggered uploads (default 60)help
--log-uploader-hookwhether to enable automatic log uploads on error or higher logs (default true)help
--log-uploader-hook-level stringlevel to trigger automatic log upload on (default "error")help
--log-uploader-interval-secs intlog upload interval (default 60)help
--md5-exclusion-endpoint stringAPI Endpoint for sending/getting md5 exclusions.help
--memstats-enabledWhether to enable logging memstatshelp
--metrics-enabledWhether to enable the prometheus clienthelp
--metrics-port stringPort the prometheus client will listen on (default "9090")help
--network-endpoint stringAPI Endpoint for sending network reports.help
--network-endpoint-authWhether to authorize network endpoint requests (default true)help
--network-endpoint-verifyWhether to verify tokens for network endpoint requestshelp
--no-cloud-initDo not read metadata from local cloud-init datahelp
--nodes-watcherenable watcher for nodeshelp
--otel-collectorenable the otel logs collectorhelp
--otel-port stringport for the otel grpc logs receiver (default "4317")help
--package-scan-endpoint stringThe endpoint we should upload package scan reports tohelp
-p, --platform stringAgent platform (k8s, docker, host, auto) (default "auto")help
--pod-buffer intpod event channel size (default 5000)help
--pods-watcherenable watcher for pods (default true)help
--posture-endpoint stringAPI Endpoint for sending posture reports.help
--pprofEnable pprofhelp
--private-cidrs stringcomma-separated list of additional CIDRs to treat as private IP rangeshelp
--process-endpoint stringAPI Endpoint for sending process reports.help
--process-events-clusters-endpoint stringAPI Endpoint for sending process events reports for clusters.help
--process-events-hosts-endpoint stringAPI Endpoint for sending process events reports for hosts.help
--procfs stringHost procfs path.help
--registration-host stringHost to send registration requests to (default "https://agent.upwind.io")help
--replicasets-watcherenable watcher for replicasets (default true)help
--report-ingestion-endpoint stringAPI Endpoint for sending reports to report-ingestion service.help
--reports-service-verifyWhether to verify tokens for grpc report uploadshelp
--running-processes-clusters-endpoint stringAPI Endpoint for sending running processes reports for clusters.help
--running-processes-hosts-endpoint stringAPI Endpoint for sending running processes reports for hosts.help
--scan-cache-endpoint stringThe endpoint we should query to check if an ImageID has already been scanned.help
--scan-endpoints-verifyWhether to verify tokens for scan endpointshelp
--services-watcherenable watcher for serviceshelp
--snapshotter stringcontainerd snapshotterhelp
--svc-buffer intservice event channel size (default 1000)help
--uploader-latency-metricenable uploader latency metricshelp
--use-report-ingestionRoute all runtime report uploads to the report-ingestion service (sent as protobuf).help
--zone stringSet zone (use if IMDS not available and node label not sethelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.