envVar

EnvVar represents an environment variable present in a Container.

Constuctors

• fromFieldPath

  fromFieldPath(name='', fieldPath='')
  

  ---

• fromSecretRef

  fromSecretRef(name='', secretRefName='', secretRefKey='')
  

  ---

• new

  new(name='', value='')
  

  ---

Functions

• withName

  withName(name)
  

  Name of the environment variable. Must be a C_IDENTIFIER.

  ---

• withValue

  withValue(value)
  

  Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

  ---

Mixins

• valueFrom

  Source for the environment variable's value. Cannot be used if value is not empty.

  ---

  Functions

  • mixinInstance

    mixinInstance(valueFrom)
    

    ---

  Mixins

  • configMapKeyRef

    Selects a key of a ConfigMap.

    ---

    Functions

    • mixinInstance

      mixinInstance(configMapKeyRef)
      

      ---

    • withKey

      withKey(key)
      

      The key to select.

      ---

    • withName

      withName(name)
      

      Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

      ---

    • withOptional

      withOptional(optional)
      

      Specify whether the ConfigMap or its key must be defined

      ---

  • fieldRef

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.

    ---

    Functions

    • mixinInstance

      mixinInstance(fieldRef)
      

      ---

    • withFieldPath

      withFieldPath(fieldPath)
      

      Path of the field to select in the specified API version.

      ---

  • resourceFieldRef

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

    ---

    Functions

    • mixinInstance

      mixinInstance(resourceFieldRef)
      

      ---

    • withContainerName

      withContainerName(containerName)
      

      Container name: required for volumes, optional for env vars

      ---

    • withResource

      withResource(resource)
      

      Required: resource to select

      ---

    Mixins

    • divisor

      Specifies the output format of the exposed resources, defaults to "1"

      ---

      Functions

      • mixinInstance

        mixinInstance(divisor)
        

        ---

  • secretKeyRef

    Selects a key of a secret in the pod's namespace

    ---

    Functions

    • mixinInstance

      mixinInstance(secretKeyRef)
      

      ---

    • withKey

      withKey(key)
      

      The key of the secret to select from. Must be a valid secret key.

      ---

    • withName

      withName(name)
      

      Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

      ---

    • withOptional

      withOptional(optional)
      

      Specify whether the Secret or its key must be defined

      ---