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