Skip to main content

edgeDevice

apiVersion: v0

import "github.com/edgenesis/shifu/pkg/k8s/crd"

EdgeDevice​

EdgeDevice is a custom resource created by Kubernetes CRD that represents a virtualized digital twin of a physical IoT device.

  • apiVersion: v1alpha1
  • kind: EdgeDevice
  • metadata
    Standard Kubernetes ObjectMeta.
  • spec (Spec)
    Describes the specification of an EdgeDevice.
  • status (EdgeDeviceStatus)
    Describes the observed status of the EdgeDevice.

EdgeDeviceSpec​

EdgeDeviceSpec is the description of an EdgeDevice.

Sku​

Hardware model of an EdgeDevice, e.g. Siemens S7-1200.

  • sku (string) required

Connection​

Indicates how the EdgeDevice connects to Shifu.

  • connection (Connection) required
    • Connection (string)
      Indicates the connection method, which has to be Ethernet (for now).

Address​

Connection address of the EdgeDevice, the format varies depending on the protocol.

  • address (string) required

Protocol​

Connection protocol of the EdgeDevice.

  • protocol (Protocol) required
    • Protocol (string)
      indicates the connection protocol, which has to be HTTP, HTTPCommandline, MQTT, OPCUA, Socket, PLC4X (deprecated, will be removed in v0.81.0) or LwM2M(for now).

ProtocolSettings​

Settings of EdgeDevice connection protocol.

  • protocolSettings (ProtocolSettings)

    • MQTTSetting (MQTTSetting)

      • MQTTTopic (string)
        subscription of MQTT topic, e.g. /test/test.

    • OPCUASetting (OPCUASetting)

      • OPCUAEndpoint (string)
        server address of OPC UA, e.g. opc.tcp://192.168.0.1:4840/test/server.
      • SecurityMode (string)
        message encryption mode of OPC UA, which has to be None (for now).
      • Username (string)
        connection authentication username of OPC UA, e.g. operator.
      • Password (string)
        connection authentication password of OPC UA, e.g. password.
      • ConnectionTimeoutInMilliseconds (int64)
        requested connection milliseconds for OPC UA, e.g. 1000.

    • SocketSetting (SocketSetting)

      • encoding (string)
        encoding of the socket connection, optionally utf-8 or hex, the default value is utf-8.
      • NetworkType (string)
        protocol of the socket link, which has to be tcp (for now).
      • bufferLength (int)
        buffer size of the socket when transferring data, the default value is 1024.

    • PLC4XSetting (PLC4XSetting) (deprecated, will be removed in v0.81.0)

      • protocol (Plc4xProtocol)
        protocol used by plc4x to connect to the device.

    • LwM2MSetting (LwM2MSetting)

      • endpointName (string)
        the unique identifier for the LwM2M client, e.g. leshan-client.
      • securityMode (string)
        the security mode setting for the LwM2M protocol, which can be one of the following:
        • None (for no security)
        • DTLS (for Datagram Transport Layer Security)
      • dtlsMode (string)
        the DTLS mode, applicable if securityMode is set to DTLS. Options include:
        • PSK (Pre-Shared Key)
      • cipherSuites (array of strings)
        the list of DTLS cipher suites, applicable when securityMode is DTLS. The following ciphersuites are currently supported:CipherSuites
      • pskIdentity (string)
        the identity for the pre-shared, applicable when dtlsMode is set to PSK. Example: hint.
      • pskKey (string)
        the key for the pre-shared key, applicable when dtlsMode is PSK. Example: ABC123.

CipherSuites(enum)​

TLS_ECDHE_ECDSA_WITH_AES_128_CCM     = "TLS_ECDHE_ECDSA_WITH_AES_128_CCM"
TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8   = "TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8"
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256   = "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384   = "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA  = "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA    = "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"
TLS_PSK_WITH_AES_128_CCM               = "TLS_PSK_WITH_AES_128_CCM"
TLS_PSK_WITH_AES_128_CCM_8             = "TLS_PSK_WITH_AES_128_CCM_8"
TLS_PSK_WITH_AES_256_CCM_8             = "TLS_PSK_WITH_AES_256_CCM_8"
TLS_PSK_WITH_AES_128_GCM_SHA256       = "TLS_PSK_WITH_AES_128_GCM_SHA256"
TLS_PSK_WITH_AES_128_CBC_SHA256        = "TLS_PSK_WITH_AES_128_CBC_SHA256"
TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256  = "TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256"

Plc4xProtocol(enum) (deprecated, will be removed in v0.81.0)​

Plc4xProtocolS7           = "s7"
Plc4xProtocolADS          = "ads"
Plc4xProtocolBACnet       = "bacnet"
Plc4xProtocolCBus         = "cbus"
Plc4xProtocolEip          = "eip"
Plc4xProtocolKnx          = "knx"
Plc4xProtocolModbusAscii  = "modbus-ascii"
Plc4xProtocolModbusRTU    = "modbus-rtu"
Plc4xProtocolModbusTcp    = "modbus-tcp"

GatewaySettings​

Settings of EdgeDevice Gateway.

  • gatewaySetting (GatewaySetting)
    • protocol (string)
      protocol used by the gateway, specified as LwM2M.
    • address (string)
      the server address, typically represented as a Fully Qualified Domain Name (FQDN) within the Kubernetes cluster, for example: deviceshifu-lwm2m-service.deviceshifu.svc.cluster.local:5683.
    • protocolSettings (ProtocolSettings)
      LwM2MSetting is supported currently. For detailed protocol configuration parameters, please refer to protocolSettings
      • LwM2MSetting (LwM2MSetting)
        • endpointName (string)
          the unique identifier for the LwM2M client, e.g. leshan-client.
        • securityMode (string)
          the security mode setting for the LwM2M protocol, which can be one of the following:
          • None (for no security)
          • DTLS (for Datagram Transport Layer Security)
        • dtlsMode (string)
          the DTLS mode, applicable if securityMode is set to DTLS. Options include:
          • PSK (Pre-Shared Key)
        • cipherSuites (array of strings)
          the list of DTLS cipher suites, applicable when securityMode is DTLS. The following ciphersuites are currently supported:CipherSuites
        • pskIdentity (string)
          the identity for the pre-shared, applicable when dtlsMode is set to PSK. Example: hint.
        • pskKey (string)
          the key for the pre-shared key, applicable when dtlsMode is PSK. Example: ABC123.

CustomMetadata​

Additional information about the EdgeDevice.

  • customMetadata (string: string)
    additional information, e.g. ChargingTime: 9h.

EdgeDeviceStatus​

Current status information

EdgeDevicePhase (will automatically update based on device telemetry)​

Current state of EdgeDevice.

  • edgedevicephase (EdgeDevicePhase)
    • EdgeDevicePhase (string)
      State of EdgeDevice, has to be Pending, Running, Failed or Unknown.