@oneuptime/common 11.7.4 → 12.0.0

package/Models/DatabaseModels/{RunbookAgentJob.ts → RunnerJob.ts}

@@ -1,5 +1,5 @@
 import Project from "./Project";
-import RunbookAgent from "./RunbookAgent";
+import Runner from "./Runner";
 import RunbookExecution from "./RunbookExecution";
 import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
 import Route from "../../Types/API/Route";
@@ -15,22 +15,24 @@ import TenantColumn from "../../Types/Database/TenantColumn";
 import IconProp from "../../Types/Icon/IconProp";
 import ObjectID from "../../Types/ObjectID";
 import Permission from "../../Types/Permission";
-import RunbookAgentJobStatus from "../../Types/Runbook/RunbookAgentJobStatus";
+import { JSONObject } from "../../Types/JSON";
+import RunnerJobStatus from "../../Types/Runbook/RunnerJobStatus";
+import RunnerJobOrigin from "../../Types/Runbook/RunnerJobOrigin";
 import RunbookStepType from "../../Types/Runbook/RunbookStepType";
 import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
 
 @TenantColumn("projectId")
-@CrudApiEndpoint(new Route("/runbook-agent-job"))
+@CrudApiEndpoint(new Route("/runner-job"))
 @Entity({
-  name: "RunbookAgentJob",
+  name: "RunnerJob",
 })
 @TableMetadata({
-  tableName: "RunbookAgentJob",
-  singularName: "Runbook Agent Job",
-  pluralName: "Runbook Agent Jobs",
+  tableName: "RunnerJob",
+  singularName: "Runner Job",
+  pluralName: "Runner Jobs",
   icon: IconProp.Logs,
   tableDescription:
-    "One row per Bash or JavaScript step dispatched to a specific Runbook Agent. Tracks claim, execution, and result. Managed by the Worker and the agents; not user-writable.",
+    "One row per Bash or JavaScript step dispatched to a specific Runner. Tracks claim, execution, and result. Managed by the Worker and the agents; not user-writable.",
 })
 @TableAccessControl({
   create: [],
@@ -47,7 +49,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   delete: [],
   update: [],
 })
