Kubeprobes

Uma ferramenta CLI para verificar probes do Kubernetes em seus workloads.

Funcionalidades

• Verifica liveness, readiness e startup probes
• Suporta múltiplos namespaces
• Fornece recomendações de configuração
• Integração com diferentes contextos do Kubernetes

Instalação

Para uso com Docker, consulte a documentação Docker.

Binários Pré-compilados

Baixe o binário apropriado para seu sistema da página de releases.

Compilando do Código Fonte

1. Clone o repositório:

git clone https://github.com/Tech-Preta/kubeprobes.git

2. Entre no diretório do projeto:

cd kubeprobes

3. Compile o código fonte:

cd src
go build -o kubeprobes

4. (Opcional) Mova o binário para o diretório /usr/local/bin:

sudo mv kubeprobes /usr/local/bin

5. Verifique se a instalação foi bem sucedida:

kubeprobes --help

Uso

# Verificar todos os tipos de probes no namespace padrão
kubeprobes scan

# Verificar um tipo específico de probe com recomendações
kubeprobes scan -p liveness -r

# Verificar em um namespace específico
kubeprobes scan -n meu-namespace

# Usar um kubeconfig e contexto específicos
kubeprobes scan -k /path/to/kubeconfig -c meu-contexto

# Exemplo completo:
kubeprobes scan -k <caminho-para-o-kubeconfig> -c <contexto-kubeconfig> -n <namespace> -p <tipo-de-probe> -r

Códigos de saída

• 0: Nenhum problema de probe encontrado
• 1: Problemas de probe encontrados

Comandos Disponíveis

• scan: Escaneia workloads do Kubernetes em busca de probes.

Flags

• -k, --kubeconfig: Caminho para o arquivo kubeconfig.
• -c, --kubeContext: Contexto do Kubernetes.
• -n, --namespace: Namespace do Kubernetes.
• -p, --probe-type: Tipo de probe para escanear (liveness, readiness, startup).
• -r, --recommendation: Mostrar recomendações para sondas ausentes.

Segurança

Este projeto segue as melhores práticas de segurança do OpenSSF. Para reportar uma vulnerabilidade, por favor consulte nosso SECURITY.md.

Contribuindo

Contribuições são bem-vindas! Por favor, leia nosso CONTRIBUTING.md para detalhes sobre nosso código de conduta e o processo para enviar pull requests.

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para detalhes.

Changelog

Veja CHANGELOG.md para uma lista de mudanças.

sequenceDiagram
    participant Usuário
    participant CLI kubeprobes
    participant Kubernetes API

    Usuário->>CLI kubeprobes: Executa comando scan (com flags)
    CLI kubeprobes->>CLI kubeprobes: Valida flags (kubeconfig, namespace, probe-type)
    CLI kubeprobes->>Kubernetes API: Lista pods no namespace
    Kubernetes API-->>CLI kubeprobes: Retorna lista de pods
    alt Nenhum pod encontrado
        CLI kubeprobes->>Usuário: Exibe mensagem "Nenhum pod encontrado"
    else Pods encontrados
        CLI kubeprobes->>CLI kubeprobes: Para cada pod/container, verifica probes
        alt Container sem probe requisitado
            CLI kubeprobes->>Usuário: Exibe aviso de ausência de probe e recomendações (se flag ativada)
        end
        alt Nenhum problema encontrado
            CLI kubeprobes->>Usuário: Exibe mensagem "Nenhum problema de probe encontrado"
        else Problemas encontrados
            CLI kubeprobes->>Usuário: Sai com status 1
        end
    end

Loading

Requisitos

• Go 1.13 ou superior
• kubectl
• Um cluster Kubernetes acessível

Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir um issue ou enviar um pull request.