Elastic Confluence connector reference
editElastic Confluence connector reference
editThe Elastic Confluence connector is a connector for Atlassian Confluence. This connector is written in Python using the Elastic connector framework.
View the source code for this connector (branch 8.11, compatible with Elastic 8.11).
Native connector (Elastic Cloud)
editView native connector reference
Availability and prerequisites
editThis connector is available as a native connector on Elastic Cloud, as of 8.9.1.
To use this connector natively in Elastic Cloud, satisfy all native connector requirements.
Usage
editTo use this connector as a native connector, see Native connectors (managed service).
For additional operations, see Using connectors.
Compatibility
edit- Confluence Cloud or Confluence Server versions 7 or later.
- Confluence Data Center editions are not currently supported.
Configuration
editThe following configuration fields are required to set up the connector:
- Confluence data source
-
Dropdown to determine the Confluence platform type:
Confluence Cloud
orConfluence Server
. Default value isConfluence Server
. - Confluence Server username
- The username of the account for Confluence server.
- Confluence Server password
- The password of the account to be used for the Confluence server.
- Confluence Cloud account email
- The account email for Confluence Cloud.
- Confluence Cloud API token
- The API Token to authenticate with Confluence cloud.
- Confluence URL label
-
The domain where the Confluence is hosted. Examples:
-
https://192.158.1.38:8080/
-
https://test_user.atlassian.net/
-
- Confluence space keys
-
Comma-separated list of Space Keys to fetch data from Confluence server or cloud. If the value is
*
, the connector will fetch data from all spaces present in the configuredspaces
. Default value is*
. Examples:-
EC
,TP
-
*
-
- Enable SSL
-
Whether SSL verification will be enabled. Default value is
False
. - SSL certificate
-
Content of SSL certificate. Note: If
ssl_enabled
isFalse
, the value in this field is ignored. Example certificate:-----BEGIN CERTIFICATE----- MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT ... 7RhLQyWn2u00L7/9Omw= -----END CERTIFICATE-----
- Enable document level security
-
Toggle to enable document level security (DLS). Only available for Atlassian Confluence Cloud. When enabled, full syncs will fetch access control lists for each document and store them in the
_allow_access_control
field. Access control syncs will fetch users' access control lists and store them in a separate index.To access user data in Jira Administration, the account you created must be granted Product Access for Jira Administration. This access needs to be provided by an administrator from the Atlassian Admin, and the access level granted should be
Product Admin
.
Documents and syncs
editThe connector syncs the following Confluence object types:
- Pages
- Spaces
- Blog Posts
- Attachments
- Files bigger than 10 MB won’t be extracted
- Permissions are not synced by default. You must first enable DLS. Otherwise, all documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync rules
editBasic sync rules are identical for all connectors and are available by default.
This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with <basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.
Advanced sync rules examples
editExample 1: Query for indexing data that is in a particular Space with key DEV.
[ { "query": "space = DEV" } ]
Example 2: Queries for indexing data based on created
and lastmodified
time.
[ { "query": "created >= now('-5w')" }, { "query": "lastmodified < startOfYear()" } ]
Example 3: Query for indexing only given types in a Space with key SD.
[ { "query": "type in ('page', 'attachment') AND space.key = 'SD'" } ]
Syncing recently created/updated items in Confluence may be delayed when using advanced sync rules, because the search endpoint used for CQL queries returns stale results in the response. For more details refer to the following issue in the Confluence documentation.
Document level security
editDLS is only available for Atlassian Confluence Cloud.
Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. Refer to configuration on this page for how to enable DLS for this connector.
Refer to DLS in Search Applications to learn how to ingest data from a connector with DLS enabled, when building a search application. The example uses SharePoint Online as the data source, but the same steps apply to every connector.
Content Extraction
editSee Content extraction.
Known issues
editThere are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Connector client (self-managed)
editView connector client reference
Availability and prerequisites
editThis connector is available as a connector client using the Elastic connector framework. This connector client is compatible with Elastic versions 8.7.0+. To use this connector, satisfy all connector client requirements.
Usage
editSelf-manage this connector
Because this client is available as a native connector, you’ll first need to convert to a connector client in the Kibana UI. This action is irreversible. Use the Convert connector button on the right-hand side of the configuration page.
To use this connector as a connector client, see Connector clients.
For additional usage operations, see Using connectors.
Compatibility
edit- Confluence Cloud or Confluence Server versions 7 or later.
- Confluence Data Center editions are not currently supported.
Configuration
editWhen using the connector client workflow, initially these fields will use the default configuration set in the connector source code.
These are set in the get_default_configuration
function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
-
data_source
-
Dropdown to determine the Confluence platform type:
Confluence Cloud
orConfluence Server
. Default value isConfluence Server
. -
username
- The username of the account for Confluence server.
-
password
- The password of the account to be used for the Confluence server.
-
account_email
- The account email for the Confluence cloud.
-
api_token
- The API Token to authenticate with Confluence Cloud.
-
confluence_url
-
The domain where the Confluence is hosted. Examples:
-
https://192.158.1.38:8080/
-
https://test_user.atlassian.net/
-
-
spaces
-
Comma-separated list of Space Keys to fetch data from Confluence server or cloud. If the value is
*
, the connector will fetch data from all spaces present in the configuredspaces
. Default value is*
. Examples:-
EC
,TP
-
*
-
-
ssl_enabled
-
Whether SSL verification will be enabled. Default value is
False
. -
ssl_ca
-
Content of SSL certificate. Note: If
ssl_enabled
isFalse
, the value in this field is ignored. Example certificate:-----BEGIN CERTIFICATE----- MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT ... 7RhLQyWn2u00L7/9Omw= -----END CERTIFICATE-----
-
retry_count
-
The number of retry attempts after failed request to Confluence. Default value is
3
. -
concurrent_downloads
-
The number of concurrent downloads for fetching the attachment content. This speeds up the content extraction of attachments. Defaults to
50
. -
use_document_level_security
-
Toggle to enable document level security (DLS). Only available for Atlassian Confluence Cloud. When enabled, full syncs will fetch access control lists for each document and store them in the
_allow_access_control
field. Access control syncs will fetch users' access control lists and store them in a separate index.To access user data in Jira Administration, the account you created must be granted Product Access for Jira Administration. This access needs to be provided by an administrator from the Atlassian Admin, and the access level granted should be
Product Admin
. -
use_text_extraction_service
-
Toggle to enable the local text extraction service. Default value is
False
. Requires a separate deployment of the Elastic Text Extraction Service. Requires that ingest pipeline settings disable text extraction.
Deployment using Docker
editYou can deploy the Confluence connector as a self-managed connector client using Docker. Follow these instructions.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml
Remember to update the --output
argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
-
elasticsearch.host
-
elasticsearch.api_key
-
connectors
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
# When connecting to your cloud deployment you should edit the host value elasticsearch.host: http://host.docker.internal:9200 elasticsearch.api_key: <ELASTICSEARCH_API_KEY> connectors: - connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: confluence api_key: <CONNECTOR_API_KEY_FROM_KIBANA>
Using the elasticsearch.api_key
is the recommended authentication method. However, you can also use elasticsearch.username
and elasticsearch.password
to authenticate with your Elasticsearch instance.
Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:8.11.4.0 \ /app/bin/elastic-ingest \ -c /config/config.yml
Refer to DOCKER.md
in the elastic/connectors
repo for more details.
Find all available Docker images in the official registry.
Documents and syncs
editThe connector syncs the following Confluence object types:
- Pages
- Spaces
- Blog Posts
- Attachments
- Content of files bigger than 10 MB won’t be extracted.
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync rules
editBasic sync rules are identical for all connectors and are available by default.
This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with <basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.
Advanced sync rules examples
editExample 1: Query for indexing data that is in a particular Space with key DEV.
[ { "query": "space = DEV" } ]
Example 2: Queries for indexing data based on created
and lastmodified
time.
[ { "query": "created >= now('-5w')" }, { "query": "lastmodified < startOfYear()" } ]
Example 3: Query for indexing only given types in a Space with key SD.
[ { "query": "type in ('page', 'attachment') AND space.key = 'SD'" } ]
Syncing recently created/updated items in Confluence may be delayed when using advanced sync rules, because the search endpoint used for CQL queries returns stale results in the response. For more details refer to the following issue in the Confluence documentation.
Document level security
editDLS is only available for Atlassian Confluence Cloud.
Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. Refer to configuration on this page for how to enable DLS for this connector.
Refer to DLS in Search Applications to learn how to ingest data from a connector with DLS enabled, when building a search application. The example uses SharePoint Online as the data source, but the same steps apply to every connector.
Content Extraction
editSee Content extraction.
Connector client operations
editEnd-to-end testing
editThe connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To perform E2E testing for the Confluence connector, run the following command:
$ make ftest NAME=confluence
For faster tests, add the DATA_SIZE=small
flag:
make ftest NAME=confluence DATA_SIZE=small
Known issues
editThere are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.