Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 4.29 KB

ContainerNetworkConfig.md

File metadata and controls

32 lines (22 loc) · 4.29 KB

ContainerNetworkConfig

ContainerNetworkConfig contains information on a container's network configuration.

Properties

Name Type Description Notes
networks Map<String, PerNetworkOptions> Map of networks names or ids that the container should join. You can request additional settings for each network, you can set network aliases, static ips, static mac address and the network interface name for this container on the specific network. If the map is empty and the bridge network mode is set the container will be joined to the default network. Optional. [optional]
baseHostsFile String BaseHostsFile is the base file to create the `/etc/hosts` file inside the container. This must either be an absolute path to a file on the host system, or one of the special flags `image` or `none`. If it is empty it defaults to the base_hosts_file configuration in containers.conf. Optional. [optional]
cniNetworks List<String> CNINetworks is a list of CNI networks to join the container to. If this list is empty, the default CNI network will be joined instead. If at least one entry is present, we will not join the default network (unless it is part of this list). Only available if NetNS is set to bridge. Optional. Deprecated: as of podman 4.0 use &quot;Networks&quot; instead. [optional]
dnsOption List<String> DNSOptions is a set of DNS options that will be used in the container's resolv.conf, replacing the host's DNS options which are used by default. Conflicts with UseImageResolvConf. Optional. [optional]
dnsSearch List<String> DNSSearch is a set of DNS search domains that will be used in the container's resolv.conf, replacing the host's DNS search domains which are used by default. Conflicts with UseImageResolvConf. Optional. [optional]
dnsServer List<String> DNSServers is a set of DNS servers that will be used in the container's resolv.conf, replacing the host's DNS Servers which are used by default. Conflicts with UseImageResolvConf. Optional. [optional]
expose Object Expose is a number of ports that will be forwarded to the container if PublishExposedPorts is set. Expose is a map of uint16 (port number) to a string representing protocol i.e map[uint16]string. Allowed protocols are &quot;tcp&quot;, &quot;udp&quot;, and &quot;sctp&quot;, or some combination of the three separated by commas. If protocol is set to &quot;&quot; we will assume TCP. Only available if NetNS is set to Bridge or Slirp, and PublishExposedPorts is set. Optional. [optional]
hostadd List<String> HostAdd is a set of hosts which will be added to the container's etc/hosts file. Conflicts with UseImageHosts. Optional. [optional]
netns Namespace [optional]
networkOptions Map<String, List<String>> NetworkOptions are additional options for each network Optional. [optional]
portmappings List<PortMapping> PortBindings is a set of ports to map into the container. Only available if NetNS is set to bridge, slirp, or pasta. Optional. [optional]
publishImagePorts Boolean PublishExposedPorts will publish ports specified in the image to random unused ports (guaranteed to be above 1024) on the host. This is based on ports set in Expose below, and any ports specified by the Image (if one is given). Only available if NetNS is set to Bridge or Slirp. Optional. [optional]
useImageHostname Boolean UseImageHostname indicates that /etc/hostname should not be managed by Podman, and instead sourced from the image. Optional. [optional]
useImageHosts Boolean UseImageHosts indicates that /etc/hosts should not be managed by Podman, and instead sourced from the image. Conflicts with HostAdd. Optional. [optional]
useImageResolveConf Boolean UseImageResolvConf indicates that resolv.conf should not be managed by Podman, but instead sourced from the image. Conflicts with DNSServer, DNSSearch, DNSOption. Optional. [optional]

Implemented Interfaces

  • Serializable