From 99dee3c552ba123ba3ed724b51c120ed45947198 Mon Sep 17 00:00:00 2001 From: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com> Date: Thu, 30 Nov 2023 16:27:51 -0300 Subject: [PATCH 1/2] [Feat] Document builtin nats topics --- .../{nats-configuration.md => nats-config.md} | 41 ++++++------------- 1 file changed, 13 insertions(+), 28 deletions(-) rename content/reference/{nats-configuration.md => nats-config.md} (65%) diff --git a/content/reference/nats-configuration.md b/content/reference/nats-config.md similarity index 65% rename from content/reference/nats-configuration.md rename to content/reference/nats-config.md index ae9c7e796..55087db94 100644 --- a/content/reference/nats-configuration.md +++ b/content/reference/nats-config.md @@ -1,7 +1,6 @@ --- title: 'NATS configuration' date: '2023-10-04T10:22:15-03:00' -draft: true categories: ["reference"] description: Values and parameters to configure NATS in your Rhize operation weight: 300 @@ -32,22 +31,17 @@ The `$KV` topic is reserved for messages about the [Key/Value Store](https://doc Subtopics include the following: -| Topic | Description | -|--------------------|-------------| -| `$KV/JobResponses` | | +- `$KV/JobResponses` ## BPMN topics and configuration The `libreBPMN` topic is for messages about the BPMN engine. Subtopics include the following: - -| Topic | Description | -|---------------------------------------|-------------| -| `libreBPMN/command/START_EVENT` | | -| `libreBPMN/command/TASK_COMPLETE` | | -| `libreBPMN/command/SERVICE_TASK` | | -| `libreBPMN/command/EXCLUSIVE_GATEWAY` | | +- `libreBPMN/command/START_EVENT` +- `libreBPMN/command/TASK_COMPLETE` +- `libreBPMN/command/SERVICE_TASK` +- `libreBPMN/command/EXCLUSIVE_GATEWAY` ### Streams @@ -56,7 +50,6 @@ Subtopics include the following: - `JobResponses KV` - `WorkflowSpecificationKV` - ## NATS configuration The following parameters configure the NATS message queues for different services. @@ -65,13 +58,11 @@ The following parameters configure the NATS message queues for different service The NATS configuration parameters for the BMPN streams are as follows: -| Topic | Description | -|-----------------------------------|-------------| -| `CommandStreamReplicas` | | -| `JobResponseKVMaxGB` | | -| `JobResponseKVReplicas` | | -| `JobResponseKVTTLMinutes` | | -| `WorkflowSpecificationKVReplicas` | | +- `CommandStreamReplicas` +- `JobResponseKVMaxGB` +- `JobResponseKVReplicas` +- `JobResponseKVTTLMinutes` +- `WorkflowSpecificationKVReplicas` For example: @@ -85,14 +76,8 @@ For example: }, ``` -### Libre core +### Libre core The NATS configuration parameters for the Libre core topics are as follows: - -| Parameter | Description | -|-------------|-------------| -| `serverUrl` | | -| `replicas` | | - - - +- `serverUrl` +- `replicas` From 60facf5173d444782cb2b7fb0634b63c7b80856d Mon Sep 17 00:00:00 2001 From: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com> Date: Thu, 30 Nov 2023 16:30:21 -0300 Subject: [PATCH 2/2] reorder reference sidebar --- content/reference/agent-configuration.md | 2 +- content/reference/nats-config.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/reference/agent-configuration.md b/content/reference/agent-configuration.md index 4a586280f..9fa08ec49 100644 --- a/content/reference/agent-configuration.md +++ b/content/reference/agent-configuration.md @@ -2,7 +2,7 @@ title: 'Agent configuration' categories: ["reference"] description: Authentication types for the Rhize agent -weight: 900 +weight: 100 menu: main: parent: reference diff --git a/content/reference/nats-config.md b/content/reference/nats-config.md index 55087db94..5e4bae632 100644 --- a/content/reference/nats-config.md +++ b/content/reference/nats-config.md @@ -3,7 +3,7 @@ title: 'NATS configuration' date: '2023-10-04T10:22:15-03:00' categories: ["reference"] description: Values and parameters to configure NATS in your Rhize operation -weight: 300 +weight: 200 menu: main: parent: reference