Skip to main content

ContainerBuilder

Struct ContainerBuilder 

Source
pub struct ContainerBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> ContainerBuilder<S>

Source

pub fn build(self) -> Container
where S: IsComplete,

Finish building and return the requested object

Source

pub fn tunnel(self, value: ContainerTunnel) -> ContainerBuilder<SetTunnel<S>>
where S::Tunnel: IsUnset,

Optional (Some / Option setters). Makes one HTTP port reachable from the control plane through the manager’s tunnel, over the operator’s outbound connection. Nothing is exposed on the deployment’s network.

Source

pub fn maybe_tunnel( self, value: Option<ContainerTunnel>, ) -> ContainerBuilder<SetTunnel<S>>
where S::Tunnel: IsUnset,

Optional (Some / Option setters). Makes one HTTP port reachable from the control plane through the manager’s tunnel, over the operator’s outbound connection. Nothing is exposed on the deployment’s network.

Source

pub fn kubernetes_liveness_probe( self, value: KubernetesHttpProbe, ) -> ContainerBuilder<SetKubernetesLivenessProbe<S>>
where S::KubernetesLivenessProbe: IsUnset,

Optional (Some / Option setters). Kubernetes liveness probe. Restarts an unhealthy container.

Source

pub fn maybe_kubernetes_liveness_probe( self, value: Option<KubernetesHttpProbe>, ) -> ContainerBuilder<SetKubernetesLivenessProbe<S>>
where S::KubernetesLivenessProbe: IsUnset,

Optional (Some / Option setters). Kubernetes liveness probe. Restarts an unhealthy container.

Source

pub fn kubernetes_readiness_probe( self, value: KubernetesHttpProbe, ) -> ContainerBuilder<SetKubernetesReadinessProbe<S>>
where S::KubernetesReadinessProbe: IsUnset,

Optional (Some / Option setters). Kubernetes readiness probe. Removes an unready pod from Service endpoints.

Source

pub fn maybe_kubernetes_readiness_probe( self, value: Option<KubernetesHttpProbe>, ) -> ContainerBuilder<SetKubernetesReadinessProbe<S>>
where S::KubernetesReadinessProbe: IsUnset,

Optional (Some / Option setters). Kubernetes readiness probe. Removes an unready pod from Service endpoints.

Source

pub fn security( self, value: ContainerSecurity, ) -> ContainerBuilder<SetSecurity<S>>
where S::Security: IsUnset,

Optional (Some / Option setters). Security settings shared by supported container runtimes.

Source

pub fn maybe_security( self, value: Option<ContainerSecurity>, ) -> ContainerBuilder<SetSecurity<S>>
where S::Security: IsUnset,

Optional (Some / Option setters). Security settings shared by supported container runtimes.

Source

pub fn cluster(self, value: String) -> ContainerBuilder<SetCluster<S>>
where S::Cluster: IsUnset,

Optional (Some / Option setters). ComputeCluster resource ID that this container runs on. If None, will be auto-assigned by ComputeClusterMutation at deployment time.

Source

pub fn maybe_cluster( self, value: Option<String>, ) -> ContainerBuilder<SetCluster<S>>
where S::Cluster: IsUnset,

Optional (Some / Option setters). ComputeCluster resource ID that this container runs on. If None, will be auto-assigned by ComputeClusterMutation at deployment time.

Source

pub fn code(self, value: ContainerCode) -> ContainerBuilder<SetCode<S>>
where S::Code: IsUnset,

Required.

Container code (image or source)

Source

pub fn cpu(self, value: ResourceSpec) -> ContainerBuilder<SetCpu<S>>
where S::Cpu: IsUnset,

Required.

CPU resource requirements

Source

pub fn memory(self, value: ResourceSpec) -> ContainerBuilder<SetMemory<S>>
where S::Memory: IsUnset,

Required.

Memory resource requirements (must use Ki/Mi/Gi/Ti suffix)

Source

pub fn gpu(self, value: ContainerGpuSpec) -> ContainerBuilder<SetGpu<S>>
where S::Gpu: IsUnset,

Optional (Some / Option setters). GPU requirements (optional)

Source

pub fn maybe_gpu( self, value: Option<ContainerGpuSpec>, ) -> ContainerBuilder<SetGpu<S>>
where S::Gpu: IsUnset,

Optional (Some / Option setters). GPU requirements (optional)

Source

pub fn ephemeral_storage( self, value: String, ) -> ContainerBuilder<SetEphemeralStorage<S>>
where S::EphemeralStorage: IsUnset,

Optional (Some / Option setters). Ephemeral storage requirement (e.g., “10Gi”)

Source

pub fn maybe_ephemeral_storage( self, value: Option<String>, ) -> ContainerBuilder<SetEphemeralStorage<S>>
where S::EphemeralStorage: IsUnset,

Optional (Some / Option setters). Ephemeral storage requirement (e.g., “10Gi”)

Source

pub fn persistent_storage( self, value: PersistentStorage, ) -> ContainerBuilder<SetPersistentStorage<S>>
where S::PersistentStorage: IsUnset,

Optional (Some / Option setters). Persistent storage configuration (only for stateful containers)

Source

pub fn maybe_persistent_storage( self, value: Option<PersistentStorage>, ) -> ContainerBuilder<SetPersistentStorage<S>>
where S::PersistentStorage: IsUnset,

Optional (Some / Option setters). Persistent storage configuration (only for stateful containers)

Source

pub fn replicas(self, value: u32) -> ContainerBuilder<SetReplicas<S>>
where S::Replicas: IsUnset,

Optional (Some / Option setters). Fixed replica count (for stateful containers or stateless without autoscaling)

