Merge pull request #117 from fres-co/master

Allow custom cloud provider

Author: oanaianc

.eslintrc.js

@@ -2,19 +2,20 @@ module.exports = {
     root: true,
     parser: '@typescript-eslint/parser',
     env: {
-      node: true,
+        node: true,
     },
     parserOptions: {
-      ecmaVersion: 2020,
-      sourceType: "module",
+        ecmaVersion: 2020,
+        sourceType: 'module',
     },
-    plugins: [
-      '@typescript-eslint',
-    ],
+    plugins: ['@typescript-eslint'],
     extends: [
-      'eslint:recommended',
-      'plugin:@typescript-eslint/recommended',
-      "prettier/@typescript-eslint",
-      "plugin:prettier/recommended",
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'prettier/@typescript-eslint',
+        'plugin:prettier/recommended',
     ],
-  };
+    rules: {
+        '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    },
+};

digitalOcean.config.json

@@ -0,0 +1,10 @@
+{
+    "jvb": { 
+        "size": "s-2vcpu-4gb",
+        "image": "INSERT_HERE_YOUR_SNAPSHOT_ID",
+        "ssh_keys": [],
+        "backups": false,
+        "ipv6": false,
+        "tags": ["test", "jisti", "jvb"]
+     }
+}

groups-custom.json

@@ -0,0 +1,29 @@
+{
+  "groupEntries": [
+    {
+      "name": "custom-bridgeGroup1",
+      "type": "jvb",
+      "region": "FRA1",
+      "environment": "lonely",
+      "compartmentId": "",
+      "instanceConfigurationId": "",
+      "enableAutoScale": true,
+      "enableLaunch": true,
+      "gracePeriodTTLSec": 480,
+      "protectedTTLSec": 600,
+      "scalingOptions": {
+        "minDesired": 1,
+        "maxDesired": 2,
+        "desiredCount": 2,
+        "scaleUpQuantity": 1,
+        "scaleDownQuantity": 1,
+        "scaleUpThreshold": 1,
+        "scaleDownThreshold": 2,
+        "scalePeriod": 60,
+        "scaleUpPeriodsCount": 2,
+        "scaleDownPeriodsCount": 4
+      },
+      "cloud": "custom"
+    }
+  ]
+}

groups-digitalocean.json

@@ -0,0 +1,29 @@
+{
+  "groupEntries": [
+    {
+      "name": "custom-bridgeGroup1",
+      "type": "jvb",
+      "region": "FRA1",
+      "environment": "lonely",
+      "compartmentId": "",
+      "instanceConfigurationId": "",
+      "enableAutoScale": true,
+      "enableLaunch": true,
+      "gracePeriodTTLSec": 480,
+      "protectedTTLSec": 600,
+      "scalingOptions": {
+        "minDesired": 1,
+        "maxDesired": 2,
+        "desiredCount": 2,
+        "scaleUpQuantity": 1,
+        "scaleDownQuantity": 1,
+        "scaleUpThreshold": 1,
+        "scaleDownThreshold": 2,
+        "scalePeriod": 60,
+        "scaleUpPeriodsCount": 2,
+        "scaleDownPeriodsCount": 4
+      },
+      "cloud": "digitalocean"
+    }
+  ]
+}

package-lock.json

@@ -16,6 +16,7 @@
     "@types/sshpk": "^1.10.4",
     "bee-queue": "^1.2.3",
     "dotenv": "^8.2.0",
+    "dots-wrapper": "^3.5.7",
     "envalid": "^6.0.2",
     "express": "^4.17.1",
     "express-jwt": "^6.0.0",

package.json

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "Launching new instance"
+
+# the script should end by outputing the new instance id
+date +%s

scripts/custom-launch.sh

