feat(wireguard): move to stable and add docs (#3637)

.github/ct-install.yaml

@@ -26,7 +26,6 @@ excluded-charts:
   - charts/stable/ser2sock
   - charts/stable/zalando-postgres-cluster
   - charts/stable/zigbee2mqtt
-  - charts/stable/wireguard
   - charts/stable/alertmanager-bot
   - charts/stable/storj-node
   - charts/incubator/amcrest2mqtt
@@ -45,8 +44,6 @@ excluded-charts:
   - charts/dev/csgo
   - charts/dev/cstrike1-6
   - charts/dev/cstrikeconditionzero
-  - charts/stable/wireguard
-  - charts/incubator/wireguard
 chart-repos:
   - truecharts=https://charts.truecharts.org
   - truecharts-library=https://library-charts.truecharts.org

charts/stable/wireguard/Chart.yaml

@@ -19,7 +19,7 @@ name: wireguard
 sources:
   - https://github.com/truecharts/charts/tree/master/charts/incubator/wireguard
   - https://github.com/k8s-at-home/container-images/tree/main/apps/wireguard
-version: 0.0.3
+version: 1.0.0
 annotations:
   truecharts.org/catagories: |
     - network

charts/stable/wireguard/ci/ci-values.yaml

@@ -0,0 +1,12 @@
+wg:
+  config:
+    enabled: true
+    data: |
+      [Interface]
+      Address = 10.0.0.1/24
+      ListenPort = 51820
+      PrivateKey = 0K6BMiX09qRMXhcuCnpjdEVlOlhEw8Q8jpB6edY0wmw=
+      [Peer]
+      PublicKey = KajDsFV6oJ04H/jeUzds23Lrybfr1YJvwm5rghcG7yM=
+      AllowedIPs = 0.0.0.0/0
+      Endpoint = 1.1.1.1:51820

charts/stable/wireguard/docs/installation_notes.md

@@ -0,0 +1,63 @@
+# Installation Notes
+
+## Scale App
+
+TrueNAS Scale users, can configure this app from the easily from the UI.
+Store your wireguard config file in a directory, on one of your pools.
+Example `/mnt/pool/vpn.conf` (Name can be any name. eg `wg0.conf`, `x-site.conf`, etc)
+Example config content:
+
+```conf
+[Interface]
+Address = 10.0.0.1/24
+ListenPort = 51820
+PrivateKey = PRIVATE_KEY
+
+[Peer]
+PublicKey = PUBLIC_KEY
+AllowedIPs = 0.0.0.0/0
+Endpoint = wg.example:51820
+```
+
+UI Configuration is simple as that:
+
+![wg-configuration](img/wg-configuration.png)
+
+Tick `Killswitch` if you want to kill traffic when VPN is down.
+Add networks in `Excluded IPv{4,6} Networks` that you want to continue their traffic when VPN is down.
+
+That's it!
+
+## Native Helm
+
+Native helm users can modify `values.yaml` and add their wireguard config directly in there.
+
+Example:
+
+```yaml
+wg:
+  # Set to true if you want to enable killswitch
+  killswitch: false
+  # If you want to exclude networks, do like so
+  excludedIP4networks:
+    - "10.10.10.0/24"
+    - "192.168.1.0/24"
+  excludedIP6networks: []
+  # Leave empty if you going to use the paste your config bellow
+  configFileHostPath: ""
+  # Paste your config bellow.
+  # Indentation matters!
+  config:
+    enabled: false
+    # Your wg config here eg:
+    data: |
+      [Interface]
+      Address = 10.0.0.1/24
+      ListenPort = 51820
+      PrivateKey = PRIVATE_KEY
+
+      [Peer]
+      PublicKey = PUBLIC_KEY
+      AllowedIPs = 0.0.0.0/0
+      Endpoint = wg.example:51820
+```

charts/stable/wireguard/values.yaml

@@ -32,7 +32,7 @@ wg:
 
       [Peer]
       PublicKey = PUBLIC_KEY
-      AllowedIPs = 10.0.0.0/24
+      AllowedIPs = 0.0.0.0/0
       Endpoint = wg.example:51820
 
 envFrom: