Skip to content

Quick Start Guide - Kibana Cloud Connector for Confluence

The following is intended to be a quick start for those familiar with managing Kibana Cloud and are looking to quickly deploy Kibana Cloud Connector for Confluence.

Information

This app only supports Kibana Cloud and can embed contents only from the *.elastic-cloud.com and *.found.io domains to ensure security under Atlassian Marketplace app egress rules. For embedding contents from custom domains, please contact [email protected] for assistance.

Prerequisites

  1. Confluence Admin permission to install the app
  2. Administrative permission on Kibana Cloud to manage embedded content authentication
  3. An active Confluence Cloud space where you can create pages

Step 1. Installation

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

Step 2. Configure Kibana Cloud to allow embedding dashboards from Atlassian products

To embed dashboards from Kibana Cloud in your Atlassian Cloud instance, you must enable embedded content authentication through the Kibana Cloud console. Follow these instructions (see also Embedded content authentication) and set xpack.security.sameSiteCookies: "None".

  1. Go to your Elastic cloud deployment from the home screen and click Manage:

    Kibana Configuration, Manage Deployment

  2. Click Kibana from the side bar under the deployment, then find the Kibana Cloud instance you want to modify and select Edit Configuration from the drop-down menu:

    Kibana Configuration, Edit Configuration

  3. This should open up the deployment Edit page and locate the Kibana section, where you can then click Edit user settings:

    Kibana Configuration, Edit user settings

  4. In the User Settings model, enter xpack.security.sameSiteCookies. The configured settings should be similar as shown below:

    Kibana Configuration, Enable sameSiteCookies in user settings

  5. Click "Back" button and make sure you click the save button on the main Edit page of the deployment for the changes to take effect. Wait for the Elastic cloud to complete restarting your Kibana Cloud deployment before proceeding to the next step.

Anonymous access

Warning

  1. Before enabling anonymous access, review Anonymous authentication in the Kibana Guide to understand the security implications.

  2. User account credentials depend on your authentication setup. In most cases, you can add a native user for this purpose - see Managing native users in the Elasticsearch Guide. The user should be assigned the built-in viewer role for read-only access to all Kibana features and data indices. See Built-in Roles in the Elasticsearch Guide for more details.

If you want to enable anonymous users to access the embedded contents, add the following to the user settings and replace the credentials with a designated user account to be used for anonymous users:

xpack.security.sameSiteCookies: "None"
xpack.security.authc.providers:
   anonymous.anonymous1:
      order: 0
      credentials:
         username: "<anonymous_username>"
         password: "<anonymous_password>"

Step 3. Test embedding a Kibana Cloud dashboard in a Confluence page

The app requires no global or space-level configuration. You can start embedding Kibana dashboards once you've completed the above steps. Let's try it out.

  1. Get the embed code from Kibana.

    Open a dashboard, then click Share from the top menu bar of the dashboard:

    Share Kibana dashboard

    Then click Embed tab in the Share this dashboard dialog, and click Copy embed code button:

    Embed Kibana dashboards

  2. Create a new Confluence page or start editing a page. Type /kibana into the page editor and Confluence should prompt you with the Kibana macro, select to proceed:

    Inserting Kibana Macro

  3. Hover over the inserted and click edit to bring up the config panel for the marco, where you can enter the embed code from Kibana Cloud and optionally specify the height of the dashboard.

    Configuring Kibana Macro

Frequently Asked Questions (FAQs)

Why can't I see the embedded dashboards?

There are several possible reasons:

  1. Kibana Cloud security configuration is not correctly set to allow embedded contents on Confluence. Review Step 2 above and check the Kibana Documentation for details on embedding dashboards.

  2. You are not logged in to Kibana Cloud. When prompted, follow the instructions to log in with your Kibana Cloud account. Available login options depend on your Kibana/Elastic Cloud admin settings.

  3. You are using a self-managed or open-source Kibana instance with a domain other than *.elastic-cloud.com. This app only supports Kibana Cloud and can embed contents only from the *.elastic-cloud.com domain. For custom domain support, contact [email protected].

References