Porter runs on a Kubernetes cluster in your own Google Cloud account. You can provision a cluster through Porter by providing the credentials of a GCP service account.

Quick Installation uses Owner permissions to set up Porter. You can optionally specify the minimum IAM policies for provisioning both a cluster and registry.

Prerequisites

Enabling GCP APIs

To use Porter on GCP, you must first enable some APIs on your project.

  1. Navigate to the APIs & Services tab of your project.

APIs and services

  1. Click on the Enable APIs and Services button at the top. This will bring up a catalog of APIs that you can enable on GCP. Enable the following four APIs:
  • Compute Engine API
  • Kubernetes Engine API
  • Cloud Resource Manager API
  • Container Registry API
  • Artifact Registry API

It might take a few minutes for each of these APIs to be enabled. Once you can confirm that all five APIs are enabled from the APIs & Services tab, proceed to the next section.

Creating a Service Account

  1. First, go to your Google Cloud console and navigate to IAM & Admin -> Service Accounts:

Service accounts

  1. Select Create Service Account:

Create service account

  1. After naming your service account, grant the service account these four permissions:
  • Cloud Storage > Storage Admin
  • Compute Engine > Compute Admin
  • Kubernetes Engine > Kubernetes Engine Admin
  • Service Accounts > Service Account User
  • Artifact Registry > Artifact Registry Administrator

Select Done to create the service account.

Create service account confirmation

  1. Once the service account has been created, under Actions select Manage keys.

Manage keys

  1. Select ADD KEY -> Create new key and then choose JSON as your key type. After creation, your JSON key will automatically be downloaded as a file. You will need this key later.

Download JSON

Provisioning a cluster

  1. Select “GCP” from the cloud providers:

Select GCP

  1. Click “Drop a GCP Service Account JSON here, or click to browse.” and upload the JSON key file from the Prerequisites step, then click “Continue”:

Upload GCP Service Account

  1. Select the region that you would like to provision in, then click “Provision”

  2. Before you are able to provision a cluster you must pass all provision checks. Troubleshooting steps will be shown on the dashboard if you encounter these errors.

Provision

After clicking Provision from Porter, installation will begin automatically.

Deleting Provisioned Resources

Deleting resources on GCP via Porter may result in dangling resources. After clicking delete, please make sure to check your GCP console to see if all resources have properly been removed. You can remove any dangling resources via either the GCP console or the gcloud CLI.

We recommend that you delete all provisioned resources through Porter as well as confirm resources have been deleted from the GCP console. This will ensure that you do not get charged on GCP for lingering resources.

To delete resources, click on Additional Settings from the Infrastructure tab.

Click Delete Cluster to remove the cluster from Porter and delete resources in your GCP console. It may take up to 30 minutes for these resources to be deleted from your GCP console.

Cluster settings