github/kube-hunter
1
0
Fork 0
mirror of https://github.com/aquasecurity/kube-hunter.git synced 2026-02-14 18:09:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#196)

Browse Source 
* Update README.md

Added license details(and linked to the license page) and improved the readability of the README file.

* Update README.md

Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
This commit is contained in:
Aayush Srivastava
2019-10-18 20:02:54 +05:30
committed by Yehuda Chikvashvili
parent a877d86c13
commit 6a80cdede5
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -5,7 +5,7 @@
[![Docker image](https://images.microbadger.com/badges/image/aquasec/kube-hunter.svg)](https://microbadger.com/images/aquasec/kube-hunter "Get your own image badge on microbadger.com")
Kube-hunter hunts for security weaknesses in Kubernetes clusters. The tool was developed to increase awareness and visibility for security issues in Kubernetes environments. **You should NOT run kube-hunter on a Kubernetes cluster you don't own!**
kube-hunter hunts for security weaknesses in Kubernetes clusters. The tool was developed to increase awareness and visibility for security issues in Kubernetes environments. **You should NOT run kube-hunter on a Kubernetes cluster you don't own!**
**Run kube-hunter**: kube-hunter is available as a container (aquasec/kube-hunter), and we also offer a web site at [kube-hunter.aquasec.com](https://kube-hunter.aquasec.com) where you can register online to receive a token allowing you see and share the results online. You can also run the Python code yourself as described below.
@@ -41,7 +41,7 @@ You can also run kube-hunter in a pod within the cluster. This gives an indicati
### Scanning options
First check the **[pre-requisites](#prerequisites)**
First check for these **[pre-requisites](#prerequisites)**.
By default, kube-hunter will open an interactive session, in which you will be able to select one of the following scan options. You can also specify the scan option manually from the command line. These are your options:
@@ -49,7 +49,7 @@ By default, kube-hunter will open an interactive session, in which you will be a
To specify remote machines for hunting, select option 1 or use the `--remote` option. Example:
`./kube-hunter.py --remote some.node.com`
2. **interface scanning**
2. **Interface scanning**
To specify interface scanning, you can use the `--interface` option. (this will scan all of the machine's network interfaces) Example:
`./kube-hunter.py --interface`
@@ -144,3 +144,6 @@ The `job.yaml` file defines a Job that will run kube-hunter in a pod, using defa
* Run the job with `kubectl create` with that yaml file.
* Find the pod name with `kubectl describe job kube-hunter`
* View the test results with `kubectl logs <pod name>`
## License
This repository is available under the [Apache License 2.0](https://github.com/aquasecurity/kube-hunter/blob/master/LICENSE).