common, agent: add auto and manual deployment management modes

graphprotocol · Sep 6, 2023 · d9e97b7 · d9e97b7
1 parent 7a1aea4
commit d9e97b7
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 15 deletions.
diff --git a/packages/indexer-agent/src/agent.ts b/packages/indexer-agent/src/agent.ts
@@ -35,6 +35,7 @@ import {
   TransferredSubgraphDeployment,
   networkIsL2,
   networkIsL1,
+  DeploymentManagementMode,
 } from '@graphprotocol/indexer-common'
 
 import PQueue from 'p-queue'
@@ -204,6 +205,7 @@ export class Agent {
   indexerManagement: IndexerManagementClient
   offchainSubgraphs: SubgraphDeploymentID[]
   autoMigrationSupport: boolean
+  deploymentManagement: DeploymentManagementMode
 
   constructor(
     logger: Logger,
@@ -214,6 +216,7 @@ export class Agent {
     networks: Network[],
     offchainSubgraphs: SubgraphDeploymentID[],
     autoMigrationSupport: boolean,
+    deploymentManagement: DeploymentManagementMode,
   ) {
     this.logger = logger.child({ component: 'Agent' })
     this.metrics = metrics
@@ -222,6 +225,7 @@ export class Agent {
     this.multiNetworks = createMultiNetworks(networks, operators)
     this.offchainSubgraphs = offchainSubgraphs
     this.autoMigrationSupport = !!autoMigrationSupport
+    this.deploymentManagement = deploymentManagement
   }
 
   async start(): Promise<Agent> {
@@ -799,22 +803,36 @@ export class Agent {
           ...Object.values(activeAllocations).flat(),
         ]
 
-        try {
-          // Reconcile deployments
-          await this.reconcileDeployments(
-            activeDeployments,
-            targetDeployments,
-            eligibleAllocations,
-          )
-        } catch (err) {
-          logger.warn(
-            `Exited early while reconciling deployments. Skipped reconciling actions.`,
-            {
-              err: indexerError(IndexerErrorCode.IE005, err),
-            },
-          )
-          return
+        // Reconcile deployments
+        switch (this.deploymentManagement) {
+          case DeploymentManagementMode.AUTO:
+            try {
+              await this.reconcileDeployments(
+                activeDeployments,
+                targetDeployments,
+                eligibleAllocations,
+              )
+            } catch (err) {
+              logger.warn(
+                `Exited early while reconciling deployments. Skipped reconciling actions.`,
+                {
+                  err: indexerError(IndexerErrorCode.IE005, err),
+                },
+              )
+              return
+            }
+            break
+          case DeploymentManagementMode.MANUAL:
+            this.logger.debug(
+              `Skipping subgraph deployment reconciliation since DeploymentManagementMode = 'manual'`,
+            )
+            break
+          default:
+            throw new Error(
+              `Unexpected parameter for DeploymentManagementMode: ${this.deploymentManagement}`,
+            )
         }
+
         try {
           // Reconcile allocation actions
           await this.reconcileActions(

diff --git a/packages/indexer-agent/src/commands/common-options.ts b/packages/indexer-agent/src/commands/common-options.ts
@@ -2,6 +2,7 @@ import fs from 'fs'
 
 import { Argv } from 'yargs'
 import { parse as yaml_parse } from 'yaml'
+import { parseDeploymentManagementMode } from '@graphprotocol/indexer-common'
 
 // Injects all CLI options shared between this module's commands into a `yargs.Argv` object.
 export function injectCommonStartupOptions(argv: Argv): Argv {
@@ -128,6 +129,14 @@ export function injectCommonStartupOptions(argv: Argv): Argv {
       default: false,
       group: 'Indexer Infrastructure',
     })
+    .option('deployment-management', {
+      describe: 'Indexer agent subgraph deployment management automation mode',
+      required: false,
+      default: 'auto',
+      choices: ['auto', 'manual'],
+      coerce: parseDeploymentManagementMode,
+      group: 'Indexer Infrastructure',
+    })
     .config({
       key: 'config-file',
       description: 'Indexer agent configuration file (YAML format)',

diff --git a/packages/indexer-agent/src/commands/start.ts b/packages/indexer-agent/src/commands/start.ts
@@ -581,6 +581,7 @@ export async function run(
     networks,
     argv.offchainSubgraphs.map((s: string) => new SubgraphDeploymentID(s)),
     argv.enableAutoMigrationSupport,
+    argv.deploymentManagement,
   )
   await agent.start()
 }

diff --git a/packages/indexer-common/src/types.ts b/packages/indexer-common/src/types.ts
@@ -7,6 +7,11 @@ export enum AllocationManagementMode {
   OVERSIGHT = 'oversight',
 }
 
+export enum DeploymentManagementMode {
+  AUTO = 'auto',
+  MANUAL = 'manual',
+}
+
 export enum OrderDirection {
   ASC = 'asc',
   DESC = 'desc',
@@ -90,3 +95,14 @@ export interface TransactionConfig extends providers.TransactionRequest {
   gasBump: BigNumber
   type: TransactionType
 }
+
+export function parseDeploymentManagementMode(input: string): DeploymentManagementMode {
+  switch (input) {
+    case DeploymentManagementMode.AUTO:
+      return DeploymentManagementMode.AUTO
+    case DeploymentManagementMode.MANUAL:
+      return DeploymentManagementMode.MANUAL
+    default:
+      throw new Error(`Invalid value for deployment management mode: ${input}`)
+  }
+}