auto-deploy-sh 2.1.1 → 2.1.3

package/README.md

@@ -82,6 +82,12 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
 - `Options`: **Optional** advanced settings (all sub-properties are optional)
   - `volumes`: Volume mappings (array of strings), formatted as `[host-path/volume-name]:[container-path]:[optional-flags]` (e.g., `["/host/data:/container/data:ro"]`).
   - `networks`: Connect the container to a custom Docker network (created via `docker network create <network-name>`) for inter-container communication.
+  - `logging`: Docker log management configuration. During deployment, it is converted to Docker `--log-driver` and `--log-opt` arguments. Before starting the container, the tool checks the logging drivers supported by the remote Docker daemon. If the configured `driver` is not supported, deployment stops and prints the current default driver and supported driver list.
+    - `driver`: Logging driver. The interactive guide currently supports `json-file`, `local`, `none`, `syslog`, `journald`, `gelf`, `fluentd`, `awslogs`, `splunk`, and `gcplogs`.
+    - `options`: Logging driver options passed to `docker run` as `--log-opt key=value`.
+    - `options.max-size`: Maximum size of a single log file. The guided default is `10m`.
+    - `options.max-file`: Number of rotated log files to keep. The guided default is `3`.
+    - `options.compress`: Whether to enable log compression. The interactive guide asks for this option when `json-file` is selected.
 
 ### Format Introduction
 
@@ -100,7 +106,15 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "restart": "'no' | 'always' | 'unless-stopped' | 'on-failure'",
   "Options": {
     "volumes": "string[]",
-    "networks": "string[]"
+    "networks": "string[]",
+    "logging": {
+      "driver": "'json-file' | 'local' | 'none' | 'syslog' | 'journald' | 'gelf' | 'fluentd' | 'awslogs' | 'splunk' | 'gcplogs'",
+      "options": {
+        "max-size": "string",
+        "max-file": "string",
+        "compress": "boolean"
+      }
+    }
   }
 }
 ```
@@ -122,7 +136,15 @@ The configuration file is **fixed as `deploy-config.json`**. If missing, the too
   "restart": "unless-stopped",
   "Options": {
     "volumes": ["/host/logs:/app/logs:rw"],
-    "networks": ["my-custom-network", "my-custom-network-1"]
+    "networks": ["my-custom-network", "my-custom-network-1"],
+    "logging": {
+      "driver": "json-file",
+      "options": {
+        "max-size": "10m",
+        "max-file": "3",
+        "compress": true
+      }
+    }
   }
 }
 ```

package/dist/bin/config.js

@@ -81,6 +81,98 @@ const optionsMethod = {
         message: 'Bound networks (separated by , ): ',
         handleFn: (value) => value.split(','),
     },
