Pular para o conteúdo

Recursos

Planos e licenciamento

O SRE Orbit tem um plano grátis com limite de tamanho e planos pagos que uma chave de licença offline libera. Aconteça o que acontecer com a licença, o SRE Orbit continua coletando e mantém os seus dados. Esta página cobre o que cada plano inclui, o que o orbit-api conta, como você obtém e aplica uma chave, e o que acontece depois de um limite.

Planos

PlanoCobreIncluiRoda em
Freeaté 250 vCPU somando todos os clustersmétricas, logs, traces, APM, dashboards, alertas, FinOps, Orbit SQL e o editor SQL nos seus bancos, monitoramento de MySQL (coleta, carga do banco por espera, chamadas, latência, erros), o arquivo no S3, SSO e papéis personalizados, usuários e clusters ilimitadosseus clusters
Enterpriseas vCPU da sua chavetudo do Free, mais Nocturne AI, as telas de statements do MySQL (o texto SQL de cada statement, sessões ao vivo, planos de EXPLAIN), reidratação do arquivo e um engenheiro dedicadoseus clusters, inclusive isolados da internet
Enterprise Cloudas vCPU da sua chavetudo do Enterprise, instalado, atualizado e com backup feito por nósa nossa nuvem

Os planos pagos custam um valor por vCPU por mês, cobrado anualmente. Peça uma cotação pelo formulário de contato com o nome da empresa e o número de vCPU.

O Free não tem teto de retenção: os seus dados ficam enquanto o seu armazenamento os guardar.

O monitoramento de bancos cobre MySQL (performance_schema). Conexões PostgreSQL funcionam no editor SQL em todos os planos; o SRE Orbit não monitora PostgreSQL. Veja docs/databases.md.

O que é medido

Uma unidade só: as vCPU dos nodes que o SRE Orbit monitora.

  • Cada node conta o seu status.capacity.cpu (o status.allocatable.cpu quando o node não informa capacidade). Um node NotReady continua contando enquanto existir.
  • O orbit-api lê os caches de nodes que ele já mantém para cada cluster que atende, a cada 5 minutos, começando cerca de 30 segundos depois de iniciar. Ele pula um cluster cujo cache ainda não encheu.
  • O orbit-api guarda um documento por dia UTC no seu diretório de dados (usage/<YYYY-MM-DD>.json): por cluster, o número de medições, a soma e o máximo delas, e a contagem de nodes. Ele guarda 400 dias.
  • O valor cobrado é a média das médias diárias dos últimos 30 dias, somada entre os clusters. Dias sem medição não contam. Um pico de nodes do autoscaler durante uma tarde quase não mexe nesse número.

Conte as suas antes de instalar:

sh
kubectl get nodes -o jsonpath='{range .items[*]}{.status.capacity.cpu}{"\n"}{end}' \  | awk '{s+=$1} END {print s " vCPU"}'

Admin > Licença mostra a mesma contagem por cluster, a média de 30 dias ao lado do limite do plano e o histórico diário.

Teste, limites e carência

Em todos os casos abaixo, a ingestão continua, os seus dados ficam e ninguém é deslogado.

SituaçãoO que acontece
Primeiros 30 dias sem chaveTeste do Enterprise sem limite de vCPU. Ele começa na primeira vez que o orbit-api roda uma versão com licenciamento, tanto em uma instalação nova quanto em uma atualização.
Free, acima de 250 vCPUTodos os recursos do Free continuam funcionando. Todo usuário do Deck vê um aviso com a média de 30 dias até uma chave entrar ou a média cair para menos de 250.
Licenciado, acima das vCPU da chaveNada muda no produto. Os administradores veem o excedente no Deck, e nós acertamos na renovação.
Chave vencidaO plano da chave continua por mais 30 dias, com um aviso para os administradores. Depois a instalação roda como Free.
Free (teste encerrado, sem chave utilizável)Três coisas desligam, listadas abaixo. Todo o resto continua rodando, inclusive as conexões de banco, o editor SQL e os coletores do MySQL.

No Free:

  • nocturne aparece com switchedOffBy: "plan" no GET /api/v1/features, as rotas dele respondem 403 plan_required, e os pods dele ficam estacionados quando o chart permite que o orbit-api os estacione.
  • As telas de statements do MySQL respondem 403 plan_required: GET /api/v1/databases/{id}/digests, GET /api/v1/databases/{id}/activity, POST /api/v1/databases/{id}/explain e POST /api/v1/databases/{id}/reveal. A página do banco no Deck continua mostrando a carga por espera, as chamadas, a latência e os erros, e mostra um aviso no lugar dos statements e das sessões. Os coletores continuam coletando, então uma chave abre essas telas sobre dados que você já tem.
  • Iniciar ou restaurar uma reidratação do arquivo responde 403 plan_required. Os dados reidratados antes continuam legíveis, e o arquivamento continua em todos os planos.

