⚠️ Deprecation notice

This preview integration of IoT Edge 1.x and Kubernetes will not be made generally available, and is no longer supported. The recommended way to run IoT Edge 1.x on Kubernetes is noted in the product's official docs

Edge agent can be configured with various environment variables as described below

Variable NameValue
portMappingServiceType
  • clusterIP to expose the service on a cluster Internal IP
  • NodePort to expose the service on each Node's IP at a static port
  • LoadBalancer to expose the service externally using a cloud provider's load balancer
    backupConfigFilePath
      Path of the location for the backup configuration file
    enableK8sServiceCallTracing
    • true to enable the logging for K8s service API
    • false to enable the logging for K8s service API
    runtimeLogLevel
    • debug
    • info
    • warn
    • error
    upstreamProtocol
    • Amqp for AMQP protocol
    • AmqpWs for the fallback sceanrio
    runAsNonRoot
    • true starts all modules as a non-root user (uid 1000)
    • false starts all module per user specfied in Dockerfile (docker defaults to root if no user is specified in Dockerfile)
      enableK8sExtensions
      • true to enable the module's create options with K8s primitives
      • false to disable the module's create options with K8s primitives
      enableExperimentalFeatures
      • true to enable the experimental features
      • false to disable the experimental features
      storageClassName
        Specify the storage class name if you wish the volumes that backs persistent storage in modules to use dynamically provisioned PVCs.

        When the edgeAgent is started with this option, any module that specifies a docker mount of type volume will be backed by a dynamically created PVC.
      persistentVolumeName
        Specify the persistent volume name if you wish the volume that backs up the persistent storage in modules to use that PV
      persistentVolumeClaimDefaultSizeInMb
        Specify the persistent volume claim size in Mb when creating PVCs