Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Config schema

cloudexit supports running assessments using configuration files.

Configuration files are useful when you want to:

  • run assessments repeatedly in a consistent way
  • automate runs in CI or scripts
  • store non-secret defaults (scope, provider, strategy)

name

Assessment name shown in reports.

Example:

"name": "DMS System"

cloudServiceProvider

Which cloud provider to assess.

Cloud ProviderValue
Microsoft Azure1
Amazon Web Services2
Google Cloud PlatformTBD
Alibaba CloudTBD

exitStrategy

Which exit strategy the assessment should model.

StrategyValue
Repatriation to On-Premises1
Hybrid Cloud AdoptionTBD
Migration to Alternate Cloud3

assessmentType

Which assessment type to run.

TypeValueComment
Basic1No API key required
Standard2API key required

providerDetails

Provider-specific authentication details (varies by cloud provider).

See:

Example structure

{
  "name": "DMS System",
  "cloudServiceProvider": 2,
  "exitStrategy": 3,
  "assessmentType": 1,
  "providerDetails": {
    "...": "..."
  }
}