Skip to main content

CreateOptions

Struct CreateOptions 

Source
pub struct CreateOptions {
    pub packages: Option<Vec<String>>,
    pub envs: HashMap<String, String>,
    pub name: String,
    pub egress: Option<Vec<String>>,
    pub egress_policy: String,
    pub document: Option<Vec<u8>>,
    pub source: Option<GitSource>,
    pub start_timeout: Option<Duration>,
    pub client: Option<Client>,
    pub instance: String,
}
Expand description

Configures Sandbox::create. The default is a sandbox with DEFAULT_PACKAGES and open egress.

Fields§

§packages: Option<Vec<String>>

Packages installed in the sandbox (Chainguard package names). None means DEFAULT_PACKAGES; Some(vec![]) means none beyond the base system. They are resolved when the sandbox is created; an unknown package fails create.

§envs: HashMap<String, String>

Environment variables for every command (per-command ones override them). They are kept client-side, in this Sandbox value.

§name: String

Labels the sandbox. Its display name becomes <name>/<word-word>. Defaults to “sandbox”.

§egress: Option<Vec<String>>

The outbound allowlist (hostnames; “*” allows all). None means ["*"]. The platform always blocks cloud metadata, loopback and private ranges.

§egress_policy: String

What happens to a connection outside egress: “deny” (refuse it; the default) or “destroy” (tear the sandbox down).

§document: Option<Vec<u8>>

Replaces the generated environment document entirely (a .chainguard/ci.yaml-style document). packages, egress and egress_policy are then ignored.

§source: Option<GitSource>

Starts from a GitHub repository instead of an empty tree.

§start_timeout: Option<Duration>

Bounds waiting for the guest to start (default 3 minutes).

§client: Option<Client>

The Workspaces client to use. None creates one with the default login and the organization from instance.

§instance: String

The organization ID (used when client is None). If empty, $CHAINCTL_SANDBOX_INSTANCE is used; if that’s empty too, the organization is auto-detected when you belong to exactly one (turn off with $CHAINGUARD_SANDBOX_NO_DETECT_INSTANCE=1). List IDs with list_organizations, chainguard-sandbox orgs or chainctl iam organizations list.

Trait Implementations§

Source§

impl Clone for CreateOptions

Source§

fn clone(&self) -> CreateOptions

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 CreateOptions

Source§

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

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

impl Default for CreateOptions

Source§

fn default() -> CreateOptions

Returns the “default value” for a type. 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.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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