Platform Manager | On-Premise | 2GIS Documentation
On-Premise

Установка Platform Manager

  1. Ознакомьтесь с основной информацией:

  2. Выполните предварительные шаги:

    1. Подготовка к установке
    2. Получение артефактов установки
    3. Установка сервиса ключей
    4. Установка API для работы с картами
    5. Установка API для работы с поиском
    6. Установка API для работы с навигацией
  3. Соберите необходимые данные, заданные или полученные на предыдущих шагах:

    Объект Пример значения Как получить значение
    Эндпоинт зеркала реестра Docker docker.storage.example.local:5000 См. Получение артефактов установки
    Эндпоинт MapGL JS API http://mapgl-js-api См. Установка API для работы с картами
    Эндпоинт Catalog APIs http://catalog-api См. Установка API для работы с поиском
    Эндпоинт Navigation API http://navi-front См. Установка API для работы с навигацией
    API-ключи MAPGL_KEY
    CATALOG_KEY
    NAVI_KEY
    См. Установка сервиса ключей
  4. Убедитесь, что удовлетворены требования к ресурсам, приведенные в Helm-чартe.

    Подробнее о том, как это сделать, смотрите в документе Системные требования.

    Примечание

    Содержание Helm-чарта, описанное в данном разделе, актуально для последней версии On-Premise (см. Релизы). Чтобы изучить параметры для более ранних версий, откройте values.yaml в GitHub и введите номер нужной версии комплекса (например, 1.18.0) в переключателе тегов слева.

  5. Определите доменное имя для сервиса Platform Manager. Например, platform.example.com.

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

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

    values-platform.yaml
    dgctlDockerRegistry: ''
    
    ui:
        brand: ''
        defaultLocale: en
        pages: ''
    
        status:
            mapgl: ''
            search: ''
            navi: ''
            pro: ''
            gisPlatform: ''
            keys: ''
    
        mapgl:
            url: 'https://mapgl-js-api.example.com'
            scriptPath: /api.js
            key: 'MAPGL_KEY'
            initCenter: ''
    
        catalog:
            url: 'https://catalog.example.com'
            key: 'CATALOG_KEY'
    
        navi:
            url: 'https://navi.example.com'
            key: 'NAVI_KEY'
    
        resources:
            requests:
                cpu: 300m
                memory: 384M
            limits:
                cpu: 1100m
                memory: 512M
    
        ingress:
            enabled: true
            className: nginx
            hosts:
                - host: platform.example.com
                  paths:
                      - path: /
                        pathType: Prefix
            tls: []
            #- hosts:
            #  - platform.example.com
            #  secretName: secret.tls
    

    Где:

    • dgctlDockerRegistry: эндпоинт вашего реестра Docker, в котором находятся образы сервисов On-Premise. Пример: HOST:PORT.

    • ui: базовые настройки приложения.

      • brand: брендирование внутри приложения. Возможные значения: 2gis, urbi.

      • defaultLocale: язык приложения по умолчанию. Возможные значения: en.

      • pages: список доступных страниц в приложении. Возможные значения: status, playground, map_styles. Значения записываются одной строкой через запятую, например, 'status, playground'. Первое значение в списке — страница по умолчанию.

      • status: перечень статусов для сервисов On-Premise.

        Значение — строка, содержащая пары из названия сервиса и URL до его healthcheck. Пары записываются через запятую. Значения внутри пары соединяются символом "=". Например, mapgl: 'MapGL JS=https://example.com/healthcheck'. URL должен быть абсолютным. Можно указать только URL, например, mapgl: 'https://example.com/healthcheck'.

      • mapgl: настройки доступа к сервису MapGL JS API:

        • url: хост сервиса в формате HTTP(S)://HOST.
        • key: API-ключ для сервиса.
        • initCenter: координаты карты по умолчанию. Состоят из двух чисел в массиве: [lng, lat]. Например: [55.27, 25.2] для Дубая, [37.64, 55.74] для Москвы.
        • scriptPath: путь до скрипта инициализации сервиса. Путь строится относительно ui.mapgl.url. Возможные значения: /api.js.
      • catalog: настройки доступа к сервису Catalog APIs:

        • url: хост сервиса в формате HTTP(S)://HOST.
        • key: API-ключ для сервиса.
      • navi: настройки доступа к сервису Navigation API:

        • url: хост сервиса в формате HTTP(S)://HOST.
        • key: API-ключ для сервиса.
      • resources: настройки вычислительных ресурсов для сервиса. Чтобы узнать рекомендуемые значения ресурсов, см. Вычислительные ресурсы.

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

    helm upgrade --install --version=1.29.0 --atomic --values ./values-platform.yaml platform 2gis-on-premise/platform
    

Перейдите по адресу https://platform.example.com в браузере. Вы должны успешно войти в веб-интерфейс. Далее вы можете проверить статус работы установленных сервисов на странице Мониторинг и протестировать работу ключевых API на странице Песочницы.

Вы можете создать уникальный стиль карты и использовать его в своём контуре. Для этого:

  1. Убедитесь, что в составе сервисов карт установлен Styles API.

  2. Откройте редактор стилей и создайте свой стиль карты.

    См. инструкции по созданию и настройке стилей в документации редактора.

  3. Выгрузите готовый стиль:

    1. В верхнем меню редактора стилей выберите Поделиться, а затем нажмите Экспорт стиля.

    2. Выберите необходимый стиль из списка и нажмите Экспортировать.

      В новой вкладке начнётся подготовка архива для скачивания.

    3. Когда стиль будет в статусе Готово, снова выберите его из списка и нажмите Скачать стиль.

    4. Сохраните созданный архив в формате .tar.gz локально.

  4. Загрузите стиль в ваш контур On-Premise:

    1. Откройте Platform Manager в браузере.
    2. Перейдите во вкладку Стили карты и нажмите Загрузить стиль.
    3. Добавьте скачанный архив в формате .tar.gz и дождитесь его загрузки.
  5. Проверьте, как выглядит загруженный стиль в песочнице: кликните на название нужного стиля во вкладке Стили карты.

  6. Скопируйте сгенерированный ID стиля и примените его к карте с помощью MapGL JS API.

Вы можете загружать разные версии одного стиля и переключаться между ними в Platform Manager. Подробнее см. в инструкции по обновлению стилей.