Установка SQL REST Proxy сервиса

== 1. Описание сервиса ==

**SQL REST Proxy** — лёгкий REST-сервис на Python, разработанный как замена прямым вызовам SQL через ADODB.Connection в конфигурациях 1С, работающих на Linux. Поскольку COM-объекты и нативные ODBC-драйверы недоступны на Linux-платформе 1С:Предприятие, этот сервис позволяет выполнять произвольные SQL-запросы к внешним базам данных через стандартный HTTP-вызов из встроенного языка 1С.

4

5

**Поддерживаемые СУБД**

6

7

|=СУБД |=Драйвер |=Порт по умолчанию

8

|PostgreSQL|psycopg2 |5432

9

|Microsoft SQL Server|pymssql|1433

10

|MySQL |PyMySQL |3306

**Режим развёртывания**

15

Сервис запускается в Docker-контейнере и не требует установки каких-либо драйверов в хост-систему. Управление через docker-compose.

16

17

**Безопасность**

18

- Аутентификация по API-ключу (X-API-Key заголовок)

19

- HTTPS/TLS с поддержкой собственного сертификата

20

- Параметризованные запросы исключают SQL-инъекции

21

22

**Мониторинг**

23

Эндпоинт /metrics предоставляет метрики в формате Prometheus. Готовый конфиг prometheus.yml для сбора метрик включён в поставку. Эндпоинт /pools/stats возвращает детальную статистику по активным пулам соединений.

24

25

26

== 2. Установка через docker контейнер ==

27

28

29

Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):

30

31

> git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git

32

33

**Запуск**

34

Переходим в директорию сервиса

35

36

> cd p-skud-sql-proxy-service

37

38

Генерируем сертификаты

39

40

> bash generate_certs.sh

Копируем .env

> cp .env.example .env

45

46

И если требуется настраиваем под ваш контур .env

> nano .env

В файле можно изменить:

51

52

> API Key для аутентификации запросов

53

> API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46

54

55

> И порты работы Сервиса

56

> SERVICE_PORT=8443

57

> PROMETHEUS_PORT=9090

58

59

Поднимаем все сервисы из docker-compose.yml

60

61

> docker compose up -d

Проверка

> curl -k https://<server> :8443/health

66

67

== 3. Установка в виде сервиса ==

68

69

Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):

70

71

> git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git

72

73

При разворачивании без Docker:

74

75

~1. На сервере нужна совместимая версия Python, желательно Python 3.11.

76

2. Нужны системные библиотеки для Python-драйверов БД.

77

3. Нужно создать виртуальное окружение.

78

4. Нужно установить зависимости из `requirements.txt`.

79

5. Нужно создать TLS-сертификаты или указать корпоративные сертификаты.

80

6. Нужно запускать `uvicorn app.main:app` как обычную службу `systemd`

81

82

=== 3.1 Системные зависимости ===

83

84

Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.

85

86

Минимальный набор пакетов для онлайн-установки зависимостей:

87

88

> sudo apt update

89

> sudo apt install -y \

> python3 \

> python3-venv \

> python3-pip \

> python3-dev \

> build-essential \

> gcc \

> g++ \

> openssl \

> ca-certificates \

> freetds-dev \

> libpq-dev \

> default-libmysqlclient-dev \

> pkg-config

Пояснение:

- `freetds-dev` нужен для `pymssql`, который используется для MS SQL Server;

107

- `libpq-dev` полезен для PostgreSQL-зависимостей;

108

- `default-libmysqlclient-dev` и `pkg-config` могут понадобиться при сборке MySQL-зависимостей, хотя в проекте используется `PyMySQL`;

109

- `openssl` нужен для генерации сертификатов;

110

- `build-essential`, `gcc`, `g++`, `python3-dev` нужны, если какие-то wheels недоступны и зависимость собирается из исходников.

111

112

Если какие-то из пакетов недоступны необходимо добавить репозитории.

113

Например для Astra Linux Special Edition 1.8 x86-64:

114

115

> sudo nano /etc/apt/sources.list.d/astra.list

Содержимое:

> deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/main-repository/ 1.8_x86-64 main contrib non-free non-free-firmware

120

> deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/extended-repository/ 1.8_x86-64 main contrib non-free non-free-firmware

121

122

=== 3.2 Пользователь и каталоги ===

Создать каталоги:

> sudo mkdir -p /opt/sql-proxy

127

> sudo mkdir -p /etc/sql-proxy/certs

128

> sudo mkdir -p /var/lib/sql-proxy

129

> sudo mkdir -p /var/log/sql-proxy

130

131

Создать отдельного пользователя:

132

133

> sudo addgroup {{{--system sqlproxy }}}

134

> sudo adduser {{{--system --ingroup sqlproxy --home /var/lib/sql-proxy --no-create-home --shell /usr/sbin/nologin sqlproxy}}}

135

136

Дать права а каталоги:

