containerify 2.5.1 → 2.6.0

package/README.md

@@ -18,6 +18,19 @@ This will pull the `node:13-slim` image from Docker hub, build the image by addi
 containerify --fromImage node:13-slim --folder src/ --toImage myapp:latest --toRegistry https://registry.example.com/v2/ --setTimeStamp=$(git show -s --format="%aI" HEAD)
 ```
 
+### customContent - Adding compiled code to non-node container
+
+If you want to build a non-node container (e.g. add compiled frontend code to an nginx container), you can use `--customContent`. When doing this
+the normal `node_modules` etc layers will not be added, and workdir, user and entrypoint will not be overridden (allthough they can be explicitely modified
+if needed).
+
+```
+npm run build
+containerify --fromImage nginx:alpine --folder . --toImage frontend:latest --customContent dist:/var/www/html --toRegistry https://registry.example.com/v2/
+```
+
+This will take nginx:alpine and copy the files in `./dist/` into `/var/www/html`.
+
 ### Command line options
 
 ```

package/lib/appLayerCreator.js

@@ -166,19 +166,26 @@ function parseCommandLineToParts(entrypoint) {
 }
 function addAppLayers(options, config, todir, manifest, tmpdir) {
     return __awaiter(this, void 0, void 0, function* () {
-        addEmptyLayer(config, options, `WORKDIR ${options.workdir}`, (config) => (config.config.WorkingDir = options.workdir));
-        const entrypoint = parseCommandLineToParts(options.entrypoint);
-        addEmptyLayer(config, options, `ENTRYPOINT ${JSON.stringify(entrypoint)}`, (config) => (config.config.Entrypoint = entrypoint));
-        addEmptyLayer(config, options, `USER ${options.user}`, (config) => {
-            config.config.User = options.user;
-            config.container_config.User = options.user;
-        });
-        yield addEnvsLayer(options, config);
-        yield addLabelsLayer(options, config);
-        if (options.customContent.length > 0) {
-            yield addDataLayer(tmpdir, todir, options, config, manifest, options.customContent, "custom");
+        if (Object.entries(options.customContent).length > 0) {
+            // We only add these layers if they have been explicitely set for customContent. This allows customContent
+            // to be used to add compiled frontend code to an nginx container without also modifying the entrypoint, user,
+            // and workdir.
+            if (options.nonDefaults.workdir)
+                yield addWorkdirLayer(options, config, options.nonDefaults.workdir);
+            if (options.nonDefaults.entrypoint)
+                yield addEntrypointLayer(options, config, options.nonDefaults.entrypoint);
+            if (options.nonDefaults.user)
+                yield addUserLayer(options, config, options.nonDefaults.user);
+            yield addEnvsLayer(options, config);
+            yield addLabelsLayer(options, config);
+            yield addDataLayer(tmpdir, todir, options, config, manifest, Object.entries(options.customContent), "custom");
         }
         else {
+            yield addWorkdirLayer(options, config, options.workdir);
+            yield addEntrypointLayer(options, config, options.entrypoint);
+            yield addUserLayer(options, config, options.user);
+            yield addEnvsLayer(options, config);
+            yield addLabelsLayer(options, config);
             const appFiles = (yield fs_1.promises.readdir(options.folder)).filter((l) => !ignore.includes(l));
             const depLayerContent = appFiles.filter((l) => depLayerPossibles.includes(l));
             const appLayerContent = appFiles.filter((l) => !depLayerPossibles.includes(l));
@@ -190,6 +197,25 @@ function addAppLayers(options, config, todir, manifest, tmpdir) {
         }
     });
 }
+function addWorkdirLayer(options, config, workdir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        addEmptyLayer(config, options, `WORKDIR ${workdir}`, (config) => (config.config.WorkingDir = workdir));
+    });
+}
+function addEntrypointLayer(options, config, entrypoint) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const entrypointParts = parseCommandLineToParts(entrypoint);
+        addEmptyLayer(config, options, `ENTRYPOINT ${JSON.stringify(entrypoint)}`, (config) => (config.config.Entrypoint = entrypointParts));
+    });
+}
+function addUserLayer(options, config, user) {
+    return __awaiter(this, void 0, void 0, function* () {
+        addEmptyLayer(config, options, `USER ${user}`, (config) => {
+            config.config.User = user;
+            config.container_config.User = user;
+        });
+    });
+}
 function addLabelsLayer(options, config) {
     return __awaiter(this, void 0, void 0, function* () {
         if (Object.keys(options.labels).length > 0) {

package/lib/cli.js

@@ -38,9 +38,9 @@ const possibleArgs = {
     "--registry <path>": "Optional: Convenience argument for setting both from and to registry",
     "--platform <platform>": "Optional: Preferred platform, e.g. linux/amd64 or arm64",
     "--token <path>": "Optional: Convenience argument for setting token for both from and to registry",
-    "--user <user>": "Optional: User account to run process in container - default: 1000",
-    "--workdir <directory>": "Optional: Workdir where node app will be added and run from - default: /app",
-    "--entrypoint <entrypoint>": "Optional: Entrypoint when starting container - default: npm start",
+    "--user <user>": "Optional: User account to run process in container - default: 1000 (empty for customContent)",
+    "--workdir <directory>": "Optional: Workdir where node app will be added and run from - default: /app (empty for customContent)",
+    "--entrypoint <entrypoint>": "Optional: Entrypoint when starting container - default: npm start (empty for customContent)",
     "--labels <labels>": "Optional: Comma-separated list of key value pairs to use as labels",
     "--label <label>": "Optional: Single label (name=value). This option can be used multiple times.",
     "--envs <envs>": "Optional: Comma-separated list of key value pairs to use av environment variables.",
@@ -48,16 +48,17 @@ const possibleArgs = {
     "--setTimeStamp <timestamp>": "Optional: Set a specific ISO 8601 timestamp on all entries (e.g. git commit hash). Default: 1970 in tar files, and current time on manifest/config",
     "--verbose": "Verbose logging",
     "--allowInsecureRegistries": "Allow insecure registries (with self-signed/untrusted cert)",
-    "--customContent <dirs/files>": "Optional: Skip normal node_modules and applayer and include specified root folder files/directories instead",
+    "--customContent <dirs/files>": "Optional: Skip normal node_modules and applayer and include specified root folder files/directories instead. You can specify as local-path:absolute-container-path if you want to place it in a specific location",
     "--extraContent <dirs/files>": "Optional: Add specific content. Specify as local-path:absolute-container-path,local-path2:absolute-container-path2 etc",
     "--layerOwner <gid:uid>": "Optional: Set specific gid and uid on files in the added layers",
     "--buildFolder <path>": "Optional: Use a specific build folder when creating the image",
     "--layerCacheFolder <path>": "Optional: Folder to cache base layers between builds",
     "--version": "Get containerify version",
 };
-function setKeyValue(target, keyValue, separator = "=") {
+function setKeyValue(target, keyValue, separator = "=", defaultValue) {
+    var _a;
     const [k, v] = keyValue.split(separator, 2);
-    target[k.trim()] = v.trim();
+    target[k.trim()] = (_a = v === null || v === void 0 ? void 0 : v.trim()) !== null && _a !== void 0 ? _a : defaultValue;
 }
 const cliLabels = {};
 commander_1.program.on("option:label", (ops) => {
@@ -114,9 +115,9 @@ Object.keys(envOpt)
     exitWithErrorIf(true, `Env ${l} specified both with --envs and --env`);
 });
 const envs = Object.assign(Object.assign(Object.assign({}, configFromFile.envs), envOpt), cliEnv); //Let cli arguments override file
-const customContent = [];
-(_e = configFromFile.customContent) === null || _e === void 0 ? void 0 : _e.forEach((c) => customContent.push(c));
-(_f = cliOptions.customContent) === null || _f === void 0 ? void 0 : _f.split(",").forEach((c) => customContent.push(c));
+const customContent = {};
+(_e = configFromFile.customContent) === null || _e === void 0 ? void 0 : _e.forEach((c) => setKeyValue(customContent, c, ":", c));
+(_f = cliOptions.customContent) === null || _f === void 0 ? void 0 : _f.split(",").forEach((c) => setKeyValue(customContent, c, ":", c));
 const cliExtraContent = {};
 (_g = cliOptions.extraContent) === null || _g === void 0 ? void 0 : _g.split(",").forEach((x) => setKeyValue(cliExtraContent, x, ":"));
 const extraContent = Object.assign(Object.assign({}, configFromFile.extraContent), cliExtraContent);
@@ -128,9 +129,14 @@ const cliParams = (0, utils_1.omit)(cliOptions, [
     "customContent",
     "extraContent",
 ]);
-const options = Object.assign(Object.assign(Object.assign(Object.assign({}, defaultOptions), configFromFile), cliParams), { customContent,
+const setOptions = Object.assign(Object.assign(Object.assign({}, configFromFile), cliParams), { customContent,
     extraContent,
     labels, envs: Object.entries(envs).map(([k, v]) => `${k}=${v}`) });
+const options = Object.assign(Object.assign(Object.assign({}, defaultOptions), setOptions), { nonDefaults: {
+        user: setOptions.user,
+        workdir: setOptions.workdir,
+        entrypoint: setOptions.entrypoint,
+    } });
 function exitWithErrorIf(check, error) {
     if (check) {
         logger_1.default.error("ERROR: " + error);
@@ -179,7 +185,7 @@ if (options.fromRegistry && !options.fromRegistry.endsWith("/"))
 if (!options.fromRegistry && !((_k = (_j = (_h = options.fromImage) === null || _h === void 0 ? void 0 : _h.split(":")) === null || _j === void 0 ? void 0 : _j[0]) === null || _k === void 0 ? void 0 : _k.includes("/"))) {
     options.fromImage = "library/" + options.fromImage;
 }
-options.customContent.forEach((p) => {
+Object.keys(options.customContent).forEach((p) => {
     exitWithErrorIf(!fs.existsSync(p), "Could not find " + p + " in the base folder " + options.folder);
 });
 if (options.layerCacheFolder) {
@@ -196,7 +202,7 @@ if (options.layerCacheFolder) {
         options.layerCacheFolder += "/";
     }
 }
-Object.keys(options.extraContent).forEach(k => {
+Object.keys(options.extraContent).forEach((k) => {
     exitWithErrorIf(!fs.existsSync(options.folder + k), "Could not find `" + k + "` in the folder " + options.folder);
 });
 function run(options) {

package/lib/types.d.ts

@@ -75,10 +75,15 @@ export type Options = {
     setTimeStamp?: string;
     verbose?: boolean;
     allowInsecureRegistries?: boolean;
-    customContent: string[];
+    customContent: Record<string, string>;
     extraContent: Record<string, string>;
     layerOwner?: string;
     buildFolder?: string;
     layerCacheFolder?: string;
+    nonDefaults: {
+        user?: string;
+        workdir?: string;
+        entrypoint?: string;
+    };
 };
 export {};

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.5.1";
+export declare const VERSION = "2.6.0";

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "2.5.1";
+exports.VERSION = "2.6.0";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "containerify",
-	"version": "2.5.1",
+	"version": "2.6.0",
 	"description": "Build node.js docker images without docker",
 	"main": "./lib/cli.js",
 	"scripts": {