talos

1
syntax = "proto3";
2

3
package common;
4

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

7
import "google/protobuf/any.proto";
8
import "google/protobuf/descriptor.proto";
9
import "google/rpc/status.proto";
10

11
// An alternative to using options could be extracting versions from comments.
12
// Unfortunately, they are not available: https://github.com/golang/protobuf/issues/1134
13
// Also, while option numbers can be the same,
14
// names should be different: https://github.com/protocolbuffers/protobuf/issues/4861
15

16
extend google.protobuf.MessageOptions {
17
  // Indicates the Talos version when this deprecated message will be removed from API.
18
  string remove_deprecated_message = 93117;
19
}
20

21
extend google.protobuf.FieldOptions {
22
  // Indicates the Talos version when this deprecated filed will be removed from API.
23
  string remove_deprecated_field = 93117;
24
}
25

26
extend google.protobuf.EnumOptions {
27
  // Indicates the Talos version when this deprecated enum will be removed from API.
28
  string remove_deprecated_enum = 93117;
29
}
30

31
extend google.protobuf.EnumValueOptions {
32
  // Indicates the Talos version when this deprecated enum value will be removed from API.
33
  string remove_deprecated_enum_value = 93117;
34
}
35

36
extend google.protobuf.MethodOptions {
37
  // Indicates the Talos version when this deprecated method will be removed from API.
38
  string remove_deprecated_method = 93117;
39
}
40

41
extend google.protobuf.ServiceOptions {
42
  // Indicates the Talos version when this deprecated service will be removed from API.
43
  string remove_deprecated_service = 93117;
44
}
45

46
enum Code {
47
  FATAL = 0;
48
  LOCKED = 1;
49
  CANCELED = 2;
50
}
51

52
message Error {
53
  Code code = 1;
54
  string message = 2;
55
  repeated google.protobuf.Any details = 3;
56
}
57

58
// Common metadata message nested in all reply message types
59
message Metadata {
60
  // hostname of the server response comes from (injected by proxy)
61
  string hostname = 1;
62
  // error is set if request failed to the upstream (rest of response is
63
  // undefined)
64
  string error = 2;
65
  // error as gRPC Status
66
  google.rpc.Status status = 3;
67
}
68

69
message Data {
70
  Metadata metadata = 1;
71
  bytes bytes = 2;
72
}
73

74
message DataResponse {
75
  repeated Data messages = 1;
76
}
77

78
message Empty {
79
  Metadata metadata = 1;
80
}
81

82
message EmptyResponse {
83
  repeated Empty messages = 1;
84
}
85

86
enum ContainerDriver {
87
  CONTAINERD = 0;
88
  CRI = 1;
89
}
90

91
enum ContainerdNamespace {
92
  NS_UNKNOWN = 0;
93
  NS_SYSTEM = 1;
94
  NS_CRI = 2;
95
}
96

97
message URL {
98
  string full_path = 1;
99
}
100

101
message PEMEncodedCertificateAndKey {
102
  bytes crt = 1;
103
  bytes key = 2;
104
}
105

106
message PEMEncodedKey {
107
  bytes key = 1;
108
}
109

110
message PEMEncodedCertificate {
111
  bytes crt = 1;
112
}
113

114
message NetIP {
115
  bytes ip = 1;
116
}
117

118
message NetIPPort {
119
  bytes ip = 1;
120
  int32 port = 2;
121
}
122

123
message NetIPPrefix {
124
  bytes ip = 1;
125
  int32 prefix_length = 2;
126
}
127