Skip to main content

OciConfig

Struct OciConfig 

Source
pub struct OciConfig {
    pub oci_version: String,
    pub root: OciRoot,
    pub process: OciProcess,
    pub hostname: Option<String>,
    pub mounts: Vec<OciMount>,
    pub linux: Option<OciLinux>,
    pub hooks: Option<OciHooks>,
    pub annotations: HashMap<String, String>,
}
Expand description

OCI Runtime Specification configuration

This implements a subset of the OCI runtime spec for gVisor compatibility Spec: https://github.com/opencontainers/runtime-spec/blob/main/config.md

Fields§

§oci_version: String§root: OciRoot§process: OciProcess§hostname: Option<String>§mounts: Vec<OciMount>§linux: Option<OciLinux>§hooks: Option<OciHooks>§annotations: HashMap<String, String>

Implementations§

Source§

impl OciConfig

Source

pub fn new(command: Vec<String>, hostname: Option<String>) -> Self

Create a minimal OCI config for Nucleus containers

Source

pub fn with_resources(self, limits: &ResourceLimits) -> Self

Add resource limits to the config

Source

pub fn with_env(self, vars: &[(String, String)]) -> Self

Add environment variables to the OCI process config.

Source

pub fn with_sd_notify(self) -> Self

Add sd_notify socket passthrough.

Source

pub fn with_secret_mounts(self, secrets: &[SecretMount]) -> Self

Add bind mounts for secrets.

Source

pub fn with_process_identity(self, identity: &ProcessIdentity) -> Self

Set the process identity for the OCI workload.

Source

pub fn with_inmemory_secret_mounts( self, stage_dir: &Path, secrets: &[SecretMount], ) -> Result<Self>

Add a read-only bind mount of an in-memory secret staging directory at /run/secrets, plus compatibility bind mounts for each staged secret to its requested container destination.

Source

pub fn with_volume_mounts(self, volumes: &[VolumeMount]) -> Result<Self>

Add bind or tmpfs volume mounts.

Source

pub fn with_context_bind(self, context_dir: &Path) -> Self

Bind mount the host context directory into the container.

The gVisor integration path expects /context to be writable so test workloads can write results back to the host.

Source

pub fn with_rootfs_binds(self, rootfs_path: &Path) -> Self

Add rootfs bind mounts from a pre-built rootfs path.

Source

pub fn with_namespace_config(self, config: &NamespaceConfig) -> Self

Replace the default namespace list with an explicit configuration.

Source

pub fn with_host_runtime_binds(self) -> Self

Add read-only bind mounts for host runtime paths.

This mirrors the native fallback path for non-production containers so common executables such as /bin/sh remain available inside the OCI rootfs when no explicit rootfs is configured.

Source

pub fn with_user_namespace(self) -> Self

Add user namespace configuration

Source

pub fn with_rootless_user_namespace(self, config: &UserNamespaceConfig) -> Self

Configure gVisor’s true rootless OCI path.

gVisor expects UID/GID mappings in the OCI spec for this mode, and its rootless OCI implementation does not currently support a network namespace entry in the spec. We still control networking through runsc’s top-level --network flag.

Source

pub fn with_hooks(self, hooks: OciHooks) -> Self

Set OCI lifecycle hooks on the config.

Source

pub fn with_rlimits(self, pids_max: Option<u64>) -> Self

Set process rlimits from the hardcoded Nucleus defaults.

Mirrors the RLIMIT backstops applied in-process for native containers (runtime.rs), expressed as OCI config so gVisor can enforce them.

Source

pub fn with_seccomp(self, seccomp: OciSeccomp) -> Self

Set the linux.seccomp section from an OCI seccomp config.

Source

pub fn with_cgroups_path(self, path: String) -> Self

Set the linux.cgroupsPath field.

Source

pub fn with_sysctl(self, sysctl: HashMap<String, String>) -> Self

Set sysctl key-value pairs on the linux config.

Source

pub fn with_annotations(self, annotations: HashMap<String, String>) -> Self

Set annotations on the OCI config.

Trait Implementations§

Source§

impl Clone for OciConfig

Source§

fn clone(&self) -> OciConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OciConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OciConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OciConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,