Struct oci_spec::runtime::SpecBuilder

source ·

pub struct SpecBuilder { /* private fields */ }

Expand description

Builder for Spec.

Implementations§

source §

impl SpecBuilder

source

pub fn version<VALUE: Into<String>>(self, value: VALUE) -> Self

MUST be in SemVer v2.0.0 format and specifies the version of the Open Container Initiative Runtime Specification with which the bundle complies. The Open Container Initiative Runtime Specification follows semantic versioning and retains forward and backward compatibility within major versions. For example, if a configuration is compliant with version 1.1 of this specification, it is compatible with all runtimes that support any 1.1 or later release of this specification, but is not compatible with a runtime that supports 1.0 and not 1.1.

source

pub fn root<VALUE: Into<Root>>(self, value: VALUE) -> Self

Specifies the container’s root filesystem. On Windows, for Windows Server Containers, this field is REQUIRED. For Hyper-V Containers, this field MUST NOT be set.

On all other platforms, this field is REQUIRED.

source

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

Specifies additional mounts beyond root. The runtime MUST mount entries in the listed order.

For Linux, the parameters are as documented in mount(2) system call man page. For Solaris, the mount entry corresponds to the ‘fs’ resource in the zonecfg(1M) man page.

source

pub fn process<VALUE: Into<Process>>(self, value: VALUE) -> Self

Specifies the container process. This property is REQUIRED when start is called.

source

pub fn hostname<VALUE: Into<String>>(self, value: VALUE) -> Self

Specifies the container’s hostname as seen by processes running inside the container. On Linux, for example, this will change the hostname in the container UTS namespace. Depending on your namespace configuration, the container UTS namespace may be the runtime UTS namespace.

source

pub fn domainname<VALUE: Into<String>>(self, value: VALUE) -> Self

Specifies the container’s domainame as seen by processes running inside the container. On Linux, for example, this will change the domainame in the container UTS namespace. Depending on your namespace configuration, the container UTS namespace may be the runtime UTS namespace.

source

pub fn hooks<VALUE: Into<Hooks>>(self, value: VALUE) -> Self

Hooks allow users to specify programs to run before or after various lifecycle events. Hooks MUST be called in the listed order. The state of the container MUST be passed to hooks over stdin so that they may do work appropriate to the current state of the container.

source

pub fn annotations<VALUE: Into<HashMap<String, String>>>( self, value: VALUE, ) -> Self

Annotations contains arbitrary metadata for the container. This information MAY be structured or unstructured. Annotations MUST be a key-value map. If there are no annotations then this property MAY either be absent or an empty map.

Keys MUST be strings. Keys MUST NOT be an empty string. Keys SHOULD be named using a reverse domain notation - e.g. com.example.myKey. Keys using the org.opencontainers namespace are reserved and MUST NOT be used by subsequent specifications. Runtimes MUST handle unknown annotation keys like any other unknown property.

Values MUST be strings. Values MAY be an empty string.

source