> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboard a GCP Account

> Onboard Google Cloud to Aviatrix PaaS

You can quickly onboard your Google Cloud Platform (GCP) account to the Aviatrix
PaaS console. This enables you to manage and monitor your GCP resources through
the PaaS console.

## Prerequisites

To onboard your GCP account, you need to have the following prerequisites:

* A Google Cloud account with a project created.
* The project's ID.
* A JSON key file for the service account with the necessary permissions to
  manage GCP resources.
  * The JSON key file must be downloaded from your GCP account. You will upload
    to the PaaS console.

If you are not certain where to find the project ID or how to create a key file,
see [Collect GCP Project Information](#collect-gcp-project-information) below
for detailed instructions.

To onboard your Google Cloud (GCP) account to the Aviatrix PaaS console, use the
following steps.

1. In the PaaS console, go to *Cloud Resources > Cloud Accounts*.

2. Click *+ Create Account* and enter a name for the account.

   This is the name that will be displayed in the Cloud Accounts list.

   <img src="https://mintcdn.com/aviatrix-14b37c43/Edj7hoOEnFtUHgGn/docs/cloud/images/gcp-onboard-dialog.png?fit=max&auto=format&n=Edj7hoOEnFtUHgGn&q=85&s=13ea72b717f307db13b01f09fe8aa07d" alt="screenshot of GCP onboarding dialog" width="497" height="495" data-path="docs/cloud/images/gcp-onboard-dialog.png" />

3. Click the *GCP* logo.

4. Enter the following information.

   | Parameter | Description |
   | - | - |
   | Project ID | Enter the ID of the Google Cloud project for this account. It is typically in the format `csp-gcp-<username>`. |
   | Project Credentials | Click *Upload* and choose the JSON file downloaded from your GCP account. |

5. Click *Next*.

   Your GCP resources are discovered. The cloud account is visible on the Cloud
   Accounts page and VPCs, subnets, and VMs can be viewed on *Cloud Resources >
   Cloud Assets*.

## Next Step

* [Onboard a VPC/VNet](../onboard-offboard/vpc-vnet-onboard)

## Collect GCP Project Information

Before you onboard your GCP account, you need to collect the following
information from your GCP project:

* Project ID

  The project ID is the unique identifier for your GCP project. It is used to
  reference the project in API calls and other operations. You can find the
  project ID on the GCP Console Welcome page or in the project settings.

  <img src="https://mintcdn.com/aviatrix-14b37c43/Edj7hoOEnFtUHgGn/docs/cloud/images/gcp-welcome-page-project-id.png?fit=max&auto=format&n=Edj7hoOEnFtUHgGn&q=85&s=c6e5a7bf5df326866834232211c5ebbf" alt="screenshot of GCP welcome page showing project ID" width="642" height="358" data-path="docs/cloud/images/gcp-welcome-page-project-id.png" />

* Project Credentials (Key File)

  The project credentials are in a JSON file that contains the service account
  key. This file is used to authenticate and authorize access to your GCP
  resources. You can create and download the key file from the GCP Console under
  *IAM & Admin > Service Accounts > Keys*.

### Create Key File Credentials in GCP

You need a JSON key file for the service account that has the necessary
permissions to manage GCP resources.

You will upload this file when onboarding your GCP account, to authenticate your
GCP account in the PaaS console.

To create a key file for your GCP project, follow these steps:

1. In the GCP Console, go to *IAM & Admin > Service Accounts*.

   <img src="https://mintcdn.com/aviatrix-14b37c43/Edj7hoOEnFtUHgGn/docs/cloud/images/gcp-path-to-service-account.png?fit=max&auto=format&n=Edj7hoOEnFtUHgGn&q=85&s=75a318ab334a432c86b917cfce3e3c9c" alt="screenshot of GCP service accounts page" width="937" height="473" data-path="docs/cloud/images/gcp-path-to-service-account.png" />

2. (Optional) Create a service account that has the necessary permissions to
   manage GCP resources.

   You do not need to create a service account if you already have one with the
   required permissions.

3. In the table, click the Email (name) for the service account you want to use.

4. Click *Keys* and then click *Add Key > Create New Key*.

   <img src="https://mintcdn.com/aviatrix-14b37c43/Edj7hoOEnFtUHgGn/docs/cloud/images/gcp-path-to-keys.png?fit=max&auto=format&n=Edj7hoOEnFtUHgGn&q=85&s=d71491cac7deaccdf7a2895096db0bb0" alt="screenshot of GCP console keys page" width="960" height="604" data-path="docs/cloud/images/gcp-path-to-keys.png" />

5. Select *JSON* as the key type and click *Create*.

   The JSON key file is downloaded to your local machine.

   Save the JSON key file securely, as it contains sensitive information that
   should not be shared publicly.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.