Перейти к содержимому

Исходный код вики Установка SQL REST Proxy сервиса

Версия 14.1 от PROSTO:СКУД на 2026/07/22 08:52
Скрыть последних авторов
PROSTO:СКУД 10.1 1 == 1. Описание сервиса ==
2
PROSTO:СКУД 2.1 3 **SQL REST Proxy** — лёгкий REST-сервис на Python, разработанный как замена прямым вызовам SQL через ADODB.Connection в конфигурациях 1С, работающих на Linux. Поскольку COM-объекты и нативные ODBC-драйверы недоступны на Linux-платформе 1С:Предприятие, этот сервис позволяет выполнять произвольные SQL-запросы к внешним базам данных через стандартный HTTP-вызов из встроенного языка 1С.
PROSTO:СКУД 1.1 4
PROSTO:СКУД 2.1 5 **Поддерживаемые СУБД**
6
PROSTO:СКУД 10.1 7 |=СУБД     |=Драйвер               |=Порт по умолчанию
8 |PostgreSQL|psycopg2           |5432
PROSTO:СКУД 7.1 9 |Microsoft SQL Server|pymssql|1433
PROSTO:СКУД 10.1 10 |MySQL     |PyMySQL               |3306
PROSTO:СКУД 7.1 11
12
13
PROSTO:СКУД 2.1 14 **Режим развёртывания**
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
PROSTO:СКУД 10.1 25
26 == 2. Установка через docker контейнер ==
27
28
PROSTO:СКУД 9.1 29 Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
PROSTO:СКУД 7.1 30
PROSTO:СКУД 13.1 31 > git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
PROSTO:СКУД 2.1 32
33 **Запуск**
34 Переходим в директорию сервиса
35
PROSTO:СКУД 13.1 36 > cd p-skud-sql-proxy-service
PROSTO:СКУД 1.1 37
PROSTO:СКУД 3.1 38 Генерируем сертификаты
PROSTO:СКУД 4.1 39
PROSTO:СКУД 13.1 40 > bash generate_certs.sh
PROSTO:СКУД 1.1 41
PROSTO:СКУД 2.1 42 Копируем .env
PROSTO:СКУД 4.1 43
PROSTO:СКУД 13.1 44 > cp .env.example .env
PROSTO:СКУД 3.1 45
PROSTO:СКУД 2.1 46 И если требуется настраиваем под ваш контур .env
PROSTO:СКУД 4.1 47
PROSTO:СКУД 13.1 48 > nano .env
PROSTO:СКУД 3.1 49
PROSTO:СКУД 1.1 50 В файле можно изменить:
PROSTO:СКУД 4.1 51
PROSTO:СКУД 13.1 52 > API Key для аутентификации запросов
53 > API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
PROSTO:СКУД 2.1 54
PROSTO:СКУД 13.1 55 > И порты работы Сервиса
56 > SERVICE_PORT=8443
57 > PROMETHEUS_PORT=9090
PROSTO:СКУД 1.1 58
PROSTO:СКУД 2.1 59 Поднимаем все сервисы из docker-compose.yml
PROSTO:СКУД 4.1 60
PROSTO:СКУД 13.1 61 > docker compose up -d
PROSTO:СКУД 2.1 62
63 Проверка
PROSTO:СКУД 4.1 64
PROSTO:СКУД 13.1 65 > curl -k https://<server> :8443/health
PROSTO:СКУД 10.1 66
67 == 3. Установка в виде сервиса ==
68
69 Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
70
PROSTO:СКУД 13.1 71 > git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
PROSTO:СКУД 10.1 72
PROSTO:СКУД 11.1 73 При разворачивании без Docker необходимо:
74 1. На сервере нужна совместимая версия Python, желательно Python 3.11.
75 2. Нужны системные библиотеки для Python-драйверов БД.
76 3. Нужно создать виртуальное окружение.
77 4. Нужно установить зависимости из `requirements.txt`.
78 5. Нужно создать TLS-сертификаты или указать корпоративные сертификаты.
79 6. Нужно запускать `uvicorn app.main:app` как обычную службу `systemd`
PROSTO:СКУД 10.1 80
PROSTO:СКУД 11.1 81 === 3.1 Системные зависимости===
82
83 Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
84
PROSTO:СКУД 10.2 85 Минимальный набор пакетов для онлайн-установки зависимостей:
86
PROSTO:СКУД 13.1 87 > sudo apt update
88 > sudo apt install -y \
89 > python3 \
90 > python3-venv \
91 > python3-pip \
92 > python3-dev \
93 > build-essential \
94 > gcc \
95 > g++ \
96 > openssl \
97 > ca-certificates \
98 > freetds-dev \
99 > libpq-dev \
100 > default-libmysqlclient-dev \
101 > pkg-config
PROSTO:СКУД 10.2 102
103 Пояснение:
104
105 - `freetds-dev` нужен для `pymssql`, который используется для MS SQL Server;
106 - `libpq-dev` полезен для PostgreSQL-зависимостей;
107 - `default-libmysqlclient-dev` и `pkg-config` могут понадобиться при сборке MySQL-зависимостей, хотя в проекте используется `PyMySQL`;
108 - `openssl` нужен для генерации сертификатов;
109 - `build-essential`, `gcc`, `g++`, `python3-dev` нужны, если какие-то wheels недоступны и зависимость собирается из исходников.
110
PROSTO:СКУД 11.1 111 Если какие-то из пакетов недоступны необходимо добавить репозитории.
PROSTO:СКУД 10.2 112 Например для Astra Linux Special Edition 1.8 x86-64:
PROSTO:СКУД 13.1 113 > sudo nano /etc/apt/sources.list.d/astra.list
PROSTO:СКУД 11.1 114 Содержимое:
PROSTO:СКУД 13.1 115 > deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/main-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
116 > deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/extended-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
PROSTO:СКУД 11.1 117
118 === 3.2 Пользователь и каталоги===
119
120 Создать каталоги:
121
PROSTO:СКУД 13.1 122 > sudo mkdir -p /opt/sql-proxy
123 > sudo mkdir -p /etc/sql-proxy/certs
124 > sudo mkdir -p /var/lib/sql-proxy
125 > sudo mkdir -p /var/log/sql-proxy
PROSTO:СКУД 11.1 126
127 Создать отдельного пользователя:
128
PROSTO:СКУД 13.1 129 > sudo addgroup --system sqlproxy
130 > sudo adduser \
131 > --system \
132 > --ingroup sqlproxy \
133 > --home /var/lib/sql-proxy \
134 > --no-create-home \
135 > --shell /usr/sbin/nologin \
136 > sqlproxy
PROSTO:СКУД 11.1 137
138 Дать права а каалоги:
139
PROSTO:СКУД 13.1 140 > sudo chown -R root:root /opt/sql-proxy
141 > sudo chown -R root:sqlproxy /etc/sql-proxy
142 > sudo chown -R sqlproxy:sqlproxy /var/lib/sql-proxy
143 > sudo chown -R sqlproxy:sqlproxy /var/log/sql-proxy
PROSTO:СКУД 11.1 144
PROSTO:СКУД 13.1 145 > sudo chmod 755 /opt/sql-proxy
146 > sudo chmod 750 /etc/sql-proxy
147 > sudo chmod 750 /etc/sql-proxy/certs
148 > sudo chmod 750 /var/lib/sql-proxy
149 > sudo chmod 750 /var/log/sql-proxy
PROSTO:СКУД 11.1 150
151 === 3.3 Копирование проекта===
152
153 Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
154 app/
155 requirements.txt
156 .env.example
157 generate_certs.sh
158
159 После копирования:
160 Не делайте владельцем /opt/sql-proxy пользователя sqlproxy на постоянной основе. Для промышленной установки лучше держать код под root:root, а sqlproxy использовать только для запуска сервиса.
161
PROSTO:СКУД 13.1 162 > sudo chown -R root:root /opt/sql-proxy
163 > sudo find /opt/sql-proxy -type d -exec chmod 755 {} \;
164 > sudo find /opt/sql-proxy -type f -exec chmod 644 {} \;
PROSTO:СКУД 11.1 165
166 Сделайте скрипт `generate_certs.sh` исполняемым:
167
PROSTO:СКУД 13.1 168 > sudo chmod 755 /opt/sql-proxy/generate_certs.sh
PROSTO:СКУД 11.1 169
170 И переместите его в каталог /etc/sql-proxy/certs
171
PROSTO:СКУД 12.1 172 Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов
PROSTO:СКУД 13.1 173 > sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem
174 > sudo chmod 640 /etc/sql-proxy/certs/key.pem
175 > sudo chmod 644 /etc/sql-proxy/certs/cert.pem
PROSTO:СКУД 12.1 176
PROSTO:СКУД 11.1 177 === 3.4 Создание виртуального окружения===
178
PROSTO:СКУД 13.1 179 > sudo python3 -m venv /opt/sql-proxy/venv
180 > sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
PROSTO:СКУД 11.1 181
182 Права:
183
PROSTO:СКУД 13.1 184 > sudo chown -R root:root /opt/sql-proxy/venv
185 > sudo chmod -R go-w /opt/sql-proxy/venv
PROSTO:СКУД 11.1 186
187
188 === 3.5 Онлайн-установка Python-зависимостей===
189
190 Установка зависимостей:
191
PROSTO:СКУД 13.1 192 > sudo /opt/sql-proxy/venv/bin/pip install -r /opt/sql-proxy/requirements.txt
PROSTO:СКУД 11.1 193
194 Далее необходимо проверить, что основные модули импортируются:
195
PROSTO:СКУД 13.1 196 > sudo /opt/sql-proxy/venv/bin/python -c "import fastapi, uvicorn, sqlalchemy, psycopg2, pymssql, pymysql; print('OK')"
PROSTO:СКУД 11.1 197
198
PROSTO:СКУД 12.1 199 3.6 Настройка конфигурации
200
201 В проекте есть `.env.example`. Для промышленного сервера лучше хранить конфигурацию в `/etc/sql-proxy/sql-proxy.env`, а не в каталоге приложения.
202
203 Создайте файл:
204
PROSTO:СКУД 13.1 205 > sudo nano /etc/sql-proxy/sql-proxy.env
PROSTO:СКУД 12.1 206
207 И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:
PROSTO:СКУД 13.1 208 > API Key для аутентификации запросов
209 > API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
PROSTO:СКУД 12.1 210
PROSTO:СКУД 13.1 211 > ## Ограничения
212 > MAX_ROWS_LIMIT=10000
213 > DEFAULT_ROWS_LIMIT=1000
PROSTO:СКУД 12.1 214
PROSTO:СКУД 13.1 215 > ## Пул соединений
216 > POOL_SIZE=10
217 > MAX_OVERFLOW=20
218 > POOL_TIMEOUT=30
219 > POOL_RECYCLE=3600
220 > POOL_PRE_PING=true
PROSTO:СКУД 12.1 221
PROSTO:СКУД 13.1 222 > ## Таймауты
223 > QUERY_TIMEOUT=300
224 > CONNECTION_TIMEOUT=30
PROSTO:СКУД 12.1 225
PROSTO:СКУД 13.1 226 > ## SSL/TLS
227 > SSL_ENABLED=true
228 > SSL_CERTFILE=/app/certs/cert.pem
229 > SSL_KEYFILE=/app/certs/key.pem
PROSTO:СКУД 12.1 230
PROSTO:СКУД 13.1 231 > ## Сервис
232 > SERVICE_PORT=8443
233 > PROMETHEUS_PORT=9090
PROSTO:СКУД 12.1 234
235 Далее назначим права:
236
PROSTO:СКУД 13.1 237 > sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
238 > sudo chmod 640 /etc/sql-proxy/sql-proxy.env
PROSTO:СКУД 12.1 239
PROSTO:СКУД 14.1 240 === 3.6 Настройка запуска через systemd===
PROSTO:СКУД 12.1 241
242 Создадим unit:
243
PROSTO:СКУД 13.1 244 > sudo nano /etc/systemd/system/sql-proxy.service
PROSTO:СКУД 12.1 245
246 Содержимое файла:
247
PROSTO:СКУД 13.1 248 > [Unit]
249 > Description=P-SKUD SQL REST Proxy Service
250 > After=network-online.target
251 > Wants=network-online.target
PROSTO:СКУД 12.1 252
PROSTO:СКУД 13.1 253 > [Service]
254 > Type=simple
255 > User=sqlproxy
256 > Group=sqlproxy
PROSTO:СКУД 12.1 257
PROSTO:СКУД 13.1 258 > WorkingDirectory=/opt/sql-proxy
259 > EnvironmentFile=/etc/sql-proxy/sql-proxy.env
260 > Environment=PYTHONUNBUFFERED=1
PROSTO:СКУД 12.1 261
PROSTO:СКУД 13.1 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
PROSTO:СКУД 12.1 263
PROSTO:СКУД 13.1 264 > Restart=on-failure
265 > RestartSec=5
266 > TimeoutStartSec=30
267 > TimeoutStopSec=30
PROSTO:СКУД 12.1 268
PROSTO:СКУД 13.1 269 > NoNewPrivileges=true
270 > PrivateTmp=true
271 > ProtectHome=true
272 > ProtectSystem=strict
273 > ProtectKernelTunables=true
274 > ProtectKernelModules=true
275 > ProtectControlGroups=true
276 > RestrictSUIDSGID=true
277 > LockPersonality=true
278 > UMask=0027
PROSTO:СКУД 12.1 279
PROSTO:СКУД 13.1 280 > ReadWritePaths=/var/lib/sql-proxy /var/log/sql-proxy
281 > ReadOnlyPaths=/etc/sql-proxy /opt/sql-proxy
PROSTO:СКУД 12.1 282
PROSTO:СКУД 13.1 283 > StandardOutput=journal
284 > StandardError=journal
PROSTO:СКУД 12.1 285
PROSTO:СКУД 13.1 286 > [Install]
287 > WantedBy=multi-user.target
PROSTO:СКУД 12.1 288
289 Включить службу:
290
PROSTO:СКУД 13.1 291 > sudo systemctl daemon-reload
292 > sudo systemctl enable --now sql-proxy
PROSTO:СКУД 12.1 293
294 Проверить:
295
PROSTO:СКУД 13.1 296 > sudo systemctl status sql-proxy
PROSTO:СКУД 12.1 297
298
299