Roles Description and Installation#
Please review carefully this sections before attempting to install Carbonio on a Single-Server or on a Multi-Node infrastructure.
Carbonio is made of Roles#
A Carbonio infrastructure is created with the installation of some Roles.
A Role is a Carbonio functionality that is considered atomic and consists of one or more packages.
As we will see, it’s possible to install a single role on a dedicated node or group multiple roles according to affinity rules.
Although this is not a suggested or supported scenario, it would be technically possible to install almost all Carbonio Roles on a single virtual machine.
The possibility of installation by roles allows you to design architectures that precisely correspond to the requirements and purposes of your infrastructure.
The roles of Carbonio#
We can group the available Carbonio Roles into 3 macro categories:
Infrastructure Roles, which are mandatory in any Carbonio installation
Service Roles broaden the functionality provided by Carbonio
This is the list of roles that make up a Carbonio installation.
Note
Postgres, Pgpool, Grafana, Zookeper, and Kafka are third-party software that are installed from their respective official repositories.
Type of Role: Infrastructure
Packages:
service-discover-server
carbonio-directory-server
carbonio-message-broker
Type of Role: Infrastructure
Packages:
service-discover-server
Type of Role: Infrastructure
Packages:
postgresql
carbonio-notification-push-db
carbonio-message-dispatcher-db
carbonio-ws-collaboration-db
Type of Role: Infrastructure
Packages:
pgpool2
carbonio-files-db
carbonio-mailbox-db
carbonio-docs-connector-db
carbonio-tasks-db
service-discover-agent
Type of Role: Infrastructure
Packages:
carbonio-proxy
carbonio-webui
carbonio-files-ui
carbonio-chats-ui
carbonio-user-management
carbonio-tasks-ui
carbonio-ws-collaboration-ui
carbonio-avdb-updater
service-discover-agent
Type of Role: Infrastructure
Packages:
carbonio-mta
service-discover-agent
Type of Role: Service role
Packages:
carbonio-advanced
carbonio-storages
service-discover-agent
Type of Role: Service role
Packages:
carbonio-files
service-discover-agent
Note
The Files Role can be installed without the Docs and Editor and Preview Roles.
Type of Role: Service role
Packages:
carbonio-docs-connector
carbonio-docs-editor
service-discover-agent
Type of Role: Service role
Packages:
carbonio-preview
service-discover-agent
Type of Role: Service role
Packages:
carbonio-tasks
service-discover-agent
Type of Role: Service role
Packages:
carbonio-videoserver
carbonio-videoserver-recorder
service-discover-agent
Type of Role: Service role
Packages:
carbonio-prometheus
grafana
service-discover-agent
Type of Role: Service role
Packages:
ZooKeeper
Apache Kafka
Type of Role: Service role
Packages:
carbonio-directory-server
Type of Role: Service role
Packages:
carbonio-message-dispatcher
carbonio-ws-collaboration
carbonio-notification-push
carbonio-push-connector
service-discover-agent
Type of Role: Service role
Packages:
carbonio-videoserver-advanced
carbonio-videorecorder
service-discover-agent
How to install Roles#
Before presenting each Role and the tasks necessary for their correct installation, please review these important remarks:
-
While the overall procedure is the same for both Ubuntu and RHEL 8, the actual commands and file paths may differ on the two operating system, so pay attention that you execute the correct command on the correct files and operating system. The commands that differ are separated as follows. Click the Ubuntu or RHEL tab according to the Operating System on which you are installing Carbonio.
# <command to be executed on Ubuntu systems>
# <command to be executed on Red Hat systems>
All the commands that are mentioned in this installation procedure must be executed as the
root
user.In case you experience some issues during the installation, please refer to Section CLI Commands, in which you can find helpful commands.
When the installation process has successfully finished, you can access Carbonio's GUI using a browser: directions can be found in Section Access to the Web Interface.
You must start with the installation of the Database Role, followed by the Mesh and Directory and Database Connector. Then you can proceed with the other infrastructure Roles and finally with all other Roles.