Skip to content

Commit 4e9935d

Browse files
authored
Merge pull request #4595 from ClickHouse/restructure-byoc-documentation
Restructure BYOC documentation
2 parents 62c7c3d + dfb1cea commit 4e9935d

File tree

18 files changed

+334
-249
lines changed

18 files changed

+334
-249
lines changed

docs/cloud/features/04_infrastructure/deployment-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Learn more about [ClickHouse Cloud](/getting-started/quick-start/cloud).
2424

2525
ClickHouse Bring Your Own Cloud (BYOC) allows organizations to deploy and manage ClickHouse within their own cloud environment while leveraging a managed service layer. This option bridges the gap between the fully managed experience of ClickHouse Cloud and the complete control of self-managed deployments. With ClickHouse BYOC, users retain control over their data, infrastructure, and security policies, meeting specific compliance and regulatory requirements, while offloading operational tasks like patching, monitoring, and scaling to the ClickHouse. This model offers the flexibility of a private cloud deployment with the benefits of a managed service, making it suitable for large-scale deployments at enterprises with stringent security, governance, and data residency needs.
2626

27-
Learn more about [Bring Your Own Cloud](/cloud/reference/byoc).
27+
Learn more about [Bring Your Own Cloud](/cloud/reference/byoc/overview).
2828

2929
## ClickHouse Private {#clickhouse-private}
3030

