Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Plugins): 📝 detail behavior and expected values on plugin storage #1248

Merged
merged 2 commits into from
Nov 8, 2024
Merged

docs(Plugins): 📝 detail behavior and expected values on plugin storage #1248

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bb5cb2
fix: :memo: fix plugin documentation to git chart current behavior
darkweaver87 Nov 4, 2024
7c596a3
review
mloiseleur Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,12 +460,22 @@ ports:
trustedIPs: *DOTrustedIPs
```

# Enable plugin storage
# Using plugins

This chart follows common security practices: it runs as non root with a readonly root filesystem.
When enabling a plugin which needs storage, you have to add it to the deployment.
This chart follows common security practices: it runs as non-root with a readonly root filesystem.
When enabling a plugin, this Chart provides by default an `emptyDir` for plugin storage.

Here is a simple example with crowdsec. You may want to replace with your plugin or see complete exemple on crowdsec [here](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/blob/main/examples/kubernetes/README.md).
Here is an example with [crowdsec](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/blob/main/examples/kubernetes/README.md) plugin:

```yaml
experimental:
plugins:
demo:
moduleName: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
version: v1.3.5
```

When persistence is needed, this `emptyDir` can be replaced with a PVC:

```yaml
deployment:
Expand All @@ -476,7 +486,7 @@ additionalVolumeMounts:
mountPath: /plugins-storage
additionalArguments:
- "--experimental.plugins.bouncer.moduleName=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
- "--experimental.plugins.bouncer.version=v1.1.9"
- "--experimental.plugins.bouncer.version=v1.3.5"
```

# Use Traefik native Let's Encrypt integration, without cert-manager
Expand Down