Skip to content

EnvItem

Contexts

Context Relationship Object Path Package File Path
Database.Shard.Dap.Instances.env Package -> Database -> Shard -> Dap -> Instances -> EnvItem $.databases[*].shards[*].daps.instances.*.env[*] {package-root}/databases/{db-name}/shards/{shard-name}.yaml
Database.Shard.Sequencer.env Package -> Database -> Shard -> Sequencer -> EnvItem $.databases[*].shards[*].sequencers.*.env[*] {package-root}/databases/{db-name}/shards/{shard-name}.yaml
Database.Shard.Sm.Dbm.env Package -> Database -> Shard -> Sm -> Dbm -> EnvItem $.databases[*].shards[*].sm.dbm.env[*] {package-root}/databases/{db-name}/shards/{shard-name}.yaml
Database.Shard.Sm.env Package -> Database -> Shard -> Sm -> EnvItem $.databases[*].shards[*].sm.env[*] {package-root}/databases/{db-name}/shards/{shard-name}.yaml
DeploymentConfig.env Package -> DeploymentConfig -> EnvItem $.deployment_config.env[*] {package-root}/deployment_config/deployment_config.yaml
Pipeline.env Package -> Pipeline -> EnvItem $.pipelines[*].env[*] {package-root}/pipelines/{pipeline-name}.yaml
Router.Agg.env Package -> Router -> Agg -> EnvItem $.router.agg.env[*] {package-root}/router/{router-name}.yaml
Router.Rc.env Package -> Router -> Rc -> EnvItem $.router.rc.env[*] {package-root}/router/{router-name}.yaml

Fields

Field Type Required Description Constraints Default
name string yes Name of the environment variable. May consist of any printable ASCII characters except '='. - -
value string | null no Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single \(, which allows for escaping the \((VAR_NAME) syntax: i.e. "\)\)(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". - null
valueFrom ValueFrom | null no Source for the environment variable's value. Cannot be used if value is not empty. - null

Used In

Back to top