docs/cloud/guides/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ doc_type: 'landing-page'
1010
| Page | Description |
1111
|-----|-----|
1212
| [Accessing S3 data securely](/cloud/data-sources/secure-s3) | This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely. |
13+
| [Architecture](/cloud/reference/byoc/architecture) | Deploy ClickHouse on your own cloud infrastructure |
1314
| [AWS PrivateLink](/manage/security/aws-privatelink) | This document describes how to connect to ClickHouse Cloud using AWS PrivateLink. |
1415
| [Azure Private Link](/cloud/security/azure-privatelink) | How to set up Azure Private Link |
15-
| [BYOC (Bring Your Own Cloud) for AWS](/cloud/reference/byoc) | Deploy ClickHouse on your own cloud infrastructure |
16+
| [BYOC on AWS FAQ](/cloud/reference/byoc/faq/aws) | Deploy ClickHouse on your own cloud infrastructure |
17+
| [BYOC on AWS Observability](/cloud/reference/byoc/observability) | Deploy ClickHouse on your own cloud infrastructure |
18+
| [BYOC Onboarding for AWS](/cloud/reference/byoc/onboarding/aws) | Deploy ClickHouse on your own cloud infrastructure |
1619
| [BYOC security playbook](/cloud/security/audit-logging/byoc-security-playbook) | This page illustrates methods customers can use to identify potential security events |
1720
| [ClickHouse Government](/cloud/infrastructure/clickhouse-government) | Overview of ClickHouse Government offering |
1821
| [ClickHouse Private](/cloud/infrastructure/clickhouse-private) | Overview of ClickHouse Private offering |
@@ -24,13 +27,14 @@ doc_type: 'landing-page'
2427
| [Data masking in ClickHouse](/cloud/guides/data-masking) | A guide to data masking in ClickHouse |
2528
| [Database audit log](/cloud/security/audit-logging/database-audit-log) | This page describes how users can review the database audit log |
2629
| [Gather your connection details](/cloud/guides/sql-console/gather-connection-details) | Gather your connection details |
27-
| [GCP Private Service Connect](/manage/security/gcp-private-service-connect) | This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists. |
30+
| [GCP private service connect](/manage/security/gcp-private-service-connect) | This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists. |
2831
| [HIPAA onboarding](/cloud/security/compliance/hipaa-onboarding) | Learn more about how to onboard to HIPAA compliant services |
2932
| [Manage cloud users](/cloud/security/manage-cloud-users) | This page describes how administrators can add users, manage assignments, and remove users |
3033
| [Manage database users](/cloud/security/manage-database-users) | This page describes how administrators can add database users, manage assignments, and remove database users |
3134
| [Manage my account](/cloud/security/manage-my-account) | This page describes how users can accept invitations, manage MFA settings, and reset passwords |
3235
| [Manage SQL console role assignments](/cloud/guides/sql-console/manage-sql-console-role-assignments) | Guide showing how to manage SQL console role assignments |
3336
| [Multi tenancy](/cloud/bestpractices/multi-tenancy) | Best practices to implement multi tenancy |
37+
| [Overview](/cloud/reference/byoc/overview) | Deploy ClickHouse on your own cloud infrastructure |
3438
| [PCI onboarding](/cloud/security/compliance/pci-onboarding) | Learn more about how to onboard to PCI compliant services |
3539
| [Query API Endpoints](/cloud/get-started/query-endpoints) | Easily spin up REST API endpoints from your saved queries |
3640
| [SAML SSO setup](/cloud/security/saml-setup) | How to set up SAML SSO with ClickHouse Cloud |
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: 'Overview'
3+
slug: /cloud/reference/byoc/overview
4+
sidebar_label: 'Overview'
5+
keywords: ['BYOC', 'cloud', 'bring your own cloud']
6+
description: 'Deploy ClickHouse on your own cloud infrastructure'
7+
doc_type: 'reference'
8+
---
9+
10+
## Overview {#overview}
11+
12+
BYOC (Bring Your Own Cloud) allows you to deploy ClickHouse Cloud on your own cloud infrastructure. This is useful if you have specific requirements or constraints that prevent you from using the ClickHouse Cloud managed service.
13+
14+
> **If you would like access, please [contact us](https://clickhouse.com/cloud/bring-your-own-cloud).** Refer to our [Terms of Service](https://clickhouse.com/legal/agreements/terms-of-service) for additional information.
15+
16+
BYOC is currently only supported for AWS. You can join the wait list for GCP and Azure [here](https://clickhouse.com/cloud/bring-your-own-cloud).
17+
18+
:::note
19+
BYOC is designed specifically for large-scale deployments, and requires customers to sign a committed contract.
20+
:::
21+
22+
## Glossary {#glossary}
23+
24+
- **ClickHouse VPC:** The VPC owned by ClickHouse Cloud.
25+
- **Customer BYOC VPC:** The VPC, owned by the customer's cloud account, is provisioned and managed by ClickHouse Cloud and dedicated to a ClickHouse Cloud BYOC deployment.
26+
- **Customer VPC** Other VPCs owned by the customer cloud account used for applications that need to connect to the Customer BYOC VPC.
27+
28+
## Features {#features}
29+
30+
### Supported features {#supported-features}
31+
32+
- **SharedMergeTree**: ClickHouse Cloud and BYOC use the same binary and configuration. Therefore all features from ClickHouse core are supported in BYOC such as SharedMergeTree.
33+
- **Console access for managing service state**:
34+
- Supports operations such as start, stop, and terminate.
35+
- View services and status.
36+
- **Backup and restore.**
37+
- **Manual vertical and horizontal scaling.**
38+
- **Idling.**
39+
- **Warehouses**: Compute-Compute Separation
40+
- **Zero Trust Network via Tailscale.**
41+
- **Monitoring**:
42+
- The Cloud console includes built-in health dashboards for monitoring service health.
43+
- Prometheus scraping for centralized monitoring with Prometheus, Grafana, and Datadog. See the [Prometheus documentation](/integrations/prometheus) for setup instructions.
44+
- **VPC Peering.**
45+
- **Integrations**: See the full list on [this page](/integrations).
46+
- **Secure S3.**
47+
- **[AWS PrivateLink](https://aws.amazon.com/privatelink/).**
48+
49+
### Planned features (currently unsupported) {#planned-features-currently-unsupported}
50+
51+
- [AWS KMS](https://aws.amazon.com/kms/) aka CMEK (customer-managed encryption keys)
52+
- ClickPipes for ingest
53+
- Autoscaling
54+
- MySQL interface
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 'Architecture'
3+
slug: /cloud/reference/byoc/architecture
4+
sidebar_label: 'Architecture'
5+
keywords: ['BYOC', 'cloud', 'bring your own cloud']
6+
description: 'Deploy ClickHouse on your own cloud infrastructure'
7+
doc_type: 'reference'
8+
---
9+
10+
import Image from '@theme/IdealImage';
11+
import byoc1 from '@site/static/images/cloud/reference/byoc-1.png';
12+
13+
## Architecture {#architecture}
14+
15+
Metrics and logs are stored within the customer's BYOC VPC. Logs are currently stored in locally in EBS. In a future update, logs will be stored in LogHouse, which is a ClickHouse service in the customer's BYOC VPC. Metrics are implemented via a Prometheus and Thanos stack stored locally in the customer's BYOC VPC.
16+
17+
<br />
18+
19+
<Image img={byoc1} size="lg" alt="BYOC Architecture" background='black'/>
20+
21+
<br />

0 commit comments

Comments
 (0)