Procedure

1. In the top right, click the Plus icon (+). The Import YAML window opens.
2. From the top left drop-down menu, select the amq-online-infra project.

3. Copy the following code:

   apiVersion: admin.enmasse.io/v1beta1
   kind: StandardInfraConfig
   metadata:
     name: default

4. In the Import YAML window, paste the copied code and click Create. The StandardInfraConfig overview page is displayed.
5. Click Operators > Installed Operators.
6. Click the AMQ Online Operator and click the Standard Infra Config tab to verify that its Status displays as Active.

Procedure

1. In the top right, click the Plus icon (+). The Import YAML window opens.
2. From the top left drop-down menu, select the amq-online-infra project.

3. Copy the following code:

   apiVersion: admin.enmasse.io/v1beta1
   kind: AuthenticationService
   metadata:
     name: standard-authservice
   spec:
     type: standard

4. In the Import YAML window, paste the copied code and click Create. The AuthenticationService overview page is displayed.
5. Click Workloads > Pods. In the Readiness column, the Pod status is Ready when the custom resource has been deployed.

Procedure

1. In the top right, click the Plus icon (+). The Import YAML window opens.
2. From the top left drop-down menu, select the amq-online-infra project.

3. Copy the following code:

   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressSpacePlan
   metadata:
     name: standard-small
   spec:
     addressSpaceType: standard
     infraConfigRef: default
     addressPlans:
       - standard-small-queue
     resourceLimits:
       router: 2.0
       broker: 3.0
       aggregate: 4.0

4. In the Import YAML window, paste the copied code and click Create. The AddressSpacePlan overview page is displayed.
5. Click Operators > Installed Operators.
6. Click the AMQ Online Operator and click the Address Space Plan tab to verify that its Status displays as Active.

Procedure

1. In the top right, click the Plus icon (+). The Import YAML window opens.
2. From the top left drop-down menu, select the amq-online-infra project.

3. Copy the following code:

   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressPlan
   metadata:
     name: standard-small-queue
   spec:
     addressType: queue
     resources:
       router: 0.01
       broker: 0.1

4. In the Import YAML window, paste the copied code and click Create. The AddressPlan overview page is displayed.
5. Click Operators > Installed Operators.
6. Click the AMQ Online Operator and click the Address Plan tab to verify that its Status displays as Active.

Procedure

1. Export the device registry host:

   export REGISTRY_HOST=$(oc -n amq-online-infra get routes device-registry --template='{{ .spec.host }}')

2. Export the device registry access token:

   export TOKEN=$(oc whoami --show-token)

   This token is used to authenticate against the device registry management API.

3. Register a device with a defined ID (this example uses 4711):

   curl --insecure -X POST -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" https://$REGISTRY_HOST/v1/devices/myapp.iot/4711

4. (Optional) If you need to provide additional registration information, do so as follows:

   curl --insecure -X POST -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" --data-binary '{
   	"via": ["gateway1"]
   }' https://$REGISTRY_HOST/v1/devices/myapp.iot/4711

Procedure

1. Add the credentials for a device:

   curl --insecure -X PUT -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" --data-binary '[{
   	"type": "hashed-password",
   	"auth-id": "sensor1",
   	"secrets": [{
   		"pwd-plain":"'hono-secret'"
   	}]
   }]' https://$REGISTRY_HOST/v1/credentials/myapp.iot/4711

Procedure

1. Connect to your database instance using the admin user
2. Review and deploy the SQL schema templates/iot/examples/postgresql/create.sql

Procedure

1. Edit the IoTConfig instance named default:

   oc edit iotconfig default

2. Configure the logging options, save and exit the editor:

   apiVersion: iot.enmasse.io/v1alpha1
   kind: IoTConfig
   metadata:
     namespace: enmasse-infra
     name: default
   spec:
     logging:
       level: info 1
       loggers: 2
         io.enmasse: debug 3
         io.netty: error 4

   1

   The default global log level. If omitted, info is used.

   2

   The section for log channel specific entries.

   3

   Lowers the filtering to debug level for messages in the channel io.enmasse.

   4

   Raises the filtering to error level for messages in the channel io.netty.

3. The operator applies the logging configuration and re-deploys all required components.

Procedure

1. Edit the IoTConfig instance named default:

   oc edit iotconfig default

2. Configure the logging options, save and exit the editor:

   apiVersion: iot.enmasse.io/v1alpha1
   kind: IoTConfig
   metadata:
     namespace: enmasse-infra
     name: default
   spec:
     adapters:
       mqtt:
         containers:
           adapter:
             logback:
               level: info 1
               loggers: 2
                 io.enmasse: debug 3
                 io.netty: error 4

   1

   The application global log level. If omitted, the default global level is used.

   2

   The section for log channel specific entries. If omitted and the application global log level is also omitted, the default log channel configuration of the infrastructure is used. If the application global log level is set, it is considered an empty set, and no log channel specific configuration is applied.

   3

   Lowers the filtering to debug level for messages in the channel io.enmasse.

   4

   Raises the filtering to error level for messages in the channel io.netty.

