Skip to main content
Version: v3.9.0

Plant user rules

Goal​

Deploy the user rules for the plant microservices. The Applications on the later pages reference these names. Edgelet nodes site-a and ops-b should already exist. You can change agent.name when you deploy the Applications.

  • sensor-publisher publishes telemetry.machine.>.
  • anomaly-processor subscribes to telemetry and publishes alerts and journal events.
  • ops-viewer subscribes to imported alerts, the journal, and fleet telemetry. It runs later on ops-b.

The file is deploy/steps/01-nats-user-rules.yaml.

YAML​

sensor-publisher
apiVersion: datasance.com/v3
kind: NatsUserRule
metadata:
name: sensor-publisher
spec:
description: sensor-simulator - publish multi-metric machine telemetry (in-account)
maxSubscriptions: -1
maxPayload: 1048576
maxData: -1
bearerToken: false
allowedConnectionTypes:
- STANDARD
pubAllow:
- telemetry.machine.>
anomaly-processor
apiVersion: datasance.com/v3
kind: NatsUserRule
metadata:
name: anomaly-processor
spec:
description: smart-anomaly-detector - subscribe telemetry, publish alerts and journal events
maxSubscriptions: -1
maxPayload: 1048576
maxData: -1
bearerToken: false
allowedConnectionTypes:
- STANDARD
pubAllow:
- notify.alerts.>
- journal.events.>
- "$JS.API.>"
subAllow:
- telemetry.machine.>
- "_INBOX.>"

$JS.API.> lets the detector create JetStream stream JOURNAL_PRODUCTION.

ops-viewer
apiVersion: datasance.com/v3
kind: NatsUserRule
metadata:
name: ops-viewer
spec:
description: alert-dashboard - subscribe to imported alerts, journal, and fleet telemetry fan-in
maxSubscriptions: -1
maxPayload: 1048576
maxData: -1
bearerToken: false
allowedConnectionTypes:
- STANDARD
pubAllow:
- "$JS.API.>"
- "$JS.ACK.>"
subAllow:
- notify.alerts.>
- journal.events.>
- telemetry.machine.>
- "_INBOX.>"
- "$JS.ACK.>"
SubjectPurpose
telemetry.machine.{machineId}In-account telemetry for M001 through M004
notify.alerts.{machineId}Live alert panel
journal.events.{machineId}Journal kept in JetStream

Use telemetry.machine.>. Older demos published telemetry.temperature.

Deploy​

potctl deploy -f deploy/steps/01-nats-user-rules.yaml

What you should see​

potctl get nats-user-rules

sensor-publisher, anomaly-processor, and ops-viewer are listed. No microservices are running yet.

Common mistakes​

Deploying an Application before these rules exist.

Skipping ops-viewer. The dashboard on ops-b uses it.

Next​

Account export

Group 3See anything wrong with the document? Help us improve it!