Struct HostConfigBuilder

pub struct HostConfigBuilder { /* private fields */ }

Builder for HostConfig.

Implementations

impl HostConfigBuilder

pub fn binds<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of volume bindings for this container.

pub fn container_id_file<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

File (path) where the containerId is written.

pub fn log_config<VALUE: Into<Option<LogConfig>>>( &mut self, value: VALUE, ) -> &mut Self

Configuration of the logs for this container.

pub fn network_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Network mode to use for the container.

pub fn port_bindings<VALUE: Into<Option<PortMap>>>( &mut self, value: VALUE, ) -> &mut Self

Port mapping between the exposed port (container) and the host.

pub fn restart_policy<VALUE: Into<Option<RestartPolicy>>>( &mut self, value: VALUE, ) -> &mut Self

Restart policy to be used for the container.

pub fn auto_remove<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Automatically remove container when it exits.

pub fn volume_driver<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Name of the volume driver used to mount volumes.

pub fn volumes_from<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of volumes to take from other container.

pub fn cap_add<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of kernel capabilities to add to the container.

pub fn cap_drop<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of kernel capabilities to remove from the container.

pub fn capabilities<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of kernel capabilities to be available for container (this overrides the default set).

pub fn cgroup_ns_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Cgroup namespace mode to use for the container.

pub fn dns<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of DNS server to lookup.

pub fn dns_options<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of DNSOption to look for.

pub fn dns_search<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of DNSSearch to look for.

pub fn extra_hosts<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of extra hosts.

pub fn group_add<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of additional groups that the container process will run as.

pub fn ipc_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

IPC namespace to use for the container.

pub fn cgroup<VALUE: Into<Option<String>>>(&mut self, value: VALUE) -> &mut Self

Cgroup to use for the container.

pub fn links<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of links (in the name:alias form).

pub fn oom_score_adj<VALUE: Into<Option<i32>>>( &mut self, value: VALUE, ) -> &mut Self

Container preference for OOM-killing.

pub fn pid_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

PID namespace to use for the container.

pub fn privileged<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Is the container in privileged mode.

pub fn publish_all_ports<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Should docker publish all exposed port for the container.

pub fn readonly_rootfs<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Is the container root filesystem in read-only.

pub fn security_opt<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of string values to customize labels for MLS systems, such as SELinux.

pub fn storage_opt<VALUE: Into<Option<HashMap<String, String>>>>( &mut self, value: VALUE, ) -> &mut Self

Storage driver options per container.

pub fn tmpfs<VALUE: Into<Option<HashMap<String, String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of tmpfs (mounts) used for the container.

pub fn uts_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

UTS namespace to use for the container.

pub fn user_ns_mode<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

The user namespace to use for the container.

pub fn shm_size<VALUE: Into<Option<i64>>>(&mut self, value: VALUE) -> &mut Self

Total shm memory usage.

pub fn sysctls<VALUE: Into<Option<HashMap<String, String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of Namespaced sysctls used for the container.

pub fn runtime<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Runtime to use with this container.

pub fn console_size<VALUE: Into<Option<[u32; 2]>>>( &mut self, value: VALUE, ) -> &mut Self

Initial console size (height,width).

pub fn isolation<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Isolation technology of the container (e.g. default, hyperv).

pub fn cpu_shares<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

CPU shares (relative weight vs. other containers).

pub fn memory<VALUE: Into<Option<i64>>>(&mut self, value: VALUE) -> &mut Self

Memory limit (in bytes).

pub fn nano_cpus<VALUE: Into<Option<i64>>>(&mut self, value: VALUE) -> &mut Self

CPU quota in units of 10^-9 CPUs.

pub fn cgroup_parent<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Parent cgroup.

pub fn blkio_weight<VALUE: Into<Option<u16>>>( &mut self, value: VALUE, ) -> &mut Self

Block IO weight (relative weight vs. other containers).

pub fn blkio_weight_device<VALUE: Into<Option<Vec<WeightDevice>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn blkio_device_read_bps<VALUE: Into<Option<Vec<ThrottleDevice>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn blkio_device_write_bps<VALUE: Into<Option<Vec<ThrottleDevice>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn blkio_device_read_iops<VALUE: Into<Option<Vec<ThrottleDevice>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn blkio_device_write_iops<VALUE: Into<Option<Vec<ThrottleDevice>>>>( &mut self, value: VALUE, ) -> &mut Self

pub fn cpu_period<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

CPU CFS (Completely Fair Scheduler) period.

pub fn cpu_quota<VALUE: Into<Option<i64>>>(&mut self, value: VALUE) -> &mut Self

CPU CFS (Completely Fair Scheduler) quota.

pub fn cpu_realtime_period<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

CPU real-time period.

pub fn cpu_realtime_runtime<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

CPU real-time runtime.

pub fn cpuset_cpus<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

CpusetCpus 0-2, 0,1.

pub fn cpuset_mems<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

CpusetMems 0-2, 0,1.

pub fn devices<VALUE: Into<Option<Vec<DeviceMapping>>>>( &mut self, value: VALUE, ) -> &mut Self

List of devices to map inside the container.

pub fn device_cgroup_rules<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of rule to be added to the device cgroup.

pub fn device_requests<VALUE: Into<Option<Vec<DeviceRequest>>>>( &mut self, value: VALUE, ) -> &mut Self

List of device requests for device drivers.

pub fn kernel_memory<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Kernel memory limit (in bytes).

pub fn kernel_memory_tcp<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Hard limit for kernel TCP buffer memory (in bytes).

pub fn memory_reservation<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Memory soft limit (in bytes).

pub fn memory_swap<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Total memory usage (memory + swap); set -1 to enable unlimited swap.

pub fn memory_swappiness<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Tuning container memory swappiness behaviour.

pub fn oom_kill_disable<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Whether to disable OOM Killer or not.

pub fn pids_limit<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Setting PIDs limit for a container; Set 0 or -1 for unlimited, or null to not change.

pub fn ulimits<VALUE: Into<Option<Vec<Ulimit>>>>( &mut self, value: VALUE, ) -> &mut Self

List of ulimits to be set in the container.

pub fn cpu_count<VALUE: Into<Option<i64>>>(&mut self, value: VALUE) -> &mut Self

CPU count.

pub fn cpu_percent<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

CPU percent.

pub fn io_maximum_iops<VALUE: Into<Option<u64>>>( &mut self, value: VALUE, ) -> &mut Self

Maximum IOps for the container system drive.

pub fn io_maximum_bandwidth<VALUE: Into<Option<u64>>>( &mut self, value: VALUE, ) -> &mut Self

Maximum IO in bytes per second for the container system drive.

pub fn mounts<VALUE: Into<Option<Vec<Mount>>>>( &mut self, value: VALUE, ) -> &mut Self

Mounts specs used by the container.

pub fn masked_paths<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

MaskedPaths is the list of paths to be masked inside the container (this overrides the default set of paths).

pub fn readonly_paths<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

ReadonlyPaths is the list of paths to be set as read-only inside the container (this overrides the default set of paths).

pub fn init<VALUE: Into<Option<bool>>>(&mut self, value: VALUE) -> &mut Self

Run a custom init inside the container, if null, use the daemon’s configured settings.

pub fn build(&self) -> Result<HostConfig, String>

Builds a new HostConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for HostConfigBuilder

fn clone(&self) -> HostConfigBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for HostConfigBuilder

fn default() -> HostConfigBuilder

Returns the “default value” for a type.