@ossy/deployment-tools 0.0.52 → 0.0.54

package/jsdoc.config.js

@@ -1,19 +1,15 @@
 
 module.exports = {
-  plugins: ['plugins/markdown'],
   recurseDepth: 10,
   source: {
-    // includePattern: '.+\\.js(doc|x)?$',
-    includePattern: '.+\\.js$',
-    excludePattern: '(^|\\/|\\\\)_'
+    include: ['src'],
+    includePattern: '\.js',
+    exclude: ['node_modules']
   },
-  sourceType: 'module',
-  tags: {
-    allowUnknownTags: true,
-    dictionaries: ['jsdoc', 'closure']
-  },
-  templates: {
-    cleverLinks: false,
-    monospaceLinks: false
+  opts: {
+    // template: './template',
+    destination: './jsdoc',
+    recurse: true
+    // tutorials: './tutorials'
   }
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ossy/deployment-tools",
-  "version": "0.0.52",
+  "version": "0.0.54",
   "description": "Collection of scripts and tools to aid deployment of containers and static files to Amazon Web Services through GitHub Actions",
   "source": "./src/index.js",
   "main": "./src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "echo \"The build step is not required when using JavaScript!\" && exit 0",
-    "build:docs": "jsdoc -c ./jsdoc.config.js ./src/index.js ./package.json",
+    "build:docs": "jsdoc -c jsdoc.config.js",
     "cdk": "cdk"
   },
   "author": "Ossy",
@@ -18,15 +18,16 @@
     "@aws-sdk/client-sqs": "^3.186.0",
     "@aws-sdk/client-sts": "^3.188.0",
     "arg": "^5.0.2",
+    "aws-cdk-lib": "2.47.0",
+    "constructs": "^10.0.0",
+    "dockerode": "^3.3.4",
     "express": "^4.18.1",
     "nanoid": "^3.3.4",
-    "node-fetch": "^2.6.7",
-    "aws-cdk-lib": "2.47.0",
-    "constructs": "^10.0.0"
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "jsdoc": "^3.6.11",
     "aws-cdk": "2.47.0",
-    "jest": "^27.5.1"
+    "jest": "^27.5.1",
+    "jsdoc": "^3.6.11"
   }
 }

package/src/aws-credentials/aws-credentials.js

@@ -3,6 +3,9 @@ const { STSClient, AssumeRoleWithWebIdentityCommand } = require('@aws-sdk/client
 
 const { logInfo, logError } = require('../log')
 
+/**
+  * @class
+*/
 class AwsCredentialsService {
 
   static resolveAwsCredentials(platformConfig) {

package/src/config/platform-config.js

@@ -15,6 +15,15 @@ const SupportedDeploymentTypes = {
   // Static = 'STATIC'
 }
 
+// export interface PlatformConfig extends Required<Omit<PlatformTemplate, 'awsRoleToAssume' | 'awsKeyPairName'>> {
+//   activeEnvironment: SupportedEnvironments;
+//   awsRoleToAssume?: string;
+//   awsKeyPairName?: string;
+// }
+
+/**
+  * @class
+*/
 class PlatformConfigService {
 
   static from(template) {

package/src/deploy/platform-deployment.js

@@ -5,6 +5,36 @@ const { PlatformConfigService, SupportedDeploymentTypes } = require('../config')
 const { DeploymentQueueService } = require('../deployment-queue')
 const { logError } = require('../log')
 
+// export interface DeploymentTemplate {
+//   type: SupportedDeploymentTypes;
+//   targetDeploymentPlatform: string;
+//   subdomain?: string;
+//   env?: {
+//     shared?: { [name: string]: string | number };
+//     prod?: { [name: string]: string | number };
+//     test?: { [name: string]: string | number };
+//     qa?: { [name: string]: string | number };
+//   }
+// }
+
+// export interface ContainerDeploymentTemplate extends DeploymentTemplate {
+//   type: SupportedDeploymentTypes.Container;
+//   dockerFile: string;
+//   dockerContext: string;
+//   image: string;
+//   hostPort: number;
+//   containerPort: number;
+//   registry: string;
+// }
+
+// export interface ContainerDeploymentRequest extends ContainerDeploymentTemplate {
+//   authentication?: string;
+//   username?: string;
+// }
+
+/**
+  * @class
+*/
 class PlatformDeploymentService {
 
   static deploy({

package/src/deployment-queue/deployment-queue.js

@@ -7,6 +7,9 @@ const {
 const { AwsCredentialsService } = require('../aws-credentials')
 const { logInfo, logError, logDebug } = require('../log')
 
+/**
+  * @class
+*/
 class DeploymentQueueService {
 
   static sendDeploymentRequest(platformConfig, deploymentRequest) {

package/src/docker/docker-service.js

@@ -0,0 +1,91 @@
+const { exec } = require('child_process')
+const Docker = require('dockerode')
+
+const { logInfo } = require('../log')
+
+// const exec = command => new Promise((resolve, reject) => {
+//   execBash('command', (error, stdout, stderr) => {
+//
+//     if (error) {
+//       console.error(`exec error: ${error}`)
+//       return
+//     }
+//
+//     console.log(`stdout: ${stdout}`)
+//     console.error(`stderr: ${stderr}`)
+//
+//     command.stdout.on('data', data => {
+//       logInfo({ message: `[DockerService]: ${data}` })
+//     })
+//
+//     command.stderr.on('data', (data) => {
+//       logError({ message: `[DockerService]: ${data}` })
+//     })
+//
+//   })
+// })
+
+/**
+  * @class
+*/
+class DockerService {
+
+  static createDockerNetworkForContainerManagerServer(platformConfig) {
+    logInfo({ message: '[DockerService] Creating docker network for comunication between containers' })
+    exec(`sudo docker network create ${platformConfig.ciDockerNetworkName}`)
+  }
+
+  static stopContainer(deploymentRequest) {
+    const name = deploymentRequest.image.replaceAll('/', '_')
+    logInfo({ message: `[DockerService] Running docker stop for image with the name of ${name}` })
+    exec(`sudo docker stop ${name}`)
+  }
+
+  static startContainer(platformConfig, { image, containerPort, hostPort, registry, env }) {
+    const name = image.replaceAll('/', '_')
+    const imageUrl = !!registry ? `${registry}/${image}` : image
+    const envsAsString = Object.entries(env || {}).reduce((envs, [name, value]) => `${envs} --env ${name}=${value}`, '')
+    logInfo({ message: `[DockerService] Running docker start for image with the name of ${name} with port mapping ${hostPort}:${containerPort} and source ${imageUrl}` })
+    exec(`sudo docker run -d -p ${hostPort}:${containerPort} --name=${name} --network=${platformConfig.ciDockerNetworkName} --network-alias=${name} --rm ${envsAsString} ${imageUrl}`)
+  }
+
+  static pullImage({ registry, username, authentication, image }) {
+    let authconfig
+    const shouldAuthenticate = username || authentication
+
+    if (shouldAuthenticate) {
+      authconfig = {
+        username: username,
+        password: authentication,
+        // auth: '',
+        // email: 'your@email.email',
+        serveraddress: registry
+      }
+    }
+
+    shouldAuthenticate
+      ? logInfo({ message: '[DockerService] Docker credentials provided, trying to pull from private repository' })
+      : logInfo({ message: '[DockerService] No docker credentials provided, assuming image is publicly hosted' })
+
+    const docker = new Docker()
+
+    return docker.pull(image, { authconfig })
+    // .then()
+    // .catch()
+
+    // logInfo({ message: `[DockerService] Resolving docker credentials for ${registry}` })
+    // exec(`sudo docker login ${registry} -u ${username} -p ${authentication}`)
+  }
+
+  static deploy(platformConfig, deploymentRequest) {
+    logInfo({ message: '[DockerService] Starting docker deployment sequence' })
+    DockerService.stopContainer(deploymentRequest)
+    DockerService.pullImage(deploymentRequest)
+    DockerService.startContainer(platformConfig, deploymentRequest)
+  }
+
+}
+
+module.exports = {
+  DockerService
+}

package/src/docker/docker-service.playground.js

@@ -0,0 +1,17 @@
+const { DockerService } = require('./docker-service')
+
+DockerService.deploy(
+  { ciDockerNetworkName: 'deployment-tools' },
+  {
+    type: 'CONTAINER',
+    dockerFile: './Dockerfile-prod',
+    dockerContext: './',
+    targetDeploymentPlatform: 'oskarssylwan',
+    image: 'mongo',
+    hostPort: '3005',
+    containerPort: '3000',
+    subdomain: 'cms',
+    env: {},
+    registry: 'ghcr.io'
+  }
+)

package/src/docker/index.js

@@ -0,0 +1 @@
+module.exports = require('./docker-service')

package/src/infrastructure/container-server/aws-profile.js

@@ -1,3 +1,6 @@
+/**
+  * @class
+*/
 class AwsProfile {
 
   static writeFile(roleArn, region) {

package/src/infrastructure/container-server/caddy.service.js

@@ -30,6 +30,9 @@ AmbientCapabilities=CAP_NET_BIND_SERVICE
 WantedBy=multi-user.target cloud-init.target
 `
 
+/**
+  * @class
+*/
 class CaddyService {
 
   static install() {

package/src/infrastructure/container-server/container-server.js

@@ -35,6 +35,9 @@ const InstanceImages = {
   UBUNTU: 'ami-092cce4a19b438926'
 }
 
+/**
+  * @class
+*/
 class ContainerServer extends Construct {
 
   /**
@@ -148,6 +151,7 @@ class ContainerServer extends Construct {
     })
 
     props.platformConfigBucket.grantRead(ec2Instance, '*')
+    props.deploymentQueue.grant(ec2Instance, '*')
 
     // const hostedZone = !!props.createNewHostedZone
     //   ? new PublicHostedZone(this, 'HostedZone', { zoneName: props.domain })

package/src/infrastructure/container-server/deployment-tools.service.js

@@ -16,6 +16,9 @@ Restart=on-failure
 WantedBy=multi-user.target cloud-init.target
 `
 
+/**
+  * @class
+*/
 class DeploymentToolsService {
 
   static install() {

package/src/infrastructure/establish-trust-stack.js

@@ -8,6 +8,9 @@ const {
   PolicyStatement
 } = require('aws-cdk-lib/aws-iam')
 
+/**
+  * @class
+*/
 class EstablishTrustStack extends Stack {
   /**
    * Establishes trust between GithHub and Amazon Web Services.

package/src/infrastructure/platform-stack.js

@@ -8,6 +8,9 @@ const { ContainerServer } = require('./container-server')
 
 const { SupportedDeploymentTypes } = require('../config')
 
+/**
+  * @class
+*/
 class PlatformStack extends Stack {
   constructor(scope, id, props) {
     super(scope, id, props)
@@ -20,7 +23,7 @@ class PlatformStack extends Stack {
 
     if (isContainerDeploymentsEnabled) {
 
-      new Queue(this, 'DeploymentQueue', {
+      const deploymentQueue = new Queue(this, 'DeploymentQueue', {
         queueName: `${props.config.platformName}-${props.config.activeEnvironment}`,
         receiveMessageWaitTime: Duration.seconds(20)
       })
@@ -40,7 +43,8 @@ class PlatformStack extends Stack {
 
       new ContainerServer(this, 'ContainerServer', {
         platformConfig: props.config,
-        platformConfigBucket: platformConfigDeployment.deployedBucket
+        platformConfigBucket: platformConfigDeployment.deployedBucket,
+        deploymentQueue: deploymentQueue
       })
 
     }

package/src/server/caddy.js

@@ -17,6 +17,9 @@ const Handlers = {
   })
 }
 
+/**
+  * @class
+*/
 class CaddyService {
 
   static addDeployment(platformConfig, deploymentRequest) {

package/src/server/platform-server.js

@@ -1,13 +1,16 @@
 const { CaddyService } = require('./caddy')
-const { DockerService } = require('./docker')
+const { DockerService } = require('../docker')
 const { RestApiService } = require('./rest-api')
 
 const { PlatformTemplateService } = require('../template')
 const { PlatformConfigService } = require('../config')
-const { DeploymentQueueClient } = require('../deployment-queue')
+const { DeploymentQueueService } = require('../deployment-queue')
 const { logError } = require('../log')
 
 // journalctl -u service-name.service
+/**
+  * @class
+*/
 class PlatformServerService {
 
   static start(platformTemplatesFilePath) {
@@ -17,7 +20,7 @@ class PlatformServerService {
       RestApiService.start(platformConfig)
       CaddyService.applyDefaultConfig(platformConfig)
 
-      DeploymentQueueClient.pollForDeploymentRequests(
+      DeploymentQueueService.pollForDeploymentRequests(
         platformConfig,
         deploymentRequest => {
           DockerService.deploy(platformConfig, deploymentRequest)

package/src/server/rest-api.js

@@ -1,6 +1,9 @@
 const express = require('express')
 const { logInfo } = require('../log')
 
+/**
+  * @class
+*/
 class RestApiService {
 
   static start(platformConfig) {

package/src/template/platform-template.js

@@ -4,27 +4,33 @@ const { logError, logInfo } = require('../log')
 
 /**
  * Platform template definition
- * @namespace PlatformTemplate
  * @typedef {Object} PlatformTemplate
  * @property {string} platformName - Name of platform
  * @property {string} domain - example.com
  * @property {string[]} supportedDeploymentTypes - container
  * @property {string[]} supportedEnvironments - qa
+ *
  * @property {string} awsAccountId - Aws account id
- * @property {string} awsRegion - ?
- * @property {string} awsKeyPairName - ?
+ * @property {string=} awsRegion - ?
+ * @property {string=} awsKeyPairName - ?
  * @property {string} awsRoleToAssume - ?
- * @property {string} awsDeploymentSqsArn - ?
- * @property {string} ciSubDomain - ?
- * @property {string} ciInternalServerPort- ? | number;
- * @property {string} ciServerName - ?
- * @property {string} ciDockerNetworkName - ?
+ * @property {string=} awsDeploymentSqsArn - ?
+ *
+ * @property {string=} ciSubDomain - ?
+ * @property {string|mumber=} ciInternalServerPort - ? | number;
+ * @property {string=} ciServerName - ?
+ * @property {string=} ciDockerNetworkName - ?
  * @property {string} ciGithubActionsRepo - organisation/repoName
  */
+
+/**
+  * Utility class that helps you read and validate platfor templates from file system
+  * @class
+  */
 class PlatformTemplateService {
 
   /**
-   * Reads the json file that holds the platform templates
+   *  Read and validat platform template(s) from file system
    *
    * @param {string} path - File path to platform templates json
    * @return @Async {PlatformTemplate[]} - List of platform templates
@@ -57,6 +63,15 @@ class PlatformTemplateService {
     return Promise.resolve(templates)
   }
 
+  /**
+   *  Validates the template
+   *
+   * @param {PlatformTemplate} platformTemplate - File path to platform templates json
+   * @return @Async {PlatformTemplate} - List of platform templates
+   *
+   * @example
+   *     const platformTemplate = PlatformTemplateService.readFromFile('./platforms.json')
+   */
   static fakeValidateTemplate(obj) {
     // todo: implement real one
     return obj

package/src/types.js

@@ -1,32 +0,0 @@
-// export interface PlatformConfig extends Required<Omit<PlatformTemplate, 'awsRoleToAssume' | 'awsKeyPairName'>> {
-//   activeEnvironment: SupportedEnvironments;
-//   awsRoleToAssume?: string;
-//   awsKeyPairName?: string;
-// }
-
-// export interface DeploymentTemplate {
-//   type: SupportedDeploymentTypes;
-//   targetDeploymentPlatform: string;
-//   subdomain?: string;
-//   env?: {
-//     shared?: { [name: string]: string | number };
-//     prod?: { [name: string]: string | number };
-//     test?: { [name: string]: string | number };
-//     qa?: { [name: string]: string | number };
-//   }
-// }
-//
-// export interface ContainerDeploymentTemplate extends DeploymentTemplate {
-//   type: SupportedDeploymentTypes.Container;
-//   dockerFile: string;
-//   dockerContext: string;
-//   image: string;
-//   hostPort: number;
-//   containerPort: number;
-//   registry: string;
-// }
-
-// export interface ContainerDeploymentRequest extends ContainerDeploymentTemplate {
-//   authentication?: string;
-//   username?: string;
-// }