Skip to content

Commit 433c3cf

Browse files
authored
Update architecture.md
Minor typing changes.
1 parent b3cdfc4 commit 433c3cf

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

docs/architecture.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
## Architecture
22

3-
OpenFlow is an extendible stack, it's core components consist of a [MongoDB](https://www.mongodb.com/) database (preferably a replica set to allow support for change streams )
4-
A stateless [RabbitMQ](https://www.rabbitmq.com/) (but if needed you can run with durable queues and persistent storage)
5-
And the OpenFlow API and web interface.
6-
If deployed in docker, you can the spin up multiple NodeRED instances using the API or from the we interface.
7-
Different types of clients, [custom web](https://github.com/open-rpa/openflow-web-angular11-template) interfaces, [OpenRPA](https://github.com/open-rpa/openrpa) robots, PowerShell modules and remotely installed NodeRED's can then connect to the OpenFlow API using web sockets and receive events and data. Clients will use the API to register/publish queues and exchanges in order to add an extra layer of authentication and to simply for network requirements. All database access is exposed as natively close to the MongoDB driver, but with an added layer of security though the API
3+
OpenFlow is an extendible stack, it's core components consist of a [MongoDB](https://www.mongodb.com/) database (preferably a replica set to allow support for change streams).
4+
A stateless [RabbitMQ](https://www.rabbitmq.com/) (Can be run with durable queues and persistent storage.) OpenFlow API and web interface.
5+
If deployed in docker, you can spin up multiple NodeRED instances using the API or the web interface.
6+
Different types of clients, [custom web](https://github.com/open-rpa/openflow-web-angular11-template) interfaces, [OpenRPA](https://github.com/open-rpa/openrpa) robots, PowerShell modules and remotely installed NodeRED's can then connect to the OpenFlow API using web sockets and receive events and data. Clients will use the API to register/publish queues and exchanges in order to add an extra layer of authentication and to simply for network requirements. All database access is exposed as natively close to the MongoDB driver, but with an added layer of security though the API.
87

9-
If installed [using NPM](https://openflow.openiap.io/npmopenflow) or the basic [docker-compose](https://github.com/open-rpa/openflow/blob/master/docker-compose.yml) file that would like something like this
8+
If installed [using NPM](https://openflow.openiap.io/npmopenflow) or the basic [docker-compose](https://github.com/open-rpa/openflow/blob/master/docker-compose.yml) file that would like something like this.
109

1110
![openflow_basic](architecture/openflow_basic.png)
1211

13-
But for most people you should go for the docker install using [traefik](https://traefik.io/) as an ingress controller/reverse proxy. This way we can segregate internal traffic that only OpenFlow should know about from traffic going in and out to the rest of the network/world. That will look something like below
12+
But for most people you should go for the docker install using [traefik](https://traefik.io/) as an ingress controller/reverse proxy. This way we can segregate internal traffic that only OpenFlow should know about from traffic going in and out to the rest of the network/world. That will look something like below.
1413

1514
![openflow_traefik](architecture/openflow_with_traefik.png)
1615

@@ -20,4 +19,3 @@ For bigger installations we recommend using kubernetes, we supply an easy to get
2019

2120
When running in high secured network, where you need to control the direction and priority the flow of data and events, OpenFlow can be deployed in mesh topologies.
2221
This can also be useful if working in distributed networks where network outage can last for very long periods of time, and the local storage of a remote NodeRED is not enough, or you need access to the web interface and reports even when the network is down.
23-

0 commit comments

Comments
 (0)