github/kube-hunter
1
0
Fork 0
mirror of https://github.com/aquasecurity/kube-hunter.git synced 2026-05-10 19:26:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated read me for devs so the mistake won't happen again

Browse Source
This commit is contained in:
ori.agmon
2018-10-14 16:04:37 +03:00
committed by oriagmon
parent 1e4ead93f4
commit 1883abaa23
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/README.md
View File

@@ -71,7 +71,10 @@ _The file's (module's) content is imported automatically"_
The second step is to determine what events your Hunter will subscribe to, and from where you can get them.
`Convention:` Events should be declared in their corresponding module. for example, a KubeDashboardEvent event is declared in the dashboard discovery module.
`Note:` An hunter located under the `disovery` folder should not import any modules located under the `hunting` folder
in order to prevent circular dependency bugs
Following the above example, let's figure out the imports:
```python
from ...core.types import Hunter
@@ -114,7 +117,7 @@ relative import: `...core.types`
## Creating Events
As discussed above, we know there are alot of different types of events that can be created. but at the end, they all need to inherit from the base class `Event`
As discussed above, we know there are a lot of different types of events that can be created. but at the end, they all need to inherit from the base class `Event`
lets see some examples of creating different types of events:
### Vulnerability
```python