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

Сводка

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

Подробности

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

Родительский документ

...	...	@@ -1,1 +1,1 @@
1		-Main.AllDocs
	1	+Main.WebHome

Содержимое

...	...	@@ -1,11 +1,16 @@
	1	+== 1. Описание сервиса ==
	2	+
1	1	**SQL REST Proxy** — лёгкий REST-сервис на Python, разработанный как замена прямым вызовам SQL через ADODB.Connection в конфигурациях 1С, работающих на Linux. Поскольку COM-объекты и нативные ODBC-драйверы недоступны на Linux-платформе 1С:Предприятие, этот сервис позволяет выполнять произвольные SQL-запросы к внешним базам данных через стандартный HTTP-вызов из встроенного языка 1С.
2	2
3	3	**Поддерживаемые СУБД**
4		-СУБД Драйвер Порт по умолчанию
5		-PostgreSQL psycopg2 5432
6		-Microsoft SQL Server pymssql 1433
7		-MySQL PyMySQL 3306
8	8
	7	+|=СУБД     |=Драйвер               |=Порт по умолчанию
	8	+|PostgreSQL|psycopg2           |5432
	9	+|Microsoft SQL Server|pymssql|1433
	10	+|MySQL     |PyMySQL               |3306
	11	+
	12	+
	13	+
9	9	**Режим развёртывания**
10	10	Сервис запускается в Docker-контейнере и не требует установки каких-либо драйверов в хост-систему. Управление через docker-compose.
11	11
...	...	@@ -17,35 +17,86 @@
17	17	**Мониторинг**
18	18	Эндпоинт /metrics предоставляет метрики в формате Prometheus. Готовый конфиг prometheus.yml для сбора метрик включён в поставку. Эндпоинт /pools/stats возвращает детальную статистику по активным пулам соединений.
19	19
20		-**Установка**
21		-Для установки нужно скачать проект с github либо развернуть из архива (доступного для скачивания по ссылке):
22		-git clone https://prosto-skud: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@github.com/prosto-skud/p-skud-sql-proxy-service.git
23	23
	26	+== 2. Установка через docker контейнер ==
	27	+
	28	+
	29	+Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
	30	+
	31	+># git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
	32	+
24	24	**Запуск**
25	25	Переходим в директорию сервиса
26	26
27		-{{html}}
28		-cd p-skud-sql-proxy-service
29		-{{/html}}
	36	+># cd p-skud-sql-proxy-service
30	30
31		-
32	32	Генерируем сертификаты
33		-bash generate_certs.sh
	39	+
	40	+># bash generate_certs.sh
	41	+
34	34	Копируем .env
35		-cp .env.example .env
	43	+
	44	+># cp .env.example .env
	45	+
36	36	И если требуется настраиваем под ваш контур .env
37		-nano .env
	47	+
	48	+># nano .env
	49	+
38	38	В файле можно изменить:
39	39
40		-# API Key для аутентификации запросов
41		-API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
	52	+># API Key для аутентификации запросов
	53	+># API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
42	42
43		-# И порты работы Сервиса
44		-SERVICE_PORT=8443
45		-PROMETHEUS_PORT=9090
	55	+># И порты работы Сервиса
	56	+># SERVICE_PORT=8443
	57	+># PROMETHEUS_PORT=9090
46	46
47	47	Поднимаем все сервисы из docker-compose.yml
48		-docker compose up -d
49	49
	61	+># docker compose up -d
	62	+
50	50	Проверка
51		-curl -k https://<server>:8443/health
	64	+
	65	+># curl -k https://<server>:8443/health
	66	+
	67	+== 3. Установка в виде сервиса ==
	68	+
	69	+Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
	70	+
	71	+># git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
	72	+
	73	+Для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
	74	+
	75	+Минимальный набор пакетов для онлайн-установки зависимостей:
	76	+
	77	+># sudo apt update
	78	+># sudo apt install -y \
	79	+># python3 \
	80	+># python3-venv \
	81	+># python3-pip \
	82	+># python3-dev \
	83	+># build-essential \
	84	+># gcc \
	85	+># g++ \
	86	+># openssl \
	87	+># ca-certificates \
	88	+># freetds-dev \
	89	+># libpq-dev \
	90	+># default-libmysqlclient-dev \
	91	+># pkg-config
	92	+
	93	+Пояснение:
	94	+
	95	+- `freetds-dev` нужен для `pymssql`, который используется для MS SQL Server;
	96	+- `libpq-dev` полезен для PostgreSQL-зависимостей;
	97	+- `default-libmysqlclient-dev` и `pkg-config` могут понадобиться при сборке MySQL-зависимостей, хотя в проекте используется `PyMySQL`;
	98	+- `openssl` нужен для генерации сертификатов;
	99	+- `build-essential`, `gcc`, `g++`, `python3-dev` нужны, если какие-то wheels недоступны и зависимость собирается из исходников.
	100	+
	101	+Если какие-то из пакетов недоступны необходимо добавить добавить и расширенный репозиторий.
	102	+Например для Astra Linux Special Edition 1.8 x86-64:
	103	+># sudo nano /etc/apt/sources.list.d/astra.list
	104	+Содержимое для stable-ветки:
	105	+># deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/main-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
	106	+># deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/extended-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
	107	+