[server] Some cleanup around WorkspaceGarbageCollector

Author: geropl

components/server/src/config.ts

@@ -43,10 +43,23 @@ export interface WorkspaceDefaults {
 export interface WorkspaceGarbageCollection {
     disabled: boolean;
     startDate: number;
+
+    /** The number of seconds between a run and the next */
+    intervalSeconds: number;
+
+    /** The maximum amount of workspaces that are marked as 'softDeleted' in one go */
     chunkLimit: number;
+
+    /** The minimal age of a workspace before it is marked as 'softDeleted' (= hidden for the user) */
     minAgeDays: number;
+
+    /** The minimal age of a prebuild (incl. workspace) before it's content is deleted (+ marked as 'softDeleted') */
     minAgePrebuildDays: number;
+
+    /** The minimal number of days a workspace has to stay in 'softDeleted' before it's content is deleted */
     contentRetentionPeriodDays: number;
+
+    /** The maximum amount of workspaces whose content is deleted in one go */
     contentChunkLimit: number;
 }
 

components/server/src/workspace/garbage-collector.ts

@@ -34,7 +34,10 @@ export class WorkspaceGarbageCollector {
                 dispose: () => {},
             };
         }
-        return repeat(async () => this.garbageCollectWorkspacesIfLeader(), 30 * 60 * 1000);
+        return repeat(
+            async () => this.garbageCollectWorkspacesIfLeader(),
+            this.config.workspaceGarbageCollection.intervalSeconds * 1000,
+        );
     }
 
     public async garbageCollectWorkspacesIfLeader() {
@@ -128,7 +131,7 @@ export class WorkspaceGarbageCollector {
         }
     }
 
-    // finds volume snapshots that have been superceded by newer volume snapshot and removes them
+    // finds volume snapshots that have been superseded by newer volume snapshot and removes them
     protected async deleteOutdatedVolumeSnapshots() {
         const span = opentracing.globalTracer().startSpan("deleteOutdatedVolumeSnapshots");
         try {

components/server/src/workspace/gitpod-server-impl.ts

@@ -1166,7 +1166,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             try {
                 await this.guardAccess({ kind: "workspace", subject: workspace }, "create");
             } catch (err) {
-                await this.workspaceDb.trace(ctx).hardDeleteWorkspace(workspace.id);
+                await this.workspaceDeletionService.hardDeleteWorkspace(ctx, workspace.id);
                 throw err;
             }
 

components/server/src/workspace/workspace-deletion-service.ts

@@ -46,6 +46,17 @@ export class WorkspaceDeletionService {
         });
     }
 
+    /**
+     * This *hard deletes* the workspace entry and all corresponding workspace-instances, by triggering a db-sync mechanism that purges it from the DB.
+     * Note: when this function returns that doesn't mean that the entries are actually gone yet, that might still take a short while until db-sync comes
+     *       around to deleting them.
+     * @param ctx
+     * @param workspaceId
+     */
+    public async hardDeleteWorkspace(ctx: TraceContext, workspaceId: string): Promise<void> {
+        await this.db.trace(ctx).hardDeleteWorkspace(workspaceId);
+    }
+
     /**
      * This method garbageCollects a workspace. It deletes its contents and sets the workspaces 'contentDeletedTime'
      * @param ctx

install/installer/pkg/components/server/configmap.go

@@ -185,12 +185,13 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
 		DefinitelyGpDisabled: ctx.Config.DisableDefinitelyGP,
 		GitHubApp:            githubApp,
 		WorkspaceGarbageCollection: WorkspaceGarbageCollection{
-			ChunkLimit:                 1000,
-			ContentChunkLimit:          1000,
-			ContentRetentionPeriodDays: 21,
 			Disabled:                   disableWsGarbageCollection,
+			IntervalSeconds:            1800,
 			MinAgeDays:                 14,
 			MinAgePrebuildDays:         7,
+			ChunkLimit:                 1000,
+			ContentRetentionPeriodDays: 21,
+			ContentChunkLimit:          1000,
 		},
 		EnableLocalApp: enableLocalApp,
 		AuthProviderConfigFiles: func() []string {

install/installer/pkg/components/server/types.go

@@ -91,6 +91,7 @@ type IncrementalPrebuilds struct {
 type WorkspaceGarbageCollection struct {
 	Disabled                   bool  `json:"disabled"`
 	StartDate                  int32 `json:"startDate"`
+	IntervalSeconds            int32 `json:"intervalSeconds"`
 	ChunkLimit                 int32 `json:"chunkLimit"`
 	MinAgeDays                 int32 `json:"minAgeDays"`
 	MinAgePrebuildDays         int32 `json:"minAgePrebuildDays"`