kube-hunter-plugins

The following repo contains an official collection of kube-hunter plugins. As well as documentation for how to create one yourselves.

Intro

Due to the pluggable mechanism in kube-hunter (provided by the pluggy package)
You can add almost any additional functionality to kube-hunter without diving into a large codebase. By convention plugins should be a pypi package named with the following format:
kube-hunter-example-plugin

Plugins are functionalities that should not be included in the official implementations. it is there for users who wish to uniquely serve a specific solution for their private deployment. If you have an idea for a new functionality. feel free to create a PR to kube-hunter directly. We encourage every contribution!

Official plugins

The plugins that are featured here are:

Develop a new plugin

prerequisites

• read the pluggy docs
• look at the examples in this repo

1. setup.py

Create a setup.py for the package. containing the following:

from setuptools import setup

setup(
    name="kube-hunter-your-plugin",
    install_requires=["kube-hunter", "your-requirement-package>=0.0.0"],
    entry_points={"kube_hunter": ["plugin_entrypoint = plugin_entrypoint"]},
    py_modules=["kube_hunter_your_plugin"],
)

2. plugin_entrypoint.py

Create a plugin_entrypoint.py for the package. containing the following:

from kube_hunter.plugins import hookimpl

""" This function will run BEFORE argument parsing """
@hookimpl
def parser_add_arguments(parser):
    parser.add_argument('--custom-argument', help="example for your custom argument")

""" This function will run AFTER argument parsing """
@hookimpl
def load_plugin(args):
    # You can either put your implementation directly here, or:
    import your_plugin_implementation # file

Optional plugin types:

3. Install

Install the plugin

pip install .