From a89d32688be7d1c4c30b27073a0902ba00426ffc Mon Sep 17 00:00:00 2001 From: Seu Nome Date: Wed, 31 Dec 2025 14:57:35 -0300 Subject: [PATCH] Adiciona Makefile com atalhos de DX e comandos manage/db-shell --- Makefile | 30 +++++++++++++++++++++++ docs/onboarding.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 Makefile create mode 100644 docs/onboarding.md diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..55a7117 --- /dev/null +++ b/Makefile @@ -0,0 +1,30 @@ +.PHONY: up down ps logs logs-netbox shell-netbox superuser restart-netbox manage db-shell + +up: + docker compose up -d + +down: + docker compose down + +ps: + docker compose ps + +logs: + docker compose logs -f --tail=200 + +logs-netbox: + docker compose logs -f --tail=200 netbox + +shell-netbox: + docker compose exec netbox bash + +superuser: + docker compose exec netbox python /opt/netbox/netbox/manage.py createsuperuser + +restart-netbox: + docker compose restart netbox netbox-worker +manage: + docker compose exec netbox python /opt/netbox/netbox/manage.py $(cmd) + +db-shell: + docker compose exec postgres psql -U netbox netbox diff --git a/docs/onboarding.md b/docs/onboarding.md new file mode 100644 index 0000000..55a6ae4 --- /dev/null +++ b/docs/onboarding.md @@ -0,0 +1,59 @@ +# Onboarding - netbox-docker (Dev) + +## Visão geral +Este repositório sobe o NetBox em ambiente de desenvolvimento usando Docker Compose. + +**Acesso local:** http://localhost:8001 +(Porta `8001` no host → `8080` dentro do container `netbox`) + +Serviços principais: +- `postgres` (banco) +- `redis` e `redis-cache` (cache/filas) +- `netbox` (web) +- `netbox-worker` (tarefas assíncronas) + +--- + +## Pré-requisitos +- Docker + Docker Compose (comando `docker compose`) +- `curl` instalado +- Porta `8001` livre no host +- (Opcional) `make` para usar os atalhos do `Makefile` + +--- + +## Arquivos importantes do projeto +- `docker-compose.yml` + Define os serviços, volumes, healthchecks e dependências. +- `docker-compose.override.yml` + Ajustes locais (ex.: mapeamento `8001:8080`). +- `env/*.env` + Variáveis de ambiente por serviço (dev). + **Boas práticas:** não reutilizar esses valores em produção; em produção use secrets/variáveis seguras. +- `Makefile` + Atalhos para os comandos mais usados. + +Atalhos disponíveis no Makefile: +- `make up` / `make down` / `make ps` +- `make logs` / `make logs-netbox` +- `make shell-netbox` +- `make superuser` +- `make restart-netbox` +- `make db-shell` +- `make manage cmd=...` + +--- + +## Subir o ambiente + +### O que faz +Sobe Postgres + Redis + Redis-cache + NetBox + Worker em background. + +### Quando usar +Primeira vez no dia, após reiniciar a máquina, ou depois de derrubar o ambiente. + +### Como rodar +```bash +make up +# ou: dockerup +# ou: docker compose up -d