From f5fba93f4c9773fc4deeacbf42440d82de336a45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20P=C3=A9rez=20Lorenzo?= Date: Mon, 27 Jan 2025 10:28:57 +0000 Subject: [PATCH] chore: clean content --- about.md | 51 +++++++++------------------------------------ imgs/full_layout.md | 39 ---------------------------------- intro.md | 50 +++++++------------------------------------- 3 files changed, 17 insertions(+), 123 deletions(-) delete mode 100644 imgs/full_layout.md diff --git a/about.md b/about.md index 7cf3289..2c4d9bb 100644 --- a/about.md +++ b/about.md @@ -1,4 +1,9 @@ -# PerfSPEC Learning Phase +--- +gitea: none +include_toc: true +--- + +# PerfSPEC Learning Phase - ABOUT 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. @@ -10,48 +15,12 @@ Based in [PrefSPEC: Performance Profiling-based Proactive Security Policy Enforc -__PerfSPEC__ has three phases: -- Ranking -- Learning -- Runtime +# What is done so far ? -This repository is focused in __Learning__ phase with attention on: +- [X] -- Event logs info load and process -- Predictive learning model - -> Note: It is considered that __event data collection__ in `raw-audit-logs.log.gz` 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. - -Tools are distributed in directories: - -- [Collect](collect) -- [Process](process) -- [Learning](learning) - -As some tasks can be used in [Python](https://python.org) or [Rust](https://www.rust-lang.org/) there are directories for each programming languge inside directories tasks. - -Each `task/programming-language` may have a __data__ directory where processing output files is generated. - -### Collect data - -If you wish to [collect](collect) your own dataset, there are several source files that might help: - -- `collect/collect.py` is a script to trigger the installation and uninstallation of public Helm repositories. -- `collect/helm-charts.json` is a backup of Helm charts used at the time of the collection. - -### Process data +# Plans -### Learning - - - -## Reference - -[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) +# In Review \ No newline at end of file diff --git a/imgs/full_layout.md b/imgs/full_layout.md deleted file mode 100644 index ee16095..0000000 --- a/imgs/full_layout.md +++ /dev/null @@ -1,39 +0,0 @@ -# PerfSPEC Learning Phase Directory Layout - -
-    ├── PerfSPEC.pdf                   Reference document
-    ├── README.md
-    ├── about.md
-    ├── actions_distribution.pdf       Generated actions distribytion
-    ├── collect                        Collect logs scripts 
-    │   ├── audit-policy.yaml
-    │   ├── collect.py
-    │   └── helm-charts.json
-    ├── data                           Extracted from compress archive 
-    │   ├── actions-dataset-audit.txt
-    │   ├── actions-logs.log
-    │   ├── actions_distribution.pdf
-    │   ├── main-audit-logs.log
-    │   └── raw-audit-logs.log
-    ├── data_sample.tar.xz             Compress archive with 'data'
-    ├── imgs
-    ├── install.md                     Installation notes
-    ├── intro.md
-    ├── learning
-    │   └── python
-    │       ├── __pycache__            Ignored in git
-    │       ├── lib_perfspec.py
-    │       ├── model_perfspec.py
-    │       ├── prepare_perfspec.py
-    │       ├── run_perfspec.py
-    │       └── train_perfspec.py
-    ├── models                        Extracted from compress archive
-    │   ├── checkpoints
-    │   │   ├── model_at_epoch_175.keras
-    │   │   └── model_at_epoch_185.keras
-    │   ├── history.json
-    │   └── perfSPEC_model.keras
-    ├── models_sample.tar.xz          Comperss archive with 'models'
-    ├── presentacion.pdf              Presentation slides
-    └── raw-audit-logs.log.xz         Main Raw Logs file
-
diff --git a/intro.md b/intro.md index efd7cbc..deda883 100644 --- a/intro.md +++ b/intro.md @@ -1,3 +1,8 @@ +--- +gitea: none +include_toc: true +--- + # PerfSPEC Learning Phase INTRO 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. @@ -10,48 +15,7 @@ Based in [PrefSPEC: Performance Profiling-based Proactive Security Policy Enforc -__PerfSPEC__ has three phases: +# Why ? -- Ranking -- Learning -- Runtime +Security has to be **PROACTIVE** -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.gz` 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. - -Tools are distributed in directories: - -- [Collect](collect) -- [Process](process) -- [Learning](learning) - -As some tasks can be used in [Python](https://python.org) or [Rust](https://www.rust-lang.org/) there are directories for each programming languge inside directories tasks. - -Each `task/programming-language` may have a __data__ directory where processing output files is generated. - -### Collect data - -If you wish to [collect](collect) your own dataset, there are several source files that might help: - -- `collect/collect.py` is a script to trigger the installation and uninstallation of public Helm repositories. -- `collect/helm-charts.json` is a backup of Helm charts used at the time of the collection. - -### Process data - - -### Learning - - - -## Reference - -[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)