Quick Start Guide - Databricks Connector for Confluence¶

This guide helps you quickly set up and start using the Databricks Connector for Confluence. It's designed for users who are familiar with Databricks administration and want to embed Databricks dashboards in Confluence.

In this guide we'll do the following¶

Install the app
Configure Databricks to allow embedding dashboards from Atlassian products
Test embedding a Databricks dashboard in a Confluence page
Frequently Asked Questions (FAQs)

Prerequisites¶

Before you begin, ensure you have:

Confluence Cloud Administrator permissions
Databricks Administrator access with permissions to manage embedding settings
An active Confluence Cloud space with page creation permissions
A published Databricks dashboard that you want to embed

Step 1. Installation¶

Install Databricks Connector for Confluence on the Atlassian Marketplace on your desired Confluence instance.
Once installed, you can find Databricks Connector for Confluence in the top-level Apps menu, under Manage apps.
The app does not require any admin configurations.

Step 2. Configure Databricks to allow embedding dashboards from Atlassian products¶

To enable dashboard embedding in your Atlassian Cloud instance, you must configure the Databricks console to allow specific Atlassian domains. Follow these steps:

Navigate to the Databricks console.
Go to Settings and select the Security page under the Workspace admin section in the sidebar.
In the External access section, add the following Atlassian domains (including subdomains) to the approved domains for external access:
- [your-subdomain].atlassian.net
- *.prod.atlassian-dev.net
The configured settings should be similar as shown below:

For detailed instructions, refer to Manage dashboard embedding in the Databricks documentation.

Information

The Databricks Connector app is built with Atlassian Forge technology. The app is served by Atlassian from a subdomain under http://prod.atlassian-dev.net that is both random and unique. Therefore, the https://prod.atlassian-dev.net domain and its subdomains need to be added to the Databricks allow list so that the Content Security Policy (CSP) as set by Databricks will allow the embed code to function.

Step 3. Test embedding a Databricks dashboard in a Confluence page¶

The app does not require any global or space level configuration. You can start embedding Databricks dashboards once you've finished the above steps. Let's give it a try.

Information

You can only embed a published Databricks dashboard. See Databricks Documentation for more details on embedding dashboards.

Get the embed code from Databricks.

Open a published dashboard, then click Share:

Then click Embed dashboard in the Sharing dialog:

Then click Copy embed code:
Create a new Confluence page or start editing a page. Type /databricks into the page editor and Confluence should prompt you with the Databricks macro, select to proceed:
Hover over the inserted and click edit to bring up the config panel for the macro, where you can enter the embed code from Databricks and optionally specify the height of the dashboard.

Frequently Asked Questions (FAQs)¶

FAQ-1. Why can't I see the embedded dashboards?¶

Common issues and solutions:

Domain Access Issues
- Verify that Atlassian Cloud domains are added to Databricks' Approved Domains
- Check for any typos in the domain names
- Ensure you've included both required domains
Dashboard Sharing Settings
- Confirm the dashboard is published
- Verify the dashboard's sharing settings allow public viewing
- Check if any authentication requirements are blocking access
Browser Issues
- Clear your browser cache
- Check if any browser extensions are blocking the embed
- Ensure third-party cookies are enabled if required

For additional assistance, consult the Databricks Documentation on embedding dashboards.