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

Сводка

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

Подробности

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

Содержимое

...	...	@@ -66,133 +66,11 @@
66	66
67	67	== 3. Установка в виде сервиса ==
68	68
	69	+
69	69	Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
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.
75		-2. Нужны системные библиотеки для Python-драйверов БД.
76		-3. Нужно создать виртуальное окружение.
77		-4. Нужно установить зависимости из `requirements.txt`.
78		-5. Нужно создать TLS-сертификаты или указать корпоративные сертификаты.
79		-6. Нужно запускать `uvicorn app.main:app` как обычную службу `systemd`
	74	+**Запуск**
80	80
81		-
82		-=== 3.1 Системные зависимости===
83		-
84		-Т.к. для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
85		-
86		-Минимальный набор пакетов для онлайн-установки зависимостей:
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
103		-
104		-Пояснение:
105		-
106		-- `freetds-dev` нужен для `pymssql`, который используется для MS SQL Server;
107		-- `libpq-dev` полезен для PostgreSQL-зависимостей;
108		-- `default-libmysqlclient-dev` и `pkg-config` могут понадобиться при сборке MySQL-зависимостей, хотя в проекте используется `PyMySQL`;
109		-- `openssl` нужен для генерации сертификатов;
110		-- `build-essential`, `gcc`, `g++`, `python3-dev` нужны, если какие-то wheels недоступны и зависимость собирается из исходников.
111		-
112		-Если какие-то из пакетов недоступны необходимо добавить репозитории.
113		-Например для Astra Linux Special Edition 1.8 x86-64:
114		-># sudo nano /etc/apt/sources.list.d/astra.list
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		-
119		-
120		-=== 3.2 Пользователь и каталоги===
121		-
122		-Создать каталоги:
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
128		-
129		-Создать отдельного пользователя:
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
139		-
140		-
141		-Дать права а каалоги:
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
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
153		-
154		-=== 3.3 Копирование проекта===
155		-
156		-Из скачанного проекта необходимо перенести в дирректорию /opt/sql-proxy следующие файлы:
157		-app/
158		-requirements.txt
159		-.env.example
160		-generate_certs.sh
161		-
162		-После копирования:
163		-Не делайте владельцем /opt/sql-proxy пользователя sqlproxy на постоянной основе. Для промышленной установки лучше держать код под root:root, а sqlproxy использовать только для запуска сервиса.
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		-```
169		-
170		-Сделайте скрипт `generate_certs.sh` исполняемым:
171		-
172		-># sudo chmod 755 /opt/sql-proxy/generate_certs.sh
173		-
174		-И переместите его в каталог /etc/sql-proxy/certs
175		-
176		-=== 3.4 Создание виртуального окружения===
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
180		-
181		-Права:
182		-
183		-># sudo chown -R root:root /opt/sql-proxy/venv
184		-># sudo chmod -R go-w /opt/sql-proxy/venv
185		-
186		-
187		-=== 3.5 Онлайн-установка Python-зависимостей===
188		-
189		-Установка зависимостей:
190		-
191		-># sudo /opt/sql-proxy/venv/bin/pip install -r /opt/sql-proxy/requirements.txt
192		-
193		-Далее необходимо проверить, что основные модули импортируются:
194		-
195		-># sudo /opt/sql-proxy/venv/bin/python -c "import fastapi, uvicorn, sqlalchemy, psycopg2, pymssql, pymysql; print('OK')"
196		-
197		-
198	198