Inteligência
Developer Portal
Catálogo de serviços com dono, scorecards com evidência, golden paths e adoção do portal, com a leitura pela API v1 e pela CLI.
#O que faz
Catálogo de serviços, documentação, padrões de engenharia e autosserviço.
| Funcionalidade | O que faz | Na área logada |
|---|---|---|
| Engineering standards | Inventário, blueprint, padrões e score de engenharia acompanhados com a equipe AIUBY. | /plataforma/inventario |
| Service catalog | Serviços, sistemas, APIs e donos (time ou pessoa) sobre o grafo de entrega, com lifecycle, tier, links e o descritor aiuby.yaml lido do repositório (só leitura). | /plataforma/portal |
| Scorecards | Regras declarativas (dono, runbook, SLO, achados críticos, dependências, rollout progressivo, CI) avaliadas sobre o grafo: nota por serviço e por time, histórico semanal e a evidência de cada regra. | /plataforma/portal/scorecards |
| Self-service | Golden paths: templates com parâmetros tipados geram arquivos por substituição de texto (nada é executado), para baixar em zip ou patch, ou como proposta que vira PR em rascunho pelo Code Automation após a aprovação de outra pessoa. Ambiente sob pedido, que dispara pipeline, fica com os blueprints das extensões do portal. | /plataforma/portal/templates |
| Portal adoption | Quanto do catálogo está preenchido (dono, descritor, repositório, lifecycle), quantos serviços têm nota e quanto os golden paths são usados, com a série das últimas 12 semanas. Só contagens do que o portal guarda: não mede visita de tela nem mostra número por pessoa. | /plataforma/portal/adocao |
| Portal extensions | Regras de agregação entre fontes, blueprints de ambiente com custo previsto, pedido de ambiente com quatro olhos que dispara o pipeline, plugins por HTTPS e tipos de entidade próprios. | /plataforma/portal/extensoes |
#Como ativar
- Na área logada: o dono adiciona o Cortex em Produtos (veja Produtos e conta pré-paga). As telas ficam no menu do produto.
- Pela API v1 e pela CLI: a organização precisa do Cortex ativo, de conta de faturamento válida e de uma chave de API ligada ao workspace, com o escopo da rota.
- Os padrões de engenharia acompanhados com a equipe AIUBY fazem parte do Core, contratado à parte.
Nota
Produto da plataforma não ativo ou módulo não liberado para a organização: a API v1 responde
404 not_found, como se a rota não existisse. Sem conta de faturamento válida: 402. Veja API v1.#Primeiro uso
Descreva o serviço no repositório
Umaiuby.yamlno repositório conectado dá nome, dono, sistema, lifecycle e links ao serviço. A AIUBY só lê o arquivo.Leia o catálogo e as notas
bash curl "https://aiuby.com/api/v1/engineering/portal/services?lifecycle=production" -H "Authorization: Bearer $AIUBY_TOKEN" aiuby catalog list --lifecycle production aiuby catalog get checkout aiuby scorecard checkout aiuby portal adoption
#Rotas da API
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/portal/services | Ler a engenharia (API v1) engineering:read | Catálogo do Developer Portal | aiuby catalog list |
GET /api/v1/engineering/portal/services/{id} | Ler a engenharia (API v1) engineering:read | Serviço e notas dos scorecards | aiuby catalog get <id> |
GET /api/v1/engineering/portal/scorecards | Ler a engenharia (API v1) engineering:read | Scorecards | aiuby scorecards list |
GET /api/v1/engineering/portal/scorecards/{id} | Ler a engenharia (API v1) engineering:read | Relatório de um scorecard | aiuby scorecards get <id> |
GET /api/v1/engineering/portal/adoption | Ler a engenharia (API v1) engineering:read | Adoção do Developer Portal | aiuby portal adoption |
O grafo por trás do catálogo também se lê pela API: GET /api/v1/engineering/catalog, /entities/{id}, /events e POST /api/v1/engineering/query. Veja a referência.
#O que ainda não existe
- Cadastrar serviço, scorecard ou template pela API: a v1 só lê.
- Rodar golden path por chave: a geração é na tela e não executa nada (só substitui texto).
- Contar visita de tela ou mostrar número por pessoa na adoção.