Перейти к основному содержимому

Установка API-gateway

Цель выполнения​

API-gateway выступает в роли граничного прокси-сервера и предоставляет единую точку входа для остальных модулей продукта CopyWala.

Установка API-gateway является опциональной и необходима, если планируется использование централизованного каталога резервных копий.

Внимание!

После установки PBR-Agent необходимо также обязательно установить:

Предусловия​

Перед началом установки убедитесь, что выполнены следующие условия:

  1. Подготовлено окружение.
  2. Получен и доступен для установки дистрибутив Platform V SynGX / Nginx версии, соответствующей системным требованиям.

Последовательность действий​

примечание

Официальная документация Platform V SynGX.

  1. Установите пакет syngx-{rpm_version}-{OS_version}.x86_64.rpm:

    sudo dnf install {component_name}-{component_version}-{OS_version}.x86_64.rpm

  2. Откройте файл конфигурации API-gateway:

    sudo vi /opt/syngx/conf/syngx.conf

  3. Заполните конфигурационные параметры.

  4. После обновления конфигурационного файла перезапустите сервис: $ systemctl syngx -s reload

  5. Запустите сервис syngx.service:

    sudo systemctl start syngx.service

Настройка TLS-сертификатов для API-gateway​

примечание

Ниже приведены шаги настройки TLS-сертификатов для Copywala VDB. Настройка сертификатов для текущего компонента выполняется аналогичным образом.

Для обеспечения взаимодействия с Vector DB по протоколу HTTPS/mTLS выполните описанные ниже шаги:

  1. Сгенерируйте корневой сертификат (далее – Root CA).

    примечание

    Данный шаг является опциональным, выполните его, если в инфраструктуре отсутствует готовый Root CA. В противном случае следует использовать уже существующий Root CA.

    Важно помнить, что при самостоятельной генерации Root CA, его необходимо использовать для подписи сертификата сервера (Vector DB).

    Пример команды:

    openssl req -subj "/CN=RootCA" -newkey rsa:2048 -nodes \
    -keyout rootCA.key \
    -new -x509 \
    -days 365 \
    -out rootCA.crt

    В результате будут получены:

    • rootCA.key — приватный ключ Root CA;
    • rootCA.crt — самоподписанный корневой сертификат.

  2. Создайте файл openssl.cnf, указав актуальные значения, включая SAN-параметры:

    [ req ]
    default_bits        = 2048
    default_md          = sha256
    prompt              = no
    distinguished_name  = req_distinguished_name
    req_extensions      = req_ext

    [ req_distinguished_name ]
    C                   = RU
    ST                  = Moscow
    L                   = Moscow
    O                   = myCompany
    OU                  = IT Department
    CN                  = example.com

    [ req_ext ]
    subjectAltName      = DNS:<dns_name>, DNS:localhost, IP:<ip>, IP:127.0.0.1

    Замените <dns_name> и <ip> на фактические значения, используемые в инфраструктуре.

  3. Сгенерируйте приватный ключ и CSR (пример команды):

    openssl genpkey -algorithm RSA -out copywala-vdb.key

    openssl req -new \
    -key copywala-vdb.key \
    -out copywala-vdb.csr \
    -config openssl.cnf

  4. Подпишите CSR с использованием Root CA (существующего или сгенерированного):

    openssl x509 -req \
    -in copywala-vdb.csr \
    -CA rootCA.crt \
    -CAkey rootCA.key \
    -CAcreateserial \
    -out copywala-vdb.crt \
    -days 365 \
    -extfile openssl.cnf \
    -extensions req_ext

    В результате будет создан сертификат для Copywala VDB – copywala-vdb.crt.

  5. Для проверки корректности сертификата используйте команду:

    openssl x509 -in copywala-vdb.crt -text -noout

    В результате выполнения команды отображается:

    • Subject и Issuer;
    • срок действия;
    • расширения сертификата (включая SAN);
    • другие параметры X.509.

  6. После генерации и/или получения сертификатов настройте подключение к Vector DB. Для этого в конфигурационном файле copywala-vdb.yaml заполните секцию tls, указав пути к созданным TLS-артефактам.

Проверка результата​

Для проверки установки и работоспособности компонентов CopyWala обратитесь к разделу Чек-лист проверки корректности работы.

к сведению

После завершения установки данного модуля:

  1. При необходимости выполните установку других модулей Platform V CopyWala.
  2. Перейдите к следующему шагу — Настройка интеграции Platform V CopyWala с внешними сервисами.