Skip to content

Commit 24b4e20

Browse files
committed
Merge branch 'requirements' into 'master'
updated server requirements See merge request CodeScoring/docs!617
2 parents 4194b67 + a9d6f67 commit 24b4e20

2 files changed

Lines changed: 53 additions & 16 deletions

File tree

docs/on-premise/server-requirements.en.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,44 @@ Installation of the on-premise version is possible on **GNU/Linux** distribution
1111

1212
## Server resources
1313

14-
Minimum requirements to run: **16Gb RAM, 8 CPU cores**.
14+
### Baseline requirements for production installation
1515

16-
Recommended requirements: **32Gb RAM, 16 CPU cores**.
16+
- Minimum supported resources for application servers: **32Gb RAM, 16 CPU cores**.
1717

18-
Additionally, make sure that the space where the directory with docker data is located (data-root docker, by default /var) has at least **20Gb of memory**. At the same time, for smooth operation of the system, it is necessary to reserve **disk space based on the size of the analyzed repositories, multiplied by three**.
18+
!!! warning "Resource recommendation"
19+
For production installations, it is not recommended to go below these values, as this may lead to performance degradation and unstable platform operation.
20+
21+
### Data services requirements
22+
23+
- **PostgreSQL**: from **32Gb RAM**;
24+
- **Redis**: from **2Gb RAM**;
25+
- `shm` size for **PostgreSQL**: at least **4Gb**;
26+
- If an [external database](/on-premise/external-database.en/) is used, **PostgreSQL** is recommended to have at least **64Gb RAM**.
27+
28+
### Storage requirements
29+
30+
- For **CodeScoring.SCA** with VCS projects, calculate `analysis-root` volume based on the size of analyzed repositories multiplied by three;
31+
- For **CodeScoring.SCA** with CLI projects and for **CodeScoring.OSA**, there is no mandatory `×3` storage formula;
32+
- For the offline installation allocate at least **300Gb** for the [CodeScoring Index](/feeds/index.en/) database, with additional capacity reserved for further updates.
33+
34+
### Example of a high-load installation
35+
36+
- Database server: **96Gb RAM, 24 CPU cores**;
37+
- Application server: **192Gb RAM, 48 CPU cores**.
1938

2039
## Supported versions of external services
2140

2241
When using your own database instances, make sure that their versions meet the requirements below:
2342

2443
### Redis
2544

26-
- Minimum version: **7.0.0**
27-
- Tested version: **7.4.6**
45+
- Minimum version: **7.0.0**;
46+
- Tested version: **7.4.6**.
2847

2948
### PostgreSQL
3049

31-
- Minimum version: **13.x** (any minor)
32-
- Tested version: **13.21**
50+
- Minimum version: **15.x** (any minor);
51+
- Tested version: **15.15**.
3352

3453
Using other major branches does not guarantee correct results and may lead to errors or performance degradation.
3554

@@ -149,4 +168,4 @@ An example of a request from the platform to the Index API with data on hashes o
149168
"sha256": "e01c736a351633932e8b3ed041e553f67968e07d35d2c153b02b60e910a8c433"
150169
}
151170
]
152-
```
171+
```

docs/on-premise/server-requirements.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,44 @@ hide:
1111

1212
## Ресурсы сервера
1313

14-
Минимальные требования для запуска: **16Gb RAM, 8 ядер CPU**.
14+
### Базовые требования для рабочей среды
1515

16-
Рекомендуемые требования: **32Gb RAM, 16 ядер CPU**.
16+
- Минимально допустимые требования для серверов приложения: **32Gb RAM, 16 ядер CPU**.
1717

18-
Дополнительно стоит убедиться, что раздел, на котором размещается директория с данными docker (data-root docker, по умолчанию `/var`), имеет **не менее 20Gb** памяти. При этом для бесперебойного функционирования системы необходимо **резервировать дисковое пространство из расчета размера анализируемых репозиториев, умноженного на три**.
18+
!!! warning "Рекомендация по ресурсам"
19+
Для установки в рабочей среде не рекомендуется опускаться ниже указанных значений, так как это может приводить к деградации производительности и нестабильной работе платформы.
20+
21+
### Требования к сервисам данных
22+
23+
- **PostgreSQL**: от **32Gb RAM**;
24+
- **Redis**: от **2Gb RAM**;
25+
- Размер `shm` для **PostgreSQL**: не менее **4Gb**;
26+
- При использовании [внешней базы данных](/on-premise/external-database/) для **PostgreSQL** рекомендуется от **64Gb RAM**.
27+
28+
### Требования к хранилищу
29+
30+
- Для модуля **CodeScoring.SCA** при использовании VCS-проектов объем тома `analysis-root` рассчитывается из размера анализируемых репозиториев, умноженного на три;
31+
- Для модуля **CodeScoring.SCA** при использовании CLI-проектов и для модуля **CodeScoring.OSA** отдельные требования по формуле `×3` не предъявляются;
32+
- При оффлайн-установке для базы данных [CodeScoring Index](/feeds/) необходимо выделять от **300Gb** с запасом под последующие обновления;
33+
34+
### Пример высоконагруженной инсталляции
35+
36+
- Сервер базы данных: **96Gb RAM, 24 ядер CPU**;
37+
- Сервер приложений: **192Gb RAM, 48 ядер CPU**.
1938

2039
## Поддерживаемые версии внешних сервисов
2140

2241
При использовании собственных экземпляров баз данных убедитесь, что их версии соответствуют требованиям ниже:
2342

2443
### Redis
2544

26-
- Минимальная версия: **7.0.0**
27-
- Протестированная версия: **7.4.6**
45+
- Минимальная версия: **7.0.0**;
46+
- Протестированная версия: **7.4.6**.
2847

2948
### PostgreSQL
3049

31-
- Минимальная версия: **13.x** (любая минорная)
32-
- Протестированная версия: **13.21**
50+
- Минимальная версия: **15.x** (любая минорная);
51+
- Протестированная версия: **15.15**.
3352

3453
Использование других мажорных веток не гарантирует корректный результат и может приводить к ошибкам или снижению производительности.
3554

@@ -150,4 +169,3 @@ hide:
150169
}
151170
]
152171
```
153-

0 commit comments

Comments
 (0)