Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New global option interface_name in containers.conf #1814

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/containers.conf.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,13 @@ Path to the container-init binary, which forwards signals and reaps processes
within containers. Note that the container-init binary will only be used when
the `--init` for podman-create and podman-run is set.

**interface_name**=""

Default way to set interface names inside containers. Defaults to legacy pattern
of ethX, where X is an integer, when left undefined.
Options are:
`device` Uses the network_interface name from the network config as interface name. Falls back to the ethX pattern if the network_interface is not set.

**ipcns**="shareable"

Default way to to create a IPC namespace for the container.
Expand Down
11 changes: 11 additions & 0 deletions pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,13 @@ type ContainersConfig struct {
// Deprecated: Do not use this field directly use conf.FindInitBinary() instead.
InitPath string `toml:"init_path,omitempty"`

// InterfaceName tells container runtimes how to set interface names
// inside containers.
// The only valid value at the moment is "device" that indicates the
// interface name should be set as the network_interface name from
// the network config.
InterfaceName string `toml:"interface_name,omitempty"`

// IPCNS way to create a ipc namespace for the container
IPCNS string `toml:"ipcns,omitempty"`

Expand Down Expand Up @@ -814,6 +821,10 @@ func (c *ContainersConfig) Validate() error {
return err
}

if err := c.validateInterfaceName(); err != nil {
return err
}

if err := c.validateTZ(); err != nil {
return err
}
Expand Down
8 changes: 8 additions & 0 deletions pkg/config/config_local.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ func (c *ContainersConfig) validateDevices() error {
return nil
}

func (c *ContainersConfig) validateInterfaceName() error {
if c.InterfaceName == "device" || c.InterfaceName == "" {
return nil
}

return fmt.Errorf("invalid interface_name option %s", c.InterfaceName)
}

func (c *ContainersConfig) validateUlimits() error {
for _, u := range c.DefaultUlimits.Get() {
ul, err := units.ParseUlimit(u)
Expand Down
45 changes: 45 additions & 0 deletions pkg/config/config_local_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,51 @@ var _ = Describe("Config Local", func() {
gomega.Expect(err).NotTo(gomega.BeNil())
})

It("should fail on invalid interface_name", func() {
defConf, err := defaultConfig()
gomega.Expect(err).To(gomega.BeNil())
gomega.Expect(defConf).NotTo(gomega.BeNil())

// Given
defConf.Containers.InterfaceName = "random"

// When
err = defConf.Containers.Validate()

// Then
gomega.Expect(err).NotTo(gomega.BeNil())
})

It("should succeed on good interface_name", func() {
defConf, err := defaultConfig()
gomega.Expect(err).To(gomega.BeNil())
gomega.Expect(defConf).NotTo(gomega.BeNil())

// Given
defConf.Containers.InterfaceName = "device"

// When
err = defConf.Containers.Validate()

// Then
gomega.Expect(err).To(gomega.BeNil())
})

It("should succeed on default interface_name", func() {
defConf, err := defaultConfig()
gomega.Expect(err).To(gomega.BeNil())
gomega.Expect(defConf).NotTo(gomega.BeNil())

// Given
defConf.Containers.InterfaceName = ""

// When
err = defConf.Containers.Validate()

// Then
gomega.Expect(err).To(gomega.BeNil())
})

It("should fail on bad timezone", func() {
defConf, err := defaultConfig()
gomega.Expect(err).To(gomega.BeNil())
Expand Down
4 changes: 4 additions & 0 deletions pkg/config/config_remote.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ func (c *ContainersConfig) validateDevices() error {
return nil
}

func (c *ContainersConfig) validateInterfaceName() error {
return nil
}

func (c *ContainersConfig) validateUlimits() error {
return nil
}
Expand Down
1 change: 1 addition & 0 deletions pkg/config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ var _ = Describe("Config", func() {
gomega.Expect(err).To(gomega.BeNil())
gomega.Expect(defaultConfig.Containers.ApparmorProfile).To(gomega.Equal(apparmor.Profile))
gomega.Expect(defaultConfig.Containers.BaseHostsFile).To(gomega.Equal(""))
gomega.Expect(defaultConfig.Containers.InterfaceName).To(gomega.Equal(""))
gomega.Expect(defaultConfig.Containers.PidsLimit).To(gomega.BeEquivalentTo(2048))
gomega.Expect(defaultConfig.Containers.Privileged).To(gomega.BeFalse())
gomega.Expect(defaultConfig.Containers.ReadOnly).To(gomega.BeFalse())
Expand Down
7 changes: 7 additions & 0 deletions pkg/config/containers.conf
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,13 @@ default_sysctls = [
#
#ipcns = "shareable"

# Default way to set an interface name inside container. Defaults to legacy
# pattern of ethX, where X is a integer, when left undefined.
# Options are:
# "device" Uses the network_interface name from the network config as interface name.
# Falls back to the ethX pattern if the network_interface is not set.
#interface_name = ""

# keyring tells the container engine whether to create
# a kernel keyring for use within the container.
#
Expand Down
3 changes: 3 additions & 0 deletions pkg/config/testdata/containers_comment.conf
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@
# Run an init inside the container that forwards signals and reaps processes.
# init = false

# Pattern of interface name inside container.
# interface_name = ""


# The network table containers settings pertaining to the management of
# CNI plugins.
Expand Down
3 changes: 3 additions & 0 deletions pkg/config/testdata/containers_default.conf
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ env = [
# Run an init inside the container that forwards signals and reaps processes.
init = false

# Set interface name inside container in legacy way, ethX.
interface_name = ""

host_containers_internal_ip = "1.2.3.4"

# proxy environment variables are passed into the container
Expand Down