Skip to content

Commit 55d7a6a

Browse files
committed
docs: Explanation of the Cube Cloud Region
1 parent 3386fb7 commit 55d7a6a

File tree

2 files changed

+52
-2
lines changed

2 files changed

+52
-2
lines changed

docs/pages/product/deployment/cloud/byoc/aws/privatelink.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To enable proper hostname resolution, create a private Route 53 hosted zone:
6969

7070
<InfoBox>
7171

72-
The `<byoc-region>` placeholder in the domain name should be replaced with the exact region identifier provided by Cube Cloud support. This is **not** the standard AWS region name (like `us-east-1`), but rather a Cube Cloud-specific identifier that uniquely identifies your BYOC infrastructure provisioning.
72+
The `<byoc-region>` placeholder in the domain name should be replaced with the exact region identifier provided by Cube Cloud support. This is **not** the standard AWS region name (like `us-east-1`), but rather a Cube Cloud-specific identifier that uniquely identifies your BYOC infrastructure provisioned.
7373

7474
For example, if Cube Cloud provides you with a region identifier like `aws-us-east-1-t-12345-prod`, you would use that exact string in place of `<byoc-region>`.
7575

docs/pages/product/deployment/cloud/infrastructure.mdx

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Dedicated infrastructure with CSPS is available in Cube Cloud on the
9797

9898
## BYOC
9999

100-
With [Bring Your Own Cloud](/product/deployment/cloud/byoc) (BYOC) all the components interacting with private data are deployed on the customer infrastructure
100+
With [Bring Your Own Cloud](/product/deployment/cloud/byoc) (BYOC) all the components interacting with private data are deployed on the customer infrastructure
101101
on a platform of choice (AWS/Azure/GCP) and managed by the Cube Cloud Control Plane via the Cube Cloud Operator.
102102

103103
<SuccessBox>
@@ -116,4 +116,54 @@ BYOC is available in Cube Cloud on the
116116
/>
117117
</div>
118118

119+
## Understanding "Cube Cloud Region"
120+
121+
Throughout Cube documentation and when interacting with Cube staff, you may encounter the term **"Cube Cloud Region"** or simply **"Region"**. Understanding this term is crucial for properly configuring and managing your Cube deployments.
122+
123+
### What is a Cube Cloud Region?
124+
125+
A **Cube Cloud Region** refers to a specific cloud infrastructure instance used to host your Cube deployments. While it includes a geographical location component, it encompasses much more than just a physical data center location.
126+
127+
Each Cube Cloud Region is identified by a unique identifier that contains several components:
128+
- **Cloud provider** (AWS, GCP, or Azure)
129+
- **Geographical region** (e.g., us-east-1, eu-west-1)
130+
- **Infrastructure type** (shared, dedicated, or BYOC)
131+
- **Tenant identifier** (for dedicated infrastructure)
132+
- **Environment** (e.g., prod, staging)
133+
134+
For example, a region identifier might look like:
135+
- `aws-us-east-1-shared` for shared infrastructure in AWS US East
136+
- `aws-us-east-1-t-12345-prod` for dedicated infrastructure with tenant ID 12345
137+
- `gcp-europe-west1-t-12345-byoc` for a BYOC deployment in GCP Europe
138+
139+
Each region also has a human-readable display name that's visible in the Cube Cloud UI. For dedicated infrastructure regions, these display names typically include the customer name and/or environment name (e.g., "Acme Corp Production (N. Virginia)" or "Acme Corp Staging (Iowa)") to help distinguish between different infrastructure instances.
140+
141+
<Screenshot src="https://lgo0ecceic.ucarecd.net/01212311-b1c5-48ce-80a2-06a923fe4eac/" />
142+
143+
### Not to be confused with...
144+
145+
The term "Cube Cloud Region" should **not** be confused with:
146+
147+
- **Cloud provider regions alone** (like AWS `us-east-1`) - A Cube Cloud Region includes but is not limited to the underlying cloud provider region
148+
- **Geographical regions** - While geography is a component, the Cube Cloud Region encompasses infrastructure type and tenant isolation as well
149+
- **Availability zones** - These are subdivisions within cloud provider regions and are handled transparently by Cube Cloud
150+
151+
### Why this matters
152+
153+
Understanding your Cube Cloud Region is important for:
154+
155+
1. **API endpoints**: Your deployment's API endpoints include the region identifier (e.g., `<deployment-id>.<region>.cubecloudapp.dev`)
156+
2. **Network configuration**: When setting up VPC peering, PrivateLink, or custom domains, you'll need the exact region identifier
157+
3. **Support requests**: Providing the correct region identifier helps Cube support team quickly locate and assist with your deployment
158+
4. **Infrastructure planning**: Different region types offer different capabilities (e.g., PrivateLink is only available in dedicated and BYOC regions)
159+
160+
### Finding your region identifier
161+
162+
You can find your Cube Cloud Region identifier in:
163+
- The Cube Cloud UI deployment settings
164+
- API endpoint URLs provided in the deployment overview
165+
- Communication from Cube Cloud support when your infrastructure is provisioned
166+
167+
When in doubt, contact Cube Cloud support with your deployment ID, and they can provide the exact region identifier for your infrastructure.
168+
119169
[ref-dedicated-vpc]: /product/deployment/cloud/vpc

0 commit comments

Comments
 (0)