feat: Create remote config

eslint.config.mjs

@@ -70,6 +70,17 @@ export default [
       '@typescript-eslint/no-empty-function': 'off',
       '@typescript-eslint/class-literal-property-style': 'off',
       'no-invalid-this': [ 'error', { capIsConstructor : false } ],
+      'no-prototype-builtins': 'off',
+      '@typescript-eslint/no-dynamic-delete': 'off',
+
+      // Ensure all class members have explicit access modifiers
+      "@typescript-eslint/explicit-member-accessibility": ["warn", { "accessibility": "explicit" }],
+
+      // Require return types on all functions and methods
+      "@typescript-eslint/explicit-function-return-type": "warn",
+
+      // Require return types on exported functions or methods
+      "@typescript-eslint/explicit-module-boundary-types": "warn"
     }
   },
   { // test ts files

package.json

@@ -63,7 +63,6 @@
     "inquirer": "^12.1.0",
     "ip": "^2.0.1",
     "js-base64": "^3.7.7",
-    "js-yaml": "^4.1.0",
     "jsdoc": "^4.0.4",
     "listr2": "^8.2.5",
     "semver": "^7.6.3",
@@ -96,6 +95,7 @@
     "@types/stream-buffers": "^3.0.7",
     "@types/tar": "^6.1.13",
     "@types/uuid": "^10.0.0",
+    "@types/ws": "^8.5.13",
     "@types/yargs": "^17.0.33",
     "@typescript-eslint/utils": "^8.15.0",
     "c8": "^10.1.2",

src/commands/base.ts

@@ -18,9 +18,10 @@
 import paths from 'path'
 import { MissingArgumentError } from '../core/errors.js'
 import { ShellRunner } from '../core/shell_runner.js'
-import type {  ChartManager,  ConfigManager,  Helm,  K8,  DependencyManager, LeaseManager } from '../core/index.js'
-import type {  CommandFlag,  Opts } from '../types/index.js'
-import { type LocalConfig } from '../core/config/local_config.js'
+import type {
+  ChartManager, ConfigManager, Helm, K8, DependencyManager, LeaseManager, RemoteConfigManager, LocalConfig
+} from '../core/index.js'
+import type { CommandFlag,  Opts } from '../types/index.js'
 
 export class BaseCommand extends ShellRunner {
   protected readonly helm: Helm
@@ -31,6 +32,7 @@ export class BaseCommand extends ShellRunner {
   protected readonly leaseManager: LeaseManager
   protected readonly _configMaps = new Map<string, any>()
   protected readonly localConfig: LocalConfig
+  protected readonly remoteConfigManager: RemoteConfigManager
 
   constructor (opts: Opts) {
     if (!opts || !opts.logger) throw new Error('An instance of core/SoloLogger is required')
@@ -40,6 +42,7 @@ export class BaseCommand extends ShellRunner {
     if (!opts || !opts.configManager) throw new Error('An instance of core/ConfigManager is required')
     if (!opts || !opts.depManager) throw new Error('An instance of core/DependencyManager is required')
     if (!opts || !opts.localConfig) throw new Error('An instance of core/LocalConfig is required')
+    if (!opts || !opts.remoteConfigManager) throw new Error('An instance of core/config/RemoteConfigManager is required')
 
     super(opts.logger)
 
@@ -50,6 +53,7 @@ export class BaseCommand extends ShellRunner {
     this.depManager = opts.depManager
     this.leaseManager = opts.leaseManager
     this.localConfig = opts.localConfig
+    this.remoteConfigManager = opts.remoteConfigManager
   }
 
   async prepareChartPath (chartDir: string, chartRepo: string, chartReleaseName: string) {

src/commands/deployment.ts

@@ -0,0 +1,148 @@
+/**
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the ""License"");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an ""AS IS"" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import { Listr, type ListrTaskWrapper } from 'listr2'
+import { SoloError } from '../core/errors.js'
+import { BaseCommand } from './base.js'
+import * as flags from './flags.js'
+import { constants, Templates } from '../core/index.js'
+import * as prompts from './prompts.js'
+import chalk from 'chalk'
+import { RemoteConfigTasks } from '../core/config/remote/remote_config_tasks.js'
+import { ListrLease } from '../core/lease/listr_lease.js'
+import type { Namespace } from '../core/config/remote/types.js'
+import type { CommandFlag, ContextClusterStructure } from '../types/index.js'
+
+export class DeploymentCommand extends BaseCommand {
+  private static get DEPLOY_FLAGS_LIST (): CommandFlag[] {
+    return [
+      flags.quiet,
+      flags.namespace,
+      flags.userEmailAddress,
+      flags.deploymentClusters,
+      flags.contextClusterUnparsed,
+    ]
+  }
+
+  private async create (argv: any): Promise<boolean> {
+    const self = this
+    const lease = await self.leaseManager.create()
+
+    interface Config {
+      namespace: Namespace
+      contextClusterUnparsed: string
+      contextCluster: ContextClusterStructure }
+    interface Context { config: Config }
+
+    const tasks = new Listr<Context>([
+      {
+        title: 'Initialize',
+        task: async (ctx, task): Promise<Listr<Context, any, any>> => {
+          self.configManager.update(argv)
+          self.logger.debug('Loaded cached config', { config: self.configManager.config })
+
+          await prompts.execute(task, self.configManager, DeploymentCommand.DEPLOY_FLAGS_LIST)
+
+          ctx.config = {
+            contextClusterUnparsed: self.configManager.getFlag<string>(flags.contextClusterUnparsed),
+            namespace: self.configManager.getFlag<Namespace>(flags.namespace),
+          } as Config
+
+          ctx.config.contextCluster = Templates.parseContextCluster(ctx.config.contextClusterUnparsed)
+
+          const namespace = ctx.config.namespace
+
+          if (!await self.k8.hasNamespace(namespace)) {
+            await self.k8.createNamespace(namespace)
+          }
+
+          self.logger.debug('Prepared config', { config: ctx.config, cachedConfig: self.configManager.config })
+
+          return ListrLease.newAcquireLeaseTask(lease, task)
+        }
+      },
+      this.localConfig.promptLocalConfigTask(),
+      {
+        title: 'Validate cluster connections',
+        task: async (ctx, task): Promise<Listr<Context, any, any>> => {
+          const subTasks = []
+
+          for (const cluster of Object.keys(ctx.config.contextCluster)) {
+            subTasks.push({
+              title: `Testing connection to cluster: ${chalk.cyan(cluster)}`,
+              task: async (_: Context, task: ListrTaskWrapper<Context, any, any>) => {
+                if (!await self.k8.testClusterConnection(cluster)) {
+                  task.title = `${task.title} - ${chalk.red('Cluster connection failed')}`
+
+                  throw new SoloError(`Cluster connection failed for: ${cluster}`)
+                }
+              }
+            })
+          }
+
+          return task.newListr(subTasks, {
+            concurrent: true,
+            rendererOptions: { collapseSubtasks: false }
+          })
+        }
+      },
+      RemoteConfigTasks.createRemoteConfig.bind(this)(),
+    ], {
+      concurrent: false,
+      rendererOptions: constants.LISTR_DEFAULT_RENDERER_OPTION
+    })
+
+    try {
+      await tasks.run()
+    } catch (e: Error | any) {
+      throw new SoloError(`Error installing chart ${constants.SOLO_DEPLOYMENT_CHART}`, e)
+    } finally {
+      await lease.release()
+    }
+
+    return true
+  }
+
+  public getCommandDefinition (): { command: string; desc: string; builder: Function } {
+    const networkCmd = this
+    return {
+      command: 'deployment',
+      desc: 'Manage solo network deployment',
+      builder: (yargs: any): any => {
+        return yargs
+          .command({
+            command: 'create',
+            desc: 'Creates solo deployment',
+            builder: (y: any) => flags.setCommandFlags(y, ...DeploymentCommand.DEPLOY_FLAGS_LIST),
+            handler: (argv: any) => {
+              networkCmd.logger.debug('==== Running \'deployment create\' ===')
+              networkCmd.logger.debug(argv)
+
+              networkCmd.create(argv).then(r => {
+                networkCmd.logger.debug('==== Finished running `deployment create`====')
+
+                if (!r) process.exit(1)
+              }).catch(err => {
+                networkCmd.logger.showUserError(err)
+                process.exit(1)
+              })
+            }
+          })
+          .demandCommand(1, 'Select a chart command')
+      }
+    }
+  }
+}

src/commands/flags.ts

@@ -75,6 +75,26 @@ export const namespace: CommandFlag = {
   }
 }
 
+export const contextClusterUnparsed: CommandFlag = {
+  constName: 'contextClusterUnparsed',
+  name: 'context-cluster',
+  definition: {
+    describe:
+      'Context cluster mapping where context is key = value is cluster and comma delimited if more than one, ' +
+      '(e.g.: --context-cluster kind-solo=kind-solo,kind-solo-2=kind-solo-2)',
+    type: 'string'
+  }
+}
+
+export const context: CommandFlag = {
+  constName: 'context',
+  name: 'context',
+  definition: {
+    describe: 'Kubernetes context to use for command',
+    type: 'string'
+  }
+}
+
 export const deployHederaExplorer: CommandFlag = {
   constName: 'deployHederaExplorer',
   name: 'hedera-explorer',
@@ -743,17 +763,6 @@ export const userEmailAddress: CommandFlag = {
   name: 'email',
   definition: {
     describe: 'User email address used for local configuration',
-    defaultValue: '',
-    type: 'string'
-  }
-}
-
-export const deploymentName: CommandFlag = {
-  constName: 'deploymentName',
-  name: 'deployment-name',
-  definition: {
-    describe: 'Solo deployment name',
-    defaultValue: '',
     type: 'string'
   }
 }
@@ -763,7 +772,6 @@ export const deploymentClusters: CommandFlag = {
   name: 'deployment-clusters',
   definition: {
     describe: 'Solo deployment cluster list (comma separated)',
-    defaultValue: '',
     type: 'string'
   }
 }
@@ -847,14 +855,14 @@ export const allFlags: CommandFlag[] = [
   chartDirectory,
   clusterName,
   clusterSetupNamespace,
+  context,
   deletePvcs,
   deleteSecrets,
   deployCertManager,
   deployCertManagerCrds,
   deployHederaExplorer,
   deployJsonRpcRelay,
   deploymentClusters,
-  deploymentName,
   deployMinio,
   deployPrometheusStack,
   devMode,
@@ -908,6 +916,7 @@ export const allFlags: CommandFlag[] = [
   grpcWebTlsCertificatePath,
   grpcTlsKeyPath,
   grpcWebTlsKeyPath,
+  contextClusterUnparsed
 ]
 
 /** Resets the definition.disablePrompt for all flags */

src/commands/index.ts

@@ -22,6 +22,7 @@ import { NetworkCommand } from './network.js'
 import { NodeCommand } from './node/index.js'
 import { RelayCommand } from './relay.js'
 import { AccountCommand } from './account.js'
+import { DeploymentCommand } from './deployment.js'
 import { type Opts } from '../types/index.js'
 
 /**
@@ -37,6 +38,7 @@ function Initialize (opts: Opts) {
   const relayCmd = new RelayCommand(opts)
   const accountCmd = new AccountCommand(opts)
   const mirrorNodeCmd = new MirrorNodeCommand(opts)
+  const deploymentCommand = new DeploymentCommand(opts)
 
   return [
     initCmd.getCommandDefinition(),
@@ -45,7 +47,8 @@ function Initialize (opts: Opts) {
     nodeCmd.getCommandDefinition(),
     relayCmd.getCommandDefinition(),
     accountCmd.getCommandDefinition(),
-    mirrorNodeCmd.getCommandDefinition()
+    mirrorNodeCmd.getCommandDefinition(),
+    deploymentCommand.getCommandDefinition(),
   ]
 }