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

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

Версия 11.1 от PROSTO:СКУД на 2026/07/22 08:30
Скрыть последних авторов
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:СКУД 8.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:СКУД 3.1 36 ># cd p-skud-sql-proxy-service
PROSTO:СКУД 1.1 37
PROSTO:СКУД 3.1 38 Генерируем сертификаты
PROSTO:СКУД 4.1 39
PROSTO:СКУД 3.1 40 ># bash generate_certs.sh
PROSTO:СКУД 1.1 41
PROSTO:СКУД 2.1 42 Копируем .env
PROSTO:СКУД 4.1 43
PROSTO:СКУД 3.1 44 ># cp .env.example .env
45
PROSTO:СКУД 2.1 46 И если требуется настраиваем под ваш контур .env
PROSTO:СКУД 4.1 47
PROSTO:СКУД 3.1 48 ># nano .env
49
PROSTO:СКУД 1.1 50 В файле можно изменить:
PROSTO:СКУД 4.1 51
PROSTO:СКУД 6.1 52 ># API Key для аутентификации запросов
PROSTO:СКУД 3.1 53 ># API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
PROSTO:СКУД 2.1 54
PROSTO:СКУД 6.1 55 ># И порты работы Сервиса
PROSTO:СКУД 3.1 56 ># SERVICE_PORT=8443
57 ># PROMETHEUS_PORT=9090
PROSTO:СКУД 1.1 58
PROSTO:СКУД 2.1 59 Поднимаем все сервисы из docker-compose.yml
PROSTO:СКУД 4.1 60
PROSTO:СКУД 3.1 61 ># docker compose up -d
PROSTO:СКУД 2.1 62
63 Проверка
PROSTO:СКУД 4.1 64
PROSTO:СКУД 3.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
71 ># git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
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
82 === 3.1 Системные зависимости===
83
84 Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
85
PROSTO:СКУД 10.2 86 Минимальный набор пакетов для онлайн-установки зависимостей:
87
88 ># sudo apt update
89 ># sudo apt install -y \
90 ># python3 \
91 ># python3-venv \
92 ># python3-pip \
93 ># python3-dev \
94 ># build-essential \
95 ># gcc \
96 ># g++ \
97 ># openssl \
98 ># ca-certificates \
99 ># freetds-dev \
100 ># libpq-dev \
101 ># default-libmysqlclient-dev \
102 ># pkg-config
103
104 Пояснение:
105
106 - `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
PROSTO:СКУД 11.1 112 Если какие-то из пакетов недоступны необходимо добавить репозитории.
PROSTO:СКУД 10.2 113 Например для Astra Linux Special Edition 1.8 x86-64:
114 ># sudo nano /etc/apt/sources.list.d/astra.list
PROSTO:СКУД 11.1 115 Содержимое:
PROSTO:СКУД 10.2 116 ># deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/main-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
117 ># 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 118
119
120 === 3.2 Пользователь и каталоги===
121
122 Создать каталоги:
123
124 ># sudo mkdir -p /opt/sql-proxy
125 ># sudo mkdir -p /etc/sql-proxy/certs
126 ># sudo mkdir -p /var/lib/sql-proxy
127 ># sudo mkdir -p /var/log/sql-proxy
128
129 Создать отдельного пользователя:
130
131 ># sudo addgroup --system sqlproxy
132 ># sudo adduser \
133 ># --system \
134 ># --ingroup sqlproxy \
135 ># --home /var/lib/sql-proxy \
136 ># --no-create-home \
137 ># --shell /usr/sbin/nologin \
138 ># sqlproxy
139
140
141 Дать права а каалоги:
142
143 ># sudo chown -R root:root /opt/sql-proxy
144 ># sudo chown -R root:sqlproxy /etc/sql-proxy
145 ># sudo chown -R sqlproxy:sqlproxy /var/lib/sql-proxy
146 ># sudo chown -R sqlproxy:sqlproxy /var/log/sql-proxy
147
148 ># sudo chmod 755 /opt/sql-proxy
149 ># sudo chmod 750 /etc/sql-proxy
150 ># sudo chmod 750 /etc/sql-proxy/certs
151 ># sudo chmod 750 /var/lib/sql-proxy
152 ># sudo chmod 750 /var/log/sql-proxy
153
154 === 3.3 Копирование проекта===
155
156 Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
157 app/
158 requirements.txt
159 .env.example
160 generate_certs.sh
161
162 После копирования:
163 Не делайте владельцем /opt/sql-proxy пользователя sqlproxy на постоянной основе. Для промышленной установки лучше держать код под root:root, а sqlproxy использовать только для запуска сервиса.
164
165 ># sudo chown -R root:root /opt/sql-proxy
166 ># sudo find /opt/sql-proxy -type d -exec chmod 755 {} \;
167 ># sudo find /opt/sql-proxy -type f -exec chmod 644 {} \;
168 ```
169
170 Сделайте скрипт `generate_certs.sh` исполняемым:
171
172 ># sudo chmod 755 /opt/sql-proxy/generate_certs.sh
173
174 И переместите его в каталог /etc/sql-proxy/certs
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
180
181 Права:
182
183 ># 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
PROSTO:СКУД 10.1 198