+    logging: {
+        type: 'confirm',
+        message: 'Do you want to enable Docker log management?',
+        default: false,
+        handleFn: async (value) => {
+            if (!value)
+                return {};
+            const loggingDriver = {
+                type: 'select',
+                message: 'Select a logging driver for the container: ',
+                choices: [
+                    {
+                        name: 'json-file (default)',
+                        value: 'json-file',
+                        description: 'Write logs as JSON files on the host. Docker default and supports max-size/max-file.',
+                    },
+                    {
+                        name: 'local (recommended)',
+                        value: 'local',
+                        description: 'Write logs in Docker local format. More efficient for local log rotation and disk usage.',
+                    },
+                    {
+                        name: 'none',
+                        value: 'none',
+                        description: 'Disable container logging. Useful when logs are handled entirely by the app.',
+                    },
+                    {
+                        name: 'syslog',
+                        value: 'syslog',
+                        description: 'Send logs to the syslog service.',
+                    },
+                    {
+                        name: 'journald',
+                        value: 'journald',
+                        description: 'Send logs to systemd journald.',
+                    },
+                    {
+                        name: 'gelf',
+                        value: 'gelf',
+                        description: 'Send logs to a Graylog Extended Log Format endpoint.',
+                    },
+                    {
+                        name: 'fluentd',
+                        value: 'fluentd',
+                        description: 'Send logs to a Fluentd collector.',
+                    },
+                    {
+                        name: 'awslogs',
+                        value: 'awslogs',
+                        description: 'Send logs to Amazon CloudWatch Logs.',
+                    },
+                    {
+                        name: 'splunk',
+                        value: 'splunk',
+                        description: 'Send logs to Splunk using the HTTP Event Collector.',
+                    },
+                    {
+                        name: 'gcplogs',
+                        value: 'gcplogs',
+                        description: 'Send logs to Google Cloud Logging.',
+                    },
+                ],
+            };
+            const loggingMaxSize = {
+                type: 'input',
+                message: 'Logging max-size: (eg: 10m, 1g)',
+                default: '10m',
+            };
+            const loggingMaxFile = {
+                type: 'input',
+                message: 'Logging max-file: (eg: 3)',
+                default: '3',
+            };
+            const driver = await inquirer.invoke(loggingDriver);
+            let options = {
+                'max-size': await inquirer.invoke(loggingMaxSize),
+                'max-file': await inquirer.invoke(loggingMaxFile),
+            };
+            if (driver === 'json-file') {
+                const compress = await inquirer.invoke({
+                    type: 'confirm',
+                    message: 'Do you want to enable log compression?',
+                    default: false,
+                });
+                options['compress'] = compress;
+            }
+            return {
+                driver,
+                options: options,
+            };
+        },
+    },
 };
 export async function createConfig(rootPath) {
     const config = {};
@@ -96,7 +188,7 @@ export async function createConfig(rootPath) {
                     return value;
             };
         const value = (await inquirer.invoke(configMethod[key]));
-        config[key] = fn(value);
+        config[key] = await fn(value);
     }
     const options = await inquirer.invoke({
         type: 'checkbox',
@@ -104,6 +196,7 @@ export async function createConfig(rootPath) {
         choices: [
             { name: 'Volumes', value: 'volumes' },
             { name: 'Networks', value: 'networks' },
+            { name: 'Logging', value: 'logging' },
         ],
     });
     config['Options'] = {};
@@ -118,7 +211,7 @@ export async function createConfig(rootPath) {
                     return value;
             };
         const value = (await inquirer.invoke(optionsMethod[key]));
-        config['Options'][key] = fn(value);
+        config['Options'][key] = await fn(value);
     }
     await fs.writeFileSync(path.resolve(rootPath, 'deploy-config.json'), JSON.stringify(config, null, 2));
     const gitIgnorePath = path.resolve(rootPath, '.gitignore');

package/dist/bin/deploy.js

@@ -268,6 +268,36 @@ export class Deploy {
                             optionsCLI += ` ${cli}`;
                             break;
                         }
+                        case 'logging': {
+                            if (options.logging && options.logging.driver) {
+                                const logDriver = options.logging.driver.trim();
+                                const { stderr, code, stdout } = await ssh.execCommand(`docker info --format '{{.LoggingDriver}}|{{json .Plugins.Log}}'`);
+                                if (code !== 0 || (stderr && code !== 0)) {
+                                    stderr && log.error(stderr);
+                                    throw new Error('Failed to get Docker logging information.');
+                                }
+                                const [defaultLogDriver, supportedLogDriversJson = '[]'] = stdout.trim().split('|');
+                                const supportedLogDrivers = JSON.parse(supportedLogDriversJson);
+                                if (!supportedLogDrivers.includes(logDriver)) {
+                                    log.error(`Docker logging driver "${logDriver}" is not supported by the remote Docker daemon. ` +
+                                        `Current default driver is "${defaultLogDriver}", supported drivers are: ${supportedLogDrivers.join(', ')}`);
+                                    throw new Error();
+                                }
+                                optionsCLI += ` --log-driver ${logDriver}`;
+                                if (options.logging.options) {
+                                    const logOptions = options.logging.options;
+                                    const logOptionsKeys = Object.keys(logOptions);
+                                    for (let j = 0; j < logOptionsKeys.length; ++j) {
+                                        const logKey = logOptionsKeys[j];
+                                        const logValue = logOptions[logKey];
+                                        if (logValue !== undefined) {
+                                            optionsCLI += ` --log-opt ${logKey}=${logValue}`;
+                                        }
+                                    }
+                                }
+                            }
+                            break;
+                        }
                         default:
                             break;
                     }

package/dist/bin/index.js

@@ -35,7 +35,7 @@ export async function deploySSH(configFile = 'deploy-config.json') {
         catch {
         }
         finally {
-            fs.removeSync(path.resolve(process.cwd(), deploy.uploadFileName));
+            await fs.remove(path.resolve(process.cwd(), deploy.uploadFileName));
             ssh.dispose();
             exit(1);
         }

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

@@ -14,6 +14,14 @@ export type sshConfig = {
     Options: {
         volumes: string[];
         networks: string[];
+        logging: {
+            driver?: string;
+            options?: {
+                'max-size': string;
+                'max-file': string;
+                compress?: boolean;
+            };
+        };
     };
 };
 export type fileData = string | NodeJS.ArrayBufferView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-deploy-sh",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Automated Docker deployment tool",
   "bin": {
     "auto-deploy-sh": "./dist/cli/index.js"