@ossy/deployment-tools 0.0.89 → 0.0.91

package/README.md

@@ -45,7 +45,56 @@ The `cdk.json` file tells the CDK Toolkit how to execute your app.
 
 ## Useful commands
 
+
+**SSH into instance**
+```
+ssh -i path/to/keys ubuntu@<ip>
+```
+
+**View running containers**
+```
+docker ps
+```
+
+**View logs from docker container**
+```
+docker logs <id|alias>
+```
+
+**View logs from deployment-tools service**
+```
+// With last 200 lines and follow new logs
+journalctl -u deployment-tools.service -n 200 -f
 ```
-// journalctl -u deployment-tools.service
-// docker logs
-```
+
+**View logs from caddy service**
+```
+// With last 200 lines and follow new logs
+journalctl -u caddy-route53.service -n 200 -f
+```
+
+**Update Nodejs on the server**
+```
+# Remove old NodeSource repository if it exists
+sudo rm -f /etc/apt/sources.list.d/nodesource.list
+
+# Download and run the Node.js 24.x setup script
+curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
+
+# Install Node.js 24
+sudo apt-get install -y nodejs
+
+# Verify the installation
+node --version
+npm --version
+```
+
+**Upgrade deployment-tools server version**
+
+ - 1 release new version of the npm package with `npm publish`
+ - 2 ssh into the instance with `ssh -i path/to/keys ubuntu@<ip>`
+ - 3 stop the deployment-tools services with `sudo systemctl stop deployment-tools.service`
+ - 4 remove the old version of the tool woth `rm -rf ~/.npm/_npx`
+ - 5 start the deployment-tools services again with `sudo systemctl start deployment-tools.service`
+
+That's it, the service will download the latest version of the package.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/deployment-tools",
-  "version": "0.0.89",
+  "version": "0.0.91",
   "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",

package/src/caddy/caddy.js

@@ -60,6 +60,7 @@ class CaddyService {
   }
 
   static getProxyConfig(containerDeploymentTemplate) {
+    logInfo({ message: `[CaddyService] Checking if a proxy for ${containerDeploymentTemplate.domain} exists` })
     return fetch(`http://localhost:2019/id/${containerDeploymentTemplate.domain}`, {
       method: 'GET',
       headers: { 'Content-Type': 'application/json' }
@@ -82,6 +83,7 @@ class CaddyService {
   }
 
   static addProxyConfig(containerDeploymentTemplate) {
+    logInfo({ message: `[CaddyService] Adding proxy for ${containerDeploymentTemplate.domain}` })
     const proxyConfig = CaddyConfigService.createProxyConfig(containerDeploymentTemplate)
     return fetch('http://localhost:2019/config/apps/http/servers/deployment-tools/routes', {
       method: 'POST',
@@ -93,6 +95,7 @@ class CaddyService {
   }
 
   static replaceProxyConfig(containerDeploymentTemplate) {
+    logInfo({ message: `[CaddyService] Replacing proxy for ${containerDeploymentTemplate.domain}` })
     const proxyConfig = CaddyConfigService.createProxyConfig(containerDeploymentTemplate)
     return fetch(`http://localhost:2019/id/${containerDeploymentTemplate.domain}`, {
       method: 'POST',

package/src/docker/docker-service.js

@@ -1,9 +1,9 @@
 const { exec: execBash } = require('child_process')
-const { logInfo, logDebug, logErrorAndReject } = require('../log')
+const { logInfo, logError, logDebug, logErrorAndReject } = require('../log')
 
 const exec = command => new Promise((resolve, reject) => {
   execBash(command, (error, stdout, stderr) => {
-    if (error) return reject(error)
+    if (error || stderr) return reject({ error, stderr })
     // if (stderr) return reject(stderr)
     resolve(stdout, stderr)
   })
@@ -15,20 +15,28 @@ const exec = command => new Promise((resolve, reject) => {
 class DockerService {
 
   static startDefaultContainers(platformConfig) {
+    logInfo({ message: '[DockerService] Starting default containers' })
     return exec(`docker run -d --name=mongodb --network=${platformConfig.ciDockerNetworkName} --network-alias=mongodb --rm mongo`)
-      .catch(() => {/* if it fails it's probably because the network already exists*/})
+      .catch(() => {
+        logError({ message: '[DockerService] Faild to start default containers' })
+      })
   }
 
   static createDockerNetworkForContainerManagerServer(platformConfig) {
     logInfo({ message: '[DockerService] Creating docker network for comunication between containers' })
     return exec(`docker network create ${platformConfig.ciDockerNetworkName}`)
-      .catch(() => {/* if it fails it's probably because the network already exists*/ })
+      .catch(() => {
+        /* if it fails it's probably because the network already exists*/
+        logError({ message: '[DockerService] Faild to start default containers' })
+      })
   }
 
   static stopContainer(deploymentRequest) {
     logInfo({ message: `[DockerService] Stopping container for ${deploymentRequest.domain}` })
     return exec(`docker stop c-${deploymentRequest.domain}`)
-      .catch(() => {}) // no worries if container isn't there
+      .catch(() => {
+        logError({ message: `[DockerService] Faild to stop container for ${deploymentRequest.domain}` })
+      }) // no worries if container isn't there
   }
 
   static removeImage(deploymentRequest) {
@@ -36,7 +44,9 @@ class DockerService {
     const name = !!registry ? `${registry}/${image}` : image
     logInfo({ message: `[DockerService] Removing image ${name}` })
     return exec(`docker image rm -f ${name}`)
-      .catch(() => {}) // no worries if container isn't there
+      .catch(() => {
+        logError({ message: `[DockerService] Faild to remove image for ${deploymentRequest.domain}` })
+      }) // no worries if container isn't there
   }
 
   static pullImage({ image, registry }) {
@@ -82,6 +92,7 @@ class DockerService {
       .then(() => DockerService.removeImage(deploymentRequest))
       .then(() => DockerService.pullImage(deploymentRequest))
       .then(() => DockerService.startContainer(platformConfig, deploymentRequest))
+      .catch(logErrorAndReject('[DockerService] Deployment failed'))
   }
 
   static getUnusedPort() {

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

@@ -3,7 +3,7 @@ const { DockerService } = require('./docker-service')
 
 const deploymentTemplate =   {
     "domain": "api.qa.ossy.se",
-    "image": "ossy-se/cms-api",
+    "image": "ossy-se/api",
     "targetDeploymentPlatform": "ossybot",
     "type": "CONTAINER",
     "hostPort": "3001",