Environment Variable Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/$defs/io.k8s.api.core.v1.EnvVar
EnvVar represents an environment variable present in a Container.
Imported from Kubernetes project
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/config.yaml* |
TYPE:
object
(Environment Variable)
PROPERTIES:
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
name | string |
Required | cannot be null | Welkin Apps Config |
value | string |
Optional | cannot be null | Welkin Apps Config |
valueFrom | object |
Optional | cannot be null | Welkin Apps Config |
name¶
Name of the environment variable.
Must be a C_IDENTIFIER.
name
-
is required
-
Type:
string
(Environment Variable Name) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
(Environment Variable Name)
value¶
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.
value
-
is optional
-
Type:
string
(Environment Variable Value) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string
(Environment Variable Value)
valueFrom¶
Environment Variable Source represents a source for the value of an Environment Variable.
Imported from Kubernetes project
valueFrom
-
is optional
-
Type:
object
(Environment Variable Source) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object
(Environment Variable Source)
Return to the root config schema
Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main