@@ -98,8 +98,15 @@ const cloudManager = new CloudManager({
     isDryRun: config.DryRun,
     ociConfigurationFilePath: config.OciConfigurationFilePath,
     ociConfigurationProfile: config.OciConfigurationProfile,
+    digitalOceanAPIToken: config.DigitalOceanAPIToken,
+    digitalOceanConfigurationFilePath: config.DigitalOceanConfigurationFilePath,
+
     instanceTracker: instanceTracker,
     audit: audit,
+    cloudProviders: config.CloudProviders,
+
+    customConfigurationLaunchScriptPath: config.CustomConfigurationLaunchScriptPath,
+    customConfigurationLaunchScriptTimeoutMs: config.CustomConfigurationLaunchScriptTimeoutMs,
 });
 
 const lockManager: LockManager = new LockManager(logger, {

src/app.ts

@@ -0,0 +1,65 @@
+import { InstanceGroup } from './instance_group';
+import { Context } from './context';
+import { CloudRetryStrategy } from './cloud_manager';
+
+export interface CloudInstance {
+    instanceId: string;
+    displayName: string;
+    cloudStatus: string;
+}
+
+export interface CloudInstanceManager {
+    launchInstances(
+        ctx: Context,
+        group: InstanceGroup,
+        groupCurrentCount: number,
+        quantity: number,
+    ): Promise<Array<string | boolean>>;
+
+    getInstances(ctx: Context, group: InstanceGroup, cloudRetryStrategy: CloudRetryStrategy): Promise<CloudInstance[]>;
+}
+
+export abstract class AbstractCloudInstanceManager implements CloudInstanceManager {
+    static makeRandomString(length: number): string {
+        let result = '';
+        const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+        const charactersLength = characters.length;
+        for (let i = 0; i < length; i++) {
+            result += characters.charAt(Math.floor(Math.random() * charactersLength));
+        }
+        return result;
+    }
+
+    async launchInstances(
+        ctx: Context,
+        group: InstanceGroup,
+        groupCurrentCount: number,
+        quantity: number,
+    ): Promise<Array<string | boolean>> {
+        ctx.logger.info(`[CloudInstanceManager] Launching a batch of ${quantity} instances in group ${group.name}`);
+
+        const indexes: Array<number> = [];
+        for (let i = 0; i < quantity; i++) {
+            indexes.push(i);
+        }
+
+        const result = await Promise.all(
+            indexes.map(async (index) => {
+                return this.launchInstance(ctx, index, group);
+            }),
+        );
+        ctx.logger.info(`Finished launching all the instances in group ${group.name}`);
+
+        return result;
+    }
+
+    abstract launchInstance(ctx: Context, index: number, group: InstanceGroup): Promise<string | boolean>;
+
+    async getInstances(
+        _ctx: Context,
+        _group: InstanceGroup,
+        _cloudRetryStrategy: CloudRetryStrategy,
+    ): Promise<CloudInstance[]> {
+        return [];
+    }
+}

src/cloud_instance_manager.ts

@@ -0,0 +1,61 @@
+import OracleInstanceManager from './oracle_instance_manager';
+import CustomInstanceManager from './custom_instance_manager';
+import DigitalOceanInstanceManager from './digital_ocean_instance_manager';
+import { CloudInstanceManager } from './cloud_instance_manager';
+
+export interface CloudInstanceManagerSelectorOptions {
+    cloudProviders: string[];
+    isDryRun: boolean;
+    ociConfigurationFilePath: string;
+    ociConfigurationProfile: string;
+
+    digitalOceanAPIToken: string;
+    digitalOceanConfigurationFilePath: string;
+
+    customConfigurationLaunchScriptPath: string;
+    customConfigurationLaunchScriptTimeoutMs: number;
+}
+
+export class CloudInstanceManagerSelector {
+    private oracleInstanceManager: OracleInstanceManager;
+    private digitalOceanInstanceManager: DigitalOceanInstanceManager;
+    private customInstanceManager: CustomInstanceManager;
+
+    constructor(options: CloudInstanceManagerSelectorOptions) {
+        if (options.cloudProviders.includes('oracle')) {
+            this.oracleInstanceManager = new OracleInstanceManager({
+                isDryRun: options.isDryRun,
+                ociConfigurationFilePath: options.ociConfigurationFilePath,
+                ociConfigurationProfile: options.ociConfigurationProfile,
+            });
+        }
+
+        if (options.cloudProviders.includes('custom')) {
+            this.customInstanceManager = new CustomInstanceManager({
+                isDryRun: options.isDryRun,
+                customConfigurationLaunchScriptPath: options.customConfigurationLaunchScriptPath,
+                customConfigurationLaunchScriptTimeoutMs: options.customConfigurationLaunchScriptTimeoutMs,
+            });
+        }
+        if (options.cloudProviders.includes('digitalocean')) {
+            this.digitalOceanInstanceManager = new DigitalOceanInstanceManager({
+                isDryRun: options.isDryRun,
+                digitalOceanAPIToken: options.digitalOceanAPIToken,
+                digitalOceanConfigurationFilePath: options.digitalOceanConfigurationFilePath,
+            });
+        }
+    }
+
+    selectInstanceManager(cloud: string): CloudInstanceManager {
+        switch (cloud) {
+            case 'oracle':
+                return this.oracleInstanceManager;
+            case 'digitalocean':
+                return this.digitalOceanInstanceManager;
+            case 'custom':
+                return this.customInstanceManager;
+            default:
+                return null;
+        }
+    }
+}