137

138

> sudo chown -R root:root /opt/sql-proxy

139

> sudo chown -R root:sqlproxy /etc/sql-proxy

140

> sudo chown -R sqlproxy:sqlproxy /var/lib/sql-proxy

141

> sudo chown -R sqlproxy:sqlproxy /var/log/sql-proxy

142

143

> sudo chmod 755 /opt/sql-proxy

144

> sudo chmod 750 /etc/sql-proxy

145

> sudo chmod 750 /etc/sql-proxy/certs

146

> sudo chmod 750 /var/lib/sql-proxy

147

> sudo chmod 750 /var/log/sql-proxy

148

149

=== 3.3 Копирование проекта ===

150

151

Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:

app/

requirements.txt

.env.example

generate_certs.sh

После копирования:

Не делайте владельцем /opt/sql-proxy пользователя sqlproxy на постоянной основе. Для промышленной установки лучше держать код под root:root, а sqlproxy использовать только для запуска сервиса.

159

160

> sudo chown -R root:root /opt/sql-proxy

161

> sudo find /opt/sql-proxy -type d -exec chmod 755 {} \;

162

> sudo find /opt/sql-proxy -type f -exec chmod 644 {} \;

163

164

Сделайте скрипт `generate_certs.sh` исполняемым:

165

166

> sudo chmod 755 /opt/sql-proxy/generate_certs.sh

167

168

И переместите его в каталог /etc/sql-proxy/certs

169

170

Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов

171

172

> sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem

173

> sudo chmod 640 /etc/sql-proxy/certs/key.pem

174

> sudo chmod 644 /etc/sql-proxy/certs/cert.pem

175

176

=== 3.4 Создание виртуального окружения ===

177

178

> sudo python3 -m venv /opt/sql-proxy/venv

179

> sudo /opt/sql-proxy/venv/bin/python -m pip install {{{--upgrade}}} pip setuptools wheel

Права:

> sudo chown -R root:root /opt/sql-proxy/venv

184

> sudo chmod -R go-w /opt/sql-proxy/venv

185

186

187

=== 3.5 Онлайн-установка Python-зависимостей ===

188

189

Установка зависимостей:

190

191

> sudo /opt/sql-proxy/venv/bin/pip install -r /opt/sql-proxy/requirements.txt

192

193

Далее необходимо проверить, что основные модули импортируются:

194

195

> sudo /opt/sql-proxy/venv/bin/python -c "import fastapi, uvicorn, sqlalchemy, psycopg2, pymssql, pymysql; print('OK')"

196

197

198

3.6 Настройка конфигурации

199

200

В проекте есть `.env.example`. Для промышленного сервера лучше хранить конфигурацию в `/etc/sql-proxy/sql-proxy.env`, а не в каталоге приложения.

Создайте файл:

> sudo nano /etc/sql-proxy/sql-proxy.env

205

206

И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:

207

208

> API Key для аутентификации запросов

209

> API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46

210

211

> ## Ограничения##

212

> MAX_ROWS_LIMIT=10000

213

> DEFAULT_ROWS_LIMIT=1000

214

215

> ## Пул соединений##

> POOL_SIZE=10

> MAX_OVERFLOW=20

> POOL_TIMEOUT=30

> POOL_RECYCLE=3600

> POOL_PRE_PING=true

> ## Таймауты##

> QUERY_TIMEOUT=300

> CONNECTION_TIMEOUT=30

> ## SSL/TLS##

> SSL_ENABLED=true

> SSL_CERTFILE=/app/certs/cert.pem

229

> SSL_KEYFILE=/app/certs/key.pem

> ## Сервис##

> SERVICE_PORT=8443

> PROMETHEUS_PORT=9090

234

235

Далее назначим права:

236

237

> sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env

238

> sudo chmod 640 /etc/sql-proxy/sql-proxy.env

239

240

=== 3.6 Настройка запуска через systemd ===

Создадим unit:

> sudo nano /etc/systemd/system/sql-proxy.service

Содержимое файла:

> [Unit]

> Description=P-SKUD SQL REST Proxy Service

250

> After=network-online.target

251

> Wants=network-online.target

> [Service]

> Type=simple

> User=sqlproxy

> Group=sqlproxy

> WorkingDirectory=/opt/sql-proxy

259

> EnvironmentFile=/etc/sql-proxy/sql-proxy.env

260

> Environment=PYTHONUNBUFFERED=1

261

262

> {{{ ExecStart=/opt/sql-proxy/venv/bin/uvicorn app.main:app --host **IP_ВАШЕГО_СЕРВЕРА** --port 8443 --ssl-keyfile /etc/sql-proxy/certs/key.pem --ssl-certfile /etc/sql-proxy/certs/cert.pem }}}

> Restart=on-failure

> RestartSec=5

> TimeoutStartSec=30

> TimeoutStopSec=30

> NoNewPrivileges=true