micro-services-setup-beta.md

Microservices Setup [beta]

{% hint style="info" %} This guide is currently only valid for a special distribution of the Rocket.Chat.

The feature will be release for General Availability on the Enterprise Edition v4.0 {% endhint %}

Pre-requisites

• NATS
  • Please refer to NATS Docker installation on how to deploy NATS
• MongoDB
  • Storage Engine needs to be WiredTiger:
    • Change Standalone to WiredTiger
• Rocket.Chat
  • The setting Use REST instead of websocket for Meteor calls under Admin > General > REST API, must be enabled.

Micro services

Rocket.Chat micro services are composed by a few Docker containers:

Accounts

{% hint style="info" %} Can be scaled to multiple containers {% endhint %}

Responsible for user authentications

docker run \
--name accounts-service \
-e MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs01 \
-e TRANSPORTER=nats://nats:4222 \
registry.rocket.chat/microservices_accounts-service:latest

Authorization

{% hint style="info" %} Can be scaled to multiple containers {% endhint %}

Responsible for validate access to features

docker run \
--name authorization-service \
-e MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs01 \
-e TRANSPORTER=nats://nats:4222 \
registry.rocket.chat/microservices_authorization-service:latest

DDP Streamer

{% hint style="info" %} Can be scaled to multiple containers {% endhint %}

Web socket interface between server and clients

docker run \
--name ddp-streamer \
-e MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs01 \
-e TRANSPORTER=nats://nats:4222 \
registry.rocket.chat/microservices_ddp-streamer:latest

MongoDB Stream Hub

Receives real time data from MongoDB and emits that data to the system.

docker run \
--name mongodb-stream-hub \
-e MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs01 \
-e TRANSPORTER=nats://nats:4222 \
registry.rocket.chat/microservices_mongodb-stream-hub:latest

Presence

{% hint style="info" %} Can be scaled to multiple containers {% endhint %}

Controls and update users presence status.

docker run \
--name presence-service \
-e MONGO_URL=mongodb://mongo/rocketchat?replicaSet=rs01 \
-e TRANSPORTER=nats://nats:4222 \
registry.rocket.chat/microservices_presence-service:latest

Reverse proxy

Once all services are up and running the web socket connections should be targeted to "ddp-streamer" containers, the configuration depends on the reverse proxy you have set up, but you need to change the following routes:

• /sockjs
• /websocket

If using Kubernetes, an Ingress like the following can be used:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: ddp-streamer
spec:
  rules:
  - host: your-hostname.rocket.chat
    http:
      paths:
      - backend:
          serviceName: ddp-streamer
          servicePort: 3000
        path: /(sockjs|websocket)