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

Сводка

• Свойства страницы (1 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Содержимое

...	...	@@ -70,8 +70,9 @@
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		-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,9 +78,8 @@
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	Минимальный набор пакетов для онлайн-установки зависимостей:
...	...	@@ -111,14 +111,16 @@
111	111
112	112	Если какие-то из пакетов недоступны необходимо добавить репозитории.
113	113	Например для Astra Linux Special Edition 1.8 x86-64:
	114	+
114	114	> sudo nano /etc/apt/sources.list.d/astra.list
	116	+
115	115	Содержимое:
	118	+
116	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	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
	122	+=== 3.2 Пользователь и каталоги ===
119	119
120		-=== 3.2 Пользователь и каталоги===
121		-
122	122	Создать каталоги:
123	123
124	124	> sudo mkdir -p /opt/sql-proxy
...	...	@@ -128,18 +128,11 @@
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 {{{--system --ingroup sqlproxy --home /var/lib/sql-proxy --no-create-home --shell /usr/sbin/nologin sqlproxy}}}
139	139
	136	+Дать права а каталоги:
140	140
141		-Дать права а каалоги:
142		-
143	143	> sudo chown -R root:root /opt/sql-proxy
144	144	> sudo chown -R root:sqlproxy /etc/sql-proxy
145	145	> sudo chown -R sqlproxy:sqlproxy /var/lib/sql-proxy
...	...	@@ -151,7 +151,7 @@
151	151	> sudo chmod 750 /var/lib/sql-proxy
152	152	> sudo chmod 750 /var/log/sql-proxy
153	153
154		-=== 3.3 Копирование проекта===
	149	+=== 3.3 Копирование проекта ===
155	155
156	156	Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
157	157	app/
...	...	@@ -165,7 +165,6 @@
165	165	> sudo chown -R root:root /opt/sql-proxy
166	166	> sudo find /opt/sql-proxy -type d -exec chmod 755 {} \;
167	167	> sudo find /opt/sql-proxy -type f -exec chmod 644 {} \;
168		-```
169	169
170	170	Сделайте скрипт `generate_certs.sh` исполняемым:
171	171
...	...	@@ -174,14 +174,15 @@
174	174	И переместите его в каталог /etc/sql-proxy/certs
175	175
176	176	Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов
	171	+
177	177	> sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem
178	178	> sudo chmod 640 /etc/sql-proxy/certs/key.pem
179	179	> sudo chmod 644 /etc/sql-proxy/certs/cert.pem
180	180
181		-=== 3.4 Создание виртуального окружения===
	176	+=== 3.4 Создание виртуального окружения ===
182	182
183	183	> sudo python3 -m venv /opt/sql-proxy/venv
184		-> sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
	179	+> sudo /opt/sql-proxy/venv/bin/python -m pip install {{{--upgrade}}} pip setuptools wheel
185	185
186	186	Права:
187	187
...	...	@@ -189,7 +189,7 @@
189	189	> sudo chmod -R go-w /opt/sql-proxy/venv
190	190
191	191
192		-=== 3.5 Онлайн-установка Python-зависимостей===
	187	+=== 3.5 Онлайн-установка Python-зависимостей ===
193	193
194	194	Установка зависимостей:
195	195
...	...	@@ -209,14 +209,15 @@
209	209	> sudo nano /etc/sql-proxy/sql-proxy.env
210	210
211	211	И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:
	207	+
212	212	> API Key для аутентификации запросов
213	213	> API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
214	214
215		-> ## Ограничения
	211	+> ## Ограничения##
216	216	> MAX_ROWS_LIMIT=10000
217	217	> DEFAULT_ROWS_LIMIT=1000
218	218
219		-> ## Пул соединений
	215	+> ## Пул соединений##
220	220	> POOL_SIZE=10
221	221	> MAX_OVERFLOW=20
222	222	> POOL_TIMEOUT=30
...	...	@@ -223,16 +223,16 @@
223	223	> POOL_RECYCLE=3600
224	224	> POOL_PRE_PING=true
225	225
226		-> ## Таймауты
	222	+> ## Таймауты##
227	227	> QUERY_TIMEOUT=300
228	228	> CONNECTION_TIMEOUT=30
229	229
230		-> ## SSL/TLS
	226	+> ## SSL/TLS##
231	231	> SSL_ENABLED=true
232	232	> SSL_CERTFILE=/app/certs/cert.pem
233	233	> SSL_KEYFILE=/app/certs/key.pem
234	234
235		-> ## Сервис
	231	+> ## Сервис##
236	236	> SERVICE_PORT=8443
237	237	> PROMETHEUS_PORT=9090
238	238
...	...	@@ -241,7 +241,7 @@
241	241	> sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
242	242	> sudo chmod 640 /etc/sql-proxy/sql-proxy.env
243	243
244		-3.6 Настройка запуска через systemd
	240	+=== 3.6 Настройка запуска через systemd ===
245	245
246	246	Создадим unit:
247	247
...	...	@@ -249,7 +249,6 @@
249	249
250	250	Содержимое файла:
251	251
252		-
253	253	> [Unit]
254	254	> Description=P-SKUD SQL REST Proxy Service
255	255	> After=network-online.target
...	...	@@ -264,7 +264,7 @@
264	264	> EnvironmentFile=/etc/sql-proxy/sql-proxy.env
265	265	> Environment=PYTHONUNBUFFERED=1
266	266
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
	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 }}}
268	268
269	269	> Restart=on-failure
270	270	> RestartSec=5
...	...	@@ -294,7 +294,7 @@
294	294	Включить службу:
295	295
296	296	> sudo systemctl daemon-reload
297		-> sudo systemctl enable --now sql-proxy
	292	+> sudo systemctl enable {{{--now sql-proxy}}}
298	298
299	299	Проверить:
300	300
...	...	@@ -301,4 +301,4 @@
301	301	> sudo systemctl status sql-proxy
302	302
303	303
304		-
	299	+