chore: add device to inspect response

Signed-off-by: Arjun Raja Yogidas <[email protected]>

Author: coderbirju

cmd/nerdctl/container/container_inspect_linux_test.go

@@ -255,6 +255,7 @@ func TestContainerInspectHostConfig(t *testing.T) {
 		"--shm-size", "256m",
 		"--runtime", "io.containerd.runtime.v1.linux",
 		"--sysctl", "net.core.somaxconn=1024",
+		"--device", "/dev/zero:/dev/null",
 		testutil.AlpineImage, "sleep", "infinity").AssertOK()
 
 	inspect := base.InspectContainer(testContainer)
@@ -268,8 +269,7 @@ func TestContainerInspectHostConfig(t *testing.T) {
 	expectedExtraHosts := []string{"host1:10.0.0.1", "host2:10.0.0.2"}
 	assert.DeepEqual(t, expectedExtraHosts, inspect.HostConfig.ExtraHosts)
 	assert.Equal(t, "host", inspect.HostConfig.IpcMode)
-	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Type)
-	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Config.Driver)
+	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Driver)
 	assert.Equal(t, int64(536870912), inspect.HostConfig.Memory)
 	assert.Equal(t, int64(1073741824), inspect.HostConfig.MemorySwap)
 	assert.Equal(t, bool(true), inspect.HostConfig.OomKillDisable)
@@ -281,6 +281,8 @@ func TestContainerInspectHostConfig(t *testing.T) {
 		"net.core.somaxconn": "1024",
 	}
 	assert.DeepEqual(t, expectedSysctls, inspect.HostConfig.Sysctls)
+	expectedDevices := []string{"/dev/null:/dev/null"}
+	assert.DeepEqual(t, expectedDevices, inspect.HostConfig.Devices)
 }
 
 func TestContainerInspectHostConfigDefaults(t *testing.T) {
@@ -301,8 +303,7 @@ func TestContainerInspectHostConfigDefaults(t *testing.T) {
 	assert.Equal(t, 0, len(inspect.HostConfig.GroupAdd))
 	assert.Equal(t, 0, len(inspect.HostConfig.ExtraHosts))
 	assert.Equal(t, "", inspect.HostConfig.IpcMode)
-	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Type)
-	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Config.Driver)
+	assert.Equal(t, "json-file", inspect.HostConfig.LogConfig.Driver)
 	assert.Equal(t, int64(0), inspect.HostConfig.Memory)
 	assert.Equal(t, int64(0), inspect.HostConfig.MemorySwap)
 	assert.Equal(t, bool(false), inspect.HostConfig.OomKillDisable)
