From 1d91054461f77727f7de85722c16bf361bd37a64 Mon Sep 17 00:00:00 2001 From: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com> Date: Fri, 7 Mar 2025 15:08:05 +0100 Subject: [PATCH] docs(modsecurity-crs): helmify docs (#32978) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [x] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- .../docs/installation_notes.md | 28 ++++++++++++++----- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/charts/stable/modsecurity-crs/docs/installation_notes.md b/charts/stable/modsecurity-crs/docs/installation_notes.md index 005c0df7328..b6964c02a96 100644 --- a/charts/stable/modsecurity-crs/docs/installation_notes.md +++ b/charts/stable/modsecurity-crs/docs/installation_notes.md @@ -2,12 +2,26 @@ title: Installation Notes --- -To use this to protect multiple apps setup the traefik middleware "modsecurity". +To use this to protect multiple apps setup the traefik middleware "modsecurity" in the Traefik Chart `.Values`. -- Name -- ModSecurity Url -- timeout Millis -- maxBody Size +```yaml +middlewares: + modsecurity: + - name: modsecurity + modSecurityUrl: http://modsecurity-crs-modsecurity-crs.svc.cluster.local:8081 + timeoutMillis: 1000 + maxBodySize: 1024 +``` -If you do not plan to use traefik or only want to protect a single app, just add a custom variable "BACKEND" in Extra Environment Variables. -The value can be `` or ``. +If you do not plan to use traefik or only want to protect a single app, just add a variable "BACKEND" in the Environment Variables. +The value can be `` or ``. + +```yaml +workload: + main: + podSpec: + containers: + main: + env: + BACKEND: "http://ip:port" +```