ClickHouse

O ClickHouse Cloud se conecta com uma chave de API criada nas configurações da sua organização. Uma chave de API pertence a exatamente uma organização, então uma chave conecta uma organização, e cada organização se conecta a um workspace uma única vez. As chaves são criptografadas antes de serem armazenadas, e o agente nunca as vê.

1. Abra o ClickHouse Cloud e vá em API Keys da sua organização.
2. Clique em New API key e escolha o papel Developer (somente leitura): o Polylane apenas lê durante a sincronização.
3. Copie tanto o key ID quanto o key secret; o segredo é mostrado apenas uma vez.
4. Cole os dois valores no Polylane.
5. O Polylane valida a chave e começa a sincronizar.

O Polylane descobre seus serviços, incluindo estado, nível, região, provedor de nuvem, versão do ClickHouse, dimensionamento de réplicas e endpoints de conexão. Os hostnames de conexão são usados para vinculação entre nuvens, então aplicações que alcançam um serviço por meio de uma variável de ambiente ficam vinculadas a ele no mapa.

O monitoramento abre uma issue quando serviços ficam degradados, com falha, parados ou parcialmente em execução; serviços ociosos e em despertar são o ciclo de vida normal de serviços com escala ociosa e continuam saudáveis. O plano de controle do ClickHouse Cloud reporta métricas como um snapshot ao vivo sem histórico, então os agentes leem os valores atuais sob demanda e os serviços não trazem gráficos de métricas.

Solução de problemas

Erro "Invalid API key"

• Tanto o key ID quanto o key secret são obrigatórios; nenhum dos dois autentica sozinho.
• Confira se a chave não foi excluída ou desativada nas configurações de chaves de API do ClickHouse Cloud.
• Chaves com validade deixam de funcionar quando expiram; crie uma chave nova e faça a rotação no Polylane.

Recursos ausentes

• O ClickHouse Cloud pode levar alguns minutos para sincronizar tudo.
• Acione um Sync manual a partir do cabeçalho da conta para atualizar.

Limites de taxa

• O ClickHouse Cloud permite 10 requisições de API a cada 10 segundos por chave. Uma chave dedicada ao Polylane evita compartilhar esse orçamento com outras ferramentas.

Desconectar

Desconecte a conta no Polylane, depois exclua a chave de API nas configurações da sua organização no ClickHouse Cloud.

Conectar o ClickHouse Cloud não precisa de navegador: o mesmo endpoint que o console chama cabe em um job de CI. Um POST autenticado cria a conexão e inicia a primeira sincronização.

Pré-requisitos

• Uma chave de API do Polylane com os escopos cloud_accounts:write e cloud_accounts:read. Veja Chaves de API e OAuth.
• O ID do seu workspace, que começa com ws_. Leia-o em GET /v1/workspaces com a mesma chave.
• Um ID e um segredo de chave de API do ClickHouse Cloud de API Keys da sua organização, criados com o papel Developer (somente leitura).

Criar a conexão

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>"
  }'

Uma chave de API pertence a exatamente uma organização, então uma chamada conecta uma organização.

A resposta lista o que foi conectado, com a primeira sincronização já em andamento. Reduzida aos dois campos que o restante do fluxo lê:

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

Uma conta que já está conectada aparece em failures em vez de accounts, então repetir a chamada nunca duplica uma conexão.

Aguardar a primeira sincronização

Consulte cada conta retornada pelo seu id até que status chegue a ready (new no registro, syncing enquanto os recursos chegam):

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

Dê um prazo ao loop para que uma conexão com falha faça o job falhar em vez de travá-lo. Quando a conta estiver ready, seus recursos estão na topologia e o Polylane já iniciou sua primeira verificação.

Desconectar pela API

Excluir a conexão interrompe todas as sincronizações e verificações e apaga as credenciais que o Polylane guardava. A chamada precisa do escopo cloud_accounts:delete:

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

Depois revogue a credencial do ClickHouse Cloud no lado do provedor, como descrito em Desconectar abaixo.