Прокси для API пробок | On-Premise | 2GIS Documentation
On-Premise
Карты
Поиск
Навигация
On-Premise
ру
en

Установка прокси для API пробок

Важное примечание:

Все пароли и ключи в этом разделе приведены в иллюстративных целях.

При реальной установке рекомендуется использовать более сложные и надёжные пароли.

1. Перед установкой

  1. По возможности познакомьтесь с:

  2. Убедитесь, что выполнены необходимые предварительные шаги:

    1. Подготовка к установке
    2. Получение артефактов установки
    3. Установка сервиса лицензий
    4. Установка сервиса ключей

  3. Соберите необходимые данные, заданные или полученные на предыдущих шагах:

    Объект Пример значения Как получить значение
    Эндпоинт зеркала реестра Docker docker.storage.example.local:5000 См. Получение артефактов установки
    Секрет Kubernetes для доступа к зеркалу реестра Docker onpremise-registry-creds См. Получение артефактов установки
    Домен S3-хранилища с артефактами установки artifacts.example.com См. Получение артефактов установки
    Название бакета с артефактами установки onpremise-artifacts См. Получение артефактов установки
    Идентификатор ключа для доступа к артефактам установки AKIAIOSFODNN7EXAMPLE См. Получение артефактов установки
    Секрет ключа для доступа к артефактам установки wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKEY См. Получение артефактов установки
    Путь к файлу манифеста manifests/1640661259.json См. Получение артефактов установки
    Эндпоинт API сервиса ключей keys.example.local См. Установка сервиса ключей
    Сервисные токены TRAFFIC_PROXY_AAAAAA-111111 См. здесь

  4. Убедитесь, что удовлетворены следующие требования к ресурсам (требования приведены с учётом минимального числа реплик):

    • Для testing-окружения:

      Сервис vCPU RAM Хранилище
      Обратный прокси NGINX 2 4 ГБ —
      Итоговое количество: 2 4 ГБ —

    • Для production-окружения:

      Сервис vCPU RAM Хранилище
      Обратный прокси NGINX 4 4 ГБ —
      Итоговое количество: 4 4 ГБ —

    Примечание:

    Подробная информация о системных требованиях для отдельных сервисов и компонентов программного комплекса 2ГИС приведена в документе Системные требования.

2. Установите прокси для API пробок

  1. Создайте конфигурационный файл для Helm. Подробное описание доступных параметров см. здесь.

    Пример файла уже заполнен всеми необходимыми данными, собранными на предыдущих этапах.

    values-traffic-proxy.yaml 
    dgctlDockerRegistry: docker.storage.example.local:5000/2gis-on-premise

replicaCount: 1

proxy.host: traffic0.edromaps.2gis.com

resources:
    requests:
        cpu: 10m
        memory: 32Mi
    limits:
        cpu: 500m
        memory: 256Mi

ingress:
    hosts:
        - host: traffic-proxy.example.com

    Где:

    • dgctlDockerRegistry: эндпоинт вашего реестра Docker, в котором находятся образы сервисов программного комплекса 2ГИС.

    • replicaCount: число реплик сервиса NGINX.

    • proxy.host: FQDN публичного сервера обновлений для пробок 2ГИС. Список доступных серверов приведен в разделе Архитектура.

    • resources: настройки вычислительных ресурсов для сервиса. Для получения актуальной информации о рекомендуемых значениях настроек в этой секции см. таблицу с минимальными системными требованиями.

    • ingress: конфигурация ресурса Ingress. Адаптируйте приведенную конфигурацию для соответствия используемому вами Ingress. Обратите внимание, что путь для хоста должен указывать на /.

  2. Установите сервис с помощью Helm, используя подготовленный конфигурационный файл values-traffic-proxy.yaml:

    helm upgrade --install --atomic --wait-for-jobs --values ./values-traffic-proxy.yaml traffic-proxy 2gis-on-premise/traffic-proxy

3. Проверьте работоспособность прокси для API пробок

Чтобы проверить работоспособность прокси для API пробок, откройте в браузере адрес, указанный в параметре ingress.hosts.host. Сервис должен вернуть список файлов с данными о пробках.

Или же можно проверить работоспособность другого сервиса, настроенного на использование установленного прокси для API пробок.

Что дальше?