Skip to main content

Documentation Index

Fetch the complete documentation index at: https://qovery-feat-new-navigation.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Creating a GCP GKE Cluster

Connect Your GCP Account

Qovery needs credentials to manage resources in your GCP project. We use a secure service account approach with minimal required permissions.

Prepare Your GCP Project

1

Create or Select Project

  1. Go to Google Cloud Console
  2. Either create a new project or select an existing one
  3. Ensure billing is enabled for the project
Select or create GCP project
Use a dedicated project for Qovery to keep resources organized and costs trackable.
2

Note Your Project ID

Copy your Project ID (not the project name) from the project selector.Example: my-company-production-123456
You’ll need this Project ID in the next steps.

Generate Installation Command

1

Start Cluster Creation

  1. Go to Qovery Console
  2. Go to Clusters tab
  3. Click Create Cluster
  4. Select GCP as the cloud provider
2

Enter Project Details

  1. Enter your Project ID
  2. Click Next
Qovery will generate a secure installation command for you.
3

Copy the Command

Copy the generated command to your clipboard.The command will look like:
curl https://setup.qovery.com/create_credentials_gcp.sh | bash -s -- YOUR_PROJECT_ID qovery_role qovery-service-account
This script creates a service account with minimal required permissions.

Run Installation Script

1

Open Google Cloud Shell

  1. In Google Cloud Console, click the Cloud Shell icon (terminal icon) in the top-right
  2. Wait for Cloud Shell to initialize
  3. Ensure you’re in the correct project: gcloud config get-value project
Open Google Cloud Shell
2

Run the Command

  1. Paste the command from Qovery into Cloud Shell
  2. Press Enter
  3. The script will:
    • Enable required GCP APIs (Container, Compute, Artifact Registry, Storage, Cloud Resource Manager, Cloud Run)
    • Create a service account named qovery-service-account
    • Assign necessary IAM roles
    • Generate and download a JSON key file (key.json)
Run credential creation script
Example output:
Activating services APIs
Operation "operations/acf.p2-..." finished successfully.
...
Creating service account qovery-service-account
Created service account [qovery-service-account].
...
created key [abc123...] of type [json] as [key.json]
 Credentials configured successfully
3

Download the Key File

  1. In Cloud Shell, click the More menu (three dots)
  2. Select Download
  3. Enter the file path: key.json
  4. Save the file securely
Download key.json file from Cloud Shell
Keep this JSON key file secure! It provides access to your GCP project. Never commit it to version control.
4

Upload to Qovery

  1. Return to Qovery Console
  2. Upload the key.json file when prompted
  3. Qovery will verify the credentials
Upload credentials to Qovery Console
You can reuse these credentials for multiple clusters in the same GCP project.
Qovery requires these GCP permissions to manage your infrastructure:
  • Compute Engine: Create and manage VMs, networks, and load balancers
  • Kubernetes Engine: Create and manage GKE clusters
  • VPC Networking: Configure networks, subnets, and firewall rules
  • Service Accounts: Manage service identities for workloads
  • Cloud Storage: Store Terraform state and logs
  • Artifact Registry: Store container images
  • Cloud Run: Manage serverless deployments (optional)
The installation script automatically assigns the minimum required roles to the service account.
Yes! You can create a service account manually with custom permissions. However, ensure it has all the roles required for managing GKE, Compute Engine, and networking resources. Contact support for the minimal permissions list.
To rotate GCP credentials:
  1. In GCP Console, go to IAM & AdminService Accounts
  2. Find the qovery-service-account
  3. Click KeysAdd KeyCreate new key
  4. Choose JSON format and download
  5. Update credentials in Qovery Console
  6. Wait 24 hours, then delete the old key in GCP

Create the Cluster

1

Select GCP as Hosting Mode

Click on GCP as hosting mode and then Qovery Managed option.In the Create Cluster window enter:
  • Cluster name: enter the name of your choice for your cluster.
  • Description: enter a description to identify better your cluster.
  • Production cluster: select this option if your cluster will be used for production.
  • Region: select the geographical area in which you want your cluster to be hosted.
  • Credentials: select one of the existing cloud provider credentials or create new credentials.
To confirm, click Next.
2

Configure Network

In the Network step, select the network mode you want to enable on your cluster.If you want to manage the network layer of your cluster by yourself, you can switch VPC mode to Deploy on my existing VPC to use your own VPC instead of the one provided by Qovery.
These options can only be configured during cluster creation and cannot be modified later.

Static IP

The Static IP feature is currently only available to clusters deployed with a VPC managed by Qovery and can only be enabled at cluster creation.By default, when your cluster is created, its worker nodes are allocated public IP addresses, which are used for external communication. For improved security and control, the Static IP feature allows you to ensure that outbound traffic from your cluster uses specific IP addresses.Here is what will be deployed on your cluster:
  • Cloud Nats
  • Static IPs
  • Routers
Once set up, here is the procedure to find your static IP addresses on GCP:
  • On your GCP account, select the IP addresses service.
  • In the list you will find your static IP used by your cluster router.
If you work in a sensitive business area such as financial technology, enabling the Static IP feature can help fulfil the security requirements of some of the external services you use, therefore making it easier for you to get whitelisted by them.
3

Create and Install

In the Ready to install your cluster window, check that the services needed to install your cluster are correct.You can now press the Create and Install button.Your cluster is now displayed in your organization settings, featuring the Installing... status (orange status). Once your cluster is properly installed, its status turns to green and you will be able to deploy your applications on it.You can follow the execution of the action via the cluster status and/or by accessing the Cluster Logs

Managing your Cluster Settings

To manage the settings of an existing cluster:
1

Open Qovery Console

Open your Qovery Console.
2

Navigate to Cluster Page

On your organization overview, go on the Clusters page.
3

Access Cluster Settings

To access your cluster settings, click on your cluster card and then go on Settings tab.
Below you can find a description of each section

General

The General tab allows you to define high-level information on your cluster:
ItemDescription
Cluster NameTo edit the name of your cluster.
DescriptionTo enter or edit the description of your cluster.
Production ClusterTo enter or edit the production flag of your cluster.

Credentials

Here you can manage here the cloud provider credentials associated with your cluster. If you need to change the credentials:
  • generate a new set of credentials on your cloud provider (Procedure for GCP account)
  • create the new credential on the Qovery by opening the drop-down and selecting “New Credentials”
Once created and associated, you need to update your cluster to apply the change.

Mirroring registry

In this tab, you will see that a container registry already exist (called registry-{$UIID}). This is your cloud provider container registry used by Qovery to manage the deployment of your applications by mirroring the docker images. The credentials configured on this registry are the one used to create the cluster. But you can still update them if you prefer to manage them separately (dedicated pair of creds just to access the registry). Check this link for more information.

Network

The Network tab in your cluster settings allows you to check if the Static IP, Deploy on existing VPC features are enabled on your cluster. The enabled features cannot be changed after the creation of the cluster.