talos

1
syntax = "proto3";
2

3
package storage;
4

5
option go_package = "github.com/siderolabs/talos/pkg/machinery/api/storage";
6

7
import "common/common.proto";
8
import "google/protobuf/empty.proto";
9

10
// StorageService represents the storage service.
11
service StorageService {
12
  rpc Disks(google.protobuf.Empty) returns (DisksResponse);
13
}
14

15
// Disk represents a disk.
16
message Disk {
17
  // Size indicates the disk size in bytes.
18
  uint64 size = 1;
19
  // Model idicates the disk model.
20
  string model = 2;
21
  // DeviceName indicates the disk name (e.g. `sda`).
22
  string device_name = 3;
23
  // Name as in `/sys/block/<dev>/device/name`.
24
  string name = 4;
25
  // Serial as in `/sys/block/<dev>/device/serial`.
26
  string serial = 5;
27
  // Modalias as in `/sys/block/<dev>/device/modalias`.
28
  string modalias = 6;
29
  // Uuid as in `/sys/block/<dev>/device/uuid`.
30
  string uuid = 7;
31
  // Wwid as in `/sys/block/<dev>/device/wwid`.
32
  string wwid = 8;
33
  enum DiskType {
34
    UNKNOWN = 0;
35
    SSD = 1;
36
    HDD = 2;
37
    NVME = 3;
38
    SD = 4;
39
    CD = 5;
40
  }
41
  // Type is a type of the disk: nvme, ssd, hdd, sd card.
42
  DiskType type = 9;
43
  // BusPath is the bus path of the disk.
44
  string bus_path = 10;
45
  // SystemDisk indicates that the disk is used as Talos system disk.
46
  bool system_disk = 11;
47
  // Subsystem is the symlink path in the `/sys/block/<dev>/subsystem`.
48
  string subsystem = 12;
49
  // Readonly specifies if the disk is read only.
50
  bool readonly = 13;
51
}
52

53
// DisksResponse represents the response of the `Disks` RPC.
54
message Disks {
55
  common.Metadata metadata = 1;
56
  repeated Disk disks = 2;
57
}
58

59
message DisksResponse {
60
  repeated Disks messages = 1;
61
}
62