Skip to content

feat(doc): fold Azure into standard onboarding & make BYO-VPC self-service#6371

Merged
Blargian merged 4 commits into
mainfrom
6370-byoc-azure-self-onboarding-flow-change
Jun 12, 2026
Merged

feat(doc): fold Azure into standard onboarding & make BYO-VPC self-service#6371
Blargian merged 4 commits into
mainfrom
6370-byoc-azure-self-onboarding-flow-change

Conversation

@luisliuchao

@luisliuchao luisliuchao commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the BYOC onboarding docs to reflect the Azure self-onboarding flow change. Azure now follows the same self-service console flow as AWS and GCP, rather than a separate manual/private-preview process.

Azure onboarding

  • Removed the standalone Azure Private Preview onboarding page (05_azure_private_preview.md) and its link from the autogenerated guides index.
  • Folded Azure into the Standard onboarding page — generalized provider language (AWS account / GCP project / Azure subscription), VPC/VNet, EKS/GKE/AKS, IAM roles/managed identities. Added the Azure Terraform module to the account-setup step from the removed page.
  • Added Azure mentions to Architecture (account/subscription mixing) and Deploying additional infrastructure (new region/account/subscription).

GCP customized (BYO-VPC) setup

  • Replaced the manual "Contact ClickHouse support" provisioning step with the self-service "Set up BYOC infrastructure" console flow, matching the AWS page.
  • Added a screenshot of the GCP existing-VPC setup UI (byoc-gcp-existing-vpc-ui.png).
  • Kept a highlighted :::info/:::note callout for the secondary-IPv4-range / contact-support edge case.

Consistency & formatting

  • Aligned AWS customization wording with the GCP flow ("Set up Infrastructure", "VPC configuration").
  • Normalized frontmatter quote style, table formatting, and a couple of sidebar_label/label casings across BYOC reference pages.
  • Refreshed several BYOC onboarding screenshots.

🤖 Generated with Claude Code


Note

Low Risk
Documentation and formatting only; no application code, auth, or data-path changes.

Overview
Documents now describe Azure BYOC using the same self-service Standard onboarding path as AWS and GCP: the dedicated Azure Private Preview page is removed from the guides index, and standard onboarding covers Azure subscriptions, VNet/AKS, and the Azure Terraform module alongside existing AWS/GCP steps. Architecture and additional infrastructure pages are updated for Azure subscription mixing and multi-account deployment.

GCP BYO-VPC customization no longer ends with a support ticket; it documents the console Set up BYOC infrastructure flow (aligned with AWS), including a new existing-VPC UI screenshot. Minor consistency edits cover UI labels, VPC/VNet CIDR minimum (/23), sidebar casing, network-security table/formatting, and a new .prettierrc for quote/trailing-comma style.

Reviewed by Cursor Bugbot for commit f21fe6a. Bugbot is set up for automated code reviews on this repo. Configure here.

@luisliuchao luisliuchao requested a review from a team as a code owner June 11, 2026 08:37
@luisliuchao luisliuchao linked an issue Jun 11, 2026 that may be closed by this pull request
@vercel

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview Jun 11, 2026 1:54pm
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jun 11, 2026 1:54pm
clickhouse-docs-ko Ignored Ignored Preview Jun 11, 2026 1:54pm
clickhouse-docs-ru Ignored Ignored Preview Jun 11, 2026 1:54pm
clickhouse-docs-zh Ignored Ignored Preview Jun 11, 2026 1:54pm

Request Review

@CLAassistant

CLAassistant commented Jun 11, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Blargian
❌ luisliuchao
You have signed the CLA already but the status is still pending? Let us recheck it.

@luisliuchao luisliuchao force-pushed the 6370-byoc-azure-self-onboarding-flow-change branch 2 times, most recently from b6b6ea2 to 4b9e06c Compare June 11, 2026 08:54
@luisliuchao luisliuchao self-assigned this Jun 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates ClickHouse Cloud BYOC documentation to reflect Azure moving into the standard self-service onboarding flow and to make GCP BYO‑VPC provisioning self-service via the console, aligning wording/UI steps across providers.

