raijin-server 0.1.0__tar.gz → 0.2.1__tar.gz

raijin_server-0.2.1/PKG-INFO

@@ -0,0 +1,407 @@
+Metadata-Version: 2.4
+Name: raijin-server
+Version: 0.2.1
+Summary: CLI para automacao de setup e hardening de servidores Ubuntu Server.
+Home-page: https://example.com/raijin-server
+Author: Equipe Raijin
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: System Administrators
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.7
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == "yaml"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Provides-Extra: all
+Requires-Dist: pyyaml>=6.0; extra == "all"
+Requires-Dist: pytest>=7.0; extra == "all"
+Requires-Dist: pytest-cov>=4.0; extra == "all"
+Requires-Dist: black>=23.0; extra == "all"
+Requires-Dist: ruff>=0.1; extra == "all"
+Dynamic: license-file
+
+# raijin-server
+
+CLI em Python (Typer) para automatizar setup e hardening de servidores Ubuntu Server em ambientes produtivos. Orquestra rede, firewall, Kubernetes, observabilidade e backups para acelerar a subida de clusters e workloads.
+
+**✨ Versão Auditada e Resiliente para Produção**
+
+## Destaques
+
+- ✅ **Validações de Pré-requisitos**: OS, espaço em disco, memória, conectividade
+- ✅ **Health Checks Automáticos**: Valida serviços após instalação
+- ✅ **Retry Inteligente**: Resistente a falhas temporárias de rede
+- ✅ **Logging Estruturado**: Logs persistentes para auditoria
+- ✅ **Gestão de Dependências**: Garante ordem correta de execução
+- ✅ **Configuração via Arquivo**: Automação completa com YAML/JSON
+- ✅ **Idempotência**: Re-execução segura sem quebrar o sistema
+- ✅ **Modo Dry-run**: Simula execução sem aplicar mudanças
+
+## Requisitos
+
+- Python >= 3.9
+- Ubuntu Server 20.04+ (testado em 24.04)
+- Permissões root/sudo
+- Conectividade com internet
+- Mínimo 4GB RAM, 20GB disco livre
+- Ferramentas: `curl`, `apt-get`, `systemctl`
+
+Ferramentas adicionais (instaladas pelos módulos quando necessário):
+- `helm` (>=3.8 para OCI)
+- `kubectl`, `kubeadm`
+- `velero`, `istioctl`
+
+## Instalacao
+
+Sem venv (global):
+
+```bash
+python -m pip install .
+```
+
+Com venv (recomendado para desenvolvimento):
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+```
+
+## Uso rapido
+
+### Validar Sistema
+```bash
+# Verifica se o sistema atende pré-requisitos
+sudo raijin-server validate
+```
+
+### Menu Interativo
+```bash
+# Menu visual com stautils.py`: Funções utilitárias com retry, timeout e logging.
+- `src/raijin_server/validators.py`: Validações de pré-requisitos e dependências.
+- `src/raijin_server/healthchecks.py`: Health checks pós-instalação.
+- `src/raijin_server/config.py`: Gerenciamento de configuração via arquivo.
+- `src/raijin_server/modules/`: Automações por tópico (hardening, network, essentials, firewall, kubernetes, calico, istio, traefik, kong, minio, prometheus, grafana, loki, harness, velero, kafka).
+- `src/raijin_server/scripts/`: Shells empacotados usados pelos módulos e scripts auxiliares.
+- `ARCHITECTURE.md`: Visão do desenho técnico.
+- `AUDIT.md`: Relatório completo de auditoria e melhorias.
+- `SECURITY.md`: Como reportar vulnerabilidades
+### Execução Direta de Módulos
+```bash
+# Executar módulo específico
+sudo raijin-server kubernetes
+
+# Dry-run (simula sem aplicar)
+sudo raijin-server --dry-run kubernetes
+
+# Pular validações (não recomendado)
+sudo raijin-server --skip-validation kubernetes
+```
+
+### Automação via Arquivo de Configuração
+## Documentação Adicional
+
+- **[AUDIT.md](AUDIT.md)**: Relatório completo de auditoria e melhorias implementadas
+- **[ARCHITECTURE.md](ARCHITECTURE.md)**: Arquitetura técnica do ambiente
+- **[SECURITY.md](SECURITY.md)**: Políticas de segurança e reporte de vulnerabilidades
+
+## Fluxo de Execução Recomendado
+
+```bash
+# 1. Validar sistema
+sudo raijin-server validate
+
+# 2. Base do sistema
+sudo raijin-server essentials
+sudo raijin-server hardening
+sudo raijin-server network   # OPCIONAL: pule se IP já configurado via provedor ISP
+sudo raijin-server firewall
+
+# 3. Kubernetes
+sudo raijin-server kubernetes
+sudo raijin-server calico
+sudo raijin-server secrets
+sudo raijin-server cert-manager
+
+# 4. Ingress (escolha um)
+sudo raijin-server traefik
+# OU
+sudo raijin-server kong
+
+# 5. Observabilidade
+sudo raijin-server prometheus
+sudo raijin-server grafana
+sudo raijin-server observability-ingress
+sudo raijin-server observability-dashboards
+sudo raijin-server loki
+
+# 6. Storage e Mensageria (opcional)
+sudo raijin-server minio
+sudo raijin-server kafka
+
+# 7. Backup
+sudo raijin-server velero
+
+# 8. Service Mesh (opcional)
+sudo raijin-server istio
+```
+
+### IP Estático (pular se já configurado)
+
+O módulo `network` é **opcional** quando:
+- O IP fixo foi configurado pelo provedor ISP (ex: Ibi Internet Empresarial)
+- O IP estático foi definido durante a instalação do Ubuntu Server
+- A rede já está funcionando corretamente
+
+Para pular automaticamente em automações:
+```bash
+export RAIJIN_SKIP_NETWORK=1
+sudo raijin-server full-install
+```
+
+O módulo detecta automaticamente se já existe um Netplan com IP estático e pergunta
+se deseja pular. Se executar manualmente, basta responder "não" quando perguntado.
+
+### Notas de kernel / Secure Boot
+- WireGuard depende de módulo de kernel. Com Secure Boot ativo, o módulo DKMS pode precisar ser assinado; se `modprobe wireguard` falhar, assine ou desabilite Secure Boot temporariamente.
+- Certifique-se de ter headers do kernel instalados (`/lib/modules/$(uname -r)/build`) antes de instalar WireGuard.
+- Para Kubernetes/Calico é necessário `br_netfilter` e sysctl `bridge-nf-call-iptables=1`. O módulo `bootstrap` já aplica, mas verifique se seu kernel suporta.
+
+### Comandos Úteis
+```bash
+# Versão
+raijin-server version
+
+# Monitorar logs
+tail -f /var/log/raijin-server/raijin-server.log
+
+# Rotacao de logs (default: 20MB, 5 backups)
+# Ajuste via env:
+#   export RAIJIN_LOG_MAX_BYTES=$((50*1024*1024))
+#   export RAIJIN_LOG_BACKUP_COUNT=5
+
+# Métrica de tamanho de logs (Prometheus/Grafana) usando node_exporter textfile collector
+# 1) Habilite textfile collector (ex.: /var/lib/node_exporter/textfile_collector)
+# 2) Agende o script:
+#    sudo /bin/bash -c 'RAIJIN_METRIC_FILE=/var/lib/node_exporter/textfile_collector/raijin_log_size.prom \
+#      RAIJIN_LOG_DIR=/var/log/raijin-server \
+#      /usr/bin/bash -l $(python - <<'PY'
+#from raijin_server.utils import resolve_script_path
+#print(resolve_script_path("log_size_metric.sh"))
+#PY
+#)'
+# 3) Crie um painel no Grafana com a métrica `raijin_log_size_total_bytes` (Prometheus)
+```
+
+## Estrutura
+
+- `src/raijin_server/cli.py`: CLI principal com Typer, banner e `--dry-run`.
+- `src/raijin_server/modules/`: automacoes por topico (hardening, network, essentials, firewall, kubernetes, calico, istio, traefik, kong, minio, prometheus, grafana, loki, harness, velero, kafka).
+- `src/raijin_server/scripts/`: shells embarcados acessíveis via `raijin_server.utils.resolve_script_path()`.
+- `ARCHITECTURE.md`: visao do desenho atual.
+- `SECURITY.md`: como reportar e pensar seguranca.
+
+## Modulos disponiveis
+
+- `sanitize`: remove clusters/residuos kube*, binarios antigos e listas apt.
+- `bootstrap`: instala helm, kubectl, istioctl, velero, containerd e dependencias.
+- `ssh-hardening`: cria usuario dedicado, aplica politicas seguras de SSH e integra ao Fail2ban.
+- `hardening`: fail2ban, unattended-upgrades, sysctl.
+- `essentials`: pacotes base (curl, git, jq, etc.) e NTP.
+- `network`: Netplan com IP fixo e DNS. **OPCIONAL** se IP já configurado pelo provedor ISP.
+- `firewall`: UFW com regras para SSH/HTTP/HTTPS/K8s.
+- `vpn`: provisiona WireGuard (servidor + cliente inicial) e libera firewall.
+- `kubernetes`: kubeadm init, containerd SystemdCgroup, kubeconfig.
+- `calico`: CNI Calico com CIDR custom, default-deny e opcao de liberar egress rotulado.
+- `cert_manager`: instala cert-manager e ClusterIssuer ACME (HTTP-01/DNS-01).
+- `secrets`: instala sealed-secrets e external-secrets via Helm.
+- `istio`: istioctl install (perfil raijin) e injeção automática.
+- `traefik`: IngressController com TLS/ACME.
+- `kong`: Ingress/Gateway com Helm.
+- `minio`: armazenamento S3 compatível via Helm.
+- `prometheus`, `grafana`, `loki`: observabilidade, dashboards e persistencia.
+- `observability-ingress`: autentica e publica Grafana/Prometheus/Alertmanager com TLS dedicado.
+- `observability-dashboards`: aplica dashboards opinativos e alertas default (Grafana/Prometheus/Alertmanager).
+- `apokolips-demo`: landing page temática para validar ingress/TLS e testar DNS externo.
+- `harness`: delegate Helm com parametros interativos.
+- `velero`: backup/restore com schedule.
+- `kafka`: deploy Bitnami via OCI.
+- `full-install`: orquestra toda a sequência automaticamente (sanitize ➜ observability-dashboards).
+
+## Roadmap basico
+
+- ✅ Validacoes de pre-requisitos e health-check por modulo.
+- ✅ Provisionar ingress seguro para Grafana/Prometheus/Alertmanager (modulo `observability-ingress`).
+- ✅ Dashboards e alertas opinativos prontos para uso (modulo `observability-dashboards`).
+- ✅ Suporte a sealed-secrets/external-secrets para credenciais.
+- ⏳ Testes automatizados (pytest) e linters.
+
+## Proximos passos sugeridos
+
+- Suporte a sealed-secrets/external-secrets para credenciais sensíveis.
+- Adicionar validacoes e testes (pytest, linters, testcontainers).
+
+## Scripts embarcados
+
+Todos os helpers shell agora vivem em `src/raijin_server/scripts/` e acompanham o pacote Python.
+Para invocá-los dentro de um módulo (ou mesmo após instalar via `pip`), use o helper `resolve_script_path()`:
+
+```bash
+SCRIPT_PATH=$(python - <<'PY'
+from raijin_server.utils import resolve_script_path
+print(resolve_script_path('pre-deploy-check.sh'))
+PY
+)
+
+bash "$SCRIPT_PATH"
+```
+
+O helper garante o caminho absoluto correto independentemente de onde o pacote foi instalado.
+
+## Teste de ingress (Apokolips)
+
+O módulo [src/raijin_server/modules/apokolips_demo.py](src/raijin_server/modules/apokolips_demo.py) cria um namespace dedicado, ConfigMap com HTML, Deployment NGINX, Service e Ingress Traefik com uma landing page "Apokolips" para validar o tráfego externo.
+
+```bash
+sudo raijin-server apokolips-demo
+```
+
+Personalização rápida:
+
+- Defina `APOKOLIPS_HOST=ingress.seudominio.com` para pular o prompt de host.
+- Defina `APOKOLIPS_TLS_SECRET=nome-do-secret` caso já possua um Secret TLS pronto (caso contrário o módulo publica apenas HTTP).
+
+Recursos criados:
+
+- Namespace `apokolips-demo`
+- ConfigMap com o HTML temático
+- Deployment + Service `ClusterIP` baseado em `nginx:1.25`
+- Ingress (`ingressClassName: traefik`) apontando para o host informado
+
+Valide o acesso:
+
+```bash
+kubectl -n apokolips-demo get ingress apokolips-demo -o wide
+curl -H "Host: SEU_HOST" https://<IP_DO_LOAD_BALANCER>/ --insecure
+```
+
+Para remover rapidamente:
+
+```bash
+kubectl delete namespace apokolips-demo
+```
+
+## Liberar egress controlado para pods
+
+O módulo `calico` agora gera um `default-deny` por namespace e oferece uma política opcional
+`allow-egress-internet`. Ao responder "sim" para a pergunta de egress, basta rotular os workloads
+que precisam falar com APIs externas:
+
+```bash
+kubectl label deployment minha-api -n backend \
+	networking.raijin.dev/egress=internet
+```
+
+Somente pods com esse label terão tráfego liberado para o CIDR definido (padrão `0.0.0.0/0`).
+Isso permite manter o isolamento padrão enquanto libera acesso seletivo para integrações externas.
+
+## Automacao de segredos (sealed-secrets + external-secrets)
+
+Execute o modulo `secrets` para instalar os controladores:
+
+```bash
+sudo raijin-server secrets
+```
+
+Passos realizados:
+- Instala `sealed-secrets` (namespace padrao: `kube-system`)
+- Instala `external-secrets` (namespace padrao: `external-secrets`, com CRDs)
+- Opcional: exporta o certificado publico do sealed-secrets para gerar manifests lacrados via `kubeseal`
+
+Dicas rapidas:
+- Exportar certificado depois: `kubectl -n kube-system get secret -l sealedsecrets.bitnami.com/sealed-secrets-key -o jsonpath='{.items[0].data.tls\.crt}' | base64 -d > sealed-secrets-cert.pem`
+- Gerar sealed secret local: `kubeseal --controller-namespace kube-system --controller-name sealed-secrets < secret.yaml > sealed.yaml`
+- ESO: crie um `SecretStore`/`ClusterSecretStore` apontando para seu backend (AWS/GCP/Vault) e um `ExternalSecret` referenciando as chaves.
+
+### Validar o modulo `secrets`
+
+```bash
+# Status dos releases
+helm status sealed-secrets -n kube-system
+helm status external-secrets -n external-secrets
+
+# Pods prontos
+kubectl get pods -n kube-system -l name=sealed-secrets
+kubectl get pods -n external-secrets -l app.kubernetes.io/name=external-secrets
+
+# Health check integrado
+raijin-server --health-check secrets
+```
+
+### Exemplos (prontos para aplicar)
+
+- SecretStore AWS Secrets Manager: [examples/secrets/secretstore-aws-sm.yaml](examples/secrets/secretstore-aws-sm.yaml)
+- ExternalSecret AWS Secrets Manager: [examples/secrets/externalsecret-aws-sm.yaml](examples/secrets/externalsecret-aws-sm.yaml)
+- SecretStore Vault AppRole: [examples/secrets/secretstore-vault-approle.yaml](examples/secrets/secretstore-vault-approle.yaml)
+- ExternalSecret Vault: [examples/secrets/externalsecret-vault.yaml](examples/secrets/externalsecret-vault.yaml)
+
+Notas rápidas:
+- Para AWS/IRSA: crie um ServiceAccount (`apps/eso-aws`) anotado com o role IAM e garanta a policy para leitura dos secrets.
+- Para Vault: crie o Secret `vault-approle-secret` com `secretId` e ajuste `ROLE_ID_AQUI`. Ajuste `server`/`path` conforme seu mount de KV.
+- Aplique na ordem: SecretStore ➜ ExternalSecret ➜ valide `kubectl get secret` no namespace do app.
+
+## Testes e lint
+
+Ambiente de dev:
+```bash
+python -m pip install -e .[dev]
+pytest
+ruff check src tests
+```
+
+## Acesso remoto seguro (VPN + SSH)
+
+Execute `raijin-server ssh-hardening` para aplicar as politicas abaixo automaticamente e `raijin-server vpn` para subir o servidor WireGuard com um cliente inicial. Use `--dry-run` se quiser apenas revisar os comandos.
+
+1. **SSH reforçado**
+	- Gere chaves `ed25519` em cada estação: `ssh-keygen -t ed25519 -C "adminops@empresa"`.
+	- No servidor, crie um usuário administrativo (ex.: `adminops`) e aplique hardening no `/etc/ssh/sshd_config`:
+	  ```
+	  Port 22           # altere caso deseje
+	  PermitRootLogin no
+	  PasswordAuthentication no
+	  AllowUsers adminops
+	  ```
+	- Copie as chaves públicas para `/home/adminops/.ssh/authorized_keys`, ajuste permissões e reinicie o sshd (`systemctl restart ssh`).
+	- Para tunelar dashboards internos sem expor portas, use `ssh -L 3000:localhost:3000 adminops@IP_PUBLICO` (ou `-R` para acesso reverso).
+
+2. **VPN privada (WireGuard sugerido)**
+	- Instale `wireguard-tools` e `qrencode`, gere chaves do servidor (`wg genkey | tee server.key | wg pubkey > server.pub`).
+	- Configure `/etc/wireguard/wg0.conf`:
+	  ```
+	  [Interface]
+	  Address = 10.20.0.1/24
+	  ListenPort = 51820
+	  PrivateKey = <server.key>
+	  PostUp = ufw route allow in on wg0 out on eth0
+	  PostDown = ufw route delete allow in on wg0 out on eth0
+	  ```
+	- Adicione um `[Peer]` por estação com `AllowedIPs = 10.20.0.X/32`, distribua os arquivos `clientX.conf` ou QR codes e inicie com `systemctl enable --now wg-quick@wg0`.
+	- No modem/VPC, libere apenas `51820/UDP` e limite SSH/UIs para o range `10.20.0.0/24` (UFW `allow from 10.20.0.0/24 to any port 22`).
+
+3. **Fluxo recomendado**
+	- Exporte apenas o que precisa ser público (Traefik, Harness) e mantenha Grafana/Prometheus/Kubernetes API restritos ao túnel VPN.
+	- Documente as portas encaminhadas e mantenha as chaves/tokens em `secrets/` ou sealed-secrets para fácil rotação.
+
+	Combine esse fluxo com `raijin-server observability-ingress` para publicar Grafana/Prometheus/Alertmanager somente via TLS dedicado e autenticação básica por Traefik e finalize com `raijin-server observability-dashboards` para carregar dashboards e alertas opinativos.