nataliagranato / kubeprobes

KubeProbes é uma ferramenta de linha de comando (CLI) desenvolvida em Go para escanear workloads do Kubernetes em busca de probes (sondas) definidas.

KubeProbes - CLI Tool for Scanning Kubernetes Probes

Probes é uma ferramenta de linha de comando (CLI) desenvolvida em Go para escanear workloads do Kubernetes em busca de probes (sondas) definidas.

sequenceDiagram
    participant User
    participant CLI
    participant K8sAPI

    User->>CLI: kubeprobes scan -k <kubeconfig> -c <context> -n <namespace> -p <probe> -r
    CLI->>K8sAPI: Fetch workloads in namespace
    K8sAPI-->>CLI: Return workload details
    CLI->>CLI: Scan for specified probes
    CLI->>User: Display scan results and recommendations

Loading

Requisitos

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

Instalação

1. Clone o repositório:

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. 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

Comandos Disponíveis

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

  Exemplo de uso:

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

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.

Contribuições

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