@ossy/deployment-tools 0.0.38 → 0.0.40

package/README.md

@@ -1,28 +1,36 @@
-# deployment-tools
+# @ossy/deployment-tools
 
-Command line toolkit to aid deployment of containers and static files
+Collection of scripts and tools to aid deployment of
+containers and static files to Amazon Web Services through GitHub Actions
 
-## Getting started
+## Scripts
 
-Make sure NodeJs and npm is installed and Docker and Caddy is up and running
-```
-npx @ossy-se/deployment-tools start
-npx @ossy-se/deployment-tools deploy --ossyfile ./ossy.js
+### start
+Starts a node server in the background that polls an deployment queue for container deployment requests.
+Make sure NodeJs and npm is installed and Docker and Caddy is up and running.
+```bash
+npx @ossy/deployment-tools start
 ```
 
-## Available commands
-| Command | Description |
-|---------|-------------|
-| start | starts a node server in the background that exposes a web API on port 3000. |
-| stop | stops the server started with `start` |
-| status | prints the status of the node server |
-| deploy | make a deployment, the API needs to be up and running |
+### stop
+Stops the deployment-tools systemd service
+```bash
+npx @ossy/deployment-tools stop
+```
 
-## Configuration
+### status
+Prints the status of the deployment-tools systemd service
+```bash
+npx @ossy/deployment-tools status
+```
 
-### Environment variables
-| Name | Default | Description |
-|------|---------|-------------|
-| DEPLOYMENT_TOOLS_DOMAIN | localhost | the domain that containers are deployed to as well as the domain the web api is available on |
-| DEPLOYMENT_TOOLS_SUBDOMAIN | local-dev.ci | subdomain of the web api |
-| DEPLOYMENT_TOOLS_PORT | 3000 | port of the web api |
+### deploy
+Sends a deployment request to the aws sqs deployment queue.
+```bash
+npx --yes @ossy/deployment-tools deploy \
+  --username ${{ github.actor }} \
+  --authentication ${{ secrets.GITHUB_TOKEN }} \
+  --target-env ${{ github.event.inputs.environmentName }} \
+  --platforms packages/infrastructure/bin/deployment-platforms.json \
+  --ossyfile packages/${{ github.event.inputs.packageName }}/ossy.json \
+```

package/bin/dist/aws-credentials-client.d.ts

@@ -0,0 +1,4 @@
+import { DeploymentPlatform } from 'types';
+export declare class AwsCredentialsClient {
+    static resolveAwsCredentials({ awsAccountId, awsRegion, awsRoleToAssume }: DeploymentPlatform): Promise<any>;
+}

package/bin/dist/caddy-client.d.ts

@@ -0,0 +1,13 @@
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare const Matchers: {
+    host: (host: any) => {
+        host: any[];
+    };
+    path: (path: any) => {
+        path: any[];
+    };
+};
+export declare class CaddyClient {
+    static deploy(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void | import("node-fetch").Response>;
+    static applyDefaultServerConfig(deploymentPlatform: DeploymentPlatform): Promise<void | import("node-fetch").Response>;
+}

package/bin/dist/ci-rest-api.d.ts

@@ -0,0 +1,4 @@
+import { DeploymentPlatform } from 'types';
+export declare class CiRestApi {
+    static start(deploymentPlatform: DeploymentPlatform): void;
+}

package/bin/dist/cli-commands/deploy-handler.d.ts

@@ -0,0 +1 @@
+export declare const deployHandler: (cliArgs: any) => void;

package/bin/dist/cli-commands/index.d.ts

@@ -0,0 +1,4 @@
+export declare const runCliCommand: ({ name, args }: {
+    name: any;
+    args: any;
+}) => void;

package/bin/dist/cli-commands/start-handler.d.ts

@@ -0,0 +1 @@
+export declare const startHandler: (cliArgs: any) => void;

package/bin/dist/cli-commands/status-handler.d.ts

@@ -0,0 +1 @@
+export declare const statusHandler: () => void;

package/bin/dist/cli-commands/stop-handler.d.ts

@@ -0,0 +1 @@
+export declare const stopHandler: () => void;

package/bin/dist/deployment-platform-client.d.ts

@@ -0,0 +1,11 @@
+import { DeploymentPlatform, SupportedEnvironments, DeploymentTemplate } from 'types';
+export declare class DeploymentPlatformClient {
+    static start(pathToDeploymentPlatforms: string): void;
+    static deploy(username: any, authentication: any, targetEnvironment: any, pathToDeploymentPlatforms: any, pathToOssyFile: any): Promise<void>;
+    static getDeploymentTemplates(pathToOssyFile: string): Promise<DeploymentTemplate[]>;
+    static getDeploymentPlatforms(pathToDeploymentPlatforms: string): Promise<DeploymentPlatform[]>;
+    static getEnvironmentVariables(targetEnvironment: SupportedEnvironments, deploymentRequest: DeploymentTemplate): any;
+    static resolveDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+    static setDefaultDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+    static setCalculatedDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+}

package/bin/dist/deployment-queue-client.d.ts

@@ -0,0 +1,7 @@
+import { SQSClient } from '@aws-sdk/client-sqs';
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare class DeploymentQueueClient {
+    static sendDeploymentRequest(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void>;
+    static pollForDeploymentRequests(deploymentPlatform: DeploymentPlatform, handleDeploymentRequest: (deploymentRequest: ContainerDeploymentRequest) => Promise<void>): void;
+    static createAwsSqsClient(deploymentPlatform: DeploymentPlatform): Promise<SQSClient>;
+}

package/bin/dist/docker-client.d.ts

@@ -0,0 +1,8 @@
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare class DockerClient {
+    static createDockerNetworkForContainerManagerServer(deploymentPlatform: DeploymentPlatform): void;
+    static stopContainer(deploymentRequest: ContainerDeploymentRequest): string;
+    static startContainer(deploymentPlatform: any, { image, containerPort, hostPort, registry, env }: ContainerDeploymentRequest): string;
+    static resolveCredentials({ registry, username, authentication }: ContainerDeploymentRequest): string;
+    static deploy(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void>;
+}

package/bin/dist/index.cli.d.ts

@@ -0,0 +1 @@
+export {};

package/bin/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { DeploymentPlatformClient } from 'deployment-platform-client';
+export * from 'types';

package/bin/dist/log/index.d.ts

@@ -0,0 +1,3 @@
+export declare const logInfo: (logInput: any) => void;
+export declare const logError: (logInput: any) => void;
+export declare const logDebug: (logInput: any) => void;

package/bin/dist/types/index.d.ts

@@ -0,0 +1,65 @@
+export interface DeploymentPlatformTemplate {
+    platformName: string;
+    domain: string;
+    supportedDeploymentTypes: SupportedDeploymentTypes[];
+    supportedEnvironments: SupportedEnvironments[];
+    awsRegion?: string;
+    awsAccountId: string;
+    awsKeyPairName?: string;
+    awsRoleToAssume?: string;
+    awsDeploymentSqsArn?: string;
+    ciSubDomain?: string;
+    ciInternalServerPort?: string | number;
+    ciServerName?: string;
+    ciDockerNetworkName?: string;
+}
+export interface DeploymentPlatform extends Required<Omit<DeploymentPlatformTemplate, 'awsRoleToAssume' | 'awsKeyPairName'>> {
+    activeEnvironment: SupportedEnvironments;
+    awsRoleToAssume?: string;
+    awsKeyPairName?: string;
+}
+export declare enum SupportedRegions {
+    North = "eu-north-1"
+}
+export declare enum SupportedEnvironments {
+    LOCAL = "local",
+    QA = "qa",
+    TEST = "test",
+    DEMO = "demo",
+    PROD = "prod"
+}
+export declare enum SupportedDeploymentTypes {
+    Container = "CONTAINER"
+}
+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;
+}

package/dist/dist/aws-credentials-client.d.ts

@@ -0,0 +1,4 @@
+import { DeploymentPlatform } from 'types';
+export declare class AwsCredentialsClient {
+    static resolveAwsCredentials({ awsAccountId, awsRegion, awsRoleToAssume }: DeploymentPlatform): Promise<any>;
+}

package/dist/dist/caddy-client.d.ts

@@ -0,0 +1,13 @@
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare const Matchers: {
+    host: (host: any) => {
+        host: any[];
+    };
+    path: (path: any) => {
+        path: any[];
+    };
+};
+export declare class CaddyClient {
+    static deploy(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void | import("node-fetch").Response>;
+    static applyDefaultServerConfig(deploymentPlatform: DeploymentPlatform): Promise<void | import("node-fetch").Response>;
+}

package/dist/dist/ci-rest-api.d.ts

@@ -0,0 +1,4 @@
+import { DeploymentPlatform } from 'types';
+export declare class CiRestApi {
+    static start(deploymentPlatform: DeploymentPlatform): void;
+}

package/dist/dist/cli-commands/deploy-handler.d.ts

@@ -0,0 +1 @@
+export declare const deployHandler: (cliArgs: any) => void;

package/dist/dist/cli-commands/index.d.ts

@@ -0,0 +1,4 @@
+export declare const runCliCommand: ({ name, args }: {
+    name: any;
+    args: any;
+}) => void;

package/dist/dist/cli-commands/start-handler.d.ts

@@ -0,0 +1 @@
+export declare const startHandler: (cliArgs: any) => void;

package/dist/dist/cli-commands/status-handler.d.ts

@@ -0,0 +1 @@
+export declare const statusHandler: () => void;

package/dist/dist/cli-commands/stop-handler.d.ts

@@ -0,0 +1 @@
+export declare const stopHandler: () => void;

package/dist/dist/deployment-platform-client.d.ts

@@ -0,0 +1,11 @@
+import { DeploymentPlatform, SupportedEnvironments, DeploymentTemplate } from 'types';
+export declare class DeploymentPlatformClient {
+    static start(pathToDeploymentPlatforms: string): void;
+    static deploy(username: any, authentication: any, targetEnvironment: any, pathToDeploymentPlatforms: any, pathToOssyFile: any): Promise<void>;
+    static getDeploymentTemplates(pathToOssyFile: string): Promise<DeploymentTemplate[]>;
+    static getDeploymentPlatforms(pathToDeploymentPlatforms: string): Promise<DeploymentPlatform[]>;
+    static getEnvironmentVariables(targetEnvironment: SupportedEnvironments, deploymentRequest: DeploymentTemplate): any;
+    static resolveDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+    static setDefaultDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+    static setCalculatedDeploymentPlatformValues(deploymentPlatform: DeploymentPlatform): DeploymentPlatform;
+}

package/dist/dist/deployment-queue-client.d.ts

@@ -0,0 +1,7 @@
+import { SQSClient } from '@aws-sdk/client-sqs';
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare class DeploymentQueueClient {
+    static sendDeploymentRequest(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void>;
+    static pollForDeploymentRequests(deploymentPlatform: DeploymentPlatform, handleDeploymentRequest: (deploymentRequest: ContainerDeploymentRequest) => Promise<void>): void;
+    static createAwsSqsClient(deploymentPlatform: DeploymentPlatform): Promise<SQSClient>;
+}

package/dist/dist/docker-client.d.ts

@@ -0,0 +1,8 @@
+import { DeploymentPlatform, ContainerDeploymentRequest } from 'types';
+export declare class DockerClient {
+    static createDockerNetworkForContainerManagerServer(deploymentPlatform: DeploymentPlatform): void;
+    static stopContainer(deploymentRequest: ContainerDeploymentRequest): string;
+    static startContainer(deploymentPlatform: any, { image, containerPort, hostPort, registry, env }: ContainerDeploymentRequest): string;
+    static resolveCredentials({ registry, username, authentication }: ContainerDeploymentRequest): string;
+    static deploy(deploymentPlatform: DeploymentPlatform, deploymentRequest: ContainerDeploymentRequest): Promise<void>;
+}

package/dist/dist/index.cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { DeploymentPlatformClient } from 'deployment-platform-client';
+export * from 'types';

package/dist/dist/log/index.d.ts

@@ -0,0 +1,3 @@
+export declare const logInfo: (logInput: any) => void;
+export declare const logError: (logInput: any) => void;
+export declare const logDebug: (logInput: any) => void;

package/dist/dist/types/index.d.ts

@@ -0,0 +1,65 @@
+export interface DeploymentPlatformTemplate {
+    platformName: string;
+    domain: string;
+    supportedDeploymentTypes: SupportedDeploymentTypes[];
+    supportedEnvironments: SupportedEnvironments[];
+    awsRegion?: string;
+    awsAccountId: string;
+    awsKeyPairName?: string;
+    awsRoleToAssume?: string;
+    awsDeploymentSqsArn?: string;
+    ciSubDomain?: string;
+    ciInternalServerPort?: string | number;
+    ciServerName?: string;
+    ciDockerNetworkName?: string;
+}
+export interface DeploymentPlatform extends Required<Omit<DeploymentPlatformTemplate, 'awsRoleToAssume' | 'awsKeyPairName'>> {
+    activeEnvironment: SupportedEnvironments;
+    awsRoleToAssume?: string;
+    awsKeyPairName?: string;
+}
+export declare enum SupportedRegions {
+    North = "eu-north-1"
+}
+export declare enum SupportedEnvironments {
+    LOCAL = "local",
+    QA = "qa",
+    TEST = "test",
+    DEMO = "demo",
+    PROD = "prod"
+}
+export declare enum SupportedDeploymentTypes {
+    Container = "CONTAINER"
+}
+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;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/deployment-tools",
-  "version": "0.0.38",
-  "description": "Collection of scripts and tools to aid deployment of containers and static files",
+  "version": "0.0.40",
+  "description": "Collection of scripts and tools to aid deployment of containers and static files to Amazon Web Services through GitHub Actions",
   "type": "module",
   "types": "dist/index.d.ts" ,
   "main": "dist/index.js",

package/src/cli-commands/stop-handler.ts

@@ -2,6 +2,6 @@ import { exec } from 'child_process'
 import { logInfo } from '../log'
 
 export const stopHandler = () => {
-  logInfo({  message: 'Running stop command' })
+  logInfo({ message: 'Running stop command' })
   exec('systemctl stop deployment-tools.service')
 }

package/tsconfig.json

@@ -5,6 +5,7 @@
     "moduleResolution": "nodenext",
     "baseUrl": "src",
     "lib": ["es2021"],
-    "declaration": true
+    "declaration": true,
+    "declarationDir": "./dist"
   }
 }