Skip to content

Commit 0213e59

Browse files
committed
minor adjustments to BYOC pages
1 parent 4a83e13 commit 0213e59

File tree

11 files changed

+61
-29
lines changed

11 files changed

+61
-29
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 |

docs/cloud/guides/infrastructure/01_deployment_options/byoc/01_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ doc_type: 'reference'
1111

1212
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.
1313

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.
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.
1515
1616
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).
1717

docs/cloud/guides/infrastructure/01_deployment_options/byoc/04_faq/01_aws.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,66 @@ doc_type: 'reference'
1111

1212
### Compute {#compute}
1313

14-
#### Can I create multiple services in this single EKS cluster? {#can-i-create-multiple-services-in-this-single-eks-cluster}
14+
<details>
15+
<summary>Can I create multiple services in this single EKS cluster?</summary>
1516

1617
Yes. The infrastructure only needs to be provisioned once for every AWS account and region combination.
1718

18-
### Which regions do you support for BYOC? {#which-regions-do-you-support-for-byoc}
19+
</details>
20+
21+
<details>
22+
<summary>Which regions do you support for BYOC?</summary>
1923

2024
BYOC supports the same set of [regions](/cloud/reference/supported-regions#aws-regions ) as ClickHouse Cloud.
2125

22-
#### Will there be some resource overhead? What are the resources needed to run services other than ClickHouse instances? {#will-there-be-some-resource-overhead-what-are-the-resources-needed-to-run-services-other-than-clickhouse-instances}
26+
</details>
27+
28+
<details>
29+
<summary>Will there be some resource overhead? What are the resources needed to run services other than ClickHouse instances?</summary>
2330

2431
Besides Clickhouse instances (ClickHouse servers and ClickHouse Keeper), we run services such as `clickhouse-operator`, `aws-cluster-autoscaler`, Istio etc. and our monitoring stack.
2532

26-
Currently we have 3 m5.xlarge nodes (one for each AZ) in a dedicated node group to run those workloads.
33+
Currently, we have three m5.xlarge nodes (one for each AZ) in a dedicated node group to run those workloads.
34+
35+
</details>
2736

2837
### Network and security {#network-and-security}
2938

30-
#### Can we revoke permissions set up during installation after setup is complete? {#can-we-revoke-permissions-set-up-during-installation-after-setup-is-complete}
39+
<details>
40+
<summary>Can we revoke permissions set up during installation after setup is complete?</summary>
3141

3242
This is currently not possible.
3343

34-
#### Have you considered some future security controls for ClickHouse engineers to access customer infra for troubleshooting? {#have-you-considered-some-future-security-controls-for-clickhouse-engineers-to-access-customer-infra-for-troubleshooting}
44+
</details>
45+
46+
<details>
47+
<summary>Have you considered some future security controls for ClickHouse engineers to access customer infra for troubleshooting?</summary>
3548

3649
Yes. Implementing a customer controlled mechanism where customers can approve engineers' access to the cluster is on our roadmap. At the moment, engineers must go through our internal escalation process to gain just-in-time access to the cluster. This is logged and audited by our security team.
3750

38-
#### What is the size of the VPC IP range created? {#what-is-the-size-of-the-vpc-ip-range-created}
51+
</details>
3952

40-
By default we use `10.0.0.0/16` for BYOC VPC. We recommend reserving at least /22 for potential future scaling,
53+
<details>
54+
<summary>What is the size of the VPC IP range created?</summary>
55+
56+
By default, we use `10.0.0.0/16` for BYOC VPC. We recommend reserving at least /22 for potential future scaling,
4157
but if you prefer to limit the size, it is possible to use /23 if it is likely that you will be limited
4258
to 30 server pods.
4359

44-
#### Can I decide maintenance frequency {#can-i-decide-maintenance-frequency}
60+
</details>
61+
62+
<details>
63+
<summary>Can I decide maintenance frequency?</summary>
4564

4665
Contact support to schedule maintenance windows. Please expect a minimum of a weekly update schedule.
4766

67+
</details>
68+
4869
### Uptime SLAs {#uptime-sla}
4970

50-
#### Does ClickHouse offer an uptime SLA for BYOC? {#uptime-sla-for-byoc}
71+
<details>
72+
<summary>Does ClickHouse offer an uptime SLA for BYOC?</summary>
5173

5274
No, since the data plane is hosted in the customer's cloud environment, service availability depends on resources not in ClickHouse's control. Therefore, ClickHouse does not offer a formal uptime SLA for BYOC deployments. If you have additional questions, please contact support@clickhouse.com.
75+
76+
</details>

docs/cloud/guides/infrastructure/01_deployment_options/byoc/05_observability/01_aws.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ doc_type: 'reference'
1010
import Image from '@theme/IdealImage';
1111
import byoc4 from '@site/static/images/cloud/reference/byoc-4.png';
1212
import byoc3 from '@site/static/images/cloud/reference/byoc-3.png';
13+
import DeprecatedBadge from '@theme/badges/DeprecatedBadge';
1314

1415
## Observability {#observability}
1516

@@ -48,7 +49,9 @@ https://prometheus-internal.<subdomain>.<region>.aws.clickhouse-byoc.com/query
4849

4950
#### Prometheus Integration {#prometheus-integration}
5051

51-
**DEPRECATED: ** Please use the Prometheus stack integration in the above section instead. Besides the ClickHouse Server metrics, it provides more metrics including the K8S metrics and metrics from other services.
52+
<DeprecatedBadge/>
53+
54+
Please use the Prometheus stack integration in the above section instead. Besides the ClickHouse Server metrics, it provides more metrics including the K8S metrics and metrics from other services.
5255

5356
ClickHouse Cloud provides a Prometheus endpoint that you can use to scrape metrics for monitoring. This allows for integration with tools like Grafana and Datadog for visualization.
5457

docs/cloud/guides/security/05_audit_logging/03_byoc-security-playbook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ FROM clusterAllReplicas('default',system.crash_log)
2727

2828
ClickHouse utilizes pre-created roles to enable system functions. This section assumes the customer is using AWS with CloudTrail and has access to the CloudTrail logs.
2929

30-
If an incident may be the result of a compromised role, review activities in CloudTrail and CloudWatch related to the ClickHouse IAM roles and actions. Refer to the [CloudFormation](/cloud/reference/byoc#cloudformation-iam-roles) stack or Terraform module provided as part of setup for a list of IAM roles.
30+
If an incident may be the result of a compromised role, review activities in CloudTrail and CloudWatch related to the ClickHouse IAM roles and actions. Refer to the [CloudFormation](/cloud/reference/byoc/onboarding/aws#cloudformation-iam-roles) stack or Terraform module provided as part of setup for a list of IAM roles.
3131

3232
## Unauthorized access to EKS cluster {#unauthorized-access-eks-cluster}
3333

docs/cloud/reference/01_changelog/01_changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ remains within the ClickHouse VPC. This setup is ideal for large workloads that
214214
need to comply with strict data residency requirements by ensuring all data stays
215215
within a secure customer environment.
216216

217-
- For more details, you can refer to the [documentation](/cloud/reference/byoc) for BYOC
217+
- For more details, you can refer to the [documentation](/cloud/reference/byoc/overview) for BYOC
218218
or read our [announcement blog post](https://clickhouse.com/blog/announcing-general-availability-of-clickhouse-bring-your-own-cloud-on-aws).
219219
- [Contact us](https://clickhouse.com/cloud/bring-your-own-cloud) to request access.
220220

docs/cloud/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This section acts as a reference guide for some of the more technical details of
1616
| [Architecture](/cloud/reference/architecture) | Discusses the architecture of ClickHouse Cloud, including storage, compute, administration, and security. |
1717
| [SharedMergeTree](/cloud/reference/shared-merge-tree) | Explainer on SharedMergeTree, the cloud-native replacement for the ReplicatedMergeTree and analogues. |
1818
| [Warehouses](/cloud/reference/warehouses) | Explainer on what Warehouses and compute-compute separation are in ClickHouse Cloud. |
19-
| [BYOC (Bring Your Own Cloud)](/cloud/reference/byoc)| Explainer on the Bring Your Own Cloud (BYOC) service available with ClickHouse Cloud. |
19+
| [BYOC (Bring Your Own Cloud)](/cloud/reference/byoc/overview)| Explainer on the Bring Your Own Cloud (BYOC) service available with ClickHouse Cloud. |
2020
| [Changelogs](/cloud/reference/changelogs) | Cloud Changelogs and Release Notes. |
2121
| [Cloud Compatibility](/whats-new/cloud-compatibility) | A guide to what to expect functionally and operationally in ClickHouse Cloud. |
2222
| [Supported Cloud Regions](/cloud/reference/supported-regions) | A list of the supported cloud regions for AWS, Google and Azure. |

0 commit comments

Comments
 (0)