Admin Guide on Eclipse Hono™ Vers.: 2.7

Common Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Many Hono components support a common set of configuration options. This section describes those options.

Auth Server Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The Auth Server component exposes a service endpoint implementing Eclipse Hono™’s Authentication API. Other services use this component for authenticating clients and retrieving a JSON Web Token (JWT) asserting the client’s identity and corresponding authorities.

MongoDB Based Device Registry Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The MongoDB based Device Registry component provides an implementation of Eclipse Hono™’s Device Registration, Credentials and Tenant APIs. Protocol adapters use these APIs to determine a device’s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. In addition to the above, this Device Registry also provides an implementation of Device Registry Management APIs for managing tenants, registration information and credentials of devices.

JDBC Based Device Registry Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The JDBC based Device Registry component provides an implementation of Eclipse Hono™’s Device Registration, Credentials and Tenant APIs. Protocol adapters use these APIs to determine a device’s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. In addition to the above, this Device Registry also provides an implementation of Device Registry Management APIs for managing tenants, registration information and credentials of devices.

Configuring the Command Router Service

Mon, 01 Jan 0001 00:00:00 +0000

The Command Router service provides an implementation of Eclipse Hono™’s Command Router API.

Protocol Adapters use the Command Router API to supply information that the Command Router service component can use to route command & control messages to the particular protocol adapter instances that the target devices are connected to.

HTTP Adapter Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The HTTP protocol adapter exposes HTTP based endpoints for Eclipse Hono™’s south bound Telemetry, Event and Command & Control APIs.

MQTT Adapter Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The MQTT protocol adapter exposes an MQTT topic hierarchy for Eclipse Hono™’s south bound Telemetry, Event and Command & Control APIs.

AMQP Adapter Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The AMQP protocol adapter exposes AMQP based endpoints for Eclipse Hono™’s south bound Telemetry, Event and Command & Control APIs.

CoAP Adapter Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The CoAP protocol adapter exposes CoAP based endpoints for Eclipse Hono™’s south bound Telemetry, Event and Command & Control APIs.

Hono Client Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Hono comes with a set of Java packages that contain classes for interacting with Hono’s service components via AMQP 1.0. Hono’s protocol adapters use these classes to query the device registry, receive commands and to forward events, telemetry and command response messages to downstream business applications.

Hono Kafka Client Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Several Hono components can be configured to support Kafka as the messaging infrastructure. The Kafka client used for this purpose can be configured by means of operating system environment variables and/or Java system properties. A Hono component can use multiple Kafka clients for different tasks. Each client has a type (producer, consumer, or admin client) and a name which is part of the prefix of the configuration properties used to configure the client.

AMQP 1.0 Messaging Network Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The Qpid Dispatch Router, together with the Apache Artemis message broker, serves as the default AMQP 1.0 Messaging Network that is used in Hono’s example deployment as described in the Deployment Guides.

Kafka Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Hono may use an Apache Kafka cluster as messaging infrastructure.

Google Pub/Sub Messaging Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Hono can be configured to support Google Pub/Sub as the messaging infrastructure. The Pub/Sub client used for this purpose can be configured by means of operating system environment variables. Supporting Google Pub/Sub, Hono must run on Google Kubernetes Engine to authenticate to the Google Pub/Sub API. To authenticate to the Google Pub/Sub API, Workload Identity is used and has to be configured as described in the Google Cloud Documentation. Warning Support for Google Pub/Sub based messaging infrastructure is considered experimental and may change without further notice.

Secure Communication

Mon, 01 Jan 0001 00:00:00 +0000

The individual components of an Eclipse Hono™ installation, e.g. the protocol adapters, messaging infrastructure, Hono Auth etc. and the clients attaching to Hono in order to send and receive data all communicate with each other over IP based networking infrastructure. The Hono components and the clients will usually not be located on the same local network but will probably communicate over public networking infrastructure. For most use cases it is therefore desirable, if not necessary, to provide for confidentiality of the data being transferred between these components.

This section describes how Hono supports confidentiality by means of Transport Layer Security (TLS) and how to configure it.

Monitoring & Tracing

Mon, 01 Jan 0001 00:00:00 +0000

The individual components of an Eclipse Hono™ installation need to work together in order to provide their functionality to devices and applications. Under normal circumstances these interactions work flawlessly. However, due to the nature of distributed systems, any one (or more) of the components may crash or become otherwise unavailable due to arbitrary reasons. This page describes how Hono supports operations teams by providing insights into the individual service components and their interactions with each other by means of reporting metrics and tracing the processing of individual messages through the system.

Configuring the Device Connection Service

Mon, 01 Jan 0001 00:00:00 +0000

The Device Connection service provides an implementation of Eclipse Hono™’s Device Connection API.

Protocol adapters use this API to store and retrieve information about the gateway that a device is using to connect to Hono’s protocol adapters. This information is necessary for routing commands to the particular protocol adapter instance that the gateway used by the device is connected to.

Device Registry Configurations

Mon, 01 Jan 0001 00:00:00 +0000

The configuration of Eclipse Hono™s Device Registry implementations for the File Based Device Registry and for the MongoDB Based Device Registry.

File Based Device Registry Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The File based Device Registry component provides an exemplary implementation of Eclipse Hono™’s Device Registration, Credentials, Tenant and Device Connection APIs.

Protocol adapters use these APIs to determine a device’s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it.

Kura Adapter Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The Kura protocol adapter exposes an MQTT topic hierarchy allowing Eclipse Kura™ 3 based gateways to access Eclipse Hono™’s south bound Telemetry, Event and Command & Control APIs.