Prerequisites for Automated Deployment on GCP
This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here. |
|---|
1. Overview
Before deploying Kyvos on Google Cloud Platform (GCP), make sure the required GCP account access, IAM permissions, network configuration, infrastructure, and deployment tools are available.
2. Deployment Prerequisites at a Glance
Complete the following prerequisites before starting the Kyvos deployment.
Prerequisite | Required? | When is it required? |
|---|---|---|
GCP account and base permissions | Yes | All deployments |
Kyvos service account / IAM configuration | Yes | All deployments using an existing service account |
VPC and subnet configuration | Yes | All deployments using an existing VPC |
Firewall rules | Yes | All deployments |
Terraform and | Yes | When Terraform is run from a local machine |
BigQuery permissions | Optional | Cross-project BigQuery integration |
CMK/BYOK configuration | Optional | When customer-managed encryption is enabled |
Cloud SQL configuration | Optional | When using GCP Cloud SQL |
Dedicated Compute Cluster configuration | Optional | When using a Dedicated Compute Cluster |
Node Scaling permissions | Optional | GCP Enterprise deployments using Node Scaling |
Load Balancer configuration | Optional | When configuring a Load Balancer after deployment |
On this page:
Read prerequisites:
Next step:
3. Running Terraform from Local Machine
This section outlines the prerequisites and tools required on a local machine to run Terraform scripts for deploying Kyvos resources on Google Cloud Platform (GCP).
3.1 Requirement Overview
Requirement | Description | Reference |
|---|---|---|
Terraform | Download and install Terraform on your local machine. | |
jq | Ensure that | — |
GCP Account & CLI | Ensure you have a GCP account with the necessary permissions to create and manage resources, and configure gcloud on your local machine. |
3.2 Verification Steps
Tool | Verification Command | Expected Result |
|---|---|---|
Terraform |
| Confirms Terraform is installed and initialized successfully |
jq |
| Displays the installed jq version |
GCP CLI |
| Confirms gcloud is configured and authenticated |
Note
Ensure all three prerequisites are completed before proceeding to deploy Kyvos resources on GCP using Terraform.
4. GCP Account and User Permissions
The user performing the deployment must have a valid Google Cloud account with permissions to create and manage GCP resources.
The account is also used to authenticate Terraform and provision the required GCP resources.
4.1 Required predefined roles
Assign the following roles to the deployment user (logged-in user):
Requirement | Roles / Permissions | Purpose |
|---|---|---|
Deployment User Roles |
| Required for creating and managing GCP resources during deployment. |
Custom IAM Role |
| Required to create and configure the required IAM policies and roles. |
5. Other Prerequisites and Permissions
After completing the Terraform-based Kyvos deployment prerequisites, see the Common Prerequisites for Kyvos Deployment on GCP section and complete the listed prerequisites and permissions.
6. Common Prerequisites for Kyvos Enterprise Deployments
Complete the prerequisites common to Kyvos Enterprise deployments. See the Common Prerequisites for Kyvos Enterprise Deployment section.