@@ -311,6 +312,7 @@ func TestContainerInspectHostConfigDefaults(t *testing.T) {
 	assert.Equal(t, int64(67108864), inspect.HostConfig.ShmSize)
 	assert.Equal(t, "io.containerd.runc.v2", inspect.HostConfig.Runtime)
 	assert.Equal(t, 0, len(inspect.HostConfig.Sysctls))
+	assert.Equal(t, 0, len(inspect.HostConfig.Devices))
 }
 
 func TestContainerInspectHostConfigDNS(t *testing.T) {

pkg/cmd/container/create.go

@@ -658,6 +658,9 @@ type internalLabels struct {
 
 	// label to check if --group-add is set
 	groupAdd []string
+
+	// label for device mapping set by the --device flag
+	deviceMapping []string
 }
 
 // WithInternalLabels sets the internal labels for a container.
@@ -757,7 +760,7 @@ func withInternalLabels(internalLabels internalLabels) (containerd.NewContainerO
 		if err != nil {
 			return nil, err
 		}
-		m[labels.DnsServer] = string(dnsServersJSON)
+		m[labels.DNSServer] = string(dnsServersJSON)
 	}
 
 	if len(internalLabels.dnsSearchDomains) > 0 {
@@ -776,6 +779,14 @@ func withInternalLabels(internalLabels internalLabels) (containerd.NewContainerO
 		m[labels.DNSResolvConfOptions] = string(dnsResolvConfOptionsJSON)
 	}
 
+	if len(internalLabels.deviceMapping) > 0 {
+		devicesJSON, err := json.Marshal(internalLabels.deviceMapping)
+		if err != nil {
+			return nil, err
+		}
+		m[labels.DeviceMapping] = string(devicesJSON)
+	}
+
 	return containerd.WithAdditionalContainerLabels(m), nil
 }
 

pkg/cmd/container/run_cgroup_linux.go

@@ -41,7 +41,7 @@ type customMemoryOptions struct {
 	disableOOMKiller  *bool
 }
 
-func generateCgroupOpts(id string, options types.ContainerCreateOptions) ([]oci.SpecOpts, error) {
+func generateCgroupOpts(id string, options types.ContainerCreateOptions, internalLabels *internalLabels) ([]oci.SpecOpts, error) {
 	if options.KernelMemory != "" {
 		log.L.Warnf("The --kernel-memory flag is no longer supported. This flag is a noop.")
 	}
@@ -206,6 +206,7 @@ func generateCgroupOpts(id string, options types.ContainerCreateOptions) ([]oci.
 			return nil, fmt.Errorf("failed to parse device %q: %w", f, err)
 		}
 		opts = append(opts, oci.WithDevices(devPath, conPath, mode))
+		internalLabels.deviceMapping = append(internalLabels.deviceMapping, f)
 	}
 
 	return opts, nil

pkg/cmd/container/run_linux.go

@@ -56,7 +56,7 @@ func setPlatformOptions(ctx context.Context, client *containerd.Client, id, uts
 			{Type: "cgroup", Source: "cgroup", Destination: "/sys/fs/cgroup", Options: []string{"ro", "nosuid", "noexec", "nodev"}},
 		}))
 
-	cgOpts, err := generateCgroupOpts(id, options)
+	cgOpts, err := generateCgroupOpts(id, options, internalLabels)
 	if err != nil {
 		return nil, err
 	}

pkg/inspecttypes/dockercompat/dockercompat.go

@@ -162,6 +162,7 @@ type HostConfig struct {
 	ShmSize         int64             // Size of /dev/shm in bytes. The size must be greater than 0.
 	Sysctls         map[string]string // List of Namespaced sysctls used for the container
 	Runtime         string            // Runtime to use with this container
+	Devices         []string          // List of devices to map inside the container
 }
 
 // From https://github.com/moby/moby/blob/v20.10.1/api/types/types.go#L416-L427
@@ -439,7 +440,7 @@ func ContainerFromNative(n *native.Container) (*Container, error) {
 	c.HostConfig.Memory = memorySettings.Limit
 	c.HostConfig.MemorySwap = memorySettings.Swap
 
-	dnsSettings, err := getDnsFromNative(n.Labels)
+	dnsSettings, err := getDNSFromNative(n.Labels)
 	if err != nil {
 		return nil, fmt.Errorf("failed to Decode dns Settings: %v", err)
 	}
@@ -478,6 +479,12 @@ func ContainerFromNative(n *native.Container) (*Container, error) {
 	}
 	c.Config.Hostname = hostname
 
+	c.HostConfig.Devices = []string{}
+	if nedctlDeviceMapping := n.Labels[labels.DeviceMapping]; nedctlDeviceMapping != "" {
+		devices, _ := parseDeviceMapping(nedctlDeviceMapping)
+		c.HostConfig.Devices = devices
+	}
+
 	return c, nil
 }
 
@@ -725,10 +732,10 @@ func getMemorySettingsFromNative(sp *specs.Spec) (*MemorySetting, error) {
 	return res, nil
 }
 