No momento em que uma chave válida entra, as três voltam.

O orbit-api guarda o início do teste, a chave do Deck e o histórico de uso no seu diretório de dados. Com components.orbit-api.persistence.enabled=false esse diretório é um emptyDir, então um pod novo começa um teste novo e um histórico vazio. Mantenha a persistência ligada em produção; ela também guarda os usuários e a trilha de auditoria.

Chaves de licença

Uma chave é uma linha que começa com SO1.: um payload JSON e uma assinatura Ed25519 sobre ele, ambos em base64url. O payload leva id, customer, plan (enterprise ou cloud), vcpu, issuedAt e expiresAt. O orbit-api verifica a assinatura offline com as chaves públicas compiladas nele. Ele nunca liga para fora.

O orbit-api recusa uma chave quando:

  • alguém mudou um caractere depois que a assinamos, ou uma chave que não temos a assinou;
  • o plano não é enterprise nem cloud, as vCPU são 0, ou o payload traz um campo desconhecido;
  • uma data cai fora de 2020-01-01 a 2200-01-01, ou a chave vence antes de ter sido emitida;
  • ela já passou de expiresAt quando um administrador a aplica.

Obter uma chave

Peça pelo formulário de contato com o nome da empresa e o número de vCPU que Admin > Licença mostra. Nós assinamos a chave offline com uma chave privada que nunca sai daqui e a enviamos de volta. Ela leva o nome da empresa, o plano, o limite de vCPU e a data de vencimento.

Aplicar uma chave no Deck

Admin > Licença, cole a chave, Aplicar. Exige settings.manage. Uma chave recusada não muda nada e diz o motivo. Remover tira a chave e a instalação volta para o teste ou para o Free.

Aplicar uma chave com o Helm

O chart recebe a chave direto nos values ou de um Secret que você gerencia:

yaml
license:
  key: ""                # SO1...., rendered into the <release>-sreorbit-license Secret
  existingSecret: ""     # or a Secret you manage
  secretKey: license-key # the key in that Secret
sh
kubectl -n sreorbit create secret generic sreorbit-license --from-literal=license-key='SO1....'helm upgrade sreorbit deploy/helm/sreorbit --reuse-values --set license.existingSecret=sreorbit-license

O orbit-api lê ORBIT_LICENSE_KEY ao iniciar. Uma chave nos values reinicia o pod pelo checksum dele; depois de alterar um Secret existente, reinicie o orbit-api. Uma chave definida pelo chart vale mais que uma aplicada no Deck, e o Deck mostra que ela veio do chart. Se o orbit-api recusa uma chave do chart, ele registra o motivo no log e ignora a chave: a instalação continua no teste ou no Free.

Auditoria

Cada chave aplicada no Deck, removida ou recusada vira um evento license.apply ou license.remove na trilha de auditoria, com keyId, plan, vcpu, customer e expiresAt. O orbit-api audita uma chave do chart uma vez por mudança, ao iniciar, com source: "chart". A trilha, os logs e as respostas da API nunca levam a chave em si.

API

RotaPermissãoO que faz
GET /api/v1/licensesettings.manageo plano em vigor, a chave (nunca o texto dela), o uso e o histórico
PUT /api/v1/licensesettings.manage{"key": "SO1...."}: verifica e aplica; 400 license_invalid ou license_expired, 409 license_from_chart
DELETE /api/v1/licensesettings.manageremove a chave aplicada no Deck

O GET /api/v1/features também traz plan (plan, state, limitVcpu, billableVcpu, over, locked e as datas do teste, da carência e do vencimento), que o Deck usa no aviso. locked lista o que o plano segura agora: nocturne, dbm e rehydration no Free, nada nos outros casos.

Atualizar uma instalação existente

O primeiro início de uma versão com licenciamento começa o teste de 30 dias, então a instalação mantém todos os recursos que usa hoje por 30 dias. Admin > Licença mostra a data de fim do teste. Aplique uma chave antes dessa data e nada muda. Sem chave, Nocturne AI, as telas de statements do MySQL e novas reidratações desligam. As conexões de banco, o editor SQL, os coletores do MySQL e todo o resto continuam rodando.