Merge pull request #956 from kinvolk/alban/uid-mapping

Mrunal Patel · web-flow · commit 6be516e2237a · 2018-03-09T12:39:09.000-08:00
uidMappings: change order of fields for clarity
diff --git a/config-linux.md b/config-linux.md
@@ -82,8 +82,8 @@ If a `namespaces` field contains duplicated namespaces with same `type`, the run
 
 Each entry has the following structure:
 
-* **`hostID`** *(uint32, REQUIRED)* - is the starting uid/gid on the host to be mapped to *containerID*.
 * **`containerID`** *(uint32, REQUIRED)* - is the starting uid/gid in the container.
+* **`hostID`** *(uint32, REQUIRED)* - is the starting uid/gid on the host to be mapped to *containerID*.
 * **`size`** *(uint32, REQUIRED)* - is the number of ids to be mapped.
 
 The runtime SHOULD NOT modify the ownership of referenced filesystems to realize the mapping.
@@ -94,15 +94,15 @@ Note that the number of mapping entries MAY be limited by the [kernel][user-name
 ```json
     "uidMappings": [
         {
-            "hostID": 1000,
             "containerID": 0,
+            "hostID": 1000,
             "size": 32000
         }
     ],
     "gidMappings": [
         {
-            "hostID": 1000,
             "containerID": 0,
+            "hostID": 1000,
             "size": 32000
         }
     ]
diff --git a/config.md b/config.md
@@ -664,15 +664,15 @@ Here is a full example `config.json` for reference.
         ],
         "uidMappings": [
             {
-                "hostID": 1000,
                 "containerID": 0,
+                "hostID": 1000,
                 "size": 32000
             }
         ],
         "gidMappings": [
             {
-                "hostID": 1000,
                 "containerID": 0,
+                "hostID": 1000,
                 "size": 32000
             }
         ],
diff --git a/schema/defs.json b/schema/defs.json
@@ -108,19 +108,19 @@
         "IDMapping": {
             "type": "object",
             "properties": {
-                "hostID": {
+                "containerID": {
                     "$ref": "#/definitions/uint32"
                 },
-                "containerID": {
+                "hostID": {
                     "$ref": "#/definitions/uint32"
                 },
                 "size": {
                     "$ref": "#/definitions/uint32"
                 }
             },
             "required": [
-                "hostID",
                 "containerID",
+                "hostID",
                 "size"
             ]
         },
diff --git a/schema/test/config/good/spec-example.json b/schema/test/config/good/spec-example.json
@@ -194,15 +194,15 @@
         ],
         "uidMappings": [
             {
-                "hostID": 1000,
                 "containerID": 0,
+                "hostID": 1000,
                 "size": 32000
             }
         ],
         "gidMappings": [
             {
-                "hostID": 1000,
                 "containerID": 0,
+                "hostID": 1000,
                 "size": 32000
             }
         ],
diff --git a/specs-go/config.go b/specs-go/config.go
@@ -194,10 +194,10 @@ const (
 
 // LinuxIDMapping specifies UID/GID mappings
 type LinuxIDMapping struct {
-	// HostID is the starting UID/GID on the host to be mapped to 'ContainerID'
-	HostID uint32 `json:"hostID"`
 	// ContainerID is the starting UID/GID in the container
 	ContainerID uint32 `json:"containerID"`
+	// HostID is the starting UID/GID on the host to be mapped to 'ContainerID'
+	HostID uint32 `json:"hostID"`
 	// Size is the number of IDs to be mapped
 	Size uint32 `json:"size"`
 }

Original file line number	Diff line number	Diff line change
@@ -82,8 +82,8 @@ If a `namespaces` field contains duplicated namespaces with same `type`, the run
`82`	`82`
`83`	`83`	`Each entry has the following structure:`
`84`	`84`
`85`		-* `hostID` (uint32, REQUIRED) - is the starting uid/gid on the host to be mapped to containerID.
`86`	`85`	* `containerID` (uint32, REQUIRED) - is the starting uid/gid in the container.
	`86`	+* `hostID` (uint32, REQUIRED) - is the starting uid/gid on the host to be mapped to containerID.
`87`	`87`	* `size` (uint32, REQUIRED) - is the number of ids to be mapped.
`88`	`88`
`89`	`89`	`The runtime SHOULD NOT modify the ownership of referenced filesystems to realize the mapping.`
`@@ -94,15 +94,15 @@ Note that the number of mapping entries MAY be limited by the [kernel][user-name`
`94`	`94`	```json
`95`	`95`	`"uidMappings": [`
`96`	`96`	`{`
`97`		`- "hostID": 1000,`
`98`	`97`	`"containerID": 0,`
	`98`	`+ "hostID": 1000,`
`99`	`99`	`"size": 32000`
`100`	`100`	`}`
`101`	`101`	`],`
`102`	`102`	`"gidMappings": [`
`103`	`103`	`{`
`104`		`- "hostID": 1000,`
`105`	`104`	`"containerID": 0,`
	`105`	`+ "hostID": 1000,`
`106`	`106`	`"size": 32000`
`107`	`107`	`}`
`108`	`108`	`]`
Original file line number	Diff line number	Diff line change
@@ -664,15 +664,15 @@ Here is a full example `config.json` for reference.
`664`	`664`	`],`
`665`	`665`	`"uidMappings": [`
`666`	`666`	`{`
`667`		`- "hostID": 1000,`
`668`	`667`	`"containerID": 0,`
	`668`	`+ "hostID": 1000,`
`669`	`669`	`"size": 32000`
`670`	`670`	`}`
`671`	`671`	`],`
`672`	`672`	`"gidMappings": [`
`673`	`673`	`{`
`674`		`- "hostID": 1000,`
`675`	`674`	`"containerID": 0,`
	`675`	`+ "hostID": 1000,`
`676`	`676`	`"size": 32000`
`677`	`677`	`}`
`678`	`678`	`],`
Original file line number	Diff line number	Diff line change
`@@ -194,15 +194,15 @@`
`194`	`194`	`],`
`195`	`195`	`"uidMappings": [`
`196`	`196`	`{`
`197`		`- "hostID": 1000,`
`198`	`197`	`"containerID": 0,`
	`198`	`+ "hostID": 1000,`
`199`	`199`	`"size": 32000`
`200`	`200`	`}`
`201`	`201`	`],`
`202`	`202`	`"gidMappings": [`
`203`	`203`	`{`
`204`		`- "hostID": 1000,`
`205`	`204`	`"containerID": 0,`
	`205`	`+ "hostID": 1000,`
`206`	`206`	`"size": 32000`
`207`	`207`	`}`
`208`	`208`	`],`