3. The operator applies the logging configuration and re-deploys all required components.

Procedure

1. Evaluate if the project is stuck in the termination state using the oc tool:

   oc get iotproject iot -n myapp
   NAME   IOT TENANT  DOWNSTREAM HOST                       DOWNSTREAM PORT   TLS    PHASE
   iot    myapp.iot   messaging-be482a6.enmasse-infra.svc   5671              true   Terminating

   The output should show the project in the state "Terminating". In addition, verify that the cleanup finalizer is still present:

   oc get iotproject iot -n myapp -ojsonpath='{range .metadata.finalizers[*]}{..}{"\n"}{end}'
   iot.enmasse.io/deviceRegistryCleanup

   If the list contains an entry of iot.enmasse.io/deviceRegistryCleanup, then resource cleanup process is still pending.

2. Manually remove the finalizer iot.enmasse.io/deviceRegistryCleanup from the list of finalizers:

   oc edit iotproject iot -n myapp

   This will open up a text editor with the content of the resource:

   apiVersion: iot.enmasse.io/v1alpha1
   kind: IoTProject
   metadata:
     creationTimestamp: "2019-12-09T15:00:00Z"
     deletionTimestamp: "2019-12-09T16:00:00Z"
     finalizers:
     - iot.enmasse.io/deviceRegistryCleanup 1
     name: iot
     namespace: myapp

   1

   The line with the finalizer to delete

   Delete the line of the finalizer. Save and exit the editor. This will automatically trigger an update on the server, and the system will continue deleting the IoTProject resource.

3. After the finalizer has been removed, the resource should be deleted and disappear from the system.

Procedure

1. Extract the token for the current user:

   oc whoami -t

Procedure

1. Create a new service account:

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: my-device-manager-account 1

   1

   The name of the service account.

2. Create a new role, allowing access to the IoTProject:

   apiVersion: rbac.authorization.k8s.io/v1
   kind: Role
   metadata:
     name: device-manager-role 1
   rules: 2
   - apiGroups: ["iot.enmasse.io"]
     resources: ["iotprojects"]
     verbs: ["create", "update", "get", "list", "delete"]

   1

   The name of the role.

   2

   The access rules, which must grant CRUD access to the IoTProject.

   This example grants access to all IoTProjects in a namespace. To further restrict access, use more specific rules.

3. Create a new role binding, assigning the role to the service account:

   apiVersion: rbac.authorization.k8s.io/v1
   kind: RoleBinding
   metadata:
     name: my-device-manager-account-role-binding
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: device-manager-role 1
   subjects:
   - kind: ServiceAccount
     name: my-device-manager-account 2

   1

   The name of the role.

   2

   The name of the service account.

4. Retrieve the token from the service account:

   oc serviceaccounts get-token my-device-manager-account

Procedure

1. Export the device registry host:

   export REGISTRY_HOST=$(oc -n amq-online-infra get routes device-registry --template='{{ .spec.host }}')

2. Export the device registry access token:

   export TOKEN=$(oc whoami --show-token)

   This token is used to authenticate against the device registry management API.

3. Register a device with a defined ID (this example uses 4711):

   curl --insecure -X POST -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" https://$REGISTRY_HOST/v1/devices/myapp.iot/4711

4. (Optional) If you need to provide additional registration information, do so as follows:

   curl --insecure -X POST -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" --data-binary '{
   	"via": ["gateway1"]
   }' https://$REGISTRY_HOST/v1/devices/myapp.iot/4711

Procedure

1. Add the credentials for a device:

   curl --insecure -X PUT -i -H 'Content-Type: application/json' -H "Authorization: Bearer ${TOKEN}" --data-binary '[{
   	"type": "hashed-password",
   	"auth-id": "sensor1",
   	"secrets": [{
   		"pwd-plain":"'hono-secret'"
   	}]
   }]' https://$REGISTRY_HOST/v1/credentials/myapp.iot/4711

Procedure

1. Send telemetry using the HTTP protocol:

   curl --insecure -X POST -i -u sensor1@myapp.iot:hono-secret -H 'Content-Type: application/json' --data-binary '{"temp": 5}' https://$(oc -n amq-online-infra get routes iot-http-adapter --template='{{ .spec.host }}')/telemetry

Procedure

1. Send events using the HTTP protocol:

   curl --insecure -X POST -i -u sensor1@myapp.iot:hono-secret -H 'Content-Type: application/json' --data-binary '{"temp": 5}' https://$(oc -n amq-online-infra get routes iot-http-adapter --template='{{ .spec.host }}')/events

Procedure

1. Send a telemetry message using the HTTP protocol, specifying the hono-ttd parameter indicating how long the client will wait for the command:

   curl --insecure -X POST -i -u sensor1@myapp.iot:hono-secret -H 'Content-Type: application/json' --data-binary '{"temp": 5}' https://$(oc -n amq-online-infra get routes iot-http-adapter --template='{{ .spec.host }}')/telemetry?hono-ttd=600

