From 5b84e1d66664186b0dbd1776f66f4e6eb25fcd69 Mon Sep 17 00:00:00 2001 From: Pierre Penhouet Date: Wed, 9 Aug 2023 17:40:30 +0200 Subject: [PATCH 1/2] add concentrator prerequisites --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 602337c..6a592a2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,16 @@ The build is based on Ubuntu 22.04 and will install all the required components. ## Prerequisites To be able to run the container you need : -* A x86-64 Linux host +* A x86-64 Linux host using one of these templates : + | Number of assets | vCPUs | RAM (Go) | Disk size (Go) | Sekoia concentrator settings | + |------------------|:------:|:---------:|:--------------:|:-------------------------------------------:| + | 1000 | 2 | 4 | 200 | MEMORY_MESSAGES=2000000 / DISK_SPACE=180g | + | 10 000 | 4 | 8 | 1000 | MEMORY_MESSAGES=5000000 / DISK_SPACE=980g | + | 50 000 | 6 | 16 | 5000 | MEMORY_MESSAGES=12000000 / DISK_SPACE=4980g | + + !!! info + These data are recommendations based on standards and observed averages on Sekoia.io, so they may change depending on use cases. + * Last version of Docker Engine. You will find all the installation process on the [official website](https://docs.docker.com/engine/install/) * INBOUND TCP or UDP flows opened between the systems/applications and the concentrator on the ports of your choice * OUTBOUND TCP flow opened towards intake.sekoia.io on port 10514 @@ -64,9 +73,11 @@ environment: - MEMORY_MESSAGES=100000 - DISK_SPACE=32g ``` -* `MEMORY_MESSAGES=100000` means the queue is allowed to store up to 100,000 messages in memory. Since in the image configuration the maximum value of a message is 20ko, 100,000 means 100,000 * 20,000 = 2Go +* `MEMORY_MESSAGES=100000` means the queue is allowed to store up to 100,000 messages in memory. For instance, if your message size is 20KB, then you will use 2GB of RAM memory (100,000 * 20KB = 2GB). * `DISK_SPACE=32g` means the queue is allowed to store on disk up to 32 giga of messages. +[Here](#prerequisites) you will find recommendations to set these variables based on the number of input assets. You can also define your own values, which should be chosen according to your virtual machine's template. + #### Ports Ports in Docker are used to perform port forwarding between the host running the container and the container itself. ```yaml From f25c1a5de707eaeca788228ccfa564bf94bd677f Mon Sep 17 00:00:00 2001 From: Pierre Penhouet Date: Thu, 10 Aug 2023 08:39:41 +0200 Subject: [PATCH 2/2] fix typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6a592a2..90e4115 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ To catch incoming events and apply the right intake key, this image processes ea The build is based on Ubuntu 22.04 and will install all the required components. ## Prerequisites -To be able to run the container you need : +To be able to run the container you need: -* A x86-64 Linux host using one of these templates : +* A x86-64 Linux host using one of these templates: | Number of assets | vCPUs | RAM (Go) | Disk size (Go) | Sekoia concentrator settings | |------------------|:------:|:---------:|:--------------:|:-------------------------------------------:| | 1000 | 2 | 4 | 200 | MEMORY_MESSAGES=2000000 / DISK_SPACE=180g | @@ -76,7 +76,7 @@ environment: * `MEMORY_MESSAGES=100000` means the queue is allowed to store up to 100,000 messages in memory. For instance, if your message size is 20KB, then you will use 2GB of RAM memory (100,000 * 20KB = 2GB). * `DISK_SPACE=32g` means the queue is allowed to store on disk up to 32 giga of messages. -[Here](#prerequisites) you will find recommendations to set these variables based on the number of input assets. You can also define your own values, which should be chosen according to your virtual machine's template. +[Here](#prerequisites) you will find recommendations to set these variables based on the number of assets. You can also define your own values, which should be chosen according to your virtual machine's template. #### Ports Ports in Docker are used to perform port forwarding between the host running the container and the container itself.