From 595032fbb52deb06c9522bf52f38700833095d48 Mon Sep 17 00:00:00 2001 From: postmannen Date: Fri, 3 Jan 2025 13:50:40 +0100 Subject: [PATCH] update doc --- doc/.$ctrl-drawings.drawio.bkp | 171 ++++++++++++++++++ doc/core-messaging.svg | 2 +- doc/ctrl-drawings.drawio | 109 ++++++++++- doc/src/core_overview.md | 17 ++ .../usecase-ctrl-as-prometheus-collector.md | 6 + doc/usecase-prometheus-collector.svg | 4 + 6 files changed, 301 insertions(+), 8 deletions(-) create mode 100644 doc/.$ctrl-drawings.drawio.bkp create mode 100644 doc/usecase-prometheus-collector.svg diff --git a/doc/.$ctrl-drawings.drawio.bkp b/doc/.$ctrl-drawings.drawio.bkp new file mode 100644 index 0000000..f3a4d8c --- /dev/null +++ b/doc/.$ctrl-drawings.drawio.bkp @@ -0,0 +1,171 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/core-messaging.svg b/doc/core-messaging.svg index d66156d..557ecea 100644 --- a/doc/core-messaging.svg +++ b/doc/core-messaging.svg @@ -1,4 +1,4 @@ -
central
operator
linux1
linux1
linux1
NATS Server
command
Upgrade all servers,
and restart
to audit log
result
result
result
 \ No newline at end of file +
node
central
node
operator
node
linux1
node
linux2
node
linux3
NATS Server
command
Upgrade all servers,
and restart
to audit log
result
result
result
result
 \ No newline at end of file diff --git a/doc/ctrl-drawings.drawio b/doc/ctrl-drawings.drawio index 946c23d..ea89240 100644 --- a/doc/ctrl-drawings.drawio +++ b/doc/ctrl-drawings.drawio @@ -1,22 +1,22 @@ - - + + - + - + - + - + - + @@ -85,6 +85,101 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/src/core_overview.md b/doc/src/core_overview.md index 562a737..94cf407 100644 --- a/doc/src/core_overview.md +++ b/doc/src/core_overview.md @@ -1,5 +1,11 @@ # Core overview +This is just a quick introduction to the core concepts of ctrl. Details can be found by reading further in the **Core ctrl** section. + +## Concept + +In ctrl all nodes are treated equally, and there is no concept of client/server. There are just nodes that can send messages to other nodes, and the messages contains commands of what to do on the node that receives the message. + + + +

+ + The example that follows will scrape prometheus metrics with two ctrl nodes, deliver them to a third node called **metrics**, and expose them with the builtin http server. Prometheus can then be used to read all the metrics from the various nodes on the **metrics** node. Before you start, make sure to read the **User Guides** section for how to start up a NATS broker, and for general information about setting up ctrl. diff --git a/doc/usecase-prometheus-collector.svg b/doc/usecase-prometheus-collector.svg new file mode 100644 index 0000000..84dc1b6 --- /dev/null +++ b/doc/usecase-prometheus-collector.svg @@ -0,0 +1,4 @@ + + + +
node
central
node
metrics
node
linux1
node
linux2
node
linux3
NATS Server
to audit log
metric data
metric data
metric data
result
http/6060
 \ No newline at end of file