2. Run the customer application to send commands to a device with an ID of 4711:

   java -jar hono-cli-*-exec.jar --hono.client.host=$MESSAGING_HOST --hono.client.port=$MESSAGING_PORT --hono.client.username=consumer --hono.client.password=foobar --tenant.id=myapp.iot --hono.client.trustStorePath=tls.crt --device.id=4711 --spring.profiles.active=command

3. Follow the instructions for entering the command’s name, payload, and content type. For example:

   >>>>>>>>> Enter name of command for device [4711] in tenant [myapp.iot] (prefix with 'ow:' to send one-way command):
   ow:setVolume
   >>>>>>>>> Enter command payload:
   {"level": 50}
   >>>>>>>>> Enter content type:
   application/json
   
   INFO  org.eclipse.hono.cli.app.Commander - Command sent to device

   The client receives the command in the HTTP response:

   HTTP/1.1 200 OK
   hono-command: setVolume
   content-type: application/json
   content-length: 13
   
   {"level": 50}

Procedure

1. Send telemetry using the MQTT protocol:

   mosquitto_pub -d -h $(oc -n amq-online-infra get routes iot-mqtt-adapter --template='{{ .spec.host }}') -p 443 -u 'sensor1@myapp.iot' -P hono-secret -t telemetry -m '{"temp": 5}' -i 4711 --cafile install/components/iot/examples/k8s-tls/build/iot-mqtt-adapter-fullchain.pem

Procedure

1. Send events using the MQTT protocol:

   mosquitto_pub -d -h $(oc -n amq-online-infra get routes iot-mqtt-adapter --template='{{ .spec.host }}') -p 443 -u 'sensor1@myapp.iot' -P hono-secret -t events -m '{"temp": 5}' -i 4711 --cafile install/components/iot/examples/k8s-tls/build/iot-mqtt-adapter-fullchain.pem

Procedure

1. Use the MQTT client to subscribe to the MQTT topic for receiving commands:

   mosquitto_sub -v -d -h $(oc -n amq-online-infra get routes iot-mqtt-adapter --template='{{ .spec.host }}') -p 443 -u 'sensor1@myapp.iot' -P hono-secret -t command/+/+/req/# -i 4711 --cafile install/components/iot/examples/k8s-tls/build/iot-mqtt-adapter-fullchain.pem

2. Run the customer application to send commands to a device with an ID of 4711:

   java -jar hono-cli-*-exec.jar --hono.client.host=$MESSAGING_HOST --hono.client.port=$MESSAGING_PORT --hono.client.username=consumer --hono.client.password=foobar --tenant.id=myapp.iot --hono.client.trustStorePath=tls.crt --device.id=4711 --spring.profiles.active=command

3. Follow the instructions for entering the command’s name, payload, and content type. For example:

   >>>>>>>>> Enter name of command for device [4711] in tenant [myapp.iot] (prefix with 'ow:' to send one-way command):
   ow:setVolume
   >>>>>>>>> Enter command payload:
   {"level": 50}
   >>>>>>>>> Enter content type:
   application/json
   
   INFO  org.eclipse.hono.cli.app.Commander - Command sent to device

   The client receives the command in the MQTT message:

   Client 4711 received PUBLISH (d0, q0, r0, m0, 'command///req//setVolume', ... (13 bytes))
   command///req//setVolume {"level": 50}

Procedure

1. Register a new device.

   In step 3 of this procedure, specify sigfox-backend as the ID.

2. Set up password credentials for this device (for example, sigfox-user / sigfox-password).

Procedure

1. Locate the device ID for the Sigfox device you want to register. You obtain this ID as part of the registration process in the Sigfox backend.

2. Register a new device.

   Specify the device ID as the name (for example, 1AB2C3) and specify the name of the gateway device in the via field, as part of the registration information (for example, {"via": ["sigfox-backend"]}).

Procedure

1. Log in to https://backend.sigfox.com.
2. In the Device Type open a type for editing and switch to the Callbacks section.

3. Create a new "Custom" callback, with the following settings:

   Type

   DATA – UPLINK

   Channel

   URL

   Url pattern

   The URL pattern. For example, https://iot-sigfox-adapter.my.cluster/data/telemetry/<TENANT>?device={device}&data={data}

   Use HTTP Method

   GET

   Headers

   Authorization – Basic…

   Send SNI

   ☑ (Enabled)

Procedure

1. Log in to https://backend.sigfox.com.
2. In the Device Type open the type for editing and switch to the Callbacks section.

3. Edit the callback configuration for which you want to enable command and control.

   Type

   Switch to DATA – BIDIR

   Url Pattern

   Add the ack parameter. For example, https://iot-sigfox-adapter.my.cluster/data/telemetry/<TENANT>?device={device}&data={data}&ack={ack}