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

Jump to bottom

Document versioning/upgrading inlets for uplink #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document versioning/upgrading inlets for uplink #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions docs/uplink/create-tunnels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,33 @@ spec:
region: east
```

## Set the inlets version used by tunnels

The inlets version for a tunnel can be set by using the `inletsVersion` field in the tunnel spec. If the field is omitted, the tunnel wil use the inlets version configured in the `values.yaml` file.

```yaml
apiVersion: uplink.inlets.dev/v1alpha1
kind: Tunnel
metadata:
name: acmeco
namespace: tunnels
spec:
inletsVersion: 0.9.18
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have we released this feature yet?

licenseRef:
name: inlets-uplink-license
namespace: tunnels
```

The version can also be set when creating a tunnel with the CLI:

```bash
inlets-pro tunnel create acmeco \
-n tunnels
--version "0.9.18"
```

To prevent mismatches with the inlets uplink client existing tunnels are not automatically updated when the `inletsVersion` parameter in the Chart changes. See [upgrading tunnels](/uplink/manage-tunnels/#upgrade-the-inlets-version-of-a-tunnel).

## Connect to tunnels

The `uplink client` command is part of the inlets-pro binary. It is used to connect to tunnels and expose services over the tunnel.
Expand Down
28 changes: 28 additions & 0 deletions docs/uplink/manage-tunnels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,34 @@ spec:

Alternatively, if you have the tunnel saved as a YAML file, you can edit it and apply it again with `kubectl apply`.

## Upgrade the inlets version of a tunnel

The inlets version for a tunnel is set upon tunnel creation either by setting the `inletsVersion` in Tunnel Custom Resource or the default version configured in the `values.yaml` file is used.

To prevent mismatches with the inlets uplink client the inlets version is never upgraded unless it is explicitly updated in the Tunnel Custom Resource.

You can change the inlets version used by the tunnel deployment by editing the Tunnel CRD. Add or edit the `inletsVersion` field in the tunnel spec and set it to the desired version:

```bash
kubectl edit -n tunnels \
tunnel/acmeco
```

```diff
apiVersion: uplink.inlets.dev/v1alpha1
kind: Tunnel
metadata:
name: acmeco
namespace: tunnels
spec:
+ inletsVersion: 0.9.18
licenseRef:
name: inlets-uplink-license
namespace: tunnels
tcpPorts:
- 8080
```

## Check the logs of a tunnel

The logs for tunnels can be useful for troubleshooting or to see if clients are connecting successfully.
Expand Down