Skip to content

Commit f26e0e4

Browse files
committed
docs: add info on nautik
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
1 parent 42f167c commit f26e0e4

10 files changed

Lines changed: 50 additions & 0 deletions

omni.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ navigation:
6666
- "how-to-set-initial-machine-labels.mdx"
6767
- "setting-up-the-bare-metal-infrastructure-provider.mdx"
6868
- "omni-firewall-egress-requirement.mdx"
69+
6970
- group: "Cluster Management"
7071
folder: "omni/cluster-management"
7172
pages:
@@ -85,6 +86,7 @@ navigation:
8586
- "restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx"
8687
- "using-audit-log.mdx"
8788
- "importing-talos-clusters.mdx"
89+
- "manage-omni-cluster-with-nautik.mdx"
8890
- "wipe-a-machine.mdx"
8991
- "talos-config-overrides.mdx"
9092
- "override-ntp-servers.mdx"

public/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2433,6 +2433,7 @@
24332433
"omni/cluster-management/restore-etcd-of-a-cluster-managed-by-cluster-templates",
24342434
"omni/cluster-management/using-audit-log",
24352435
"omni/cluster-management/importing-talos-clusters",
2436+
"omni/cluster-management/manage-omni-cluster-with-nautik",
24362437
"omni/cluster-management/wipe-a-machine",
24372438
"omni/cluster-management/talos-config-overrides",
24382439
"omni/cluster-management/override-ntp-servers",
715 KB
Loading
762 KB
Loading
658 KB
Loading
746 KB
Loading
572 KB
Loading
601 KB
Loading
640 KB
Loading
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "Manage Omni Clusters with Nautik"
3+
description: "Use Nautik to view and manage your Omni-managed Talos Linux clusters from macOS, iPhone, or iPad."
4+
---
5+
6+
[Nautik](https://nautik.io) is a native Kubernetes client for Apple platforms. It has a built-in Talos Omni integration that lets you authenticate and import clusters directly through a browser-based sign-in flow, without manually handling kubeconfig files.
7+
8+
This guide walks you through connecting Nautik to your Omni instance and importing a cluster.
9+
10+
## Prerequisites
11+
12+
Before you begin, ensure you have the following:
13+
14+
- A macOS, iOS, or iPadOS device with [Nautik](https://nautik.io/) installed.
15+
- An active [Omni](https://www.siderolabs.com/omni-signup) account with at least one cluster created.
16+
17+
## Add a cluster to Nautik
18+
19+
Nautik connects to your Omni instance using a browser-based sign-in flow. Once authenticated, it lists the clusters available to your account so you can import them directly into the app.
20+
21+
To add a cluster:
22+
23+
1. Open Nautik and click **+ Add Cluster**.
24+
2. Click **Connect with Cloud Provider**.
25+
![Nautik connect with Cloud Providers](./images/manage-omni-cluster-with-nautik-cloud-provider.png)
26+
3. Select **Talos Omni** from the list of providers.
27+
![Nautik Talos Omni selection](./images/manage-omni-cluster-with-nautik-talos-omni.png)
28+
4. Enter your **Omni URL** and **Email Address**.
29+
![Enter your Omni information](./images/manage-omni-cluster-with-nautik-omni-instance-info.png)
30+
5. Click **Sign In With Sidero**. A browser window will open for you to authenticate.
31+
6. Once authenticated, select your preferred **Auth Type**:
32+
- **OpenID Connect**: Short-lived credentials. You will need to re-authenticate when they expire.
33+
- **Service Account**: Long-lived token embedded in the kubeconfig. Works immediately after import with no additional login required.
34+
![Select Auth Type](./images/manage-omni-cluster-with-nautik-auth-type.png)
35+
7. Click **Import** next to the cluster you want to add.
36+
![Import the cluster](./images/manage-omni-cluster-with-nautik-import-clusters.png)
37+
38+
Nautik stores your credentials securely in the device keychain. You can choose between **Local Keychain** and **iCloud Keychain** at import time, iCloud Keychain syncs your cluster credentials across your Apple devices automatically.
39+
40+
8. Close the modal and you should see information on your cluster in the Nautik dashboard.
41+
![Nautik](./images/manage-omni-cluster-with-nautik-dashboard-clusters.png)
42+
43+
## Remove a cluster from Nautik
44+
45+
If you need to remove a cluster from Nautik, you can do so at any time. Removing a cluster immediately and permanently deletes all stored credentials for that cluster from the device keychain.
46+
47+
To remove a cluster, right-click the cluster name in the cluster picker and select **Delete**.

0 commit comments

Comments
 (0)