diff --git a/README.md b/README.md index 8c47c03..b9a5635 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ # PerfSPEC Learning Phase + +Based in [PrefSPEC: Performance Profiling-based Proactive Security Policy Enforcement for Containers](https://ieeexplore.ieee.org/document/10577533) document presented in [1], thir repository contains source files used to generate and process data. + +__PerfSPEC__ has three phases: + +- Ranking +- Learning +- Runtime + +This repository is focused in __Learning__ phase with attention on: + +- Event logs info load and process +- Predictive learning model + +> Note: It is considered that __event data collection__ in `raw-audit-logs.log` are realistic and representative to simulate +administrative operations. + +## Files +- `raw-audit-logs.log` contains raw Kubernetes audit logs collected using the `audit-policy.yaml` audit policy. + +If you wish to collect your own dataset, we include several source files that might help: +- `collect.py` is a script to trigger the installation and uninstallation of public Helm repositories. +- `helm-charts.json` is a backup of Helm charts used at the time of the collection. + + +## Reference + +Source document + te this dataset in your publication if it helps your research: + +[1]: [H. Kermabon-Bobinnec et al., "PerfSPEC: Performance Profiling-based Proactive Security Policy Enforcement for Containers," in IEEE Transactions on Dependable and Secure Computing, doi: 10.1109/TDSC.2024.3420712.](https://ieeexplore.ieee.org/document/10577533)