Skip to content

Commit 1568519

Browse files
[Fix] remove references from old services
1 parent a37dc35 commit 1568519

13 files changed

Lines changed: 9 additions & 533 deletions

content/latest/how-to/bpmn/bpmn-elements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The parameters for a timer start event are as follows:
122122

123123
### Intermediate message events
124124

125-
Intermediate message events throw a message to the Rhize NATS broker.
125+
Intermediate message events throw a message to the Rhize broker.
126126
This may provide info for a subscribing third-party client, or initiate another BPMN workflow.
127127

128128
The parameters for an intermediate message event are as follows:

content/latest/how-to/bpmn/create-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ width="60%"
9292

9393
The strategy you choose to send and receive message data depends on your architectural setup.
9494
Generally, data-source messages come from level-1 and level-2 devices on the edge,
95-
and messages published to the Rhize broker come from any NATS, MQTT, or OPC UA client.
95+
and messages published to the Rhize broker come from any MQTT or OPC UA client.
9696
The following diagram shows some common ways to interact with messages through BPMN.
9797

9898
{{< bigFigure

content/latest/how-to/bpmn/naming-conventions.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,11 @@ Where:
3636

3737
| InvocationTypes | Description |
3838
|-----------------|------------------------------------------------------------------------------------------------|
39-
| `NATS` | Invoked when a message is received in the Rhize NATS broker |
4039
| `API` | Expects to be called from the API using `createAndRunBPMNSync` or `createAndRunBPMN` mutations |
4140
| `RULE` | Invocation is expected from the [rule engine]({{< relref "../publish-subscribe/create-equipment-class-rule" >}}) |
4241
| `FUNC` | Internal functions to be invoked as helpers |
4342

4443
Examples:
45-
- `NATS_ProcessOrderV1TransformAndPersist`
46-
- `NATS_PLMMaterialMasterV2TransformPersistAndPublish`
4744
- `RULE_ChangeOEEStatusOfCNCEquipment`
4845
- `API_WST04_GetNextLibreBatchNumber`
4946
- `API_WAT01_CloseOpenJobOrders`

content/latest/how-to/bpmn/trigger-workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ If the `version` property is empty, Rhize runs the active version of the workflo
120120

121121
The [message start event]({{< relref "./bpmn-elements#message-start-event" >}}) subscribes to a topic on the Rhize broker.
122122
Whenever a message is published to this topic, the workflow is triggered.
123-
The Rhize broker can receive messages published over MQTT, NATS, and OPC UA.
123+
The Rhize broker can receive messages published over MQTT and OPC UA.
124124

125125
For example, this workflow subscribes to the topic `material/stuff`.
126126
Whenever a message is published to the topic, it evaluates whether the quantity is in the correct threshold.

content/latest/how-to/bpmn/tune-performance.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ So an inefficient BPMN process can introduce performance degradations.
1717

1818
## Manage the process context size
1919

20-
{{< callout type="info" >}}
21-
The max size of the process variable context comes from the default max payload size of NATS Jetstreams.
22-
To increase this size, change your NATS configuration.
23-
{{< /callout >}}
24-
2520
By default, the size of the {{< abbr "process variable context" >}} is 1MB.
2621
If the sum size of all variables exceeds this limit, the BPMN process fails to execute.
2722

@@ -67,7 +62,6 @@ If a process seems slow, look for these places to refactor performance.
6762
### Avoid parallel joins
6863

6964
Running processes in [parallel]({{< relref "./bpmn-elements#parallel-gateway" >}}) can increase the workflow's complexity.
70-
Parallel joins in particular can also increase memory usage of the NATS service.
7165

7266
Where possible, prefer exclusive branching and sequential execution.
7367
When a task requires concurrency, keep the amount of data processed and the complexity of the tasks to the minimum necessary.

content/latest/how-to/model/master-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Each topic has the following fields:
8080
| Topic field | Description |
8181
|-------------------|-------------------------------------------------------------------------------|
8282
| Data type | The data type Rhize expects to find when it receives data from that topic |
83-
| Deduplication key | The field that NATS uses to de-duplicate messages from multiple data sources. |
83+
| Deduplication key | The field to de-duplicate messages from multiple data sources. |
8484
| Label | The name of the topic on the side of the data source |
8585
| Description | A freeform text field to add context |
8686

content/latest/how-to/publish-subscribe/track-changes.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aliases:
1010
You can use _change data capture_ (CDC) to track data changes over time, including
1111
a {{< abbr "mutation" >}} or drop in your database.
1212
Rhize's CDC implementation can use
13-
Kafka, NATS, or a local file as a *{{< abbr "sink" >}}* to store CDC updates streamed by Rhize's Alpha
13+
Kafka or a local file as a *{{< abbr "sink" >}}* to store CDC updates streamed by Rhize's Alpha
1414
leader nodes.
1515

1616
When CDC is enabled, Rhize streams events for:
@@ -55,16 +55,6 @@ with the `--cdc` command and the sub-option shown below, as follows:
5555
dgraph alpha --cdc "file=local-file-path"
5656
```
5757

58-
## Enable CDC with NATS JetStream KV store sink
59-
60-
To enable CDC and sink results to a NATS JetStream KV store, start Dgraph Alpha
61-
with the `--cdc` command and the sub-option shown below, as follows:
62-
63-
```bash
64-
dgraph alpha --cdc "nats=nats://system:system@localhost:4222"
65-
```
66-
67-
6858
## CDC command reference
6959

7060
The `--cdc` option includes several sub-options that you can use to configure
@@ -78,7 +68,6 @@ CDC when running the `dgraph alpha` command:
7868
| `client-cert` | `--cdc "client-cert=/c-certs/client.crt"` | Path and filename of the client certificate used for TLS encryption |
7969
| `client-key` | `--cdc "client-cert=/c-certs/client.key"` | Path and filename of the client certificate private key |
8070
| `file` | `--cdc "file=/sink-dir/cdc-file"` | Path and filename of a local file sink (alternative to Kafka sink) |
81-
| `nats` | `--cdc "nats=nats://user:password@localhost:4222"` | URL connection string to nats sink (alternative to Kafka sink) |
8271
| `kafka` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | Hostname(s) of the Kafka hosts. May require authentication using the `sasl-user` and `sasl-password` sub-options |
8372
| `sasl-user` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL username for Kafka. Requires the `kafka` and `sasl-password` sub-options |
8473
| `sasl-password` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL password for Kafka. Requires the `kafka` and `sasl-username` sub-options |

content/latest/reference/nats-configuration.md

Lines changed: 0 additions & 97 deletions
This file was deleted.

content/latest/reference/observability-metrics.md

Lines changed: 3 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,9 @@ The service metrics have endpoints at the following ports:
2121
|---------|-----------|---------|------|
2222
| Audit | Y | Y | 8084 |
2323
| BAAS | Y | Y | 8080 |
24-
| BPMN | Y | Y | 8081 |
25-
| Core | Y | Y | 8080 |
26-
| NATS | | Y | 7777 |
2724
| Router | Y | | 9090 |
2825
| Tempo | Y | Y | 3100 |
2926

30-
NATS has an available endpoint through an exporter that is present on the cluster.
3127
Router has an available endpoint that is disabled by default.
3228

3329
## Metrics configuration
@@ -46,42 +42,9 @@ For example:
4642
metrics_path: /metrics
4743
scheme: http
4844
static_configs:
49-
- targets: ['audit-demo.demo.svc.cluster.local:8084', 'baas-alpha.demo.svc.cluster.local:8080', 'bpmn-demo.demo.svc.cluster.local:8081', 'core-demo.demo.svc.cluster.local:8080', 'grafana-demo.demo.svc.cluster.local:3000', 'tempo.demo.svc.cluster.local:3100', 'nats-demo-headless.demo.svc.cluster.local:7777', 'router-demo.demo.svc.cluster.local:9090']
45+
- targets: ['audit-demo.demo.svc.cluster.local:8084', 'baas-alpha.demo.svc.cluster.local:8080', 'grafana-demo.demo.svc.cluster.local:3000', 'tempo.demo.svc.cluster.local:3100', 'router-demo.demo.svc.cluster.local:9090']
5046
```
5147
52-
### NATS
53-
54-
While NATS has no available metrics endpoint, the cluster includes a [NATS Prometheus exporter](https://github.com/nats-io/prometheus-nats-exporter).
55-
NATS metrics are exposed through port `7777`.
56-
57-
58-
#### Cluster
59-
60-
Since the cluster already includes the exporter, no further configuration is required.
61-
This endpoint should be connected through the NATS headless pod. For example:
62-
63-
`nats-demo-headless.demo.svc.cluster.local:7777`
64-
65-
#### Docker
66-
67-
To get NATS metrics in Docker, use the exporter mentioned in the preceding section.
68-
The following is a sample docker-compose configuration for the exporter.
69-
70-
```yaml
71-
services:
72-
# -- Other services
73-
nats-exporter:
74-
image: natsio/prometheus-nats-exporter:latest
75-
container_name: nats-exporter
76-
command: "-varz 'http://nats:5555'"
77-
depends_on:
78-
- nats
79-
ports:
80-
- 7777:7777
81-
```
82-
83-
Access NATS metrics at `localhost:7777/metrics`
84-
8548
### Router
8649
8750
#### Cluster
@@ -138,6 +101,7 @@ This opens the metrics endpoint on port `9090`.
138101
To view it externally, you must expose the port in docker-compose.
139102
Once the port is exposed, view the metrics at `localhost:9090/metrics`
140103

104+
141105
## Available Rhize microservice metrics
142106

143107
Several common metrics appear between Rhize microservices:
@@ -150,17 +114,14 @@ Several common metrics appear between Rhize microservices:
150114
|---------|---------------------------------------------------|-----------------|---------------|------------|
151115
| Audit | Y | Y | Y | |
152116
| BAAS | Y | Y | | Y |
153-
| BPMN | Y | Y | Y | Y |
154-
| Core | Y | | Y | |
155-
| NATS | Y | Y | Y | Y |
156117
| Router | | | | Y |
157118
| Tempo | Y | | | Y |
158119

159120
{{< callout type="info" >}}
160121
HTTP metrics are noted as `promhttp`.
161122
{{< /callout >}}
162123

163-
### BAAS
124+
164125

165126
Additional metrics on BAAS are from [dgraph](https://dgraph.io/docs/deploy/admin/metrics/). These include two categories: Badger and Dgraph.
166127

@@ -194,66 +155,6 @@ dgraph_disk_free_bytes{dir="postings_fs"} 1.0153562112e+10
194155
dgraph_disk_total_bytes{dir="postings_fs"} 1.0447245312e+10
195156
```
196157
197-
### BPMN
198-
199-
BPMN has four metrics unique to it, shown in full in the sample below.
200-
201-
#### Sample
202-
203-
```
204-
# HELP bpmn_execution_commands The number of BPMN commands that have started executing
205-
# TYPE bpmn_execution_commands counter
206-
bpmn_execution_commands 1162
207-
208-
# HELP bpmn_instances_started BPMN Instances started but not necessarily completed
209-
# TYPE bpmn_instances_started counter
210-
bpmn_instances_started 166
211-
212-
# HELP bpmn_queue_CommandConsumerQueue Number of BPMN Commands currently waiting to be executed
213-
# TYPE bpmn_queue_CommandConsumerQueue gauge
214-
bpmn_queue_CommandConsumerQueue 0
215-
216-
# HELP bpmn_queue_StartOnNatsMessages Number of BPMN trigger messages received from NATS
217-
# TYPE bpmn_queue_StartOnNatsMessages gauge
218-
bpmn_queue_StartOnNatsMessages 0
219-
```
220-
221-
### NATS
222-
223-
NATS has two categories of metrics:
224-
- `gnatsd`
225-
- `jetstream`
226-
227-
#### Sample
228-
229-
```
230-
# HELP gnatsd_connz_in_bytes in_bytes
231-
# TYPE gnatsd_connz_in_bytes counter
232-
gnatsd_connz_in_bytes{server_id="nats-demo-0"} 0
233-
234-
# HELP gnatsd_connz_in_msgs in_msgs
235-
# TYPE gnatsd_connz_in_msgs counter
236-
gnatsd_connz_in_msgs{server_id="nats-demo-0"} 0
237-
238-
# HELP gnatsd_connz_limit limit
239-
# TYPE gnatsd_connz_limit gauge
240-
gnatsd_connz_limit{server_id="nats-demo-0"} 1024
241-
```
242-
243-
```
244-
# HELP jetstream_server_jetstream_disabled JetStream disabled or not
245-
# TYPE jetstream_server_jetstream_disabled gauge
246-
jetstream_server_jetstream_disabled{cluster="nats-demo",domain="",is_meta_leader="false",meta_leader="nats-demo-1",server_id="nats-demo-0",server_name="nats-demo-0"} 0
247-
248-
# HELP jetstream_server_max_memory JetStream Max Memory
249-
# TYPE jetstream_server_max_memory gauge
250-
jetstream_server_max_memory{cluster="nats-demo",domain="",is_meta_leader="false",meta_leader="nats-demo-1",server_id="nats-demo-0",server_name="nats-demo-0"} 2.147483648e+09
251-
252-
# HELP jetstream_server_max_storage JetStream Max Storage
253-
# TYPE jetstream_server_max_storage gauge
254-
jetstream_server_max_storage{cluster="nats-demo",domain="",is_meta_leader="false",meta_leader="nats-demo-1",server_id="nats-demo-0",server_name="nats-demo-0"} 5.36870912e+10
255-
```
256-
257158
### Router
258159
259160
All metrics provided by Router are unique to Apollo Router.

content/latest/reference/service-config/agent-configuration.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Rhize agent collects data that is emitted in the manufacturing process and m
1313
It works by connecting to equipment or groups of equipment that run over protocols such as OPC UA.
1414

1515
As the communication bridge between the Rhize Data Hub and your plant, the agent has multiple functions:
16-
- It subscribes to tags and republishes the changes in NATS.
16+
- It subscribes to tags and republishes the changes in the messsage broker.
1717
- It creates an interface for the BPMN engine to send reads and writes to a data source and its associated equipment.
1818

1919

@@ -42,12 +42,6 @@ As the communication bridge between the Rhize Data Hub and your plant, the agent
4242
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4343
| `GRAPHQL_URL` | The URL of the GraphQL endpoint to use for interacting with Rhize services. <br />(Default: `http://localhost:8080/graphql`) |
4444

45-
## `NATS`
46-
47-
| Attribute | Description |
48-
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
49-
| `SERVER_URL` | The URL for connecting to the NATS server. <br />(Default: `nats://system:system@localhost:4222`) |
50-
5145
## `OIDC`
5246

5347
Configurations for Keycloak authentication and connection with OpenID Connect.

0 commit comments

Comments
 (0)