1
0
Fork 0
mirror of https://github.com/postmannen/ctrl.git synced 2025-01-05 20:09:16 +00:00
ctrl/README.md

76 lines
5.8 KiB
Markdown
Raw Normal View History

2021-01-25 14:18:11 +00:00
# steward
2021-02-03 07:28:21 +00:00
Async management of Edge Cloud units.
2021-02-03 08:06:37 +00:00
2021-02-03 07:28:21 +00:00
The idea is to build and use a pure message passing architecture for the control traffic back and forth from the Edge cloud units. The message passing backend used is <https://nats.io>
```text
┌─────────────────┐
│ │
│ │
│ ┌────────────┐ │
│ │ Edge Unit │ │
┌─────────────────┐ ┌─────────────────┐ │ └────────────┘ │
│ │ │ │ ────Event────▶ │ │
│ ┌────────────┐ │ ─────Event────▶ │ ┌───────────┐ │ ◀────ACK ───── │ │
│ │ Management │ │ │ │ Message │ │ └─────────────────┘
│ │ station │ │ │ │ broker │ │ ┌─────────────────┐
│ │ │ │ │ └───────────┘ │ │ │
│ └────────────┘ │ ◀─────ACK ───── │ │ ────Event────▶ │ │
│ │ │ │ ◀────ACK ───── │ ┌────────────┐ │
└─────────────────┘ └─────────────────┘ │ │ Edge Unit │ │
│ └────────────┘ │
│ │
│ │
└─────────────────┘
```
2021-02-03 08:06:37 +00:00
Why ?
With existing solutions there is often either a push or a pull kind of setup.
In a push setup the commands to execute is pushed to the receiver, but if a command fails because for example a broken network link it is up to you as an administrator to detect those failures and retry them at a later time until it is executed successfully.
In a pull setup an agent is installed at the Edge unit, and the configuration or commands to execute locally are pulled from a central repository. With this kind of setup you can be pretty certain that sometime in the future the Edge unit will reach it's desired state, but you don't know when. And if you want to know the current state you will need to have some second service which gives you that.
In it's simplest form the idea about using an event driven system as the core for management of Edge units is that the sender/publisher are fully decoupled from the receiver/subscriber. We can get an acknowledge if a message is received or not, and with this functionality we will at all times know the current state of the receiving end. We can also add information in the ACK message if the command sent to the receiver was successful or not by appending the actual output of the command.
2021-02-03 07:28:21 +00:00
## Disclaimer
All code in this repository are to be concidered not-production-ready. The code are the attempt to concretize the idea of a purely async management system where the controlling unit is decoupled from the receiving unit, and that that we know the state of all the receiving units at all times.
## Concepts/Ideas
### Terminology
- Node: An installation of an operating system with an ip address
- Process: One message handler running in it's own thread with 1 subject for sending and 1 for reply.
- Message:
- Command: Something to be executed on the message received. An example can be a shell command.
- Event: Something that have happened. An example can be transfer of syslog data from a host.
### Naming
#### Subject
Subject naming are case sensitive, and can not contain the space are the tab character.
2021-02-03 07:28:21 +00:00
`<nodename>.<command/event>.<method>.<domain>`
Nodename: Are the hostname of the device. This do not have to be resolvable via DNS, it is just a unique name for the host to receive the message.
Command/Event: Are type of message sent. `command` or `event`. Description of the differences are mentioned earlier.
Method: Are the functionality the message provide. Example could be `shellcommand` or `syslogforwarding`
2021-02-03 07:28:21 +00:00
Domain: Are used to describe what domain the method are for. For example there can be several logging services on an installation, but rarely there are several logging services in place for the same Domain using the same logging method. By having a specific Domain field we will be able to differentiate several loggers having for example `method=syslogforwarding` where one might be for `domain=nginx` and another for `domain=apache`.
##### Complete subject example
For syslog of type event to a host named "ship1"
2021-02-03 07:28:21 +00:00
`ship1.event.syslogforwarding.nginx`
and for a shell command of type command to a host named "ship2"
2021-02-03 07:28:21 +00:00
`ship2.command.shellcommand.operatingsystem`