Skip to content

Commit

Permalink
chore(Tailscale) Update Tailscale HowTo for Talos (#30925)
Browse files Browse the repository at this point in the history
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
This PR is to update the Tailscale How To Guide for Talos OS and to
remove TrueNAS specific components that are no longer relevant.

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

**⚙️ Type of change**

- [ ] ⚙️ 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 -->
Documentation changes only

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 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
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [ ] 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: Addison McDermid <admin@itconstruct.com.au>
  • Loading branch information
itconstruct authored Jan 23, 2025
1 parent 59d6ddf commit 84e9531
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions charts/stable/tailscale/docs/How-To-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: How-To
---

This is a quick how-to or setup-guide to use Tailscale using on your TrueNAS box.
This can be applied to other systems but this specific guide is SCALE specific with the prerequisites.
This is a quick how-to or setup-guide to use Tailscale on Talos.
This can be applied to other systems but this specific guide is Talos on TrueNAS specific with the prerequisites.

:::caution

Expand All @@ -15,6 +15,7 @@ This guide doesn't cover using Tailscale with individual applications. While the

- Tailscale Account (Free accounts available at [Tailscale's Official website](https://www.tailscale.com))
- Tailscale Truecharts Chart
- Tailscale DNS setup for Talos Cluster Domain

## Prerequisites (LAN access only)

Expand All @@ -39,13 +40,6 @@ Also prepare your Tailscale Auth Key for your setup, easy to generate on the pag

Ideally use `tailscale` but you can use any name here.

### Global Pod Options

This section is hidden by default for TrueNAS SCALE but if you wish to use `Host-Networking` or create an interface inside TrueNAS SCALE (`tailscale0`)

- Click `Expert - Pod Options`
- Click the checkbox for `Host-Networking` if it isn't enabled

### App Configuration

- `Auth Key`: The key you received from tailscale in prerequisites above
Expand All @@ -59,22 +53,26 @@ This section is hidden by default for TrueNAS SCALE but if you wish to use `Host
For more Extra Args and their usage please check the [Tailscale Knowledge Base](https://tailscale.com/kb/1080/cli/#up)
since we consider these advanced features and these may/not be compatible with everyone's exact setup.

TODO: Update image with the new fields
![tailscale-step-3](./img/How-To-Image-2.png)

**Hostname example**

![hostname-example](./img/Hostname.png)

## Namespace Privileges Required for Talos Cluster

In your namespace.yaml file add
```labels:
pod-security.kubernetes.io/enforce: privileged
```

to allow this Chart to run with privileged permissions.

### Networking and Services

The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router.

![tailscale-step-4](./img/How-To-Image-3.png)

### Storage and Persistence

Highly recommended to leave it as `PVC (Simple)`
Highly recommended to leave it as specified in the Charts values.yaml file.

### Ingress

Expand All @@ -89,6 +87,12 @@ Should be left as is, unless you know what you are doing!
You can set custom resources for CPU/RAM, but defaults should be work fine in most cases
Defaults are 4 vCores and 8G RAM.

### Tailscale DNS Setup

In Tailscale Portal on DNS, Namespace section add a new custom nameserver using the Blocky IP address and restrict to domain (SplitDNS) for the Domain used in ClusterTool for Talos.

![tailscale-nameserver](./img/tailscale-nameserver.png)

### Addons

Shouldn't need to enable any.
Expand Down
Binary file removed charts/stable/tailscale/docs/img/How-To-Image-2.png
Binary file not shown.
Binary file removed charts/stable/tailscale/docs/img/How-To-Image-3.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 84e9531

Please sign in to comment.