Справочник по соединителю Elastic Confluence

Этот соединитель доступен в качестве управляемого соединения в Elastic Cloud, начиная с версии 8.9.1.

Чтобы использовать этот соединитель напрямую в Elastic Cloud, выполните все требования к управляемым соединениям.

Чтобы создать новое соединение с Confluence:

Дополнительные операции см. в Пользовательском интерфейсе соединителей в Kibana.

Вы можете использовать Elasticsearch API для создания соединения, чтобы создать новое родное соединение с Confluence.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
    is_native=True,
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
  is_native: true,
});
console.log(response);

PUT _connector/my-confluence-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Confluence",
  "service_type": "confluence",
  "is_native": true
}

Подробные сведения обо всех доступных API соединений см. в документации Elasticsearch API.

Чтобы использовать этот соединитель как управляемое соединение, см. Управляемые соединения Elastic .

Дополнительные операции см. в Пользовательском интерфейсе соединителей в Kibana.

Для настройки соединения необходимы следующие поля конфигурации:

Соединитель синхронизирует следующие типы объектов Confluence:

Полные синхронизации поддерживаются по умолчанию для всех соединителей.

Этот соединитель также поддерживает инкрементные синхронизации.

Основные правила синхронизации одинаковы для всех соединителей и доступны по умолчанию.

Этот соединитель поддерживает расширенные правила синхронизации для удаленного фильтра. Эти правила охватывают сложные сценарии запросов и фильтрации, которые не могут быть выражены с помощью <основных правил синхронизации. Расширенные правила синхронизации определяются с помощью специфичного для источника фрагмента DSL JSON.

Пример 1: Запрос для индексирования данных, находящихся в определенном пространстве с ключом DEV.

[
  {
    "query": "space = DEV"
  }
]

Пример 2: Запросы для индексирования данных на основе created и lastmodified времени.

[
  {
    "query": "created >= now('-5w')"
  },
  {
    "query": "lastmodified < startOfYear()"
  }
]

Пример 3: Запрос для индексирования только заданных типов в пространстве с ключом SD.

[
  {
    "query": "type in ('page', 'attachment') AND space.key = 'SD'"
  }
]

Безопасность на уровне документа (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Обратитесь к настройке на этой странице, чтобы узнать, как включить DLS для этого коннектора.

См. Извлечение содержимого.

В настоящее время для этого коннектора нет известных проблем. Обратитесь к Известные проблемы для получения списка известных проблем для всех коннекторов.

См. Устранение неполадок.

См. Безопасность.

Этот коннектор доступен в качестве самостоятельно управляемого коннектора с использованием фреймворка коннекторов Elastic. Этот самостоятельно управляемый коннектор совместим с версиями Elastic 8.7.0+.

Для использования этого коннектора, выполните все требования к самостоятельно управляемым коннекторам.

Для создания нового коннектора Confluence:

Вы можете использовать Elasticsearch API для создания коннекторов для создания нового самостоятельно управляемого коннектора Confluence.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
});
console.log(response);

PUT _connector/my-confluence-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Confluence",
  "service_type": "confluence"
}

Подробные сведения обо всех доступных API-интерфейсах коннекторов см. в документации API Elasticsearch.

Для использования этого коннектора как самостоятельно управляемого коннектора, см. Самостоятельно управляемые коннекторы. Дополнительные операции по использованию см. в Интерфейсе коннекторов в Kibana.

Для настройки коннектора требуются следующие поля:

Вы можете развернуть коннектор Confluence как самостоятельно управляемый коннектор с помощью Docker. Следуйте этим инструкциям.

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# 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> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.17.3 \
/app/bin/elastic-ingest \
-c /config/config.yml

См. DOCKER.md в репозитории elastic/connectors для получения более подробной информации.

Найдите все доступные образы Docker в официальном репозитории.

Коннектор синхронизирует следующие типы объектов Confluence:

Полные синхронизации поддерживаются по умолчанию для всех коннекторов.

Этот коннектор также поддерживает инкрементные синхронизации.

Основные правила синхронизации одинаковы для всех коннекторов и доступны по умолчанию.

Этот коннектор поддерживает расширенные правила синхронизации для удаленного фильтра. Эти правила охватывают сложные сценарии запроса и фильтрации, которые нельзя выразить с помощью <основных правил синхронизации. Расширенные правила синхронизации определяются с помощью фрагмента JSON DSL, специфичного для источника.

Пример 1: Запрос для индексирования данных, находящихся в конкретном пространстве с ключом DEV.

[
  {
    "query": "space = DEV"
  }
]

Пример 2: Запросы для индексирования данных на основе created и lastmodified времени.

[
  {
    "query": "created >= now('-5w')"
  },
  {
    "query": "lastmodified < startOfYear()"
  }
]

Пример 3: Запрос для индексирования только заданных типов в пространстве с ключом SD.

[
  {
    "query": "type in ('page', 'attachment') AND space.key = 'SD'"
  }
]

Безопасность на уровне документа (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Обратитесь к настройкам на этой странице, чтобы узнать, как включить DLS для этого коннектора.

См. Извлечение содержимого.

Фреймворк коннектора позволяет операторам запускать функциональные тесты с использованием реального источника данных. См. Тестирование коннекторов для получения дополнительных сведений.

Для выполнения конечного тестирования коннектора Confluence выполните следующую команду:

$ make ftest NAME=confluence

Для более быстрых тестов добавьте флаг DATA_SIZE=small:

make ftest NAME=confluence DATA_SIZE=small

В настоящее время для этого коннектора нет известных проблем. См. Известные проблемы для списка известных проблем для всех коннекторов.

См. Поиск решения проблем.

См. Безопасность.