Skip to content

Commit

Permalink
docs(vpn guide): Update vpn guide with talos workaround (#28372)
Browse files Browse the repository at this point in the history
**Description**

updates the vpn guide docs with the workaround for talos

⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 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
- [x] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [ ] 🧪 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):` or `chore(chart-name):`

**➕ 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._

---------

Signed-off-by: StevenMcElligott <[email protected]>
Co-authored-by: StevenMcElligott <[email protected]>
  • Loading branch information
axelrtgs and StevenMcElligott authored Oct 26, 2024
1 parent 7311513 commit f7a81a3
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions website/src/content/docs/guides/vpn-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,3 +203,35 @@ In Prowlarr, under `Settings -> Indexers -> Add [Indexer Proxies]`, select `Http
If you added a `proxy` tag, make sure to also add that to the desired Indexers, under `Indexers -> Edit Indexer -> Tags`.

Your indexer traffic will now be routed through the Gluetun HTTP proxy. Check the `qbittorrent-vpn` container logs to confirm.

## Talos specific config

In talos in order to use the tun interface for Gluetun a workaround is needed otherwise you will get an error with permissions creating the tun interface.

### Step 1: Add the generic-device-plugin

you can find the steps [here](https://www.talos.dev/v1.8/kubernetes-guides/configuration/device-plugins/#deploying-the-device-plugin)

### Step 2: Add this into your helm-release.yaml for your app

Here is an example snippet for qbittorrent

```yaml
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: qbittorrent
namespace: qbittorrent
spec:
postRenderers:
- kustomize:
patches:
- target:
version: v1
kind: Deployment
name: qbittorrent
patch: |
- op: add
path: /spec/template/spec/containers/1/resources/limits/squat.ai~1tun
value: 1
```

0 comments on commit f7a81a3

Please sign in to comment.