Struct shipcat_definitions::structs::EnvVars

pub struct EnvVars {
    pub plain: BTreeMap<String, String>,
    pub secrets: BTreeSet<String>,
}

Environment variables to inject

These have a few special convenience behaviours: “IN_VAULT” values is replaced with value from vault/secret/folder/service/KEY One off tera templates are calculated with a limited template context

IN_VAULT secrets will all be put in a single kubernetes Secret object. One off templates can be put in a Secret object if marked | as_secret.

env:
  # plain eva:
  PLAIN_EVAR: plaintextvalue

  # vault lookup:
  DATABASE_URL: IN_VAULT

  # templated evars:
  INTERNAL_AUTH_URL: "{{ base_urls.services }}/auth/internal"

The vault lookup will GET from the region specific path for vault, in the webapp subfolder, getting the DATABASE_URL secret.

The kong templating will use the secrets read from the Config for this region, and replace them internally.

The as_secret destinction only serves to put AUTH_SECRET into Manifest::secrets.

Fields

plain: BTreeMap<String, String>

Plain text (non-secret) environment variables

secrets: BTreeSet<String>

Environment variable names stored in secrets

This is an internal property that is exposed as an output only.

Implementations

impl EnvVars

pub fn new(env: BTreeMap<String, String>) -> Self

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

pub fn vault_secrets(&mut self) -> BTreeSet<String>

pub fn template_secrets(&mut self) -> BTreeMap<String, String>

impl EnvVars

pub fn template(&mut self, ctx: &Context) -> Result<()>

Trait Implementations

impl Clone for EnvVars

fn clone(&self) -> EnvVars

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvVars

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

Formats the value using the given formatter.

impl Default for EnvVars

fn default() -> EnvVars

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnvVars where
    EnvVars: Default, 

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

Deserialize this value from the given Serde deserializer.

impl Serialize for EnvVars

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

Serialize this value into the given Serde serializer.