Help:Introduction: Difference between revisions

From Svacer Wiki
VisualWikitext
No edit summary
(add '8GB for migration' disclaimer)
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Help]]
[[Category:Help]]
== Введение ==
== Введение ==
Сервер историй '''Svacer''' ('''''Svace Server''''') предназначен для хранения и обработки результатов работы статического анализатора Svace. Он разработан с целью заменить старый сервер историй, встроенный в анализатор Svace.  
 
Допускается одновременное использование старого и нового серверов.
Svacer предназначен для хранения и обработки результатов статического анализатора Svace и других анализаторов, поддерживающих формат [[Help:Sarif#Загрузка_на_сервер_из_SARIF|SARIF]].
 
Svacer состоит из двух исполняемых файлов: сервера и клиента
* Сервер используется для хранения и обработки результатов анализа, для [[Help:Installation|запуска]] нужен PostgreSQL с созданной БД
* Клиент — для взаимодействия с сервером, для него никакие зависимости не требуются
 
Запущенный сервер Svacer предоставляет [[Help:UI_manual#Авторизация_в_пользовательском_интерфейсе_сервера_Svacer|web-UI]] и [[Help:Public_API|REST API]] для взаимодействия.  
 
В клиенте Svacer доступны команды для [[Help:Import_from_Svace|импорта]] предупреждений, [[Help:Import_from_Svace#Загрузка_данных_на_сервер|загрузки]] их на сервер и прочего взаимодействия с сервером.


=== Термины ===
=== Термины ===
Line 8: Line 16:
{| class="wikitable"
{| class="wikitable"
|-
|-
| ''Project''
| Project
| Проект, подлежащий анализу. По умолчанию именем проекта считается имя директории, в которой был запущен ''svace build'' и ''svace analyze''.
| Проект, подлежащий анализу. По умолчанию именем проекта считается имя директории, в которой был запущен ''svace build'' и ''svace analyze''.
На сервере проект содержит в себе несколько '''branch''' с результатами работы анализатора
На сервере проект содержит в себе несколько веток с результатами работы анализатора
|-
|-
| ''Branch (ветка)''
| Branch (ветка)
| Ветка в проекте с результатами работы анализатора. По умолчанию проект имеет одну ветку — master
| Ветка в проекте с результатами работы анализатора. По умолчанию — master
|-
|-
| ''Snapshot (снимок)''
| Snapshot (снимок)
| Результат работы ''svace analyze'', импортированный в промежуточное хранилище или на сервер. Содержит:
| Результат работы ''svace analyze'', импортированный в промежуточное хранилище или на сервер. Содержит:
* имя проекта;
* имя проекта;
Line 23: Line 31:
* вспомогательная информация для навигации по исходникам;
* вспомогательная информация для навигации по исходникам;
* дополнительные данные;
* дополнительные данные;
Допускается импортирование снимков без исходного кода и дополнительной информации
Допускается импорт снимков без исходного кода и дополнительной информации
|-
|-
| ''Marker (маркер, предупреждение)''
| Marker (маркер, предупреждение)
| Предупреждение от Svace с информацией о позиции в исходном файле
| Предупреждение от статического анализатора с информацией о позиции в исходном файле
|-
|-
| ''Svacer''
| Разметка
| Svace History Server, а также исполняемый файл, содержащий код сервера
|-
| ''Разметка''
| Проставление статуса маркера с опциональным добавлением комментария
| Проставление статуса маркера с опциональным добавлением комментария
|}
|}
Line 39: Line 44:
{| class="wikitable"
{| class="wikitable"
|-  
|-  
| '''bin/svacer<br>bin/svacer.exe'''
| bin/svacer-server<br>bin/svacer-server.exe
| Бинарный файл сервера и утилита для импортирования результатов. Режим работы зависит от аргументов
| Бинарный файл сервера
|-
|-
| '''support/svace-migration/svace-migration.jar'''
| bin/svacer<br>bin/svacer.exe
| Утилита подготовки данных для импорта из старого сервера историй.
| Бинарный файл клиента
Требует JDK для запуска. Может использоваться JDK из состава дистрибутива Svace
|-
|-
| '''extra/docker-compose*.yml''' || Docker-compose файлы для запуска БД PostgreSQL и Svacer в docker-контейнерах
| extra/docker-compose*.yml  
|-
| docker-compose файлы для запуска БД PostgreSQL и Svacer в docker-контейнерах
| '''integrations/vscode''' || Расширение для Visual Studio Code и документация на него
|}
|}


Line 55: Line 58:
{| class="wikitable"
{| class="wikitable"
|-  
|-  
| PostgreSQL
| PostgreSQL версии 10 и выше. Нужен только для сервера
версии не ниже 10-й
| Параметры подключения определяются при запуске сервера аргументом '''--pg''' или переменной окружения SVACER_PG_URL. По умолчанию: '''postgres://svace:svace@0.0.0.0:5432/svace'''<br/>
| Параметры подключения определяются аргументом при запуске сервера или переменной окружения SVACER_PG_URL. По умолчанию, используется следующий connect URL:
Можно запускать PostgreSQL в docker-контейнере, но в production мы рекомендуем использовать выделенный сервер
'''postgres://svace:svace@0.0.0.0:5432/svace'''<br>
Можно использовать PostgreSQL в docker-контейнере.<br>
'''Настоятельно рекомендуем''' использовать выделенный сервер для хранения БД, особенно в production
|-
|-
| libc.so<br>libpthread.so<br>libdl.so<br>linux-vdso.so
| libc.so<br>libpthread.so<br>libdl.so<br>linux-vdso.so
| Серверная часть написана на Go с CGO_ENABLED=1 ввиду необходимости читать sqlite-файлы из результатов работы анализатора Svace
| Серверная часть написана на Go с CGO_ENABLED=1 ввиду необходимости читать sqlite-файлы из результатов работы анализатора Svace
|-
|-
| Выделенная директория для хранения object storage
| Директория для хранения object storage
| Сервер использует встроенную key-value database для хранения информации об исходном коде: контент-файлов и вспомогательной информации для навигации
| Сервер использует встроенную key-value database для хранения информации об исходном коде: контент-файлов и вспомогательной информации для навигации
|-
|-
| svace
| Svace
| Для импорта данных на сервер историй требуется наличие Svace на хосте, откуда происходит импорт. Svace используется для получения информации из .svace-dir
| Нужен для импорта результатов анализа из .svace-dir. При этом лицензия на Svace нужна только для анализа, для импорта она не требуется
|}
|}


Line 78: Line 78:
|-
|-
| 3002
| 3002
| Используется для предоставления gRPC API.
| Используется для предоставления gRPC API (внутренний API для загрузки данных на сервер)
gRPC API является внутренним и предназначен для загрузки данных на сервер
|-
|-
| 8080
| 8080
| Используется для предоставления REST API и web-сервера для предоставления web-UI
| Используется для REST API и web-сервера для предоставления web-UI
|}
 
=== Системные требования ===
{| class="wikitable"
|-
| CPU
| x86-64. Для больших проектов рекомендуется не менее 8 ядер
|-
| RAM
| От 4 ГБ. При обновлении между версиями лучше не меньше 8 ГБ. Для больших проектов — 16+ ГБ
|-
| HDD
| От 1 ГБ до нескольких ТБ при хранении множества снимков больших проектов
|-
| OS
|
* Ubuntu 18 и выше
* Debian 10 и выше
* RHEL/CentOS 7 и 8
* Astra Linux Special Edition 1.7, базовый уровень защищенности
* Alt Linux p8 и выше
* Microsoft Windows 10
|-
| Browser
|
В качестве клиента для веб-интерфейса Svacer
* Chrome 103 и выше
* Firefox 100 и выше
* Opera 89 и выше
* Safari 16 и выше
* Edge 103 и выше
|}
|}

Revision as of 15:27, 4 July 2024

Введение

Svacer предназначен для хранения и обработки результатов статического анализатора Svace и других анализаторов, поддерживающих формат SARIF.

Svacer состоит из двух исполняемых файлов: сервера и клиента

  • Сервер используется для хранения и обработки результатов анализа, для запуска нужен PostgreSQL с созданной БД
  • Клиент — для взаимодействия с сервером, для него никакие зависимости не требуются

Запущенный сервер Svacer предоставляет web-UI и REST API для взаимодействия.

В клиенте Svacer доступны команды для импорта предупреждений, загрузки их на сервер и прочего взаимодействия с сервером.

Термины

Project Проект, подлежащий анализу. По умолчанию именем проекта считается имя директории, в которой был запущен svace build и svace analyze.

На сервере проект содержит в себе несколько веток с результатами работы анализатора

Branch (ветка) Ветка в проекте с результатами работы анализатора. По умолчанию — master
Snapshot (снимок) Результат работы svace analyze, импортированный в промежуточное хранилище или на сервер. Содержит:
  • имя проекта;
  • имя ветки;
  • результаты анализа (предупреждения);
  • исходники, которые были включены в build, на котором производился анализ;
  • вспомогательная информация для навигации по исходникам;
  • дополнительные данные;

Допускается импорт снимков без исходного кода и дополнительной информации

Marker (маркер, предупреждение) Предупреждение от статического анализатора с информацией о позиции в исходном файле
Разметка Проставление статуса маркера с опциональным добавлением комментария

Состав дистрибутива

bin/svacer-server
bin/svacer-server.exe 		Бинарный файл сервера
bin/svacer
bin/svacer.exe 		Бинарный файл клиента
extra/docker-compose*.yml docker-compose файлы для запуска БД PostgreSQL и Svacer в docker-контейнерах

Зависимости

PostgreSQL версии 10 и выше. Нужен только для сервера Параметры подключения определяются при запуске сервера аргументом --pg или переменной окружения SVACER_PG_URL. По умолчанию: postgres://svace:svace@0.0.0.0:5432/svace

Можно запускать PostgreSQL в docker-контейнере, но в production мы рекомендуем использовать выделенный сервер

libc.so
libpthread.so
libdl.so
linux-vdso.so 		Серверная часть написана на Go с CGO_ENABLED=1 ввиду необходимости читать sqlite-файлы из результатов работы анализатора Svace
Директория для хранения object storage Сервер использует встроенную key-value database для хранения информации об исходном коде: контент-файлов и вспомогательной информации для навигации
Svace Нужен для импорта результатов анализа из .svace-dir. При этом лицензия на Svace нужна только для анализа, для импорта она не требуется

Используемые порты

Приведены значения по умолчанию. Все значения могут быть переопределены.

3002 Используется для предоставления gRPC API (внутренний API для загрузки данных на сервер)
8080 Используется для REST API и web-сервера для предоставления web-UI

Системные требования

CPU x86-64. Для больших проектов рекомендуется не менее 8 ядер
RAM От 4 ГБ. При обновлении между версиями лучше не меньше 8 ГБ. Для больших проектов — 16+ ГБ
HDD От 1 ГБ до нескольких ТБ при хранении множества снимков больших проектов
OS
  • Ubuntu 18 и выше
  • Debian 10 и выше
  • RHEL/CentOS 7 и 8
  • Astra Linux Special Edition 1.7, базовый уровень защищенности
  • Alt Linux p8 и выше
  • Microsoft Windows 10
Browser

В качестве клиента для веб-интерфейса Svacer

  • Chrome 103 и выше
  • Firefox 100 и выше
  • Opera 89 и выше
  • Safari 16 и выше
  • Edge 103 и выше
Retrieved from "https://svacer.ispras.ru/mediawiki/index.php?title=Help:Introduction&oldid=2048"