Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ws-manager-bridge] Document ClusterService rpcs and messages #8721

Merged
merged 1 commit into from
Mar 10, 2022
Merged

[ws-manager-bridge] Document ClusterService rpcs and messages #8721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions components/ws-manager-bridge-api/cluster-service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,18 @@ package workspacemanagerbridge;

option go_package = "github.com/gitpod-io/gitpod/workspace-manager-bridge/api";

// ClusterService enables WorkspaceClusters to be dynamically managed.
service ClusterService {
// Register registers a new WorkspaceCluster.
rpc Register(RegisterRequest) returns (RegisterResponse) {}

// Update modififes properties of an already registered WorkspaceCluster.
rpc Update(UpdateRequest) returns (UpdateResponse) {}

// Deregister removes a WorkspaceCluster from available clusters.
rpc Deregister(DeregisterRequest) returns (DeregisterResponse) {}

// List returns the currently registered WorkspaceClusters.
rpc List(ListRequest) returns (ListResponse) {}
}

Expand Down Expand Up @@ -104,7 +112,10 @@ message ModifyAdmissionConstraint {
message UpdateResponse {}

message DeregisterRequest {
// name is the name of the WorkspaceCluster to deregister
string name = 1;
// force causes the cluster to be deregistered even if there are
// intances still running on the cluster.
bool force = 2;
}

Expand Down
7 changes: 5 additions & 2 deletions components/ws-manager-bridge-api/go/cluster-service.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions components/ws-manager-bridge-api/go/cluster-service_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions components/ws-manager-bridge-api/typescript/src/cluster-service_grpc_pb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,10 @@ function deserialize_workspacemanagerbridge_UpdateResponse(buffer_arg) {
}


// ClusterService enables WorkspaceClusters to be dynamically managed.
var ClusterServiceService = exports.ClusterServiceService = {
register: {
// Register registers a new WorkspaceCluster.
register: {
path: '/workspacemanagerbridge.ClusterService/Register',
requestStream: false,
responseStream: false,
Expand All @@ -110,7 +112,8 @@ var ClusterServiceService = exports.ClusterServiceService = {
responseSerialize: serialize_workspacemanagerbridge_RegisterResponse,
responseDeserialize: deserialize_workspacemanagerbridge_RegisterResponse,
},
update: {
// Update modififes properties of an already registered WorkspaceCluster.
update: {
path: '/workspacemanagerbridge.ClusterService/Update',
requestStream: false,
responseStream: false,
Expand All @@ -121,7 +124,8 @@ var ClusterServiceService = exports.ClusterServiceService = {
responseSerialize: serialize_workspacemanagerbridge_UpdateResponse,
responseDeserialize: deserialize_workspacemanagerbridge_UpdateResponse,
},
deregister: {
// Deregister removes a WorkspaceCluster from available clusters.
deregister: {
path: '/workspacemanagerbridge.ClusterService/Deregister',
requestStream: false,
responseStream: false,
Expand All @@ -132,7 +136,8 @@ var ClusterServiceService = exports.ClusterServiceService = {
responseSerialize: serialize_workspacemanagerbridge_DeregisterResponse,
responseDeserialize: deserialize_workspacemanagerbridge_DeregisterResponse,
},
list: {
// List returns the currently registered WorkspaceClusters.
list: {
path: '/workspacemanagerbridge.ClusterService/List',
requestStream: false,
responseStream: false,
Expand Down