Skip to content

Commit

Permalink
docs(Plugins): 📝 detail behavior and expected values on plugin storage
Browse files Browse the repository at this point in the history
  • Loading branch information
darkweaver87 authored Nov 8, 2024
1 parent 30012c0 commit 9a5b396
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions EXAMPLES.md
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

0 comments on commit 9a5b396

Please sign in to comment.