Skip to main content

Check out Port for yourself ➜ 

GCP

Loading version...

Our GCP integration allows you to import your Google Cloud resources into Port, according to your configuration. After the initial import of data, the integration will also listen to live events from Google Cloud to update data in Port in real time.

Supported resources cloudresourcemanager.googleapis.com/Projectcontainer.googleapis.com/Clustercloudfunctions.googleapis.com/CloudFunctionpubsub.googleapis.com/Topiccompute.googleapis.com/Diskpubsub.googleapis.com/Subscriptioniam.googleapis.com/ServiceAccount
Open source

Port's Google Cloud integration is open source, view the source code here.

Common use cases​

Easily fill your software catalog with data directly from your GCP Organization, for example:

  • Map all the resources in your Google Cloud Projects, including Container Clusters, Cloud Run Services, BigQuery Tables, Compute engine Autoscaler and other GCP objects.
  • Watch for Google Cloud object changes (create/update/delete) in real-time, and automatically apply the changes to your entities in Port.
  • Use relations to create complete, easily digestible views of your Google Cloud infrastructure inside Port.

How it works​

Port's Google Cloud integration can retrieve all the resources supported by the Cloud Assets API, and export them to Port as entities of existing blueprints.

The GCP integration allows you to perform extract, transform, load (ETL) on data from the Cloud Assets API into the desired software catalog data model.

Setup​

Choose one of the following installation methods: Not sure which method is right for your use case? Check the available installation methods.

First time installation

For your first deployment of the GCP exporter, we recommend starting with the Helm/scheduled installation method to perform the initial data sync. Once the initial data sync is complete, you can switch to the Terraform deployment method for real-time data sync.

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration you get after installing the GCP integration.

Default mapping configuration (click to expand)
resources:
- kind: cloudresourcemanager.googleapis.com/Project
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        blueprint: '"gcpProject"'
        title: .display_name
        properties:
          labels: .labels
- kind: container.googleapis.com/Cluster
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name
- kind: cloudfunctions.googleapis.com/CloudFunction
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name
- kind: pubsub.googleapis.com/Topic
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name
- kind: compute.googleapis.com/Disk
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name
- kind: pubsub.googleapis.com/Subscription
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name
- kind: iam.googleapis.com/ServiceAccount
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .name
        title: .name | split("/") | last
        blueprint: '"gcpCloudResource"'
        properties:
          type: .name | split("/") | .[-2]
          location: .location
          labels: .labels
        relations:
          project: .__project.name

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Mapping & examples per resource​

Use the explorer below to view the default mapping and blueprint definitions for each resource type.

Further examples​

Refer to the examples page for practical configurations and their corresponding blueprint definitions.