Quickstart¶
The goal of this guide is to perform a step-by-step installation of a complete Reemo platform. At the end of this guide, you will have a fully functional platform ready for testing, auditing, or certification. The environments deployed in this guide are: INFRA, PROVISION, RELAYWS.
1. Prerequisites¶
1 “work” machine to run Ansible.
3 target servers/VMs: infra, provision, relayws.
SSH access from the work machine to each target.
Access to Ansible roles: reemo-infra, reemo-provision, reemo-relayws.
A valid Reemo instance license key.
A Reemo Docker registry account.
2. Minimum resources¶
INFRA: 4 vCPU, 8 GB RAM, 100 GB disk.
PROVISION: 8 vCPU, 16 GB RAM, 100 GB disk.
RELAYWS: 8 vCPU, 8 GB RAM, 50 GB disk.
Supported Linux OS (Ubuntu/Debian/RedHat).
3. Preparing the work machine (Ansible)¶
The work machine is responsible for running Ansible playbooks targeting the servers.
Install Python, Docker, Ansible, and dependencies.
Red Hat / RockyLinux¶
yum install ansible-core
yum install -y python3-pip
pip3 install docker
ansible-galaxy collection install community.docker
ansible-galaxy collection install community.crypto
Warning
On RockyLinux 9, you must use community.docker >= 3.10.2.
If necessary, force the upgrade:
ansible-galaxy collection install community.docker --upgrade
Ubuntu¶
apt install ansible
apt install python3-docker
ansible-galaxy collection install community.docker
ansible-galaxy collection install community.crypto
4. Preparing target servers¶
Prepare 3 servers/VMs and configure SSH access from your work machine.
Server |
CPU |
RAM |
Disk |
|---|---|---|---|
INFRA |
4 |
8 |
100G |
PROVISION |
8 |
16 |
100G |
RELAYWS |
8 |
8 |
50G |
5. Deployment Files¶
This step is performed on the work machine.
Use the wizard below to generate the configuration files and initialization commands.
6. Deployment¶
From the reemo-deploy directory:
# 1) INFRA with init DB + install docker
ansible-playbook -i inventory.yml playbooks/infra.yml --extra-vars "INIT_DB=true INSTALL_DOCKER=true"
# 2) PROVISION with install docker
ansible-playbook -i inventory.yml playbooks/provision.yml --extra-vars "INSTALL_DOCKER=true"
# 3) RELAYWS with install docker
ansible-playbook -i inventory.yml playbooks/relayws.yml --extra-vars "INSTALL_DOCKER=true"
If any changes are made to the inventory, redeploy updates with:
# 1) Update INFRA
ansible-playbook -i inventory.yml playbooks/infra.yml
# 2) Update PROVISION
ansible-playbook -i inventory.yml playbooks/provision.yml
# 3) Update RELAYWS
ansible-playbook -i inventory.yml playbooks/relayws.yml
8. Verification¶
Active containers on each host:
docker ps
Portal access:
Users:
https://portal.domain.tldAdmin:
https://portal-admin.domain.tld
Admin IP restriction applied: verify
PORTALADMIN_URL_RESTRICT_IP.Traefik certificates correctly mounted and valid.
9. Accessing the admin portal¶
Navigate to https://portal-admin.domain.tld/register/admin to register the first instance administrator account.
With this account, you can now log in and manage the Reemo platform.