Skip to main content

AppSpec

Struct AppSpec 

Source
pub struct AppSpec {
Show 19 fields pub name: String, pub project: String, pub environment: String, pub source: Source, pub build: Option<BuildSettings>, pub env: EnvFile, pub domains: Vec<Map<String, Value>>, pub volumes: Vec<String>, pub ports: Vec<String>, pub replicas: u32, pub port: Option<u16>, pub healthcheck: Option<Value>, pub resources: Option<Resources>, pub command: Option<Value>, pub previews: Option<PreviewSettings>, pub files: Vec<AppFile>, pub user: Option<String>, pub working_dir: Option<String>, pub secret_on_change: Option<OnChange>,
}
Expand description

What a user sets on an app.

Fields§

§name: String§project: String§environment: String§source: Source§build: Option<BuildSettings>§env: EnvFile

.env text, or a {KEY: value | {secret: NAME}} map.

§domains: Vec<Map<String, Value>>

The ingress’ domains: list ({host, path?, port?, https?, redirect?}), passed to the rendered service as is. port defaults to the app’s port.

§volumes: Vec<String>

Named volumes, NAME:/path[:ro]. Each is the app’s own (<stack>_<app>_<name>), shared by its replicas. Host paths are not allowed.

§ports: Vec<String>

Published host ports, compose syntax (127.0.0.1:8080:80), load-balanced over healthy replicas.

§replicas: u32§port: Option<u16>

The port the app listens on inside its instances.

§healthcheck: Option<Value>

A compose healthcheck.

§resources: Option<Resources>§command: Option<Value>

A compose command: argv, or a line split like a shell would.

§previews: Option<PreviewSettings>

Preview deployments per pull request (git sources).

§files: Vec<AppFile>

Files in the app’s instances, each an org secret’s value (config files, certificates). Delivered like a stack’s file secrets.

§user: Option<String>

The user the app runs as; numeric (uid[:gid]) on an OCI image.

§working_dir: Option<String>§secret_on_change: Option<OnChange>

What a new version of a secret the app uses (in env or files) does to its replicas: roll (default), restart in place, or none (files updated, replicas stale until they next start).

Implementations§

Source§

impl AppSpec

Source

pub fn stack(&self) -> Result<String>

Source

pub fn validate(&self) -> Result<()>

Check everything that does not need the host.

Source

pub fn webhook_secret(&self) -> String

The webhook secret’s name in the org’s store.

Trait Implementations§

Source§

impl Clone for AppSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppSpec

Source§

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

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

impl<'de> Deserialize<'de> for AppSpec

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 PartialEq for AppSpec

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for AppSpec

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
Source§

impl StructuralPartialEq for AppSpec

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> 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 = !

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