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

Изменения документа Установка SQL REST Proxy сервиса

Редактировал(а) PROSTO:СКУД 2026/09/16 13:37
От версии 11.1
отредактировано PROSTO:СКУД
на 2026/07/22 08:30
Изменить комментарий: К данной версии нет комментариев
К версии 15.1
отредактировано PROSTO:СКУД
на 2026/07/22 08:59
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

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