Prerequisites for Wizard-Based Deployment on GCP

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

✅ Enterprise: GCP

1. Overview

This section describes the prerequisites and system requirements you must meet before manually creating Kyvos resources on Google Cloud Platform (GCP). Before creating the Kyvos resources, ensure that the following prerequisites are in place.

2. Deployment Prerequisites at a Glance

Prerequisite	Required?	When is it required?

Prerequisite	Required?	When is it required?
System resources (RAM/CPU/disk per node)	Yes	Before creating Kyvos resources — Analytical Server & Query Engine nodes need min 32 GB RAM/4 CPU cores; Kyvos Manager node needs min 200 GB free install space; Query Engine nodes need min 500 GB hard disk
Non-sudo user account with common credentials	Yes	Before installation, across all nodes in the Kyvos cluster
Required directories (`/data/kyvos/app`, `/data/kyvos/install`)	Yes	Before installation, on all nodes; set with 750 permissions, owned by the Kyvos user
Required packages (OpenSSL, zip, fontconfig)	Yes	Before installation — OpenSSL on Kyvos Manager node; zip and fontconfig on all nodes
Port availability check	Yes	Before deployment, to ensure required ports are open and configured
Semantic Model local path directory	Yes	Before deployment, on Query Engine nodes; 750 permissions, owned by Kyvos user
Single installation script downloaded	Yes	Before deployment, to auto-install prerequisites on all nodes
gcloud CLI installed	Yes	On VM instances used for all operations involving GCP bucket.
GCP service account for launching instances	Yes	Before deployment — needed to launch Kyvos instances
Secret Manager permissions/secrets configured	Yes	Before GCP deployment
VM Cloud API access scope set to "full access"	Yes	During VM configuration, in the API and Identity Management section
VM permissions for password-based auth	Conditional	Only if deploying the cluster using password-based authentication for service nodes
Install PostgreSQL 16 manually (`configure-postgres16.sh`)	Conditional	Only if using PostgreSQL 16 as an installed service (run on Kyvos Manager node with sudo/root)
`secretmanager.secrets.list` permission on service account	Conditional	Required to list Secret Manager secrets on the following: Replication Configuration page Wizard

On this page:

1 1. Overview
2 2. Deployment Prerequisites at a Glance
3 3. Install PostgreSQL 16
4 4. Secret Manager Requirements
5 5. VM Configuration Requirements
6 6. Other Prerequisites and Permissions
7 7. Common Prerequisites for Kyvos Enterprise Deployments
8 8. Kyvos Single Script to Install and Configure the Wizard-Based Prerequisites

Read prerequisites:

Next Step:

Deploying Kyvos Resources on GCP through Kyvos Manager

3. Install PostgreSQL 16

For a wizard-based deployment using PostgreSQL 16 as an installed service, complete these manual steps before starting the deployment.

Install the PostgreSQL 16 Service Manually install PostgreSQL 16 on the Kyvos Manager (KM) node by executing the Kyvos-provided configure-postgres16.sh script (available in the GCP installation files).
- Execute this script using a root user.
Update JDBC Properties Before starting Kyvos Manager, update the jdbc.properties file and set installedRepo to true.

4. Secret Manager Requirements

To create a secret, the logged in user must be assigned the Secret Manager Admin role (roles/secretmanager.admin) at the project level.
Go to IAM & Admin > Roles > Create new role. Enter a name such as secret-manager-role, and assign the following permissions:
- secretmanager.versions.access
- secretmanager.versions.add
To create secrets for the GCP deployment, see Creating Secret for Google Cloud Platform Cluster for the required Secret Manager permissions.
The secretmanager.secrets.list permission must be assigned to the existing service account. This is required to list Secret Manager secrets on the Replication Configuration page in Kyvos Manager.

5. VM Configuration Requirements

In the API and Identity Management section of the VM configuration, set Cloud API access scopes to "Allow full access to all Cloud APIs."

6. Other Prerequisites and Permissions

After completing the wizard-based Kyvos deployment prerequisites, see the Common Prerequisites for Kyvos Deployment on GCP section and complete the listed prerequisites and permissions.

7. Common Prerequisites for Kyvos Enterprise Deployments

Complete the prerequisites common to Kyvos Enterprise deployments. See the Common Prerequisites for Kyvos Enterprise Deployment section.

8. Kyvos Single Script to Install and Configure the Wizard-Based Prerequisites

Download the deployment script to install and configure the prerequisites required before running a wizard-based Kyvos deployment, using a single unified script.

See the Common Prerequisites for Kyvos Enterprise Deployment section.