-func getDnsFromNative(Labels map[string]string) (*DNSSettings, error) {
+func getDNSFromNative(Labels map[string]string) (*DNSSettings, error) {
 	res := &DNSSettings{}
 
-	if dnsServers := Labels[labels.DnsServer]; dnsServers != "" {
+	if dnsServers := Labels[labels.DNSServer]; dnsServers != "" {
 		if err := json.Unmarshal([]byte(dnsServers), &res.DNSServers); err != nil {
 			return nil, fmt.Errorf("failed to parse DNS servers: %v", err)
 		}
@@ -771,7 +778,7 @@ func getUtsModeFromNative(sp *specs.Spec) (string, error) {
 func getShmSizeFromNative(sp *specs.Spec) (int64, error) {
 	var res int64
 
-	if sp.Mounts != nil && len(sp.Mounts) > 0 {
+	if len(sp.Mounts) > 0 {
 		for _, mount := range sp.Mounts {
 			if mount.Destination == "/dev/shm" {
 				for _, option := range mount.Options {
@@ -798,6 +805,15 @@ func getSysctlFromNative(sp *specs.Spec) (map[string]string, error) {
 	return res, nil
 }
 
+func parseDeviceMapping(deviceMappingJSON string) ([]string, error) {
+	var devices []string
+	err := json.Unmarshal([]byte(deviceMappingJSON), &devices)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse device mapping: %v", err)
+	}
+	return devices, nil
+}
+
 type IPAMConfig struct {
 	Subnet  string `json:"Subnet,omitempty"`
 	Gateway string `json:"Gateway,omitempty"`

pkg/inspecttypes/dockercompat/dockercompat_test.go

@@ -78,13 +78,12 @@ func TestContainerFromNative(t *testing.T) {
 				HostConfig: &HostConfig{
 					PortBindings: nat.PortMap{},
 					GroupAdd:     []string{},
-					LogConfig: LogConfig{
-						Config: loggerLogConfig{
-							Driver: "json-file",
-							Opts:   map[string]string{},
-						},
+					LogConfig: loggerLogConfig{
+						Driver: "json-file",
+						Opts:   map[string]string{},
 					},
 					UTSMode: "host",
+					Devices: []string{},
 				},
 				Mounts: []MountPoint{
 					{
@@ -164,13 +163,12 @@ func TestContainerFromNative(t *testing.T) {
 				HostConfig: &HostConfig{
 					PortBindings: nat.PortMap{},
 					GroupAdd:     []string{},
-					LogConfig: LogConfig{
-						Config: loggerLogConfig{
-							Driver: "json-file",
-							Opts:   map[string]string{},
-						},
+					LogConfig: loggerLogConfig{
+						Driver: "json-file",
+						Opts:   map[string]string{},
 					},
 					UTSMode: "host",
+					Devices: []string{},
 				},
 				Mounts: []MountPoint{
 					{
@@ -247,13 +245,12 @@ func TestContainerFromNative(t *testing.T) {
 				HostConfig: &HostConfig{
 					PortBindings: nat.PortMap{},
 					GroupAdd:     []string{},
-					LogConfig: LogConfig{
-						Config: loggerLogConfig{
-							Driver: "json-file",
-							Opts:   map[string]string{},
-						},
+					LogConfig: loggerLogConfig{
+						Driver: "json-file",
+						Opts:   map[string]string{},
 					},
 					UTSMode: "host",
+					Devices: []string{},
 				},
 				Mounts: []MountPoint{
 					{

pkg/labels/labels.go

@@ -114,11 +114,14 @@ const (
 	CIdFile = Prefix + "cid-file"
 
 	// Custom DNS lookup servers.
-	DnsServer = Prefix + "dns"
+	DNSServer = Prefix + "dns"
 
 	// DNSResolvConfOptions set DNS options
 	DNSResolvConfOptions = Prefix + "dns-options"
 
 	// DNSSearchDomains set custom DNS search domains
 	DNSSearchDomains = Prefix + "dns-search"
+
+	//DeviceMapping specifies mapping host device to the container
+	DeviceMapping = Prefix + "devices"
 )