feat: add readonly information to the disks API response

Forward device readonly info from `go-blockdevice` library. Signed-off-by: Artem Chernyshev <artem.chernyshev@talos-systems.com>
siderolabs · Sep 12, 2023 · 2960f93 · 2960f93
1 parent 735bf9e
commit 2960f93
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 24 deletions.
diff --git a/api/storage/storage.proto b/api/storage/storage.proto
@@ -45,6 +45,8 @@ message Disk {
   bool system_disk = 11;
   // Subsystem is the symlink path in the `/sys/block/<dev>/subsystem`.
   string subsystem = 12;
+  // Readonly specifies if the disk is read only.
+  bool readonly = 13;
 }
 
 // DisksResponse represents the response of the `Disks` RPC.

diff --git a/cmd/talosctl/cmd/talos/disks.go b/cmd/talosctl/cmd/talos/disks.go
@@ -62,6 +62,7 @@ func printDisks(ctx context.Context, c *client.Client) error {
 			"SIZE",
 			"BUS_PATH",
 			"SUBSYSTEM",
+			"READ_ONLY",
 			"SYSTEM_DISK",
 		}, "\t")
 
@@ -97,6 +98,12 @@ func printDisks(ctx context.Context, c *client.Client) error {
 				args = append(args, node)
 			}
 
+			isReadonly := ""
+
+			if disk.Readonly {
+				isReadonly = "*"
+			}
+
 			isSystemDisk := ""
 
 			if disk.SystemDisk {
@@ -115,6 +122,7 @@ func printDisks(ctx context.Context, c *client.Client) error {
 				humanize.Bytes(disk.Size),
 				getWithPlaceholder(disk.BusPath),
 				getWithPlaceholder(disk.Subsystem),
+				isReadonly,
 				isSystemDisk,
 			}...)
 

diff --git a/internal/app/storaged/server.go b/internal/app/storaged/server.go
@@ -44,6 +44,7 @@ func (s *Server) Disks(ctx context.Context, in *emptypb.Empty) (reply *storage.D
 			BusPath:    d.BusPath,
 			SystemDisk: systemDisk != nil && d.DeviceName == systemDisk.Device().Name(),
 			Subsystem:  d.SubSystem,
+			Readonly:   d.ReadOnly,
 		}
 	}
 

diff --git a/pkg/machinery/api/storage/storage.pb.go b/pkg/machinery/api/storage/storage.pb.go
diff --git a/pkg/machinery/api/storage/storage_vtproto.pb.go b/pkg/machinery/api/storage/storage_vtproto.pb.go
diff --git a/website/content/v1.6/reference/api.md b/website/content/v1.6/reference/api.md
@@ -7357,6 +7357,7 @@ Disk represents a disk.
 | bus_path | [string](#string) |  | BusPath is the bus path of the disk. |
 | system_disk | [bool](#bool) |  | SystemDisk indicates that the disk is used as Talos system disk. |
 | subsystem | [string](#string) |  | Subsystem is the symlink path in the `/sys/block/<dev>/subsystem`. |
+| readonly | [bool](#bool) |  | Readonly specifies if the disk is read only. |