GTER54 - Do Git ao Router

Projeto de automação de rede demonstrando um pipeline completo desde o Git até o deployment em roteadores, apresentado no GTER54.

📋 Visão Geral

Este projeto demonstra práticas modernas de NetDevOps integrando:

• NetBox como Network Source of Truth (NSOT)
• Git para controle de versão e triggers de CI/CD
• Gitea Actions para automação de pipeline
• ContainerLab com dispositivos Nokia SR Linux para digital twin
• NUTS (Network Unit Testing System) para validação automatizada

🏗️ Arquitetura

NetBox → feature → development → main
           ↓           ↓           ↓
        Commit    CI Validation  CD - Deploy
                  (Digital Twin) (Production)

Topologia de Rede

• 3 dispositivos PE (Provider Edge) Nokia SR Linux
• Topologia OSPF
• Testes automatizados de interfaces, conectividade ICMP e neighbors OSPF

🚀 Pré-requisitos

• Sistema operacional: Linux (recomendado Ubuntu/Debian)
• Docker e Docker Compose
• Acesso root ou sudo para ContainerLab

📦 Instalação

1. Instalar NetBox via Docker

NetBox serve como a fonte da verdade (Network Source of Truth) para o projeto. A forma mais simples de instalar é usando o netbox-docker.

# Clonar o repositório netbox-docker
git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker

# Criar arquivo de configuração
tee docker-compose.override.yml <<EOF
version: '3.4'
services:
  netbox:
    ports:
      - 8000:8080
EOF

# Iniciar o NetBox
docker compose pull
docker compose up -d

# Criar superusuário (após containers iniciarem)
docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser

Acesse o NetBox em: http://localhost:8000

Documentação oficial: https://github.com/netbox-community/netbox-docker

2. Instalar ContainerLab

ContainerLab é necessário para criar e gerenciar o ambiente de digital twin com dispositivos de rede.

# Download e instalação do ContainerLab
bash -c "$(curl -sL https://get.containerlab.dev)"

# Verificar instalação
containerlab version

Documentação oficial: https://containerlab.dev/install/

3. Instalar UV (Python Package Manager)

UV é um gerenciador de pacotes Python moderno e rápido, usado para gerenciar as dependências do projeto.

# Instalação via curl
curl -LsSf https://astral.sh/uv/install.sh | sh

# Ou via pip
pip install uv

# Verificar instalação
uv --version

Documentação oficial: https://docs.astral.sh/uv/

4. Clonar o Repositório

git clone https://github.com/wsdoprado/gter54.git
cd gter54

5. Instalar Dependências Python

# Criar ambiente virtual e instalar dependências
uv venv .venv
source .venv/bin/activate
uv sync

🔧 Configuração

NetBox

1. Configure o NetBox com os dispositivos PE1, PE2, PE3
2. Configure os templates de configuração para SR Linux
3. Configure as interfaces e endereços IP conforme a topologia
4. Adicione o Script Python do data-source e adicione os dados do GITEA no generate_intended.py

Gitea

1. Configure o repositório no Gitea
2. Configure o Gitea Actions runner com acesso privilegiado ao Docker

Docker Compose (para Gitea Runner)

Exemplo de configuração para o runner com acesso ao ContainerLab:

services:
  runner:
    image: gitea/act_runner:latest
    privileged: true
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/data
    environment:
      - GITEA_INSTANCE_URL=http://gitea:3000
      - GITEA_RUNNER_REGISTRATION_TOKEN=${REGISTRATION_TOKEN}

🧪 Executando os Testes

Localmente

# Deploy da topologia ContainerLab
sudo containerlab deploy -t topology.yml

# Executar testes NUTS
uv run pytest tests/

# Destruir a topologia
sudo containerlab destroy -t topology.yml

Via CI/CD Pipeline

O pipeline é acionado automaticamente:

• feature → development: Pull Request aciona pipeline de validação
• development → main: Merge aciona pipeline de deploy

📂 Estrutura do Projeto

gter54/
├── .gitea/
│   └── workflows/
│       └── ci.yml           # Pipeline CI/CD
├── configs/                  # Configurações geradas do NetBox
│   ├── pe1.conf
│   ├── pe2.conf
│   └── pe3.conf
├── tests/                    # Testes NUTS
│   ├── test_interfaces.yml
│   ├── test_icmp.yml
│   └── test_ospf.yml
├── topology.yml              # Topologia ContainerLab
├── pyproject.toml           # Dependências Python
└── README.md

🔄 Workflow de Desenvolvimento

1. Feature Branch: NetBox gera configurações e cria commit na branch feature
2. Pull Request: Abre PR de feature → development
3. Validação: Pipeline executa testes no digital twin (ContainerLab)
4. Merge to Development: Após validação, merge para development
5. Deploy: Merge de development → main aciona deploy para produção

🧩 Componentes Principais

NUTS (Network Unit Testing System)

Framework de testes para dispositivos de rede que valida:

• Configuração de interfaces
• Conectividade ICMP
• Adjacências OSPF
• Estado operacional dos dispositivos

ContainerLab

Cria ambientes de laboratório usando containers Docker para:

• Simular topologias de rede completas
• Testar configurações antes do deploy
• Validar mudanças em ambiente controlado

NetBox

Fonte da verdade (NSOT) que mantém:

• Inventário de dispositivos
• Configuração de interfaces
• Endereçamento IP
• Templates de configuração

🐛 Troubleshooting

ContainerLab não inicia

# Verificar se o Docker está rodando
sudo systemctl status docker

# Verificar permissões
sudo usermod -aG docker $USER

Testes NUTS falhando

# Verificar conectividade com os dispositivos
sudo containerlab inspect -t topology.yml

# Verificar logs dos containers
docker logs <container-id>

Pipeline CI/CD com erros

# Verificar logs do runner
docker logs gitea-runner

# Verificar permissões do runner para acessar Docker socket
ls -la /var/run/docker.sock

📚 Recursos Adicionais

• ContainerLab Documentation
• Nokia SR Linux Documentation
• NetBox Documentation
• NUTS Framework
• Gitea Actions

📄 Licença

[Especificar licença do projeto]

📧 Contato

William - [informações de contato]

---

Apresentação GTER54: "Do Git ao Router - Automação de Rede com NetDevOps"