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

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

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

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -28,47 +28,47 @@
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 73  При разворачивании без Docker необходимо:
74 74  1. На сервере нужна совместимая версия Python, желательно Python 3.11.
... ... @@ -78,6 +78,7 @@
78 78  5. Нужно создать TLS-сертификаты или указать корпоративные сертификаты.
79 79  6. Нужно запускать `uvicorn app.main:app` как обычную службу `systemd`
80 80  
81 +
81 81  === 3.1 Системные зависимости===
82 82  
83 83  Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
... ... @@ -84,21 +84,21 @@
84 84  
85 85  Минимальный набор пакетов для онлайн-установки зависимостей:
86 86  
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
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
102 102  
103 103  Пояснение:
104 104  
... ... @@ -110,43 +110,45 @@
110 110  
111 111  Если какие-то из пакетов недоступны необходимо добавить репозитории.
112 112  Например для Astra Linux Special Edition 1.8 x86-64:
113 -> sudo nano /etc/apt/sources.list.d/astra.list
114 +># sudo nano /etc/apt/sources.list.d/astra.list
114 114  Содержимое:
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
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
117 117  
119 +
118 118  === 3.2 Пользователь и каталоги===
119 119  
120 120  Создать каталоги:
121 121  
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
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 126  
127 127  Создать отдельного пользователя:
128 128  
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
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
137 137  
140 +
138 138  Дать права а каалоги:
139 139  
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
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 144  
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
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
150 150  
151 151  === 3.3 Копирование проекта===
152 152  
... ... @@ -159,30 +159,31 @@
159 159  После копирования:
160 160  Не делайте владельцем /opt/sql-proxy пользователя sqlproxy на постоянной основе. Для промышленной установки лучше держать код под root:root, а sqlproxy использовать только для запуска сервиса.
161 161  
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 {} \;
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 +```
165 165  
166 166  Сделайте скрипт `generate_certs.sh` исполняемым:
167 167  
168 -> sudo chmod 755 /opt/sql-proxy/generate_certs.sh
172 +># sudo chmod 755 /opt/sql-proxy/generate_certs.sh
169 169  
170 170  И переместите его в каталог /etc/sql-proxy/certs
171 171  
172 172  Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов
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
177 +># sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem
178 +># sudo chmod 640 /etc/sql-proxy/certs/key.pem
179 +># sudo chmod 644 /etc/sql-proxy/certs/cert.pem
176 176  
177 177  === 3.4 Создание виртуального окружения===
178 178  
179 -> sudo python3 -m venv /opt/sql-proxy/venv
180 -> sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
183 +># sudo python3 -m venv /opt/sql-proxy/venv
184 +># sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
181 181  
182 182  Права:
183 183  
184 -> sudo chown -R root:root /opt/sql-proxy/venv
185 -> sudo chmod -R go-w /opt/sql-proxy/venv
188 +># sudo chown -R root:root /opt/sql-proxy/venv
189 +># sudo chmod -R go-w /opt/sql-proxy/venv
186 186  
187 187  
188 188  === 3.5 Онлайн-установка Python-зависимостей===
... ... @@ -189,11 +189,11 @@
189 189  
190 190  Установка зависимостей:
191 191  
192 -> sudo /opt/sql-proxy/venv/bin/pip install -r /opt/sql-proxy/requirements.txt
196 +># sudo /opt/sql-proxy/venv/bin/pip install -r /opt/sql-proxy/requirements.txt
193 193  
194 194  Далее необходимо проверить, что основные модули импортируются:
195 195  
196 -> sudo /opt/sql-proxy/venv/bin/python -c "import fastapi, uvicorn, sqlalchemy, psycopg2, pymssql, pymysql; print('OK')"
200 +># sudo /opt/sql-proxy/venv/bin/python -c "import fastapi, uvicorn, sqlalchemy, psycopg2, pymssql, pymysql; print('OK')"
197 197  
198 198  
199 199  3.6 Настройка конфигурации
... ... @@ -202,98 +202,103 @@
202 202  
203 203  Создайте файл:
204 204  
205 -> sudo nano /etc/sql-proxy/sql-proxy.env
209 +># sudo nano /etc/sql-proxy/sql-proxy.env
206 206  
207 207  И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:
208 -> API Key для аутентификации запросов
209 -> API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
212 +># API Key для аутентификации запросов
213 +># API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
210 210  
211 -> ## Ограничения
212 -> MAX_ROWS_LIMIT=10000
213 -> DEFAULT_ROWS_LIMIT=1000
215 +>## Ограничения
216 +># MAX_ROWS_LIMIT=10000
217 +># DEFAULT_ROWS_LIMIT=1000
214 214  
215 -> ## Пул соединений
216 -> POOL_SIZE=10
217 -> MAX_OVERFLOW=20
218 -> POOL_TIMEOUT=30
219 -> POOL_RECYCLE=3600
220 -> POOL_PRE_PING=true
219 +>## Пул соединений
220 +># POOL_SIZE=10
221 +># MAX_OVERFLOW=20
222 +># POOL_TIMEOUT=30
223 +># POOL_RECYCLE=3600
224 +># POOL_PRE_PING=true
221 221  
222 -> ## Таймауты
223 -> QUERY_TIMEOUT=300
224 -> CONNECTION_TIMEOUT=30
226 +>## Таймауты
227 +># QUERY_TIMEOUT=300
228 +># CONNECTION_TIMEOUT=30
225 225  
226 -> ## SSL/TLS
227 -> SSL_ENABLED=true
228 -> SSL_CERTFILE=/app/certs/cert.pem
229 -> SSL_KEYFILE=/app/certs/key.pem
230 +>## SSL/TLS
231 +># SSL_ENABLED=true
232 +># SSL_CERTFILE=/app/certs/cert.pem
233 +># SSL_KEYFILE=/app/certs/key.pem
230 230  
231 -> ## Сервис
232 -> SERVICE_PORT=8443
233 -> PROMETHEUS_PORT=9090
235 +>## Сервис
236 +># SERVICE_PORT=8443
237 +># PROMETHEUS_PORT=9090
234 234  
235 235  Далее назначим права:
236 236  
237 -> sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
238 -> sudo chmod 640 /etc/sql-proxy/sql-proxy.env
241 +># sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
242 +># sudo chmod 640 /etc/sql-proxy/sql-proxy.env
239 239  
240 -=== 3.6 Настройка запуска через systemd===
244 +3.6 Настройка запуска через systemd
241 241  
242 242  Создадим unit:
243 243  
244 -> sudo nano /etc/systemd/system/sql-proxy.service
248 +># sudo nano /etc/systemd/system/sql-proxy.service
245 245  
246 246  Содержимое файла:
247 247  
248 -> [Unit]
249 -> Description=P-SKUD SQL REST Proxy Service
250 -> After=network-online.target
251 -> Wants=network-online.target
252 252  
253 -> [Service]
254 -> Type=simple
255 -> User=sqlproxy
256 -> Group=sqlproxy
253 +># [Unit]
254 +># Description=P-SKUD SQL REST Proxy Service
255 +># After=network-online.target
256 +># Wants=network-online.target
257 257  
258 -> WorkingDirectory=/opt/sql-proxy
259 -> EnvironmentFile=/etc/sql-proxy/sql-proxy.env
260 -> Environment=PYTHONUNBUFFERED=1
258 +[Service]
259 +Type=simple
260 +User=sqlproxy
261 +Group=sqlproxy
261 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
263 +WorkingDirectory=/opt/sql-proxy
264 +EnvironmentFile=/etc/sql-proxy/sql-proxy.env
265 +Environment=PYTHONUNBUFFERED=1
263 263  
264 -> Restart=on-failure
265 -> RestartSec=5
266 -> TimeoutStartSec=30
267 -> TimeoutStopSec=30
267 +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
268 268  
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
269 +Restart=on-failure
270 +RestartSec=5
271 +TimeoutStartSec=30
272 +TimeoutStopSec=30
279 279  
280 -> ReadWritePaths=/var/lib/sql-proxy /var/log/sql-proxy
281 -> ReadOnlyPaths=/etc/sql-proxy /opt/sql-proxy
274 +NoNewPrivileges=true
275 +PrivateTmp=true
276 +ProtectHome=true
277 +ProtectSystem=strict
278 +ProtectKernelTunables=true
279 +ProtectKernelModules=true
280 +ProtectControlGroups=true
281 +RestrictSUIDSGID=true
282 +LockPersonality=true
283 +UMask=0027
282 282  
283 -> StandardOutput=journal
284 -> StandardError=journal
285 +ReadWritePaths=/var/lib/sql-proxy /var/log/sql-proxy
286 +ReadOnlyPaths=/etc/sql-proxy /opt/sql-proxy
285 285  
286 -> [Install]
287 -> WantedBy=multi-user.target
288 +StandardOutput=journal
289 +StandardError=journal
288 288  
291 +[Install]
292 +WantedBy=multi-user.target
293 +```
294 +
289 289  Включить службу:
290 290  
291 -> sudo systemctl daemon-reload
292 -> sudo systemctl enable --now sql-proxy
297 +```bash
298 +sudo systemctl daemon-reload
299 +sudo systemctl enable --now sql-proxy
300 +```
293 293  
294 294  Проверить:
295 295  
296 -> sudo systemctl status sql-proxy
304 +```bash
305 +sudo systemctl status sql-proxy
297 297  
298 298  
299 299