[ws-manager-bridge] Support forced cluster dereg

gitpod-io · Nov 18, 2021 · e1f1183 · e1f1183
1 parent 158acc4
commit e1f1183
Show file tree

Hide file tree

Showing 6 changed files with 99 additions and 50 deletions.
diff --git a/components/ws-manager-bridge-api/cluster-service.proto b/components/ws-manager-bridge-api/cluster-service.proto
@@ -107,6 +107,7 @@ message UpdateResponse {}
 
 message DeregisterRequest {
   string name = 1;
+  bool force = 2;
 }
 
 message DeregisterResponse {}

diff --git a/components/ws-manager-bridge-api/go/cluster-service.pb.go b/components/ws-manager-bridge-api/go/cluster-service.pb.go
diff --git a/components/ws-manager-bridge-api/typescript/src/cluster-service_pb.d.ts b/components/ws-manager-bridge-api/typescript/src/cluster-service_pb.d.ts
@@ -423,6 +423,8 @@ export namespace UpdateResponse {
 export class DeregisterRequest extends jspb.Message {
     getName(): string;
     setName(value: string): DeregisterRequest;
+    getForce(): boolean;
+    setForce(value: boolean): DeregisterRequest;
 
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): DeregisterRequest.AsObject;
@@ -437,6 +439,7 @@ export class DeregisterRequest extends jspb.Message {
 export namespace DeregisterRequest {
     export type AsObject = {
         name: string,
+        force: boolean,
     }
 }
 

diff --git a/components/ws-manager-bridge-api/typescript/src/cluster-service_pb.js b/components/ws-manager-bridge-api/typescript/src/cluster-service_pb.js
@@ -3266,7 +3266,8 @@ proto.workspacemanagerbridge.DeregisterRequest.prototype.toObject = function(opt
  */
 proto.workspacemanagerbridge.DeregisterRequest.toObject = function(includeInstance, msg) {
   var f, obj = {
-    name: jspb.Message.getFieldWithDefault(msg, 1, "")
+    name: jspb.Message.getFieldWithDefault(msg, 1, ""),
+    force: jspb.Message.getBooleanFieldWithDefault(msg, 2, false)
   };
 
   if (includeInstance) {
@@ -3307,6 +3308,10 @@ proto.workspacemanagerbridge.DeregisterRequest.deserializeBinaryFromReader = fun
       var value = /** @type {string} */ (reader.readString());
       msg.setName(value);
       break;
+    case 2:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setForce(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -3343,6 +3348,13 @@ proto.workspacemanagerbridge.DeregisterRequest.serializeBinaryToWriter = functio
       f
     );
   }
+  f = message.getForce();
+  if (f) {
+    writer.writeBool(
+      2,
+      f
+    );
+  }
 };
 
 
@@ -3364,6 +3376,24 @@ proto.workspacemanagerbridge.DeregisterRequest.prototype.setName = function(valu
 };
 
 
+/**
+ * optional bool force = 2;
+ * @return {boolean}
+ */
+proto.workspacemanagerbridge.DeregisterRequest.prototype.getForce = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 2, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.workspacemanagerbridge.DeregisterRequest} returns this
+ */
+proto.workspacemanagerbridge.DeregisterRequest.prototype.setForce = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 2, value);
+};
+
+
 
 
 

diff --git a/components/ws-manager-bridge/src/cluster-service-server.ts b/components/ws-manager-bridge/src/cluster-service-server.ts
@@ -240,7 +240,8 @@ export class ClusterService implements IClusterServiceServer {
 
                 const instances = await this.workspaceDB.findRegularRunningInstances();
                 const relevantInstances = instances.filter(i => i.region === req.name);
-                if (relevantInstances.length > 0) {
+                if (!req.force && relevantInstances.length > 0) {
+                    log.info({}, "forced cluster deregistration even though there are still instances running", {cluster: req.name});
                     throw new GRPCError(grpc.status.FAILED_PRECONDITION, `cluster is not empty (${relevantInstances.length} instances remaining)`);
                 }
 

diff --git a/dev/gpctl/cmd/clusters-deregister.go b/dev/gpctl/cmd/clusters-deregister.go
@@ -15,6 +15,10 @@ import (
 	"github.com/gitpod-io/gitpod/ws-manager-bridge/api"
 )
 
+var clustersDeregisterOpts struct {
+	Force bool
+}
+
 // clustersDeregisterCmd represents the clustersDeregisterCmd command
 var clustersDeregisterCmd = &cobra.Command{
 	Use:   "deregister --name [cluster name]",
@@ -31,7 +35,7 @@ var clustersDeregisterCmd = &cobra.Command{
 		defer conn.Close()
 
 		name := getClusterName()
-		_, err = client.Deregister(ctx, &api.DeregisterRequest{Name: name})
+		_, err = client.Deregister(ctx, &api.DeregisterRequest{Name: name, Force: clustersDeregisterOpts.Force})
 		if err != nil && err != io.EOF {
 			log.Fatal(err)
 		}
@@ -42,4 +46,5 @@ var clustersDeregisterCmd = &cobra.Command{
 
 func init() {
 	clustersCmd.AddCommand(clustersDeregisterCmd)
+	clustersDeregisterCmd.Flags().BoolVar(&clustersDeregisterOpts.Force, "force", false, "⚠️💥 force cluster deregistration even if there are still instances running. Use with great caution: this will break people's experience.")
 }