Skip to content

Commit c82b7b8

Browse files
bencehezsobencehezso
committed
update baselines
1 parent 1df1d17 commit c82b7b8

30 files changed

+983
-18
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# docs.exitcloud.io
1+
# cloudexit-docs

‎book.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[book]
2-
title = "exitcloud.io - User Guide"
2+
title = "exitcloud.io - docs"
33
description = "Documentation for exitcloud.io – Lightweight Cloud Exit Readiness for MSPs and SMEs."
44
authors = ["Bence Hezso"]
55
language = "en"

‎src/README.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# Welcome
1+
# exitcloud.io (EscapeCloud Light)
22

3-
exitcloud.io is a lightweight cloud exit readiness platform that helps individuals, SMEs, and MSPs assess their cloud exit risks.
3+
Welcome to the documentation for exitcloud.io - the **Lightweight Cloud Exit Readiness Platform** for MSPs and SMEs.
44

5-
This documentation explains what exitcloud.io is, who it’s for, and how your data is handled.
5+
These documentation pages explain:
6+
- what **cloud exit readiness** means,
7+
- why it matters for organizations relying on cloud services, and
8+
- how **exitcloud.io** helps assess and manage cloud exit risks in a **structured, repeatable** way.
69

7-
## Overview
8-
- [What is exitcloud.io?](overview/what-is-exitcloud.md)
9-
- [Who it’s for?](overview/who-its-for.md)
10-
- [Data & Privacy](overview/data-privacy.md)
11-
- [Security](overview/security.md)
10+
exitcloud.io focuses on **visibility, risk awareness, and informed decision-making**, without requiring intrusive access to cloud environments.
11+
12+
If you are looking for documentation about the open-source CLI tool, see the [cloudexit](https://github.com/escapecloud/cloudexit/) documentation instead.

‎src/SUMMARY.md‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,32 @@
33
- [Welcome](README.md)
44

55
# Overview
6-
- [What is exitcloud.io?](overview/what-is-exitcloud.md)
7-
- [Who it’s for](overview/who-its-for.md)
8-
- [Data & Privacy](overview/data-privacy.md)
9-
- [Security](overview/security.md)
6+
- [What is Cloud Exit Readiness?](overview/what-is-cloud-exit-readiness.md)
7+
- [Why it's important?](overview/why-its-important.md)
8+
- [What is exitcloud.io?](overview/what-is-exitcloud-io.md)
9+
- [How it works?](overview/how-it-works.md)
10+
- [Exit Strategy](overview/exit-strategy.md)
11+
- [Assessment Types](overview/assessment-types.md)
12+
13+
# Getting Started
14+
- [Data Region](getting-started/data-region.md)
15+
- [Create Account](getting-started/create-account.md)
16+
- [Sample Assessments](getting-started/sample-assessments.md)
17+
- [Pricing & Credits](getting-started/pricing-credits.md)
18+
- [First Assessment](getting-started/first-assessment.md)
19+
- [View Reports](getting-started/view-reports.md)
20+
21+
# Reports & Scores
22+
- [Overview](reports/reports-overview.md)
23+
- [Resource Inventory](reports/resource-inventory.md)
24+
- [Cost Overview](reports/cost-overview.md)
25+
- [Risk Inventory](reports/risk-inventory.md)
26+
- [Alternative Technologies](reports/alternative-technologies.md)
27+
- [Scores](reports/scores.md)
28+
29+
# FAQ
30+
- [Frequently Asked Questions](faq/faq.md)
31+
32+
# Support
33+
- [Getting Help](support/getting-help.md)
34+
- [Contact & Feedback](support/contact.md)

‎src/faq/faq.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Frequently Asked Questions
2+
3+
This section answers common questions about exitcloud.io, cloud exit readiness assessments, and how the platform works.
4+
5+
---
6+
7+
## What is cloud exit readiness?
8+
9+
Cloud exit readiness describes how prepared an organization is to **reduce, change, or fully exit** a cloud service provider.
10+
11+
It covers:
12+
- technical dependencies
13+
- service lock-in risks
14+
- cost and operational considerations
15+
- availability of alternative technologies
16+
17+
exitcloud.io helps assess and quantify this readiness in a structured way.
18+
19+
---
20+
21+
## Who is exitcloud.io for?
22+
23+
exitcloud.io is designed for:
24+
- small and medium-sized enterprises (SMEs)
25+
- managed service providers (MSPs)
26+
- consultants supporting cloud strategy and risk assessments
27+
- technical leaders who need visibility into exit risks
28+
29+
---
30+
31+
## Which cloud providers are supported?
32+
33+
Currently supported:
34+
- **AWS**
35+
- **Microsoft Azure**
36+
37+
Planned / coming soon:
38+
- Google Cloud Platform (GCP)
39+
- Alibaba Cloud
40+
41+
Support for additional providers will be added over time.
42+
43+
---
44+
45+
## Does exitcloud.io require admin access to my cloud account?
46+
47+
No.
48+
49+
exitcloud.io requires **read-only permissions** only.
50+
These permissions are used exclusively to collect metadata such as:
51+
- resource types
52+
- counts
53+
- cost summaries
54+
55+
No changes are made to your cloud environment.
56+
57+
---
58+
59+
## How are credentials handled?
60+
61+
- Credentials are used only during assessment execution
62+
- They are **not stored in the platform database**
63+
- They are securely handled via an **isolated secrets manager**
64+
- Full auditing and strict access controls are applied
65+
66+
exitcloud.io never stores long-term credentials in plaintext.
67+
68+
---
69+
70+
## What is the difference between Basic and Standard assessments?
71+
72+
**Basic** includes:
73+
- Resource Inventory
74+
- Cost Overview
75+
- Risk Inventory
76+
- Executive Summary
77+
78+
**Standard** includes everything in Basic, plus:
79+
- Exit Readiness Scoring
80+
- Detailed Exit Readiness Report
81+
- Benchmarking and trend analysis (for continuous assessments)
82+
83+
---
84+
85+
## What is a continuous assessment?
86+
87+
A continuous assessment automatically re-runs on a schedule:
88+
- daily
89+
- weekly
90+
- monthly
91+
92+
This allows you to:
93+
- track changes over time
94+
- monitor risk evolution
95+
- measure improvement or regression in readiness
96+
97+
---
98+
99+
## Can I export or download reports?
100+
101+
Yes.
102+
103+
Depending on the assessment package, you can download:
104+
- **Executive Summary** (Basic & Standard)
105+
- **Exit Readiness Report** (Standard only)
106+
107+
Reports are available as PDF files via the **Download** button on the Assessment Details page.
108+
109+
---
110+
111+
## Can I change my data region later?
112+
113+
No.
114+
115+
EU and US regions are **fully isolated**, and accounts or assessments cannot be migrated between regions.
116+
117+
Choose your data region carefully based on legal, regulatory, and contractual requirements.
118+
119+
---
120+
121+
## Is exitcloud.io vendor-neutral?
122+
123+
Yes.
124+
125+
exitcloud.io is:
126+
- cloud-provider agnostic
127+
- vendor-neutral
128+
- focused on outcomes, not tooling promotion
129+
130+
Alternative technologies are presented for analysis, not endorsement.

‎src/getting-started/create-account.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Create an Account
2+
3+
To get started with exitcloud.io, you create an account by signing in through a supported identity provider.
4+
5+
Account creation and login are handled through **secure social authentication**.
6+
7+
## Step 1: Select Data Region
8+
9+
Before signing in, select the **data region** where your account and assessment data will be hosted:
10+
11+
- 🇪🇺 European Union
12+
- 🇺🇸 United States
13+
14+
The selected region determines:
15+
- where your account is created
16+
- where all assessment data and reports are stored
17+
18+
> **Note:** The data region is selected **before login** and cannot be changed later.
19+
20+
## Step 2: Sign in
21+
22+
exitcloud.io currently supports the following sign-in methods:
23+
24+
- **Google**
25+
- **GitHub**
26+
- **Microsoft**
27+
28+
Click the provider you want to use and complete the authentication flow.
29+
30+
No separate username or password is required.

‎src/getting-started/data-region.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Data Region
2+
3+
exitcloud.io supports **regional data residency** to help meet performance and regulatory requirements.
4+
5+
You select a data region **before signing in or creating an account**.
6+
All assessment data, reports, and metadata are stored and processed **exclusively within the selected region**.
7+
8+
**How it works**
9+
10+
- The data region is selected on the **login page**
11+
- The selected region determines **where your account is created**
12+
- All future assessments and reports remain in that region
13+
14+
Once selected, the data region **cannot be changed** for that account.
15+
16+
## 🇪🇺 European Union (EU)
17+
18+
Recommended if:
19+
- your organization or customers are based in Europe
20+
- you have **GDPR** or EU data residency requirements
21+
22+
Details:
23+
- **Data residency:** European Union
24+
- **Hosting location:** Helsinki, Finland (Hetzner)
25+
- Optimized for European users
26+
27+
## 🇺🇸 United States (US)
28+
29+
Recommended if:
30+
- your organization or customers are based in the United States
31+
- you require **US-based data residency**
32+
33+
Details:
34+
- **Data residency:** United States
35+
- **Hosting location:** Ashburn, Virginia, USA (Hetzner)
36+
- Optimized for US-based users
37+
38+
**Notes**
39+
40+
- **Regions are fully isolated**
41+
EU and US environments are separate platforms with no shared data.
42+
43+
- **Region selection is permanent**
44+
Accounts and assessments **cannot be migrated** between regions.
45+
46+
- **Choose based on data residency, not convenience**
47+
For regulated environments, always select the region that matches your legal or contractual requirements.
48+
49+
If you are unsure which region to choose, select the region where your assessment data is legally required to reside.

‎src/getting-started/first-assessment.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# First Assessment
2+
3+
This guide walks you through creating and running your first cloud exit readiness assessment on exitcloud.io.
4+
5+
Assessments are created through a guided, multi-step workflow in the platform.
6+
7+
## Step 1: Add assessment details
8+
9+
Start by creating a new assessment and defining its basic parameters:
10+
11+
- **Assessment name**
12+
A human-readable name to identify the assessment.
13+
14+
- **Exit strategy**
15+
Select the exit scenario you want to evaluate, for example:
16+
- Repatriation to On-Premises
17+
- Hybrid Cloud Adoption
18+
- Migration to Alternate Cloud
19+
20+
- **Sync frequency**
21+
- **Single (one-time assessment)**
22+
Runs the assessment once and generates a point-in-time report.
23+
- **Continuous assessment**
24+
Runs the assessment automatically on a defined schedule.
25+
26+
- **Sync interval** (only for continuous assessments)
27+
- Daily
28+
- Weekly
29+
- Monthly
30+
31+
- **Description (optional)**
32+
Add context or internal notes about the assessment.
33+
34+
## Step 2: Configure cloud provider
35+
36+
Next, select the cloud service provider you want to assess:
37+
38+
- Microsoft Azure
39+
- AWS
40+
- GCP *(coming soon)*
41+
- Alibaba Cloud *(coming soon)*
42+
43+
You will then provide **read-only credentials** for the selected provider.
44+
45+
**Credential handling**
46+
47+
- Credentials are used **only** to collect cloud metadata
48+
- Read-only permissions are required
49+
- Credentials are **not stored in the platform database**
50+
- They are securely handled via an isolated secrets manager with auditing
51+
52+
The platform validates credentials and permissions before allowing you to proceed.
53+
54+
## Step 3: Select package
55+
56+
Choose the assessment package that defines the scope and outputs:
57+
58+
**Basic**
59+
- Resource Inventory
60+
- Cost Inventory
61+
- Risk Assessment
62+
- Summary Report
63+
64+
**Standard**
65+
- Everything in Basic
66+
- Exit Readiness Score
67+
- Detailed Report
68+
69+
> Package selection determines **credit usage** and available reports.
70+
71+
## Step 4: Run assessment
72+
73+
Once submitted:
74+
75+
- The assessment engine schedules the run automatically
76+
- Progress is tracked in the platform
77+
- Status updates are shown during execution
78+
- An email notification is sent when the assessment completes
79+
80+
For continuous assessments, the engine will re-run automatically based on the selected schedule.
81+
82+
## Results
83+
84+
After a successful run, you can:
85+
86+
- View results directly in the platform
87+
- Download generated reports (depending on package)
88+
- Track changes over time for continuous assessments
89+
90+
Your first assessment provides a structured baseline for understanding **cloud exit readiness** and identifying key risks and dependencies.

0 commit comments

Comments
 (0)