ClickHouse

ClickHouse Cloud підключається за допомогою ключа API, створеного в налаштуваннях вашої організації. Ключ API належить рівно одній організації, тому один ключ підключає одну організацію, і кожна організація підключається до робочого простору один раз. Ключі шифруються перед збереженням, і агент ніколи їх не бачить.

1. Відкрийте ClickHouse Cloud, перейдіть до API Keys своєї організації.
2. Натисніть New API key і виберіть роль Developer (лише для читання): Polylane лише читає під час синхронізації.
3. Скопіюйте як key ID, так і key secret; секрет показується лише один раз.
4. Вставте обидва значення в Polylane.
5. Polylane перевіряє ключ і починає синхронізацію.

Polylane знаходить ваші сервіси, включно зі станом, рівнем, регіоном, хмарним провайдером, версією ClickHouse, розміром реплік і ендпоінтами підключення. Імена хостів для підключення використовуються для зв'язування між хмарами, тому застосунки, які звертаються до сервісу через змінну середовища, зв'язуються з ним на мапі.

Моніторинг створює проблему, коли сервіси перебувають у стані degraded, failed, stopped або partially running; стани idle і waking для сервісів із масштабуванням у простій є звичайним життєвим циклом і вважаються здоровими. Панель керування ClickHouse Cloud повідомляє метрики як миттєвий знімок без історії, тому агенти читають поточні значення за потреби, а сервіси не мають графіків метрик.

Усунення несправностей

Помилка "Invalid API key"

• Потрібні і key ID, і key secret; окремо жоден із них не автентифікує.
• Перевірте, чи ключ не було видалено або вимкнено в налаштуваннях ключів API ClickHouse Cloud.
• Ключі з терміном дії перестають працювати після його завершення; створіть новий ключ і замініть його в Polylane.

Відсутні ресурси

• ClickHouse Cloud може потребувати кількох хвилин, щоб синхронізувати все.
• Запустіть ручну Sync із заголовка облікового запису, щоб оновити дані.

Обмеження частоти запитів

• ClickHouse Cloud дозволяє 10 API-запитів за 10 секунд на ключ. Окремий ключ для Polylane дає змогу не ділити цей бюджет з іншими інструментами.

Відключення

Відключіть обліковий запис у Polylane, а потім видаліть ключ API в налаштуваннях організації ClickHouse Cloud.

Для підключення ClickHouse Cloud браузер не потрібен: той самий ендпоінт, який викликає консоль, вміщується в завдання CI. Один автентифікований POST створює підключення та запускає першу синхронізацію.

Передумови

• Ключ API Polylane з областями дії cloud_accounts:write і cloud_accounts:read. Див. Ключі API та OAuth.
• Ідентифікатор вашого робочого простору, який починається з ws_. Прочитайте його через GET /v1/workspaces тим самим ключем.
• Ідентифікатор і секрет ключа API ClickHouse Cloud із розділу API Keys вашої організації, створеного з роллю Developer (лише для читання).

Створення підключення

curl -X POST https://api.polylane.com/v1/cloud_accounts \
  -H "x-api-key: $POLYLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "clickhouse",
    "workspaceId": "ws_0abc123",
    "keyId": "<key-id>",
    "keySecret": "<key-secret>"
  }'

Ключ API належить рівно одній організації, тому один виклик підключає одну організацію.

Відповідь перелічує те, що було підключено, і перша синхронізація вже виконується. Скорочено до двох полів, які читає решта процесу:

{
  "success": true,
  "result": {
    "provider": "clickhouse",
    "accounts": [{ "id": "acc_34gky74ibc92h8t2efn8csrh", "status": "syncing" }],
    "failures": []
  }
}

Обліковий запис, який уже підключено, потрапляє у failures, а не в accounts, тому повторення виклику ніколи не дублює підключення.

Очікування першої синхронізації

Опитуйте кожний повернутий обліковий запис за його id, доки status не досягне ready (new після реєстрації, syncing поки надходять ресурси):

until [ "$(curl -s "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
  -H "x-api-key: $POLYLANE_API_KEY" | jq -r '.result.status')" = "ready" ]; do
  sleep 15
done

Задайте циклу кінцевий термін, щоб невдале підключення провалювало завдання замість того, щоб зависати. Щойно обліковий запис стає ready, його ресурси перебувають у топології, і Polylane розпочав свою першу перевірку.

Відключення через API

Видалення підключення зупиняє кожну синхронізацію та перевірку і видаляє облікові дані, які зберігав Polylane. Виклик потребує області дії cloud_accounts:delete:

curl -X DELETE "https://api.polylane.com/v1/cloud_accounts/$WORKSPACE_ID/$ACCOUNT_ID" \
  -H "x-api-key: $POLYLANE_API_KEY"

Потім відкличте облікові дані ClickHouse Cloud на боці провайдера, як описано в розділі Відключення нижче.