eyjhb/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Create an initial gRPC service

Browse source 
This commit adds protobuf files and tooling surrounding generating APIs
and datatypes.
This commit is contained in:
Kristoffer Dalby 2021-10-26 20:37:37 +00:00
parent e8277595f5
commit b096a2e7e5
6 changed files with 143 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

71
proto/v1/headscale.proto Normal file
View file

@ -0,0 +1,71 @@
syntax = "proto3";
package headscale.v1;
option go_package = "github.com/juanfont/headscale/gen/go/v1";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
import "options/gorm.proto";
enum RegisterMethod {
AUTH_KEY = 0;
CLI = 1;
OIDC = 2;
}
message Namespace {
string Name = 1;
}
message PreAuthKey {
uint64 ID = 1;
string Key = 2;
uint32 NamespaceID = 3;
Namespace Namespace = 4;
bool Reusable = 5;
bool Ephemeral = 6;
bool Used = 7;
google.protobuf.Timestamp CreatedAt = 8;
google.protobuf.Timestamp Expiration = 9;
}
message GetMachineRequest {
uint64 machine_id = 1;
}
message Machine {
option(gorm.opts).ormable = true;
uint64 ID = 1;
string MachineKey = 2;
string NodeKey = 3;
string DiscoKey = 4;
string IPAddress = 5;
string Name = 6;
uint32 NamespaceID = 7;
bool Registered = 8;
RegisterMethod RegisterMethod = 9;
uint32 AuthKeyID = 10;
PreAuthKey AuthKey = 11;
google.protobuf.Timestamp LastSeen = 12;
google.protobuf.Timestamp LastSuccessfulUpdate = 13;
google.protobuf.Timestamp Expiry = 14;
bytes HostInfo = 15;
bytes Endpoints = 16;
bytes EnabledRoutes = 17;
google.protobuf.Timestamp CreatedAt = 18;
google.protobuf.Timestamp UpdatedAt = 19;
google.protobuf.Timestamp DeletedAt = 20;
}
// Gin Router will prefix this with /api/v1
service HeadscaleService {
rpc GetMachine(GetMachineRequest) returns(Machine) {
option(google.api.http) = {
get : "/api/v1/machine/{machine_id}"
};
}
}