Skip to main content

Check out Port for yourselfย 

Installation

This page details how to install Port's Bitbucket Cloud integration (powered by the Ocean framework). It outlines the following steps:

  • How to create a workspace token/app password to give the integration permissions to query your Bitbucket Cloud account.
  • How to configure and customize the integration before deploying it.
  • How to deploy the integration in the configuration that fits your use case.

Prerequisitesโ€‹

  • A Bitbucket Cloud account with admin privileges to the workspace you want to ingest data from.
  • If you choose the real time & always on installation method, you will need a kubernetes cluster on which to install the integration.
  • Your Port user role is set to Admin.

Setupโ€‹

Create a workspace token or app passwordโ€‹

Use of dedicated accounts and tokens

We recommend using workspace tokens from accounts dedicated to the integration, as this will provide a more secure and scalable solution.

Different credentials from the same Bitbucket account share the same rate limits, which can cause issues when using the integration in a large organization. Using dedicated workspace tokens helps manage rate limits more effectively.

The integration requires either a workspace token or an app password with username to authenticate with your Bitbucket Cloud account. You can create a workspace token by following the steps here or an app password by following these steps.

The token or app password should have read permission scope for each of the supported resources you want to ingest into Port and a read and write permission scope for the webhooks.

We recommend using workspace tokens when possible, as they provide better security and are easier to manage than app passwords.

BaseUrl & listening to hooksโ€‹

tip

The baseUrl parameter is used specifically to enable the real-time functionality of the integration.

If it is not provided, the integration will continue to function correctly. In such a configuration, to retrieve the latest information from the target system, the scheduledResyncInterval parameter has to be set, or a manual resync will need to be triggered through Port's UI.

In order for the Bitbucket Cloud integration to update the data in Port on every change in the Bitbucket Cloud repository, you need to specify the baseUrl parameter. The baseUrl parameter should be set to the url of your Bitbucket Cloud integration instance. The webhookSecret parameter should also be set to a string of your choice so that the integration can verify the webhook requests.

Deploy the integrationโ€‹

Choose one of the following installation methods:

Using this installation option means that the integration will be hosted by Port, with a customizable resync interval to ingest data into Port.

Live event support

This integration supports live events, allowing real-time updates to your software catalog without waiting for the next scheduled sync.

Supported live event triggers

Repository:

  • repository:created
  • repository:updated
  • repository:push

Pull Request:

  • pullrequest:created
  • pullrequest:updated
  • pullrequest:approved
  • pullrequest:unapproved
  • pullrequest:fulfilled
  • pullrequest:rejected
Self-hosted installation

Alternatively, you can install the integration using the Real-time (self-hosted) method to update Port in real time using webhooks.

Installation

To install, follow these steps:

  1. Go to the Data sources page of your portal.

  2. Click on the + Data source button in the top-right corner.

  3. Click on the relevant integration in the list.

  4. Under Select your installation method, choose Hosted by Port.

  5. Configure the integration settings and application settings as you wish (see below for details).

Application settings

Every integration hosted by Port has the following customizable application settings, which are configurable after installation:

  • Resync interval: The frequency at which Port will ingest data from the integration. There are various options available, ranging from every 1 hour to once a day.

  • Send raw data examples: A boolean toggle (enabled by default). If enabled, raw data examples will be sent from the integration to Port. These examples are used when testing your mapping configuration, they allow you to run your jq expressions against real data and see the results.

Integration settings

Every integration has its own tool-specific settings, under the Integration settings section.
Each of these settings has an โ“˜ icon next to it, which you can hover over to see a description of the setting.

Port secrets

Some integration settings require sensitive pieces of data, such as tokens.
For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.

When filling in such a setting, its value will be obscured (shown as โ€ขโ€ขโ€ขโ€ขโ€ขโ€ขโ€ขโ€ข).
For each such setting, Port will automatically create a secret in your organization.

To see all secrets in your organization, follow these steps.

Limitations

  • The maximum time for a full sync to run is based on the configured resync interval. For very large amounts of data where a resync operation is expected to take longer, please use a longer interval.

Port source IP addresses

When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses.
You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:

54.73.167.226  
63.33.143.237
54.76.185.219