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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -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,10 +130,16 @@
130	130
131	131	Создать отдельного пользователя:
132	132
133		-> sudo addgroup {{{--system sqlproxy }}}
134		-> sudo adduser {{{--system --ingroup sqlproxy --home /var/lib/sql-proxy --no-create-home --shell /usr/sbin/nologin sqlproxy}}}
	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
135	135
136		-Дать права а каталоги:
	138	+Дать права а каалоги:
137	137
138	138	> sudo chown -R root:root /opt/sql-proxy
139	139	> sudo chown -R root:sqlproxy /etc/sql-proxy
...	...	@@ -146,7 +146,7 @@
146	146	> sudo chmod 750 /var/lib/sql-proxy
147	147	> sudo chmod 750 /var/log/sql-proxy
148	148
149		-=== 3.3 Копирование проекта ===
	151	+=== 3.3 Копирование проекта===
150	150
151	151	Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
152	152	app/
...	...	@@ -168,15 +168,14 @@
168	168	И переместите его в каталог /etc/sql-proxy/certs
169	169
170	170	Далее запустим скрипт `generate_certs.sh` и назначим права на созданные файлы сертификатов
171		-
172	172	> sudo chown root:sqlproxy /etc/sql-proxy/certs/key.pem /etc/sql-proxy/certs/cert.pem
173	173	> sudo chmod 640 /etc/sql-proxy/certs/key.pem
174	174	> sudo chmod 644 /etc/sql-proxy/certs/cert.pem
175	175
176		-=== 3.4 Создание виртуального окружения ===
	177	+=== 3.4 Создание виртуального окружения===
177	177
178	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	+> sudo /opt/sql-proxy/venv/bin/python -m pip install --upgrade pip setuptools wheel
180	180
181	181	Права:
182	182
...	...	@@ -184,7 +184,7 @@
184	184	> sudo chmod -R go-w /opt/sql-proxy/venv
185	185
186	186
187		-=== 3.5 Онлайн-установка Python-зависимостей ===
	188	+=== 3.5 Онлайн-установка Python-зависимостей===
188	188
189	189	Установка зависимостей:
190	190
...	...	@@ -204,15 +204,14 @@
204	204	> sudo nano /etc/sql-proxy/sql-proxy.env
205	205
206	206	И перенестите в него содержимое из примера (`.env.example`) либо заполните свое:
207		-
208	208	> API Key для аутентификации запросов
209	209	> API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
210	210
211		-> ## Ограничения##
	211	+> ## Ограничения
212	212	> MAX_ROWS_LIMIT=10000
213	213	> DEFAULT_ROWS_LIMIT=1000
214	214
215		-> ## Пул соединений##
	215	+> ## Пул соединений
216	216	> POOL_SIZE=10
217	217	> MAX_OVERFLOW=20
218	218	> POOL_TIMEOUT=30
...	...	@@ -219,16 +219,16 @@
219	219	> POOL_RECYCLE=3600
220	220	> POOL_PRE_PING=true
221	221
222		-> ## Таймауты##
	222	+> ## Таймауты
223	223	> QUERY_TIMEOUT=300
224	224	> CONNECTION_TIMEOUT=30
225	225
226		-> ## SSL/TLS##
	226	+> ## SSL/TLS
227	227	> SSL_ENABLED=true
228	228	> SSL_CERTFILE=/app/certs/cert.pem
229	229	> SSL_KEYFILE=/app/certs/key.pem
230	230
231		-> ## Сервис##
	231	+> ## Сервис
232	232	> SERVICE_PORT=8443
233	233	> PROMETHEUS_PORT=9090
234	234
...	...	@@ -237,7 +237,7 @@
237	237	> sudo chown root:sqlproxy /etc/sql-proxy/sql-proxy.env
238	238	> sudo chmod 640 /etc/sql-proxy/sql-proxy.env
239	239
240		-=== 3.6 Настройка запуска через systemd ===
	240	+=== 3.6 Настройка запуска через systemd===
241	241
242	242	Создадим unit:
243	243
...	...	@@ -259,7 +259,7 @@
259	259	> EnvironmentFile=/etc/sql-proxy/sql-proxy.env
260	260	> Environment=PYTHONUNBUFFERED=1
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 }}}
	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	263
264	264	> Restart=on-failure
265	265	> RestartSec=5
...	...	@@ -289,7 +289,7 @@
289	289	Включить службу:
290	290
291	291	> sudo systemctl daemon-reload
292		-> sudo systemctl enable {{{--now sql-proxy}}}
	292	+> sudo systemctl enable --now sql-proxy
293	293
294	294	Проверить:
295	295
...	...	@@ -296,4 +296,4 @@
296	296	> sudo systemctl status sql-proxy
297	297
298	298
299		-
	299	+