kf migrate scan-cf-cluster

Stay organized with collections Save and categorize content based on your preferences.

Name

kf migrate scan-cf-cluster - Reports migration readiness of a CF cluster

Synopsis

kf migrate scan-cf-cluster REPORT_NAME.(xlsx|txt) [flags]

Description

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.

--config=string
Config file (default is $HOME/.kf)
--kubeconfig=string
Kubectl config file (default is $HOME/.kube/config)
--log-http
Log HTTP requests to stderr
--space=string
Space to run the command against. This overrides the currently targeted space