talos

1
syntax = "proto3";
2

3
package talos.resource.definitions.runtime;
4

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

7
import "common/common.proto";
8
import "google/protobuf/duration.proto";
9
import "resource/definitions/enums/enums.proto";
10

11
// DevicesStatusSpec is the spec for devices status.
12
message DevicesStatusSpec {
13
  bool ready = 1;
14
}
15

16
// DiagnosticSpec is the spec for devices status.
17
message DiagnosticSpec {
18
  string message = 1;
19
  repeated string details = 2;
20
}
21

22
// EventSinkConfigSpec describes configuration of Talos event log streaming.
23
message EventSinkConfigSpec {
24
  string endpoint = 1;
25
}
26

27
// ExtensionServiceConfigFile describes extensions service config files.
28
message ExtensionServiceConfigFile {
29
  string content = 1;
30
  string mount_path = 2;
31
}
32

33
// ExtensionServiceConfigSpec describes status of rendered extensions service config files.
34
message ExtensionServiceConfigSpec {
35
  repeated ExtensionServiceConfigFile files = 1;
36
  repeated string environment = 2;
37
}
38

39
// ExtensionServiceConfigStatusSpec describes status of rendered extensions service config files.
40
message ExtensionServiceConfigStatusSpec {
41
  string spec_version = 1;
42
}
43

44
// KernelModuleSpecSpec describes Linux kernel module to load.
45
message KernelModuleSpecSpec {
46
  string name = 1;
47
  repeated string parameters = 2;
48
}
49

50
// KernelParamSpecSpec describes status of the defined sysctls.
51
message KernelParamSpecSpec {
52
  string value = 1;
53
  bool ignore_errors = 2;
54
}
55

56
// KernelParamStatusSpec describes status of the defined sysctls.
57
message KernelParamStatusSpec {
58
  string current = 1;
59
  string default = 2;
60
  bool unsupported = 3;
61
}
62

63
// KmsgLogConfigSpec describes configuration for kmsg log streaming.
64
message KmsgLogConfigSpec {
65
  repeated common.URL destinations = 1;
66
}
67

68
// MachineStatusSpec describes status of the defined sysctls.
69
message MachineStatusSpec {
70
  talos.resource.definitions.enums.RuntimeMachineStage stage = 1;
71
  MachineStatusStatus status = 2;
72
}
73

74
// MachineStatusStatus describes machine current status at the stage.
75
message MachineStatusStatus {
76
  bool ready = 1;
77
  repeated UnmetCondition unmet_conditions = 2;
78
}
79

80
// MaintenanceServiceConfigSpec describes configuration for maintenance service API.
81
message MaintenanceServiceConfigSpec {
82
  string listen_address = 1;
83
  repeated common.NetIP reachable_addresses = 2;
84
}
85

86
// MetaKeySpec describes status of the defined sysctls.
87
message MetaKeySpec {
88
  string value = 1;
89
}
90

91
// MetaLoadedSpec is the spec for meta loaded. The Done field is always true when resource exists.
92
message MetaLoadedSpec {
93
  bool done = 1;
94
}
95

96
// MountStatusSpec describes status of the defined sysctls.
97
message MountStatusSpec {
98
  string source = 1;
99
  string target = 2;
100
  string filesystem_type = 3;
101
  repeated string options = 4;
102
  bool encrypted = 5;
103
  repeated string encryption_providers = 6;
104
}
105

106
// PlatformMetadataSpec describes platform metadata properties.
107
message PlatformMetadataSpec {
108
  string platform = 1;
109
  string hostname = 2;
110
  string region = 3;
111
  string zone = 4;
112
  string instance_type = 5;
113
  string instance_id = 6;
114
  string provider_id = 7;
115
  bool spot = 8;
116
  string internal_dns = 9;
117
  string external_dns = 10;
118
}
119

120
// SecurityStateSpec describes the security state resource properties.
121
message SecurityStateSpec {
122
  bool secure_boot = 1;
123
  string uki_signing_key_fingerprint = 2;
124
  string pcr_signing_key_fingerprint = 3;
125
}
126

127
// UniqueMachineTokenSpec is the spec for the machine unique token. Token can be empty if machine wasn't assigned any.
128
message UniqueMachineTokenSpec {
129
  string token = 1;
130
}
131

132
// UnmetCondition is a failure which prevents machine from being ready at the stage.
133
message UnmetCondition {
134
  string name = 1;
135
  string reason = 2;
136
}
137

138
// WatchdogTimerConfigSpec describes configuration of watchdog timer.
139
message WatchdogTimerConfigSpec {
140
  string device = 1;
141
  google.protobuf.Duration timeout = 2;
142
}
143

144
// WatchdogTimerStatusSpec describes configuration of watchdog timer.
145
message WatchdogTimerStatusSpec {
146
  string device = 1;
147
  google.protobuf.Duration timeout = 2;
148
  google.protobuf.Duration feed_interval = 3;
149
}
150

151