From 1a26653007ae2c82db04ac73a5d336f2336db772 Mon Sep 17 00:00:00 2001 From: danielsagi Date: Thu, 8 Apr 2021 19:20:09 +0300 Subject: [PATCH] Added Advanced Usage section to the readme, documenting azure quick scanning (#441) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b5a7a23..50afd70 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ Table of Contents * [Nodes Mapping](#nodes-mapping) * [Output](#output) * [Dispatching](#dispatching) + * [Advanced Usage](#advanced-usage) * [Deployment](#deployment) * [On Machine](#on-machine) * [Prerequisites](#prerequisites) @@ -114,6 +115,11 @@ Available dispatch methods are: * KUBEHUNTER_HTTP_DISPATCH_URL (defaults to: https://localhost) * KUBEHUNTER_HTTP_DISPATCH_METHOD (defaults to: POST) +### Advanced Usage +#### Azure Quick Scanning +When running **as a Pod in an Azure environment**, kube-hunter will fetch subnets from the Instance Metadata Service. Naturally this makes the discovery process take longer. +To hardlimit subnet scanning to a `/24` CIDR, use the `--quick` option. + ## Deployment There are three methods for deploying kube-hunter: