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.

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

feat: show siderolink status on dashboard #8909

Merged

Conversation

utkuozdemir
Copy link
Member

@utkuozdemir utkuozdemir commented Jun 14, 2024

Add a new resource, SiderolinkStatus, which combines the following info:

  • The Siderolink API endpoint without the query parameters or fragments (potentially sensitive info due to the join token)
  • The status of the Siderolink connection

This resource is not set as sensitive, so it can be retrieved by the users with os:operator role (e.g., using talosctl dashboard through Omni).

Make use of this resource in the dashboard to display the status of the Siderolink connection.

Additionally, rework the status columns in the dashboard to:

  • Display a Linux terminal compatible "tick" or a "cross" prefix for statuses in addition to the red/green color coding.
  • Move and combine some statuses to save rows and make them more even.

Closes #8643.

Screenshots

qemu-1
qemu-2
cli-1
cli-2

@frezbo
Copy link
Member

frezbo commented Jun 14, 2024

could you add a screenshot?

Copy link
Member

@DmitriyMV DmitriyMV left a comment

Choose a reason for hiding this comment

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

🆒

@utkuozdemir
Copy link
Member Author

could you add a screenshot?

sure, will do a bit later

@smira
Copy link
Member

smira commented Jun 14, 2024

could you add a screenshot?

and to make it perfect, screenshot from QEMU - if you need help with that, I can try it out myself

Copy link
Member

@smira smira left a comment

Choose a reason for hiding this comment

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

waiting for a screenshot, cool 👍

let me know if you need help with QEMU

@utkuozdemir
Copy link
Member Author

waiting for a screenshot, cool 👍

let me know if you need help with QEMU

Nope, all good, just AFK for a while. I'll provide both screenshots.

@utkuozdemir
Copy link
Member Author

utkuozdemir commented Jun 14, 2024

@smira @frezbo added the screenshots

You guys have any idea on getting rid of STATE on left column, so we can save 1 more row?

@utkuozdemir utkuozdemir force-pushed the siderolink-status-on-dashboard branch from 0d27f1a to 6a06f53 Compare June 14, 2024 14:44
@frezbo
Copy link
Member

frezbo commented Jun 14, 2024

@smira @frezbo added the screenshots

You guys have any idea on getting rid of STATE on left column, so we can save 1 more row?

don't see it yet 😅

@utkuozdemir
Copy link
Member Author

@smira @frezbo added the screenshots
You guys have any idea on getting rid of STATE on left column, so we can save 1 more row?

don't see it yet 😅

here :)
image

@frezbo
Copy link
Member

frezbo commented Jun 14, 2024

what does that even mean by STATE: OK? I think we can drop it, its confusing

@utkuozdemir
Copy link
Member Author

what does that even mean by STATE: OK? I think we can drop it, its confusing

It reports if the state partition is mounted. Also, if it's encrypted, it looks like OK - encrypted.

It's been there since a long time. I agree that it my itself doesn't make too much sense, but the encryption info is good.

@frezbo
Copy link
Member

frezbo commented Jun 14, 2024

what does that even mean by STATE: OK? I think we can drop it, its confusing

It reports if the state partition is mounted. Also, if it's encrypted, it looks like OK - encrypted.

It's been there since a long time. I agree that it my itself doesn't make too much sense, but the encryption info is good.

ahh now I remeber, the encrypted info i useful, i think added when we did the TPM thing, so now not so sure

@smira
Copy link
Member

smira commented Jun 14, 2024

One small nit: let's drop the protocol/port from the SideroLink, just the hostname. It helps to identify Omn instance, but it's not meant to provide the full URL

@smira
Copy link
Member

smira commented Jun 14, 2024

ahh now I remeber, the encrypted info i useful, i think added when we did the TPM thing, so now not so sure

I'd say drop it... probably we could later merge Secureboot/disk encryption into something more helpful, like "Security: Secureboot/Disk encryption"

@utkuozdemir utkuozdemir force-pushed the siderolink-status-on-dashboard branch from 6a06f53 to ca8b017 Compare June 18, 2024 10:08
@utkuozdemir
Copy link
Member Author

Updated preview after changes:
preview

Add a new resource, `SiderolinkStatus`, which combines the following info:
- The Siderolink API endpoint without the query parameters or fragments (potentially sensitive info due to the join token)
- The status of the Siderolink connection

This resource is not set as sensitive, so it can be retrieved by the users with `os:operator` role (e.g., using `talosctl dashboard` through Omni).

Make use of this resource in the dashboard to display the status of the Siderolink connection.

Additionally, rework the status columns in the dashboard to:
- Display a Linux terminal compatible "tick" or a "cross" prefix for statuses in addition to the red/green color coding.
- Move and combine some statuses to save rows and make them more even.

Closes siderolabs#8643.

Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
@utkuozdemir utkuozdemir force-pushed the siderolink-status-on-dashboard branch from ca8b017 to 5ffc3f1 Compare June 18, 2024 10:31
@utkuozdemir
Copy link
Member Author

/m

@talos-bot talos-bot merged commit 5ffc3f1 into siderolabs:main Jun 18, 2024
48 checks passed
@utkuozdemir utkuozdemir deleted the siderolink-status-on-dashboard branch June 18, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add SideroLink endpoint to Talos dashboard
5 participants