WorkerCoordination and GetSession API refactoring (#354)
* Possible api changes. * Worker API update. * Updating import alias name. * Moving session down a level as a member of the GetSessionResponse. * Marshal the auth flag into the GetSessionResponse proto instead of the session.
This commit is contained in:
1 parent
2914b4c14c
commit
33e7b4538e
18 files changed
+1923
-936
No files matched your search
@@ -0,0 +1,84 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package controller.servers.services.v1;
|
||||
|
||||
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/servers/services;services";
|
||||
|
||||
import "google/protobuf/timestamp.proto";
|
||||
import "controller/servers/v1/servers.proto";
|
||||
|
||||
service ServerCoordinationService {
|
||||
// Status gets worker status requests which include the ongoing jobs the worker is handling and
|
||||
// returns the status response which includes the changes the controller would like to make to
|
||||
// jobs as well as provide a list of the controllers in the system.
|
||||
rpc Status(StatusRequest) returns (StatusResponse) {}
|
||||
}
|
||||
|
||||
message Connection {
|
||||
// TODO: Populate the connection specific info.
|
||||
// byte up/down
|
||||
// duration
|
||||
// etc...
|
||||
}
|
||||
|
||||
message SessionJobInfo {
|
||||
repeated Connection connections = 1;
|
||||
}
|
||||
|
||||
message Job {
|
||||
string job_id = 1;
|
||||
enum JOBTYPE {
|
||||
JOBTYPE_UNSPECIFIED = 0;
|
||||
JOBTYPE_SESSION = 1;
|
||||
}
|
||||
JOBTYPE type = 2;
|
||||
oneof job_info {
|
||||
// This value is specified when type is JOBTYPE_SESSION.
|
||||
SessionJobInfo session_info = 3;
|
||||
}
|
||||
}
|
||||
|
||||
message JobStatus {
|
||||
enum STATUS {
|
||||
// TODO: Get a better picture of what states general jobs can be in.
|
||||
STATUS_UNSPECIFIED = 0;
|
||||
// Specifies that the job is actively being handled by the worker.
|
||||
STATUS_ACTIVE = 1;
|
||||
STATUS_CANCELLED = 2;
|
||||
STATUS_COMPLETED = 3;
|
||||
}
|
||||
Job job = 1;
|
||||
STATUS status = 3;
|
||||
}
|
||||
|
||||
message StatusRequest {
|
||||
// The worker info. We could use information from the TLS connection but this
|
||||
// is easier and going the other route doesn't provide much benefit -- if you
|
||||
// get access to the key and spoof the connection, you're already compromised.
|
||||
servers.v1.Server worker = 10;
|
||||
|
||||
// Jobs which this worker wants to report the status.
|
||||
repeated JobStatus jobs = 20;
|
||||
}
|
||||
|
||||
message JobChangeRequest {
|
||||
enum CHANGETYPE {
|
||||
CHANGETYPE_UNSPECIFIED = 0;
|
||||
// Indicates that the job should be cancelled on the worker.
|
||||
CHANGETYPE_CANCEL = 1;
|
||||
}
|
||||
Job job = 1;
|
||||
CHANGETYPE request_type = 2;
|
||||
}
|
||||
|
||||
message StatusResponse {
|
||||
// Active controllers. This can be used (eventually) for connection
|
||||
// management.
|
||||
repeated servers.v1.Server controllers = 10;
|
||||
|
||||
// List of jobs and the expected state changes. For example, this will include jobs witch
|
||||
// change type of cancelled for jobs which are active on a worker but should be cancelled.
|
||||
// This could also contain a request to start a job such as a worker -> worker proxy for
|
||||
// establishing a session through an enclave.
|
||||
repeated JobChangeRequest jobs_requests = 20;
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package controller.servers.services.v1;
|
||||
|
||||
option go_package = "github.com/hashicorp/boundary/internal/gen/controller/servers/services;services";
|
||||
|
||||
import "google/protobuf/timestamp.proto";
|
||||
import "controller/servers/v1/servers.proto";
|
||||
import "controller/api/resources/sessions/v1/session.proto";
|
||||
|
||||
service SessionService {
|
||||
// Validate session allows a worker to retrieve session information from the controller.
|
||||
// This endpoint validates the session
|
||||
rpc GetSession(GetSessionRequest) returns (GetSessionResponse) {}
|
||||
}
|
||||
|
||||
message GetSessionRequest {
|
||||
// The session ID from the client
|
||||
string id = 10;
|
||||
}
|
||||
|
||||
// SessionResponse contains information necessary for a client to establish a session
|
||||
message GetSessionResponse {
|
||||
api.resources.sessions.v1.Session session = 1;
|
||||
}
|
||||
Reference in new issue
Block a user