Stay organized with collections
Save and categorize content based on your preferences.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# kf doctor\n\n### Name\n\n`kf doctor` - Run validation tests against one or more components.\n\n### Synopsis\n\n```\nkf doctor [(COMPONENT|TYPE/NAME)...] [flags]\n```\n\n### Description\n\nDoctor runs tests on one or more components or objects to validate their desired status.\n\nIf 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.\n\nPossible components are:\n\n- cluster\n- istio\n- user\n\n Possible object types are:\n- app\n\n- build\n\n- clusterservicebroker\n\n- route\n\n- servicebroker\n\n- serviceinstance\n\n- serviceinstancebinding\n\n- sourcepackage\n\n- space\n\n- task\n\n### Examples\n\n```\n # Run doctor against all components.\n kf doctor\n # Run doctor against server-side components.\n kf doctor cluster\n # Run doctor for a Kf App named my-app.\n kf doctor app/my-app\n # Run doctor for a Kf Service named my-service.\n kf doctor serviceinstance/my-service\n # Run doctor for a Kf Binding named my-binding.\n kf doctor serviceinstancebinding/my-binding\n```\n\n### Flags\n\n`--delay=`\u003cvar translate=\"no\"\u003eduration\u003c/var\u003e\n: Set the delay between executions. (default 5s)\n\n`-h, --help`\n: help for doctor\n\n`--retries=`\u003cvar translate=\"no\"\u003eint\u003c/var\u003e\n: Number of times to retry doctor if it isn't successful. (default 1)\n\n### Inherited flags\n\nThese flags are inherited from parent commands.\n\n`--as=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n: Username to impersonate for the operation.\n\n`--as-group=`\u003cvar translate=\"no\"\u003estrings\u003c/var\u003e\n: Group to impersonate for the operation. Include this flag multiple times to specify multiple groups.\n\n`--config=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n: Path to the Kf config file to use for CLI requests.\n\n`--kubeconfig=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n: Path to the kubeconfig file to use for CLI requests.\n\n`--log-http`\n: Log HTTP requests to standard error.\n\n`--space=`\u003cvar translate=\"no\"\u003estring\u003c/var\u003e\n: Space to run the command against. This flag overrides the currently targeted Space."]]
