docs: add theila ui

Adds an introduction section for using Theila with Talos
clusters.

Signed-off-by: Tim Jones <tim.jones@siderolabs.com>
This commit is contained in:
Tim Jones 2022-06-27 16:27:36 +02:00
parent b81016e628
commit 758a9bf59f
No known key found for this signature in database
GPG Key ID: A2A702DD5B689F45
13 changed files with 229 additions and 0 deletions

View File

@ -8,6 +8,7 @@ preRelease: false
lastRelease: v1.0.6
kubernetesRelease: "1.23.5"
prevKubernetesRelease: "1.23.1"
theilaRelease: "v0.2.1"
---
## Welcome

View File

@ -0,0 +1,75 @@
---
title: Theila UI for Talos
weight: 35
description: "An intro to Theila - a UI for Talos clusters."
---
Once you have a Talos cluster running, you may find it easier to get insights on your cluster(s) using a visual user interface rather than the `talosctl` CLI.
For this, Sidero Labs provides [Theila](https://github.com/siderolabs/theila), a simple, single-binary web-based visual user interface for Talos clusters.
## Prerequisites
You should have a Talos cluster up & running, and the `talosconfig` file for Theila to access it.
## Installation
Theila is published as a single static binary compiled for various platforms and architectures, as well as a container image.
### Binary
You can download the correct binary for your system from the [releases](https://github.com/siderolabs/theila/releases) page, or use the following commands in your terminal.
```bash
curl -Lo /usr/local/bin/theila https://github.com/siderolabs/thelia/releases/download/{{< thelia_release >}}/thelia-$(uname -s | tr "[:upper:]" "[:lower:]")-amd64
chmod +x /usr/local/bin/talosctl
```
## Use
Once installed, you can run Theila by simply running it.
<!-- markdownlint-disable MD001 -->
<!-- markdownlint-disable MD022 -->
<!-- markdownlint-disable MD025 -->
{{< tabpane lang="bash" >}}
{{< tab header="Binary" >}}
# address and port are not required and default to the values shown
theila --address 127.0.0.1 --port 8080
{{< /tab >}}
{{< tab header="Docker" >}}
docker run --rm --volume ${HOME}/.talos/config:/opt/talosconfig:ro --env TALOSCONFIG=/opt/talosconfig --publish 8080:8080 ghcr.io/siderolabs/theila --address 0.0.0.0
{{< /tab >}}
{{< /tabpane >}}
Once it is running you should be able to point a browser at [http://localhost:8080](http://localhost:8080) to open the Theila UI.
### Clusters
You can navigate around various Talos clusters using the menu at the upper-left corner (see 1.1), then selecting the specific cluster from the list (see 1.2).
![Fig 1 Talos cluster selection with Theila](/images/theila-cluster-selection.png)
### Cluster Overview
Clicking on the "Overview" option in the menu (see 2.1) will display an overview of resource use & health of the cluster.
![Fig 2 Talos cluster overview](/images/theila-cluster-overview.png)
### Nodes
Entering the "Nodes" section on the menu (see 3.1) will give a list of nodes in the cluster (see 3.2), along with information such as IP address, status, and any roles assigned to the node.
Opening the node menu (see 3.3) show the actions that can be taken on a specific node.
![Fig 3 Node list](/images/theila-nodes.png)
Clicking on a specific node name in the node list will open the node detail page for more information on each specific node (see 4.1), including running services and their logs (see 4.2).
![Fig 4 Node detail](/images/theila-node-detail.png)
Clicking on the "Monitor" tab (see 5.1) allows you to watch resource use over time, with CPU and memory consumption graphs updated in real time, and a detailed list of running process each with their individual resource use (see 5.2).
![Fig 5 Node monitoring](/images/theila-node-monitor.png)
Lastly, the "Dmesg" tab shows all kernel messages of the node since boot.
### Pods
Using the "Pods" section on the menu (see 6.1) will list all pods in the cluster, across all namespaces.
Clicking on the drop-down arrow (see 6.2) will open up more detailed information of the specified pod.
![Fig 6 Pods](/images/theila-pods.png)

View File

@ -9,6 +9,7 @@ lastRelease: v1.1.0
kubernetesRelease: "1.24.2"
prevKubernetesRelease: "1.23.5"
iscsiToolsRelease: "v0.1.1"
theilaRelease: "v0.2.1"
menu: main
---

View File

@ -0,0 +1,75 @@
---
title: Theila UI for Talos
weight: 35
description: "An intro to Theila - a UI for Talos clusters."
---
Once you have a Talos cluster running, you may find it easier to get insights on your cluster(s) using a visual user interface rather than the `talosctl` CLI.
For this, Sidero Labs provides [Theila](https://github.com/siderolabs/theila), a simple, single-binary web-based visual user interface for Talos clusters.
## Prerequisites
You should have a Talos cluster up & running, and the `talosconfig` file for Theila to access it.
## Installation
Theila is published as a single static binary compiled for various platforms and architectures, as well as a container image.
### Binary
You can download the correct binary for your system from the [releases](https://github.com/siderolabs/theila/releases) page, or use the following commands in your terminal.
```bash
curl -Lo /usr/local/bin/theila https://github.com/siderolabs/thelia/releases/download/{{< thelia_release >}}/thelia-$(uname -s | tr "[:upper:]" "[:lower:]")-amd64
chmod +x /usr/local/bin/talosctl
```
## Use
Once installed, you can run Theila by simply running it.
<!-- markdownlint-disable MD001 -->
<!-- markdownlint-disable MD022 -->
<!-- markdownlint-disable MD025 -->
{{< tabpane lang="bash" >}}
{{< tab header="Binary" >}}
# address and port are not required and default to the values shown
theila --address 127.0.0.1 --port 8080
{{< /tab >}}
{{< tab header="Docker" >}}
docker run --rm --volume ${HOME}/.talos/config:/opt/talosconfig:ro --env TALOSCONFIG=/opt/talosconfig --publish 8080:8080 ghcr.io/siderolabs/theila --address 0.0.0.0
{{< /tab >}}
{{< /tabpane >}}
Once it is running you should be able to point a browser at [http://localhost:8080](http://localhost:8080) to open the Theila UI.
### Clusters
You can navigate around various Talos clusters using the menu at the upper-left corner (see 1.1), then selecting the specific cluster from the list (see 1.2).
![Fig 1 Talos cluster selection with Theila](/images/theila-cluster-selection.png)
### Cluster Overview
Clicking on the "Overview" option in the menu (see 2.1) will display an overview of resource use & health of the cluster.
![Fig 2 Talos cluster overview](/images/theila-cluster-overview.png)
### Nodes
Entering the "Nodes" section on the menu (see 3.1) will give a list of nodes in the cluster (see 3.2), along with information such as IP address, status, and any roles assigned to the node.
Opening the node menu (see 3.3) show the actions that can be taken on a specific node.
![Fig 3 Node list](/images/theila-nodes.png)
Clicking on a specific node name in the node list will open the node detail page for more information on each specific node (see 4.1), including running services and their logs (see 4.2).
![Fig 4 Node detail](/images/theila-node-detail.png)
Clicking on the "Monitor" tab (see 5.1) allows you to watch resource use over time, with CPU and memory consumption graphs updated in real time, and a detailed list of running process each with their individual resource use (see 5.2).
![Fig 5 Node monitoring](/images/theila-node-monitor.png)
Lastly, the "Dmesg" tab shows all kernel messages of the node since boot.
### Pods
Using the "Pods" section on the menu (see 6.1) will list all pods in the cluster, across all namespaces.
Clicking on the drop-down arrow (see 6.2) will open up more detailed information of the specified pod.
![Fig 6 Pods](/images/theila-pods.png)

View File

@ -8,6 +8,7 @@ preRelease: true
lastRelease: v1.2.0-alpha.0
kubernetesRelease: "1.24.2"
prevKubernetesRelease: "1.24.1"
theilaRelease: "v0.2.1"
---
## Welcome

View File

@ -0,0 +1,75 @@
---
title: Theila UI for Talos
weight: 35
description: "An intro to Theila - a UI for Talos clusters."
---
Once you have a Talos cluster running, you may find it easier to get insights on your cluster(s) using a visual user interface rather than the `talosctl` CLI.
For this, Sidero Labs provides [Theila](https://github.com/siderolabs/theila), a simple, single-binary web-based visual user interface for Talos clusters.
## Prerequisites
You should have a Talos cluster up & running, and the `talosconfig` file for Theila to access it.
## Installation
Theila is published as a single static binary compiled for various platforms and architectures, as well as a container image.
### Binary
You can download the correct binary for your system from the [releases](https://github.com/siderolabs/theila/releases) page, or use the following commands in your terminal.
```bash
curl -Lo /usr/local/bin/theila https://github.com/siderolabs/thelia/releases/download/{{< thelia_release >}}/thelia-$(uname -s | tr "[:upper:]" "[:lower:]")-amd64
chmod +x /usr/local/bin/talosctl
```
## Use
Once installed, you can run Theila by simply running it.
<!-- markdownlint-disable MD001 -->
<!-- markdownlint-disable MD022 -->
<!-- markdownlint-disable MD025 -->
{{< tabpane lang="bash" >}}
{{< tab header="Binary" >}}
# address and port are not required and default to the values shown
theila --address 127.0.0.1 --port 8080
{{< /tab >}}
{{< tab header="Docker" >}}
docker run --rm --volume ${HOME}/.talos/config:/opt/talosconfig:ro --env TALOSCONFIG=/opt/talosconfig --publish 8080:8080 ghcr.io/siderolabs/theila --address 0.0.0.0
{{< /tab >}}
{{< /tabpane >}}
Once it is running you should be able to point a browser at [http://localhost:8080](http://localhost:8080) to open the Theila UI.
### Clusters
You can navigate around various Talos clusters using the menu at the upper-left corner (see 1.1), then selecting the specific cluster from the list (see 1.2).
![Fig 1 Talos cluster selection with Theila](/images/theila-cluster-selection.png)
### Cluster Overview
Clicking on the "Overview" option in the menu (see 2.1) will display an overview of resource use & health of the cluster.
![Fig 2 Talos cluster overview](/images/theila-cluster-overview.png)
### Nodes
Entering the "Nodes" section on the menu (see 3.1) will give a list of nodes in the cluster (see 3.2), along with information such as IP address, status, and any roles assigned to the node.
Opening the node menu (see 3.3) show the actions that can be taken on a specific node.
![Fig 3 Node list](/images/theila-nodes.png)
Clicking on a specific node name in the node list will open the node detail page for more information on each specific node (see 4.1), including running services and their logs (see 4.2).
![Fig 4 Node detail](/images/theila-node-detail.png)
Clicking on the "Monitor" tab (see 5.1) allows you to watch resource use over time, with CPU and memory consumption graphs updated in real time, and a detailed list of running process each with their individual resource use (see 5.2).
![Fig 5 Node monitoring](/images/theila-node-monitor.png)
Lastly, the "Dmesg" tab shows all kernel messages of the node since boot.
### Pods
Using the "Pods" section on the menu (see 6.1) will list all pods in the cluster, across all namespaces.
Clicking on the drop-down arrow (see 6.2) will open up more detailed information of the specified pod.
![Fig 6 Pods](/images/theila-pods.png)

View File

@ -0,0 +1 @@
{{ .Page.FirstSection.Params.theilaRelease -}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB