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

Редактировал(а) PROSTO:СКУД 2026/09/16 13:37

От версии 21.1
отредактировано PROSTO:СКУД
на 2026/09/16 12:44
Изменить комментарий: К данной версии нет комментариев
К версии 14.1
отредактировано PROSTO:СКУД
на 2026/07/22 08:52
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -70,9 +70,8 @@
70 70  
71 71  > git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
72 72  
73 -При разворачивании без Docker:
74 -
75 -~1. На сервере нужна совместимая версия Python, желательно Python 3.11.
73 +При разворачивании без Docker необходимо:
74 +1. На сервере нужна совместимая версия Python, желательно Python 3.11.
76 76  2. Нужны системные библиотеки для Python-драйверов БД.
77 77  3. Нужно создать виртуальное окружение.
78 78  4. Нужно установить зависимости из `requirements.txt`.
... ... @@ -79,7 +79,7 @@
79 79  5. Нужно создать TLS-сертификаты или указать корпоративные сертификаты.
80 80  6. Нужно запускать `uvicorn app.main:app` как обычную службу `systemd`
81 81  
82 -=== 3.1 Системные зависимости ===
81 +=== 3.1 Системные зависимости===
83 83  
84 84  Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
85 85  
... ... @@ -111,15 +111,12 @@
111 111  
112 112  Если какие-то из пакетов недоступны необходимо добавить репозитории.
113 113  Например для Astra Linux Special Edition 1.8 x86-64:
114 -
115 115  > sudo nano /etc/apt/sources.list.d/astra.list
116 -
117 117  Содержимое:
118 -
119 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 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 121  
122 -=== 3.2 Пользователь и каталоги ===
118 +=== 3.2 Пользователь и каталоги===
123 123  
124 124  Создать каталоги:
125 125  
... ... @@ -130,16 +130,16 @@
130 130  
131 131  Создать отдельного пользователя:
132 132  
133 -> sudo addgroup {{{--system sqlproxy }}}
129 +> sudo addgroup --system sqlproxy
134 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
131 +> --system \
132 +> --ingroup sqlproxy \
133 +> --home /var/lib/sql-proxy \
134 +> --no-create-home \
135 +> --shell /usr/sbin/nologin \
136 +> sqlproxy
141 141  
142 -Дать права а каталоги:
138 +Дать права а каалоги:
143 143  
144 144  > sudo chown -R root:root /opt/sql-proxy
145 145  > sudo chown -R root:sqlproxy /etc/sql-proxy
... ... @@ -152,7 +152,7 @@
152 152  > sudo chmod 750 /var/lib/sql-proxy
153 153  > sudo chmod 750 /var/log/sql-proxy
154 154  
155 -=== 3.3 Копирование проекта ===
151 +=== 3.3 Копирование проекта===
156 156  
157 157  Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
158 158  app/
... ... @@ -174,15 +174,14 @@
174 174  И переместите его в каталог /etc/sql-proxy/certs
175 175  
176 176  Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов
177 -
178 178  > sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem
179 179  > sudo chmod 640 /etc/sql-proxy/certs/key.pem
180 180  > sudo chmod 644 /etc/sql-proxy/certs/cert.pem
181 181  
182 -=== 3.4 Создание виртуального окружения ===
177 +=== 3.4 Создание виртуального окружения===
183 183  
184 184  > sudo python3 -m venv /opt/sql-proxy/venv
185 -> sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel--
180 +> sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
186 186  
187 187  Права:
188 188  
... ... @@ -190,7 +190,7 @@
190 190  > sudo chmod -R go-w /opt/sql-proxy/venv
191 191  
192 192  
193 -=== 3.5 Онлайн-установка Python-зависимостей ===
188 +=== 3.5 Онлайн-установка Python-зависимостей===
194 194  
195 195  Установка зависимостей:
196 196  
... ... @@ -210,15 +210,14 @@
210 210  > sudo nano /etc/sql-proxy/sql-proxy.env
211 211  
212 212  И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:
213 -
214 214  > API Key для аутентификации запросов
215 215  > API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
216 216  
217 -> ## Ограничения##
211 +> ## Ограничения
218 218  > MAX_ROWS_LIMIT=10000
219 219  > DEFAULT_ROWS_LIMIT=1000
220 220  
221 -> ## Пул соединений##
215 +> ## Пул соединений
222 222  > POOL_SIZE=10
223 223  > MAX_OVERFLOW=20
224 224  > POOL_TIMEOUT=30
... ... @@ -225,16 +225,16 @@
225 225  > POOL_RECYCLE=3600
226 226  > POOL_PRE_PING=true
227 227  
228 -> ## Таймауты##
222 +> ## Таймауты
229 229  > QUERY_TIMEOUT=300
230 230  > CONNECTION_TIMEOUT=30
231 231  
232 -> ## SSL/TLS##
226 +> ## SSL/TLS
233 233  > SSL_ENABLED=true
234 234  > SSL_CERTFILE=/app/certs/cert.pem
235 235  > SSL_KEYFILE=/app/certs/key.pem
236 236  
237 -> ## Сервис##
231 +> ## Сервис
238 238  > SERVICE_PORT=8443
239 239  > PROMETHEUS_PORT=9090
240 240  
... ... @@ -243,7 +243,7 @@
243 243  > sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
244 244  > sudo chmod 640 /etc/sql-proxy/sql-proxy.env
245 245  
246 -=== 3.6 Настройка запуска через systemd ===
240 +=== 3.6 Настройка запуска через systemd===
247 247  
248 248  Создадим unit:
249 249  
... ... @@ -265,7 +265,7 @@
265 265  > EnvironmentFile=/etc/sql-proxy/sql-proxy.env
266 266  > Environment=PYTHONUNBUFFERED=1
267 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 }}}
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
269 269  
270 270  > Restart=on-failure
271 271  > RestartSec=5
... ... @@ -295,7 +295,7 @@
295 295  Включить службу:
296 296  
297 297  > sudo systemctl daemon-reload
298 -> sudo systemctl enable --now sql-proxy--
292 +> sudo systemctl enable --now sql-proxy
299 299  
300 300  Проверить:
301 301  
... ... @@ -302,4 +302,4 @@
302 302  > sudo systemctl status sql-proxy
303 303  
304 304  
305 -
299 +