-export default class RunbookAgentJob extends BaseModel {
+export default class RunnerJob extends BaseModel {
   @ColumnAccessControl({
     create: [],
     read: [
@@ -131,7 +133,8 @@ export default class RunbookAgentJob extends BaseModel {
     type: TableColumnType.Entity,
     modelType: RunbookExecution,
     title: "Runbook Execution",
-    description: "The parent runbook execution this job belongs to.",
+    description:
+      "The parent runbook execution this job belongs to. Absent for AiRemediation-origin jobs.",
   })
   @ManyToOne(
     () => {
@@ -164,18 +167,114 @@ export default class RunbookAgentJob extends BaseModel {
   @Index()
   @TableColumn({
     type: TableColumnType.ObjectID,
-    required: true,
+    required: false,
     canReadOnRelationQuery: true,
     title: "Runbook Execution ID",
-    description: "ID of the parent runbook execution.",
+    description:
+      "ID of the parent runbook execution. Null for AiRemediation-origin jobs, which link to an AI run instead.",
   })
   @Column({
     type: ColumnType.ObjectID,
-    nullable: false,
+    nullable: true,
     transformer: ObjectID.getDatabaseTransformer(),
   })
   public runbookExecutionId?: ObjectID = undefined;
 
+  /*
+   * Which pipeline created this job. Decides the Runner capability that
+   * gates claiming: Runbook-origin jobs need canRunRunbooks,
+   * AiRemediation-origin jobs need canRunAiCommands.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.RunbookAdmin,
+      Permission.RunbookMember,
+      Permission.RunbookViewer,
+      Permission.ReadRunbookExecution,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    required: true,
+    isDefaultValueColumn: true,
+    title: "Origin",
+    description:
+      "Whether this job came from a runbook execution or from an AI remediation run.",
+    defaultValue: RunnerJobOrigin.Runbook,
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    nullable: false,
+    length: ColumnLength.ShortText,
+    default: RunnerJobOrigin.Runbook,
+  })
+  public origin?: RunnerJobOrigin = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.RunbookAdmin,
+      Permission.RunbookMember,
+      Permission.RunbookViewer,
+      Permission.ReadRunbookExecution,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    title: "AI Run ID",
+    description:
+      "The AI remediation run that composed this job. Set on AiRemediation-origin jobs only.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public aiRunId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.RunbookAdmin,
+      Permission.RunbookMember,
+      Permission.RunbookViewer,
+      Permission.ReadRunbookExecution,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    title: "Auto Remediation Suggestion ID",
+    description:
+      "The auto-remediation suggestion this command belongs to. Set on AiRemediation-origin jobs only.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public autoRemediationSuggestionId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [
@@ -248,14 +347,14 @@ export default class RunbookAgentJob extends BaseModel {
   @TableColumn({
     manyToOneRelationColumn: "targetAgentId",
     type: TableColumnType.Entity,
-    modelType: RunbookAgent,
+    modelType: Runner,
     title: "Target Agent",
     description:
       "The agent the step is configured to run on. Only this agent may claim the job.",
   })
   @ManyToOne(
     () => {
-      return RunbookAgent;
+      return Runner;
     },
     {
       eager: false,
@@ -265,7 +364,7 @@ export default class RunbookAgentJob extends BaseModel {
     },
   )
   @JoinColumn({ name: "targetAgentId" })
-  public targetAgent?: RunbookAgent = undefined;
+  public targetAgent?: Runner = undefined;
 
   @ColumnAccessControl({
     create: [],
@@ -348,7 +447,7 @@ export default class RunbookAgentJob extends BaseModel {
     nullable: false,
     length: ColumnLength.ShortText,
   })
-  public status?: RunbookAgentJobStatus = undefined;
+  public status?: RunnerJobStatus = undefined;
 
   @ColumnAccessControl({
     create: [],
@@ -367,7 +466,8 @@ export default class RunbookAgentJob extends BaseModel {
     type: TableColumnType.VeryLongText,
     required: true,
     title: "Script",
-    description: "The bash script the agent must execute.",
+    description:
+      "The script the Runner must execute. Empty for step types that carry structured instructions in the payload instead.",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -375,6 +475,39 @@ export default class RunbookAgentJob extends BaseModel {
   })
   public script?: string = undefined;
 
+  /*
+   * Structured instructions for step types that are not a script — which
+   * host to reach, which workload to restart. Never holds secret material:
+   * the credential is resolved server-side at claim time and travels in the
+   * claim response, so a job row can be read by anyone who can read an
+   * execution without exposing a private key.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.RunbookAdmin,
+      Permission.RunbookMember,
+      Permission.RunbookViewer,
+      Permission.ReadRunbookExecution,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.JSON,
+    required: false,
+    title: "Payload",
+    description:
+      "Structured instructions for non-script step types. Contains no secrets.",
+  })
+  @Column({
+    type: ColumnType.JSON,
+    nullable: true,
+  })
+  public payload?: JSONObject = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/{RunbookAgentOwnerTeam.ts → RunnerOwnerTeam.ts}

@@ -1,5 +1,5 @@
 import Project from "./Project";
-import RunbookAgent from "./RunbookAgent";
+import Runner from "./Runner";
 import Team from "./Team";
 import User from "./User";
 import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
@@ -28,7 +28,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
     Permission.ProjectMember,
     Permission.RunbookAdmin,
     Permission.RunbookMember,
-    Permission.CreateRunbookAgentOwnerTeam,
+    Permission.CreateRunnerOwnerTeam,
   ],
   read: [
     Permission.ProjectOwner,
@@ -38,7 +38,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
     Permission.RunbookAdmin,
     Permission.RunbookMember,
     Permission.RunbookViewer,
-    Permission.ReadRunbookAgentOwnerTeam,
+    Permission.ReadRunnerOwnerTeam,
   ],
   delete: [
     Permission.ProjectOwner,
@@ -46,7 +46,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
     Permission.ProjectMember,
     Permission.RunbookAdmin,
     Permission.RunbookMember,
-    Permission.DeleteRunbookAgentOwnerTeam,
+    Permission.DeleteRunnerOwnerTeam,
   ],
   update: [
     Permission.ProjectOwner,
@@ -54,7 +54,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
     Permission.ProjectMember,
     Permission.RunbookAdmin,
     Permission.RunbookMember,
-    Permission.EditRunbookAgentOwnerTeam,
+    Permission.EditRunnerOwnerTeam,
   ],
 })
 @EnableWorkflow({
@@ -63,19 +63,19 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   update: true,
   read: true,
 })
-@CrudApiEndpoint(new Route("/runbook-agent-owner-team"))
+@CrudApiEndpoint(new Route("/runner-owner-team"))
 @TableMetadata({
-  tableName: "RunbookAgentOwnerTeam",
-  singularName: "Runbook Agent Team Owner",
-  pluralName: "Runbook Agent Team Owners",
+  tableName: "RunnerOwnerTeam",
+  singularName: "Runner Team Owner",
+  pluralName: "Runner Team Owners",
   icon: IconProp.Terminal,
   tableDescription: "Add teams as owners to your runbook agents.",
 })
 @Entity({
-  name: "RunbookAgentOwnerTeam",
+  name: "RunnerOwnerTeam",
 })
-@Index(["runbookAgentId", "teamId", "projectId"])
-export default class RunbookAgentOwnerTeam extends BaseModel {
+@Index(["runnerId", "teamId", "projectId"])
+export default class RunnerOwnerTeam extends BaseModel {
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -83,7 +83,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -93,7 +93,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -125,7 +125,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -135,7 +135,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -160,7 +160,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -170,21 +170,20 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
   @TableColumn({
-    manyToOneRelationColumn: "runbookAgentId",
+    manyToOneRelationColumn: "runnerId",
     type: TableColumnType.Entity,
-    modelType: RunbookAgent,
-    title: "Runbook Agent",
-    description:
-      "Relation to Runbook Agent Resource in which this object belongs",
+    modelType: Runner,
+    title: "Runner",
+    description: "Relation to Runner Resource in which this object belongs",
   })
   @ManyToOne(
     () => {
-      return RunbookAgent;
+      return Runner;
     },
     {
       eager: false,
@@ -193,8 +192,8 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       orphanedRowAction: "nullify",
     },
   )
-  @JoinColumn({ name: "runbookAgentId" })
-  public runbookAgent?: RunbookAgent = undefined;
+  @JoinColumn({ name: "runnerId" })
+  public runner?: Runner = undefined;
 
   @ColumnAccessControl({
     create: [
@@ -203,7 +202,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -213,7 +212,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -221,16 +220,15 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
     type: TableColumnType.ObjectID,
     required: true,
     canReadOnRelationQuery: true,
-    title: "Runbook Agent ID",
-    description:
-      "ID of your OneUptime Runbook Agent in which this object belongs",
+    title: "Runner ID",
+    description: "ID of your OneUptime Runner in which this object belongs",
   })
   @Column({
     type: ColumnType.ObjectID,
     nullable: false,
     transformer: ObjectID.getDatabaseTransformer(),
   })
-  public runbookAgentId?: ObjectID = undefined;
+  public runnerId?: ObjectID = undefined;
 
   @ColumnAccessControl({
     create: [
@@ -239,7 +237,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -249,7 +247,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -282,7 +280,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -292,7 +290,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -317,7 +315,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -327,7 +325,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -360,7 +358,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.ProjectMember,
       Permission.RunbookAdmin,
       Permission.RunbookMember,
-      Permission.CreateRunbookAgentOwnerTeam,
+      Permission.CreateRunnerOwnerTeam,
     ],
     read: [
       Permission.ProjectOwner,
@@ -370,7 +368,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -397,7 +395,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -434,7 +432,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })
@@ -461,7 +459,7 @@ export default class RunbookAgentOwnerTeam extends BaseModel {
       Permission.RunbookAdmin,
       Permission.RunbookMember,
       Permission.RunbookViewer,
-      Permission.ReadRunbookAgentOwnerTeam,
+      Permission.ReadRunnerOwnerTeam,
     ],
     update: [],
   })