Changes:

  • Removes the standalone Azure Private Preview onboarding page and drops it from the (en) guides index.
  • Updates Standard onboarding / Architecture / Additional infrastructure docs with multi-cloud terminology (AWS/GCP/Azure).
  • Reworks GCP customized (BYO‑VPC) onboarding to document the console “Set up Infrastructure” flow and adds a new screenshot; aligns AWS customized wording.

Reviewed changes

Copilot reviewed 9 out of 16 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
docs/cloud/guides/infrastructure/01_deployment_options/byoc/08_reference/03_network_security.md Frontmatter/table formatting tweaks; small structural changes to section labels.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/05_azure_private_preview.md Removes the Azure Private Preview page.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/04_setup_a_new_region.md Updates frontmatter + Azure subscription mention; adjusts stepper content.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/02_gcp.md Replaces support-ticket provisioning step with self-service console flow + new UI image.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/01_aws.md Aligns wording/casing with GCP flow; edits list formatting.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/category.json Adjusts category label casing.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/01_standard.md Generalizes standard onboarding language for Azure and adds Azure Terraform module link.
docs/cloud/guides/infrastructure/01_deployment_options/byoc/02_architecture.md Generalizes architecture language to include Azure; formatting adjustments.
docs/cloud/guides/index.md Removes the Azure Private Preview row from the autogenerated (en) guides index.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/cloud/guides/infrastructure/01_deployment_options/byoc/02_architecture.md Outdated
Comment thread docs/cloud/guides/index.md
@luisliuchao luisliuchao force-pushed the 6370-byoc-azure-self-onboarding-flow-change branch 2 times, most recently from 49d6757 to 1597b01 Compare June 11, 2026 09:17
@luisliuchao luisliuchao requested a review from Copilot June 11, 2026 09:25
@luisliuchao luisliuchao force-pushed the 6370-byoc-azure-self-onboarding-flow-change branch from 1597b01 to 767f9e2 Compare June 11, 2026 09:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 16 changed files in this pull request and generated 6 comments.

Comment thread docs/cloud/guides/infrastructure/01_deployment_options/byoc/02_architecture.md Outdated
Comment thread docs/cloud/guides/index.md
@Blargian

Copy link
Copy Markdown
Member

Hi @luisliuchao let me know if you're ready to merge this? I can push some small formatting fixes to get the Vercel and DocsChecks green.

@luisliuchao luisliuchao force-pushed the 6370-byoc-azure-self-onboarding-flow-change branch from 767f9e2 to 0a92146 Compare June 11, 2026 09:47
@luisliuchao luisliuchao requested a review from Copilot June 11, 2026 09:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 16 changed files in this pull request and generated 9 comments.

Comment thread docs/cloud/guides/infrastructure/01_deployment_options/byoc/02_architecture.md Outdated
@luisliuchao luisliuchao force-pushed the 6370-byoc-azure-self-onboarding-flow-change branch from 0a92146 to e742aa3 Compare June 11, 2026 10:09
@luisliuchao

Copy link
Copy Markdown
Contributor Author

@Blargian yes, it's ready for merge now

@Blargian Blargian merged commit 3e4f665 into main Jun 12, 2026
18 checks passed
@Blargian

Copy link
Copy Markdown
Member

@yiyang-shao, @luisliuchao BYOC docs are quite difficult to find currently. As part of the move to the new docs platform we will move these docs higher up in the navigation: https://private-7c7dfe99.mintlify.app/products/cloud/getting-started/cloud-get-started

I will sync across all the changes to the new platform

@luisliuchao luisliuchao changed the title BYOC: fold Azure into standard onboarding & make BYO-VPC self-service feat(doc): fold Azure into standard onboarding & make BYO-VPC self-service Jun 12, 2026
@mintlify

mintlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#190

Folded Azure BYOC into standard onboarding flow, made BYO-VPC self-service for GCP, and removed the separate Azure private preview page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BYOC Azure self-onboarding flow change

5 participants