Skip to content

Commit

Permalink
fix(modsecurity-crs) remove backend variable. (#11791)
Browse files Browse the repository at this point in the history
**Description**
Remove the backend option as it not needed for the app in use of the
traefik plugin.
Added docs.
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [X ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [X ] ⚖️ My code follows the style guidelines of this project
- [X] 👀 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 corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ I increased versions for any altered app according to semantic
versioning

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ 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._
  • Loading branch information
xstar97 authored Aug 25, 2023
1 parent b126b47 commit 0451e08
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 15 deletions.
2 changes: 1 addition & 1 deletion charts/stable/modsecurity-crs/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/modsecurity-crs
- https://github.com/coreruleset/modsecurity-crs-docker
type: application
version: 0.0.1
version: 0.0.2
annotations:
truecharts.org/catagories: |
- networking
Expand Down
11 changes: 11 additions & 0 deletions charts/stable/modsecurity-crs/docs/installation_notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Installation Notes

To use this to protect multiple apps setup the traefik middleware "modsecurity".

- Name
- ModSecurity Url
- timeout Millis
- maxBody Size

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 <http://ip:port> or <http://$NAME.ix-$NAME.svc.cluster.local:PORT>.
13 changes: 0 additions & 13 deletions charts/stable/modsecurity-crs/questions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,6 @@ questions:
# Include{podSpec}
# Include{containerMain}

- variable: env
label: Image Environment
schema:
additional_attrs: true
type: dict
attrs:
- variable: BACKEND
label: Backend
description: A string indicating the partial URL for the remote server of the ProxyPass directive.
schema:
type: string
private: true
default: ""
# Include{containerBasic}
# Include{containerAdvanced}

Expand Down
1 change: 0 additions & 1 deletion charts/stable/modsecurity-crs/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ workload:
MODSEC_DATA_DIR: "{{ .Values.persistence.data.mountPath }}"
MODSEC_TMP_DIR: "{{ .Values.persistence.temp.mountPath }}"
MODSEC_UPLOAD_DIR: "{{ .Values.persistence.upload.mountPath }}"
BACKEND: "http://localhost:80"

persistence:
data:
Expand Down

0 comments on commit 0451e08

Please sign in to comment.