OS Manuals

/usr/bin/dashboard-api

Go module handling authentication to the Kubernetes API

From kubernetes-dashboard-api 1.14.0-r23 (enterprise-packages), captured 2026-11-08 by running dashboard-api --help (exit 0). permalink

Usage of /usr/bin/dashboard-api:
      --act-as-proxy                          forces dashboard to work in full proxy mode, meaning that any in-cluster calls are disabled
      --add_dir_header                        If true, adds the file directory to the header of the log messages
      --alsologtostderr                       log to standard error as well as files (no effect when -logtostderr=true)
      --apiserver-ca-bundle string            file containing the x509 certificates used for HTTPS connection to the API Server
      --apiserver-host string                 address of the Kubernetes API server to connect to in the format of protocol://address:port, leave it empty if the binary runs inside cluster for local discovery attempt
      --apiserver-skip-tls-verify             enable if connection with remote Kubernetes API server should skip TLS verify
      --auto-generate-certificates            enables automatic certificates generation used to serve HTTPS
      --bind-address ip                       IP address on which to serve the --port, set to 0.0.0.0 for all interfaces (default 0.0.0.0)
      --cache-enabled                         whether client cache should be enabled or not (default true)
      --cache-refresh-debounce duration       minimal time between cache refreshes in the background (default 5s)
      --cache-size int                        max number of cache entries (default 1000)
      --cache-ttl duration                    cache entry TTL (default 10m0s)
      --cluster-context-enabled               whether multi-cluster cache context support should be enabled or not
      --csrf-key string                       Base64 encoded random 256 bytes key. Can be loaded from 'CSRF_KEY' environment variable. (default "znTDvMu1dkHsg8itjnjd9cELYlsYsXSvV6yEXVJzQVplr9Ip03sJnY4kJAK/wyPTziVaB2Exq62X0sSJpEZRxj2LW5HwbPIB882sjNx0T9C7vKxAkYYd0P5Xn+msA1qntDhTpmiOM0dmQwY2c+I44TVgBU8wuE3OTZCEs3jLFPzgecRHfo6RhOGyC9zDYSYs4xJkeKy6G4VtuSFV9Ydqdc5II/tJ90Fo755CqvrmSbXvCSmmxZ5DZgolK8VlmUDTfpDtwnI9taBKRYkGBchdFiX5o1QYyuIBvrPkemJAci36/XWZyfp4jhwAOqVqS1dgL3zrjzn2oEl6j2UkPflKuQ==")
      --default-cert-dir string               directory path containing files from --tls-cert-file and --tls-key-file, used also when auto-generating certificates flag is set (default "/certs")
      --disable-csrf-protection               allows disabling CSRF protection
      --insecure-bind-address ip              IP address on which to serve the --insecure-port, set to 0.0.0.0 for all interfaces (default 127.0.0.1)
      --insecure-port int                     port to listen to for incoming HTTP requests (default 8000)
      --kubeconfig string                     path to kubeconfig file with control plane location information
      --log_backtrace_at traceLocation        when logging hits line file:N, emit a stack trace (default :0)
      --log_dir string                        If non-empty, write log files in this directory (no effect when -logtostderr=true)
      --log_file string                       If non-empty, use this log file (no effect when -logtostderr=true)
      --log_file_max_size uint                Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --logtostderr                           log to standard error instead of files (default true)
      --metric-client-check-period int        time interval between separate metric client health checks in seconds (default 30)
      --metrics-provider string               select provider type for metrics, 'none' will not check metrics (default "sidecar")
      --metrics-scraper-service-name string   name of the dashboard metrics scraper service (default "kubernetes-dashboard-metrics-scraper")
      --namespace string                      Namespace to use when accessing Dashboard specific resources, i.e. metrics scraper service (default "kubernetes-dashboard")
      --one_output                            If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
      --openapi-enabled                       enables OpenAPI v2 endpoint under '/apidocs.json'
      --port int                              secure port to listen to for incoming HTTPS requests (default 8001)
      --profiler                              Enable pprof handler. By default it will be exposed on localhost:8070 under '/debug/pprof'
      --prometheus-enabled                    Enable prometheus metrics handler. By default it will be exposed on localhost:8080 under '/metrics'
      --sidecar-host string                   address of the Sidecar API server to connect to in the format of protocol://address:port, leave it empty if the binary runs inside cluster for service proxy usage
      --skip_headers                          If true, avoid header prefixes in the log messages
      --skip_log_headers                      If true, avoid headers when opening log files (no effect when -logtostderr=true)
      --stderrthreshold severity              logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
      --tls-cert-file string                  file containing the default x509 certificate for HTTPS
      --tls-key-file string                   file containing the default x509 private key matching --tls-cert-file
      --token-exchange-endpoint string        endpoint used in multi-cluster cache to exchange tokens for context identifiers
  -v, --v Level                               number for the log level verbosity (default 1)
      --vmodule moduleSpec                    comma-separated list of pattern=N settings for file-filtered logging
