Skip to content

chore(byoc): add GCP priviledge documentation#6183

Open
bojand wants to merge 1 commit intomainfrom
bojand/byoc-gcp-priviledge
Open

chore(byoc): add GCP priviledge documentation#6183
bojand wants to merge 1 commit intomainfrom
bojand/byoc-gcp-priviledge

Conversation

@bojand
Copy link
Copy Markdown
Member

@bojand bojand commented May 8, 2026

Summary

Adds reference documentation for BYOC privilege for GCP.

Checklist

@bojand bojand requested review from a team, duanshiqiang, kostyaplis and yiyang-shao May 8, 2026 15:09
@bojand bojand requested a review from a team as a code owner May 8, 2026 15:09
@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

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

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment May 8, 2026 3:18pm
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored May 8, 2026 3:18pm
clickhouse-docs-ko Ignored Ignored May 8, 2026 3:18pm
clickhouse-docs-ru Ignored Ignored May 8, 2026 3:18pm
clickhouse-docs-zh Ignored Ignored May 8, 2026 3:18pm

Request Review

Copy link
Copy Markdown
Collaborator

@dhtclk dhtclk left a comment

Choose a reason for hiding this comment

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

Some nits on sentence casing and standardization.


Lastly, **`data-plane-mgmt`** allows a ClickHouse Cloud Control Plane component to reconcile necessary custom resources, such as `ClickHouseCluster` and the Istio Virtual Service/Gateway.

## GCP Service Accounts {#gcp-service-accounts}
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
## GCP Service Accounts {#gcp-service-accounts}
## GCP service accounts {#gcp-service-accounts}

Sentence casing

- **Storage**: Used to manage Cloud Storage buckets used for ClickHouse backups, shared state, and monitoring data.
- **IAM Role**: Manages service accounts and custom roles inside the project. This role does not grant the ability to create service account keys, bind organization policies, or touch any resources in other projects.

### Additional Service Accounts created by the controller {#additional-service-accounts-created-by-the-controller}
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
### Additional Service Accounts created by the controller {#additional-service-accounts-created-by-the-controller}
### Additional service accounts created by the controller {#additional-service-accounts-created-by-the-controller}


### Additional Service Accounts created by the controller {#additional-service-accounts-created-by-the-controller}

In addition to the `clickhouse-management` service account created via Terraform as part of onboarding; when you provision your first BYOC service, ClickHouse’s control plane (authenticating as `clickhouse-management`) creates additional service accounts in your project for specific in-cluster workloads. Each of these is created with a narrow, single-purpose permission set.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
In addition to the `clickhouse-management` service account created via Terraform as part of onboarding; when you provision your first BYOC service, ClickHouse’s control plane (authenticating as `clickhouse-management`) creates additional service accounts in your project for specific in-cluster workloads. Each of these is created with a narrow, single-purpose permission set.
In addition to the `clickhouse-management` service account created via Terraform as part of onboarding. When you provision your first BYOC service, ClickHouse’s control plane (authenticating as `clickhouse-management`) creates additional service accounts in your project for specific in-cluster workloads. Each of these is created with a narrow, single-purpose permission set.

Small nit, but semicolon is not proper grammar here.


### Bootstrap service account {#bootstrap-service-account}

The bootstrap Service Account is granted project-scoped custom roles with the following permissions:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The bootstrap Service Account is granted project-scoped custom roles with the following permissions:
The bootstrap service account is granted project-scoped custom roles with the following permissions:

Comment on lines +60 to +67
- **GKE Node Runtime Identity**
- Attached to every GKE node virtual machine in your BYOC cluster.
- Used by kubelet, node-local agents, and the Cloud Operations collectors to emit logs and metrics, and by the image pulling subsystem to download container images.
- **Billing scraper identity**
- Used by standalone scraper workload to collect billing telemetry.
- **Monitoring Identity**
- Target identity for the monitoring stack running in your cluster. Used to read/write long-term metric storage in a GCS bucket dedicated to this deployment.
- **ClickHouse runtime management identity**
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- **GKE Node Runtime Identity**
- Attached to every GKE node virtual machine in your BYOC cluster.
- Used by kubelet, node-local agents, and the Cloud Operations collectors to emit logs and metrics, and by the image pulling subsystem to download container images.
- **Billing scraper identity**
- Used by standalone scraper workload to collect billing telemetry.
- **Monitoring Identity**
- Target identity for the monitoring stack running in your cluster. Used to read/write long-term metric storage in a GCS bucket dedicated to this deployment.
- **ClickHouse runtime management identity**
- **GKE node runtime identity**
- Attached to every GKE node virtual machine in your BYOC cluster.
- Used by kubelet, node-local agents, and the Cloud Operations collectors to emit logs and metrics, and by the image pulling subsystem to download container images.
- **Billing scraper identity**
- Used by standalone scraper workload to collect billing telemetry.
- **Monitoring identity**
- Target identity for the monitoring stack running in your cluster. Used to read/write long-term metric storage in a GCS bucket dedicated to this deployment.
- **ClickHouse runtime management identity**

Use consistent sentence casing here.

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.

2 participants