This tool is intended to be used by Cloud Foundry operators to provide a picture about the portability of their foundation to other platforms.
It does this by using the local cf CLI to read information about a cluster.
Requirements
The cf CLI to be on your path
The cf CLI to be authenticated to and targeting the cluster to scan
The cf CLI to be logged in with administrator permissions
Reading the report
The report does not contain all the information retrieved from the API, instead it targets specific pieces of data that can be used to estimate portability to Kubernetes.
While the tool does its best to obfuscate or skip processing any known fields that might contain sensitive data, you should read through the report before sending it off. For example, URIs might contain usernames, passwords, or keys.
Examples
# Validate the cluster to be targeted
cf curl /v2/info
# Run the command and get XLSX results (recommended)
kf migrate scan-cf-cluster report.xlsx
# Run the command and get text results
kf migrate scan-cf-cluster report.txt
Flags
-h, --help
help for scan-cf-cluster
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 migrate scan-cf-cluster\n\n### Name\n\n`kf migrate scan-cf-cluster` - Reports migration readiness of a CF cluster.\n\n### Synopsis\n\n```\nkf migrate scan-cf-cluster REPORT_NAME.(xlsx|txt) [flags]\n```\n\n### Description\n\nThis tool is intended to be used by Cloud Foundry operators to provide a picture about the portability of their foundation to other platforms.\n\nIt does this by using the local cf CLI to read information about a cluster.\n\nRequirements\n\n- The` cf` CLI to be on your path\n- The` cf` CLI to be authenticated to and targeting the cluster to scan\n- The` cf` CLI to be logged in with administrator permissions\n\n Reading the report\n\n The report does not contain all the information retrieved from the API, instead it targets specific pieces of data that can be used to estimate portability to Kubernetes.\n\n While the tool does its best to obfuscate or skip processing any known fields that might contain sensitive data, you should read through the report before sending it off. For example, URIs might contain usernames, passwords, or keys.\n\n### Examples\n\n```\n # Validate the cluster to be targeted\n cf curl /v2/info\n \n # Run the command and get XLSX results (recommended)\n kf migrate scan-cf-cluster report.xlsx\n \n # Run the command and get text results\n kf migrate scan-cf-cluster report.txt\n```\n\n### Flags\n\n`-h, --help`\n: help for scan-cf-cluster\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."]]
