Projet Kube-Knark

Tracez votre runtime Kubernetes !!

Kube-Knark est un traceur open-source qui utilise les technologies pcap et ebpf pour effectuer un traçage runtime sur un cluster Kubernetes déployé. Il trace l'exécution de l'API Kubernetes et les changements de permissions des fichiers de configuration du nœud maître. Les événements correspondant aux traces sont exploités via des webhooks de plugins Go.

kube-knark trace ce qui suit :

• Les appels d'exécution de la spécification complète de l'API Kubernetes, en particulier les mutations
  
• Les changements de permissions des fichiers de configuration du nœud maître Kubernetes selon la spécification CIS Kubernetes Benchmark

Les données de traçage de kube-knark sont rapportées :

• Tableau de bord console
• Hooks de plugins Go

Console kube-Knark :

• Prerequisites
• Installation
• Démarrage rapide
• Utilisation des plugins utilisateur
• Spécifications prises en charge
• Contribution

Prérequis

• Go 1.13+
• Linux Kernel 4.15+
• Clang 10+
• LLVM
• Kernel Headers
• Pcap

Installation

git clone https://github.com/chen-keinan/kube-knark
cd kube-knark
make build

Démarrage rapide

Exécutez kube-knark sans plugins

 ./kube-knark 

Utilisation des plugins utilisateur (via les plugins Go)

Kube-knark expose 2 hooks pour les plugins utilisateur Exemple :

• OnK8sAPICallHook - ce hook accepte un événement d'appel API k8s avec tous les détails (requête/réponse HTTP, spécification API correspondante)
• OnK8sFileConfigChangeHook - ce hook accepte un événement de changement de configuration de fichier maître avec les détails de la commande (chown ou chmod, arguments et spécification de changement de fichier correspondante)

Compiler un plugin utilisateur

go build -buildmode=plugin -o=~/<dossier plugin>/<plugin>.so ~/<dossier plugin>/<plugin>.go

Copier le plugin dans le dossier (le dossier .kube-knark est créé au premier démarrage)

cp ~/<dossier plugin>/<plugin>.so ~/.kube-knark/plugins/compile/<plugin>.so

Spécifications prises en charge

Kube-knark prend en charge 2 spécifications et peut être facilement étendu :

• La spécification complète de l'API k8s Spécification de l'API Kubernetes
• La spécification de changement de fichier de configuration maître Configuration du nœud maître

Les deux spécifications peuvent être facilement étendues en modifiant les fichiers de spécifications dans le dossier ~/.kube-knark/spec

Contribution

• Les contributions de code sont les bienvenues !! Les contributions avec des tests et un linter réussi sont plus que bienvenues :)
• Le dossier /.dev contient un Vagrantfile à utiliser pour le développement : Instructions pour le développement