Confluence Connector - Operator Manual

2 min read

Overview

This guide provides IT operators with the technical information needed to deploy, configure, and maintain the Confluence Connector.

For end-user and administrator documentation, see the Confluence Connector Overview.

Documentation

Document

Description

Deployment

Container images, Helm charts, Terraform modules, release policy

Configuration

Tenant configuration, environment variables, YAML settings

Authentication

Confluence OAuth 2.0 / PAT setup, Unique platform auth

FAQ

Frequently asked questions and common issues

Configuration Approach

The connector uses a YAML-based tenant configuration file for all settings. Each file defines exactly one tenant, with its own Confluence connection, Unique platform endpoints, processing schedule, and ingestion settings.

See Configuration Guide for details.

Architecture Overview

embedded_fdfaf70fbf9f8a5da7a0ad687c45e0d8.png

The Confluence Connector runs as a single pod that periodically scans Confluence spaces for labeled pages and synchronizes their content (and optionally file attachments, including embedded images) to the Unique knowledge base.

Cluster-Internal Deployment

When deployed within the same Kubernetes cluster as Unique services:

embedded_0c1d830b881e05c39b1c9f800575ee69.png

In cluster-internal mode, Zitadel token validation is not needed. The connector communicates with Unique services using custom request headers for company and user scope.

Infrastructure Requirements

Component

Requirement

Notes

Kubernetes

1.25+

Any Kubernetes distribution

Container Runtime

Docker / containerd

Standard container runtime

Memory

512 Mi request / 1 Gi limit

Default Helm allocation

CPU

1 core request (no limit)

Default Helm allocation

Network Requirements

Destination

Port

Protocol

Direction

api.atlassian.com

443

HTTPS

Outbound

auth.atlassian.com

443

HTTPS

Outbound

api.media.atlassian.com

443

HTTPS

Outbound

*.atlassian.net

443

HTTPS

Outbound

{data-center-host}

443

HTTPS

Outbound

Unique Ingestion Service

443 / internal

HTTPS / HTTP

Outbound / Internal

Unique Scope Management Service

443 / internal

HTTPS / HTTP

Outbound / Internal

Zitadel IdP

443

HTTPS

Outbound (external mode only)

DNS

53

UDP / TCP

Outbound

Deployment Checklist

1. Infrastructure

1incomplete Kubernetes namespace created2incomplete Network egress to Confluence instance allowed (Cloud: api.atlassian.com, auth.atlassian.com, api.media.atlassian.com, and *.atlassian.net; Data Center: your instance host)3incomplete Connectivity to Unique Ingestion Service verified4incomplete Connectivity to Unique Scope Management Service verified

2. Confluence Authentication

1incomplete OAuth 2.0 (2LO) application created in Confluence (recommended for Cloud and Data Center 10.1+), or PAT generated for Data Center versions below 10.12incomplete Client ID and client secret noted (OAuth 2.0), or PAT token noted (Data Center < 10.1)3incomplete Application configured with read access to the Confluence instance

Note: OAuth 2.0 (2LO) is the recommended authentication method. Personal Access Tokens (PATs) are not recommended and should only be used on Confluence Data Center versions below 10.1 where OAuth 2.0 (2LO) is not available.

3. Unique Platform

1incomplete Service user created with required permissions2incomplete Root scope ID obtained for ingestion (must be pre-created in Unique)3incomplete Company ID and user ID noted (for cluster-local mode), or Zitadel client credentials configured (for external mode)4incomplete Ingestion Service and Scope Management Service base URLs noted

4. Application

1incomplete Tenant configuration YAML file created with all required fields2incomplete Secrets created in Kubernetes (OAuth client secret, PAT, or Zitadel credentials)3incomplete Helm chart deployed4incomplete Confluence labels applied to pages that should be synced

5. Verification

1incomplete Connector logs show successful tenant registration2incomplete Connector logs show successful OAuth token acquisition3incomplete Labeled pages are being discovered during sync cycles4incomplete Pages and attachments appear in the Unique knowledge base
Last updated