Source

pub fn maybe_replicas( self, value: Option<u32>, ) -> ContainerBuilder<SetReplicas<S>>
where S::Replicas: IsUnset,

Optional (Some / Option setters). Fixed replica count (for stateful containers or stateless without autoscaling)

Source

pub fn autoscaling( self, value: ContainerAutoscaling, ) -> ContainerBuilder<SetAutoscaling<S>>
where S::Autoscaling: IsUnset,

Optional (Some / Option setters). Autoscaling configuration (only for stateless containers)

Source

pub fn maybe_autoscaling( self, value: Option<ContainerAutoscaling>, ) -> ContainerBuilder<SetAutoscaling<S>>
where S::Autoscaling: IsUnset,

Optional (Some / Option setters). Autoscaling configuration (only for stateless containers)

Source

pub fn stateful(self, value: bool) -> ContainerBuilder<SetStateful<S>>
where S::Stateful: IsUnset,

Optional (Some / Option setters). Default: false.

Whether container is stateful (gets stable ordinals, optional persistent volumes)

Source

pub fn maybe_stateful( self, value: Option<bool>, ) -> ContainerBuilder<SetStateful<S>>
where S::Stateful: IsUnset,

Optional (Some / Option setters). Default: false.

Whether container is stateful (gets stable ordinals, optional persistent volumes)

Source

pub fn environment( self, value: HashMap<String, String>, ) -> ContainerBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

Environment variables

Source

pub fn maybe_environment( self, value: Option<HashMap<String, String>>, ) -> ContainerBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

Environment variables

Source

pub fn pool(self, value: String) -> ContainerBuilder<SetPool<S>>
where S::Pool: IsUnset,

Optional (Some / Option setters). Capacity group to run on (must exist in the cluster) If not specified, containers are scheduled to any available group.

Source

pub fn maybe_pool(self, value: Option<String>) -> ContainerBuilder<SetPool<S>>
where S::Pool: IsUnset,

Optional (Some / Option setters). Capacity group to run on (must exist in the cluster) If not specified, containers are scheduled to any available group.

Source

pub fn permissions(self, value: String) -> ContainerBuilder<SetPermissions<S>>
where S::Permissions: IsUnset,

Required.

Permission profile name

Source

pub fn health_check( self, value: HealthCheck, ) -> ContainerBuilder<SetHealthCheck<S>>
where S::HealthCheck: IsUnset,

Optional (Some / Option setters). Health check configuration

Source

pub fn maybe_health_check( self, value: Option<HealthCheck>, ) -> ContainerBuilder<SetHealthCheck<S>>
where S::HealthCheck: IsUnset,

Optional (Some / Option setters). Health check configuration

Source

pub fn command(self, value: Vec<String>) -> ContainerBuilder<SetCommand<S>>
where S::Command: IsUnset,

Optional (Some / Option setters). Command to override image default

Source

pub fn maybe_command( self, value: Option<Vec<String>>, ) -> ContainerBuilder<SetCommand<S>>
where S::Command: IsUnset,

Optional (Some / Option setters). Command to override image default

Source

pub fn commands_enabled( self, value: bool, ) -> ContainerBuilder<SetCommandsEnabled<S>>
where S::CommandsEnabled: IsUnset,

Optional (Some / Option setters). Default: default_commands_enabled().

Whether the container can receive remote commands via the Commands protocol. When enabled, an app-owned command receiver can lease pending commands for this Container and execute registered handlers.

Source

pub fn maybe_commands_enabled( self, value: Option<bool>, ) -> ContainerBuilder<SetCommandsEnabled<S>>
where S::CommandsEnabled: IsUnset,

Optional (Some / Option setters). Default: default_commands_enabled().

Whether the container can receive remote commands via the Commands protocol. When enabled, an app-owned command receiver can lease pending commands for this Container and execute registered handlers.

Source

pub fn stop_grace_period_seconds( self, value: u32, ) -> ContainerBuilder<SetStopGracePeriodSeconds<S>>
where S::StopGracePeriodSeconds: IsUnset,

Optional (Some / Option setters). Grace period in seconds for stopping replicas during updates, drains, and deletes.

When omitted, the runtime backend applies its default. Valid values are 1 second through 24 hours.

Source

pub fn maybe_stop_grace_period_seconds( self, value: Option<u32>, ) -> ContainerBuilder<SetStopGracePeriodSeconds<S>>
where S::StopGracePeriodSeconds: IsUnset,

Optional (Some / Option setters). Grace period in seconds for stopping replicas during updates, drains, and deletes.

When omitted, the runtime backend applies its default. Valid values are 1 second through 24 hours.

Source§

impl<S: State> ContainerBuilder<S>

Links the container to another resource with specified permissions.

Source

pub fn port(self, port: u16) -> Self

Adds an internal-only port to the container.

Source

pub fn kubernetes_secret_mount(self, mount: KubernetesSecretMount) -> Self

Mounts an existing Kubernetes Secret without copying its value into the stack.

Source

pub fn public_endpoint(self, endpoint: PublicEndpoint) -> Self

Exposes a named public endpoint.

Auto Trait Implementations§

§

impl<S> Freeze for ContainerBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<Container>)>: Freeze,

§

impl<S> RefUnwindSafe for ContainerBuilder<S>

§

impl<S> Send for ContainerBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<Container>)>: Send,

§

impl<S> Sync for ContainerBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<Container>)>: Sync,

§

impl<S> Unpin for ContainerBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<Container>)>: Unpin,

§

impl<S> UnsafeUnpin for ContainerBuilder<S>

§

impl<S> UnwindSafe for ContainerBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<Container>)>: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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