Options (42)
OptionDescriptionSource
--act-as-proxyforces dashboard to work in full proxy mode, meaning that any in-cluster calls are disabledhelp
--add_dir_headerIf true, adds the file directory to the header of the log messageshelp
--alsologtostderrlog to standard error as well as files (no effect when -logtostderr=true)help
--apiserver-ca-bundle stringfile containing the x509 certificates used for HTTPS connection to the API Serverhelp
--apiserver-host stringaddress of the Kubernetes API server to connect to in the format of protocol://address:port, leave it empty if the binary runs inside cluster for local discovery attempthelp
--apiserver-skip-tls-verifyenable if connection with remote Kubernetes API server should skip TLS verifyhelp
--auto-generate-certificatesenables automatic certificates generation used to serve HTTPShelp
--bind-address ipIP address on which to serve the --port, set to 0.0.0.0 for all interfaces (default 0.0.0.0)help
--cache-enabledwhether client cache should be enabled or not (default true)help
--cache-refresh-debounce durationminimal time between cache refreshes in the background (default 5s)help
--cache-size intmax number of cache entries (default 1000)help
--cache-ttl durationcache entry TTL (default 10m0s)help
--cluster-context-enabledwhether multi-cluster cache context support should be enabled or nothelp
--csrf-key stringBase64 encoded random 256 bytes key.help
--default-cert-dir stringdirectory path containing files from --tls-cert-file and --tls-key-file, used also when auto-generating certificates flag is set (default "/certs")help
--disable-csrf-protectionallows disabling CSRF protectionhelp
--insecure-bind-address ipIP address on which to serve the --insecure-port, set to 0.0.0.0 for all interfaces (default 127.0.0.1)help
--insecure-port intport to listen to for incoming HTTP requests (default 8000)help
--kubeconfig stringpath to kubeconfig file with control plane location informationhelp
--log_backtrace_at traceLocationwhen logging hits line file:N, emit a stack trace (default :0)help
--log_dir stringIf non-empty, write log files in this directory (no effect when -logtostderr=true)help
--log_file stringIf non-empty, use this log file (no effect when -logtostderr=true)help
--log_file_max_size uintDefines the maximum size a log file can grow to (no effect when -logtostderr=true).help
--logtostderrlog to standard error instead of files (default true)help
--metric-client-check-period inttime interval between separate metric client health checks in seconds (default 30)help
--metrics-provider stringselect provider type for metrics, 'none' will not check metrics (default "sidecar")help
--metrics-scraper-service-name stringname of the dashboard metrics scraper service (default "kubernetes-dashboard-metrics-scraper")help
--namespace stringNamespace to use when accessing Dashboard specific resources, i.e. metrics scraper service (default "kubernetes-dashboard")help
--one_outputIf true, only write logs to their native severity level (vs also writing to each lower severity level;help
--openapi-enabledenables OpenAPI v2 endpoint under '/apidocs.json'help
--port intsecure port to listen to for incoming HTTPS requests (default 8001)help
--profilerEnable pprof handler.help
--prometheus-enabledEnable prometheus metrics handler.help
--sidecar-host stringaddress of the Sidecar API server to connect to in the format of protocol://address:port, leave it empty if the binary runs inside cluster for service proxy usagehelp
--skip_headersIf true, avoid header prefixes in the log messageshelp
--skip_log_headersIf true, avoid headers when opening log files (no effect when -logtostderr=true)help
--stderrthreshold severitylogs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)help
--tls-cert-file stringfile containing the default x509 certificate for HTTPShelp
--tls-key-file stringfile containing the default x509 private key matching --tls-cert-filehelp
--token-exchange-endpoint stringendpoint used in multi-cluster cache to exchange tokens for context identifiershelp
-v, --v Levelnumber for the log level verbosity (default 1)help
--vmodule moduleSpeccomma-separated list of pattern=N settings for file-filtered logginghelp

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