FileKeyRef¶

Contexts¶

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

Fields¶

Field	Type	Required	Description	Constraints	Default
`key`	`string`	yes	The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.	-	-
`path`	`string`	yes	The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.	-	-
`volumeName`	`string`	yes	The name of the volume mount containing the env file.	-	-
`optional`	`boolean` \| `null`	no	Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation.	-	`false`

Links To¶

No linked schemas.

Used In¶

ValueFrom via fileKeyRef