Справочник по подключению Elastic Box

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

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

Чтобы создать новый коннектор Box:

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

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

Например:

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-box-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Box",
  "service_type": "box",
  "is_native": true
}

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

Для использования этого коннектора в качестве самостоятельно управляемого коннектора используйте плитку Box из списка коннекторов ИЛИ рабочий процесс Настроенного коннектора.

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

Создайте пользовательскую авторизацию Box (OAuth 2.0) приложение

Вам необходимо создать приложение OAuth в консоли разработчиков Box, выполнив следующие действия:

Сгенерировать токен обновления

Чтобы сгенерировать токен обновления, выполните следующие действия:

Создайте серверную авторизацию Box (разрешение на предоставление учетных данных клиента) пользовательское приложение

Обратитесь к Извлечение содержимого.

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

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

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

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

Расширенные правила синхронизации недоступны для этого коннектора в текущей версии.

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

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

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

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

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

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

Например:

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-box-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Box",
  "service_type": "box"
}

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

Для использования этого коннектора как самоуправляемого коннектора, используйте плитку Box из списка коннекторов ИЛИ рабочий процесс Настроенный коннектор.

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

Создайте пользовательскую аутентификацию Box (OAuth 2.0) приложения

Вам нужно создать приложение OAuth в консоли разработчиков Box, выполнив следующие шаги:

Генерация токена обновления

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

Создайте серверную аутентификацию Box (присвоение полномочий клиенту) пользовательское приложение

Вы можете развернуть коннектор Box как самоуправляемый коннектор с помощью 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: box
    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 образы в официальном репозитории.

Обратитесь к Извлечение содержимого.

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

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

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

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

Расширенные правила синхронизации недоступны для этого коннектора в текущей версии.

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

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

$ make ftest NAME=box

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

make ftest NAME=box DATA_SIZE=small

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

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

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