ARB - Comitê de Arquitetura Plugin

Este plugin para Backstage fornece funcionalidades para gerenciar projetos do comitê de arquitetura (ARB).

Funcionalidades

• Listar todos os projetos apresentados e pendentes de apresentação em comitê de arquitetura (ARB)
• Criar novos projetos para apresentação
• Atualizar os projetos existentes
• Deletar os projetos

Estrutura de Dados

Cada projeto ARB possui os seguintes campos:

• Nome do projeto
• Nome do responsável
• Status do projeto (Aprovado, Reprovado, Pendente, Aprovado c/ ressalvas)
• Motivo
• Observações
• Data de apresentação
• Link da documentação
• Link da gravação do ARB
• Número do chamado
• Aprovações - Arquitetura, Infra, Segurança, FinOps, Identidades, Monitoria

Armazenamento

Todos os projetos são armazenados como arquivos JSON em um repositório no Azure Repos, com números sequenciais (1.json, 2.json, etc).

Instalação

Pré-requisitos

• Um Backstage instalado via Helm Chart em um cluster Kubernetes
• Acesso ao repositório Azure Repos para armazenamento dos projetos

Configuração do plugin dinâmico

1. Construa o plugin:

cd backstage-plugin-arb
yarn install
yarn build

2. Copie o pacote construído para o volume compartilhado do Backstage no cluster Kubernetes.

3. Configure o Backstage para carregar o plugin dinamicamente, adicionando ao app-config.yaml:

backend:
  dynamicPlugins:
    frontend:
      - package: '@internal/plugin-arb'
        path: [path-to-dynamic-plugins]/plugin-arb

4. Configure as credenciais de acesso ao Azure Repos:

arb:
  azureRepos:
    baseUrl: 'https://dev.azure.com'
    token: ${ARB_AZURE_TOKEN}
    organization: 'sua-organizacao'
    project: 'seu-projeto'
    repository: 'seu-repositorio'

5. Configure o item de menu para aparecer na sidebar (sem precisar modificar o código fonte do Backstage):

app:
  sidebar:
    items:
      - id: arb-navigation-item
        title: ARB
        to: /arb
        icon: list-alt

6. Reinicie o Backstage para carregar o plugin.

Desenvolvimento

Para executar o plugin em modo de desenvolvimento:

cd backstage-plugin-arb
yarn start

API

O plugin fornece uma API REST para interagir com os projetos ARB:

• GET /api/arb/projects - Listar todos os projetos
• GET /api/arb/projects/:id - Buscar um projeto específico
• POST /api/arb/projects - Criar um novo projeto
• PUT /api/arb/projects/:id - Atualizar um projeto
• DELETE /api/arb/projects/:id - Deletar um projeto

Licença

Apache-2.0