Add support for init field from compose

Init supports boolean values, and is not included in the config when not defined. Change-type: patch Signed-off-by: Christina Ying Wang <[email protected]>
balena-os · Sep 26, 2024 · ed1c18e · ed1c18e
1 parent e01aaaa
commit ed1c18e
Show file tree

Hide file tree

Showing 7 changed files with 412 additions and 3 deletions.
diff --git a/src/compose/service.ts b/src/compose/service.ts
@@ -337,6 +337,13 @@ class ServiceImpl implements Service {
 			config.tty = Boolean(config.tty);
 		}
 
+		// Only keep init field if it's a boolean
+		if (config.init != null) {
+			config.init = Boolean(config.init);
+		} else {
+			delete config.init;
+		}
+
 		if (Array.isArray(config.sysctls)) {
 			config.sysctls = _.fromPairs(
 				_.map(config.sysctls, (v) => _.split(v, '=')),
@@ -598,6 +605,11 @@ class ServiceImpl implements Service {
 			tty: container.Config.Tty || false,
 		};
 
+		// Only add `init` if true or false, otherwise leave blank
+		if (typeof container.HostConfig.Init === 'boolean') {
+			svc.config.init = container.HostConfig.Init;
+		}
+
 		const appId = checkInt(svc.config.labels['io.balena.app-id']);
 		if (appId == null) {
 			throw new InternalInconsistencyError(
@@ -739,6 +751,7 @@ class ServiceImpl implements Service {
 				UsernsMode: this.config.usernsMode,
 				NanoCpus: this.config.cpus,
 				IpcMode: this.config.ipc,
+				Init: this.config.init,
 			} as Dockerode.ContainerCreateOptions['HostConfig'],
 			Healthcheck: ComposeUtils.serviceHealthcheckToDockerHealthcheck(
 				this.config.healthcheck,

diff --git a/src/compose/types/service.ts b/src/compose/types/service.ts
@@ -183,7 +183,7 @@ export interface ServiceComposeConfig {
 	groupAdd?: string[];
 	healthcheck?: ComposeHealthcheck;
 	image: string;
-	init?: string | boolean;
+	init?: boolean;
 	labels?: { [labelName: string]: string };
 	running?: boolean;
 	networkMode?: string;
@@ -272,6 +272,7 @@ export interface ServiceConfig {
 	domainname: string;
 	hostname: string;
 	ipc: string;
+	init?: boolean;
 	macAddress: string;
 	memLimit: number;
 	memReservation: number;

diff --git a/test/data/docker-states/entrypoint/inspect.json b/test/data/docker-states/entrypoint/inspect.json
@@ -105,8 +105,7 @@
 		"CpuCount": 0,
 		"CpuPercent": 0,
 		"IOMaximumIOps": 0,
-		"IOMaximumBandwidth": 0,
-		"Init": false
+		"IOMaximumBandwidth": 0
 	},
 	"GraphDriver": {
 		"Data": null,

diff --git a/test/data/docker-states/init/compose.json b/test/data/docker-states/init/compose.json
@@ -0,0 +1,17 @@
+{
+	"imageId": 478890,
+	"serviceName": "main",
+	"image": "sha256:7f54fa690ce19a1f625b04479ae1f12f44d36112a74be7edfefa777ecfdb194b",
+	"running": true,
+	"environment": {},
+	"labels": {},
+	"appId": 1011165,
+	"appUuid": "aaaaaaaa",
+	"releaseId": 597007,
+	"serviceId": 43697,
+	"commit": "ff300a701054ac15281de1f9c0e84b8c",
+	"imageName": "registry2.resin.io/v2/bf9c649a5ac2fe147bbe350875042388@sha256:3a5c17b715b4f8265539c1a006dd1abdd2ff3b758aa23df99f77c792f40c3d43",
+	"composition": {
+		"init": true
+	}
+}
diff --git a/test/data/docker-states/init/imageInfo.json b/test/data/docker-states/init/imageInfo.json
@@ -0,0 +1,103 @@
+{
+	"serviceName": "main",
+	"imageInfo": {
+		"Id": "sha256:7f54fa690ce19a1f625b04479ae1f12f44d36112a74be7edfefa777ecfdb194b",
+		"RepoTags": [],
+		"RepoDigests": [
+			"registry2.resin.io/v2/90e3bf4c3dc1e59221b7b3e659a327f6@sha256:3a5c17b715b4f8265539c1a006dd1abdd2ff3b758aa23df99f77c792f40c3d43"
+		],
+		"Parent": "",
+		"Comment": "",
+		"Created": "2018-09-12T13:00:43.974720835Z",
+		"Container": "07cb0400e218ae235e67cf1fd283dc09559f57fbe2a36f5cc89302388371781c",
+		"ContainerConfig": {
+			"Hostname": "137f767087a2",
+			"Domainname": "",
+			"User": "",
+			"AttachStdin": false,
+			"AttachStdout": false,
+			"AttachStderr": false,
+			"Tty": false,
+			"OpenStdin": false,
+			"StdinOnce": false,
+			"Env": [
+				"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+			],
+			"Cmd": [
+				"/bin/sh",
+				"-c",
+				"#(nop) ",
+				"CMD [\"/bin/sh\" \"-c\" \"while true; do echo 'hello'; sleep 5; done;\"]"
+			],
+			"ArgsEscaped": true,
+			"Image": "sha256:8d68949dbddcb3ab1a61caeffa0aa1a6e27425ecc4f7665d04d8d0e5bfa03298",
+			"Volumes": null,
+			"WorkingDir": "",
+			"Entrypoint": null,
+			"OnBuild": [],
+			"Labels": {}
+		},
+		"DockerVersion": "17.05.0-ce",
+		"Author": "",
+		"Config": {
+			"Hostname": "137f767087a2",
+			"Domainname": "",
+			"User": "",
+			"AttachStdin": false,
+			"AttachStdout": false,
+			"AttachStderr": false,
+			"Tty": false,
+			"OpenStdin": false,
+			"StdinOnce": false,
+			"Env": [
+				"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+			],
+			"Cmd": [
+				"/bin/sh",
+				"-c",
+				"while true; do echo 'hello'; sleep 5; done;"
+			],
+			"ArgsEscaped": true,
+			"Image": "sha256:8d68949dbddcb3ab1a61caeffa0aa1a6e27425ecc4f7665d04d8d0e5bfa03298",
+			"Volumes": null,
+			"WorkingDir": "",
+			"Entrypoint": null,
+			"OnBuild": [],
+			"Labels": {}
+		},
+		"Architecture": "arm64",
+		"Os": "linux",
+		"Size": 104966431,
+		"VirtualSize": 104966431,
+		"GraphDriver": {
+			"Data": null,
+			"Name": "aufs"
+		},
+		"RootFS": {
+			"Type": "layers",
+			"Layers": [
+				"sha256:a3075e9def48840598abcfe08c1ee564c989d1014d847082d950dca2c94098ec",
+				"sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
+			]
+		},
+		"Metadata": {
+			"LastTagTime": "0001-01-01T00:00:00Z"
+		}
+	},
+	"appName": "supervisortest",
+	"supervisorApiHost": "172.17.0.1",
+	"hostPathExists": {
+		"firmware": true,
+		"modules": true
+	},
+	"hostname": "7dadabd",
+	"uuid": "a7feb967fac7f559ccf2a006a36bcf5d",
+	"listenPort": "48484",
+	"name": "Office",
+	"apiSecret": "d4bf8369519c32adaa5dd1f84367aa817403f2a3ce976be9c9bacd4d344fdd",
+	"deviceApiKey": "ff89e1d8db58a7ca52a435f2adea319a",
+	"version": "7.18.0",
+	"deviceArch": "amd64",
+	"deviceType": "raspberrypi3",
+	"osVersion": "Resin OS 2.13.6+rev1"
+}