Last updated Sep 6, 2021

Rate this page:

Integrate Compass with Bitbucket Cloud

What is Bitbucket Cloud?

Bitbucket Cloud is a Git-based code hosting and collaboration tool, built for teams. Compass currently supports Bitbucket Cloud as a tool to manage your components. You can integrate Compass with Bitbucket Cloud to sync data from Bitbucket to Compass and automate component management via an external tool.

We’ll show you how to integrate Compass with Bitbucket by installing and configuring the Bitbucket Cloud app in Compass.

Integrate Compass with Bitbucket Cloud

To integrate Compass with Bitbucket Cloud, you must first install the Bitbucket app in Compass. Then, you connect Compass to your Bitbucket workspace that contains the repositories from where you want to manage the component.

Before you begin

Ensure that you are an admin on:

  • the Bitbucket workspace that you want to connect with Compass
  • your Compass instance

You can connect only one Bitbucket workspace per Compass instance.

Perform the integration

To integrate Compass with Bitbucket Cloud:

  1. In Compass, select Apps from the top navigation bar.
  2. On the Bitbucket tile, select Install. The Bitbucket app installs.
  3. On the Bitbucket tile, select Configure.
  4. If not already done, authorize the Bitbucket app to access Compass on your behalf. Select Allow access and follow the on-screen instructions.
    • This step appears only once on your Compass instance for each app you install. So, if you've already authorized the Bitbucket app before, proceed to the next step.
  5. Select Connect to Bitbucket.
  6. The Authorize for workspace list displays the workspaces that you are an admin of. Select a workspace to connect with Compass.
  7. Select Grant Access.

Now you can manage components from the repositories within the connected Bitbucket workspace by setting up configuration as code (config-as-code) for your components. Learn how to manage components via config-as-code

Disconnect the Bitbucket workspace connected with Compass

Compass’s integration with a Bitbucket workspace lets you manage your components with configuration as code (config-as-code) by using Bitbucket as a component management tool. However, if you want to configure a different workspace or no longer want to use config-as-code, you can disconnect your current Bitbucket workspace from Compass.

We'll show you how to disconnect a Bitbucket workspace from Compass.

Before you begin

Ensure that you are an admin on:

  • the Bitbucket workspace that is connected with Compass
  • your Compass instance

Once you disconnect a Bitbucket workspace, any managed components in Compass are disconnected and will no longer be synced with Bitbucket. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.

Disconnect the workspace

To disconnect a Bitbucket workspace from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. On the Bitbucket tile, select Disconnect workspace.
  3. On the Disconnect workspace dialog, select Go to Bitbucket app management. We’ll take you to the Bitbucket workspace settings in Bitbucket.
  4. On the Manage installed apps screen, from the categories list, select All categories.
  5. Select Compass integration for Bitbucket, then Remove and confirm your action. The Compass Integration for Bitbucket app disconnects from Bitbucket.
  6. Go back to Compass and refresh the Apps page to verify that the Bitbucket workspace is no longer connected with Compass.

Now you can manage the components previously managed via config-as-code from the Compass UI. You can also configure a different Bitbucket workspace. Learn how to integrate Compass with Bitbucket Cloud and configure a workspace.

Uninstall the Bitbucket Cloud app from Compass

If you no longer wish to use Bitbucket as a component management tool, you can uninstall the Bitbucket app from Compass.

We'll show you how to uninstall the Bitbucket Cloud app.

Before you begin

Once you uninstall the Bitbucket Cloud app, any managed components in Compass are disconnected and will no longer be synced with Bitbucket. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.

Uninstall the Bitbucket Cloud app

To uninstall the Bitbucket workspace from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Disconnect the Bitbucket workspace connected with Compass, if you’ve not already done so.
  3. On the Bitbucket tile, select Uninstall app. The Bitbucket Cloud app uninstalls from Compass.

Now you can manage components via the Compass UI. At any time, you can again integrate Compass with Bitbucket Cloud to set up config-as-code for component management.

Rate this page: