Version 2.3

kf doctor

Name

kf doctor - Run validation tests against one or more components.

Synopsis

kf doctor [(COMPONENT|TYPE/NAME)...] [flags]

Description

Doctor runs tests on one or more components or objects to validate their desired status.

If no arguments are supplied, then all component tests are ran. If one or more arguments are suplied then only the test for those components or objects are ran.

Possible components are:

  • cluster
  • istio
  • user

    Possible object types are:

  • app

  • build

  • clusterservicebroker

  • route

  • servicebroker

  • serviceinstance

  • serviceinstancebinding

  • sourcepackage

  • space

  • task

Examples

  # Run doctor against all components.
  kf doctor
  # Run doctor against server-side components.
  kf doctor cluster
  # Run doctor for a Kf App named my-app.
  kf doctor app/my-app
  # Run doctor for a Kf Service named my-service.
  kf doctor serviceinstance/my-service
  # Run doctor for a Kf Binding named my-binding.
  kf doctor serviceinstancebinding/my-binding

Flags

--delay=duration
Set the delay between executions. (default 5s)
-h, --help
help for doctor
--retries=int
Number of times to retry doctor if it isn't successful. (default 1)

Inherited flags

These flags are inherited from parent commands.

--as=string
Username to impersonate for the operation.
--as-group=strings
Group to impersonate for the operation. Include this flag multiple times to specify multiple groups.
--config=string
Path to the Kf config file to use for CLI requests.
--kubeconfig=string
Path to the kubeconfig file to use for CLI requests.
--log-http
Log HTTP requests to standard error.
--space=string
Space to run the command against. This flag overrides the currently targeted Space.