Установка 2ГИС Про

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

Ознакомьтесь с основной информацией:
Выполните предварительные шаги:

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

Объект	Пример значения	Как получить значение
Эндпоинт зеркала реестра Docker	`docker.storage.example.local:5000`	См. Получение артефактов установки
Эндпоинт API сервиса ключей	`http://keys-api`	См. Установка сервиса ключей
Эндпоинт 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`	См. Установка сервиса ключей

Убедитесь, что удовлетворены требования к ресурсам, приведенные в Helm-чартах:
- Pro API,
- Pro UI.
Подробнее о том, как это сделать, смотрите в документе Системные требования.

Примечание

Содержание Helm-чартов, описанное в данном разделе, актуально для последней версии On-Premise (см. Релизы). Чтобы изучить параметры для более ранних версий, откройте нужный values.yaml в GitHub и введите номер нужной версии комплекса (например, 1.18.0) в переключателе тегов слева.
Определите доменные имена для сервиса 2ГИС Про. Например:
- Доменное имя для API-бэкенда: pro-api.example.com
- Доменное имя для фронтенда: pro-ui.example.com

2. Подготовьте инфраструктуру

Настройте PostgreSQL

Разместите кластер PostgreSQL с доменным именем pro-postgresql.storage.example.local в приватной сети. Предполагается, что кластер работает на стандартном порту 5432.

Настройте кластер PostgreSQL для использования в качестве хранилища:

Подключитесь к кластеру от имени суперпользователя (обычно это postgres).
Создайте пользователя базы данных и установите пароль для него:
```
create user dbuser_pro password '';
```
Создайте базу данных, принадлежащую этому пользователю:
```
create database onpremise_pro owner dbuser_pro;
```

Настройте S3-хранилище

Разместите S3-совместимое хранилище (например, Ceph) с доменным именем pro-s3.storage.example.local в приватной сети. Предполагается, что хранилище работает на стандартном порту 80.

Настройте S3-совместимое хранилище:

Создайте пользователя, который будет использоваться для сервиса:
- Access key: ``
- Secret key: ``
Запомните ключи доступа для этого пользователя.
Определите названия бакетов (buckets), которые будут использоваться для сервиса. Например:
- Бакет с наборами данных, агрегатами и фильтрами: assets.
- Бакет с подготовленными данными слоя: layer_data.
- Бакет с наборами данных, агрегатами и фильтрами, созданными пользователем: user_assets.

Настройте Elasticsearch

Разместите кластер Elasticsearch с доменным именем pro-elastic.storage.example.local в приватной сети. Предполагается, что кластер работает на порту 9200.

Настройте кластер:

Создайте пользователя, который будет использоваться для сервиса:
- Имя пользователя: ``
- Пароль: ``
Запомните реквизиты для этого пользователя.

3. Установите 2ГИС Про

Установите Pro API

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

Пример файла уже заполнен всеми необходимыми данными, собранными на предыдущих этапах.
values-pro-api.yaml
```
dgctlDockerRegistry: ''

dgctlStorage:
    host: artifacts.storage.example.local:443
    bucket: onpremise-artifacts
    accessKey: AKIAIOSFODNN7EXAMPLE
    secretKey: wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKEY
    manifest: manifests/1640661259.json
    secure: false
    region: ''
    disablePayloadSigning: false

s3:
    assetsDataBucket: ''
    userAssetsDataBucket: ''
    layerDataBucket: ''
    snapshotBucket: ''
    resourcesBucket: ''

api:
    serviceAccount: ''
    tempPath: /tmp
    allowAnyOrigin: false
    loggingFormat: simple

postgres:
    connectionString: ''
    connectionStringReadonly: ''
    password: ''

keys:
    url: ''
    token: ''

elastic:
    host: ''
    credentials: ''

redis:
    host: ''
    port: ''

catalog:
    url: ''
    key: ''

navi:
    url: ''
    key: ''

search:
    url: ''

appAssetImporterName: asset-importer
appUserAssetImporterName: user-asset-importer

assetImporter:
    repository: 2gis-on-premise/pro-importer
    tag: 1.0.23
    schedule: 0 18 * * *
    backoffLimit: 2
    successfulJobsHistoryLimit: 3
    nodeSelector: {}
    maxParallelJobs: 4
    enabled: true
    startOnDeploy: true

resources:
    requests:
        cpu: 400m
        memory: 256M
    limits:
        cpu: 1
        memory: 1024M

ingress:
    enabled: true
    className: nginx
    hosts:
        - host: pro-api.example.com
          paths:
              - path: /
                pathType: Prefix
    tls: []
    #- hosts:
    #  - pro-api.example.com
    #  secretName: secret.tls
```
Где:
- dgctlDockerRegistry: эндпоинт вашего реестра Docker, в котором находятся образы сервисов On-Premise. Пример: HOST:PORT.
- dgctlStorage: настройки хранилища артефактов развертывания.
  - Укажите общие настройки для доступа к хранилищу: endpoint, имя бакета, реквизиты для доступа.
  - manifest: укажите путь до файла с манифестом в формате manifests/1640661259.json. Этот файл содержит в себе описания фрагментов данных, которые требуются сервисам для работы. См. Жизненный цикл артефактов установки.
  - secure: использовать ли HTTPS для работы с S3-совместимым хранилищем. Значение по умолчанию: false.
  - region: регион S3-хранилища.
  - disablePayloadSigning: отключить ли проверку целостности данных. Если S3-совместимое хранилище не поддерживает AWS Signature Version 4 streaming, значение должно быть true. Значение по умолчанию: false.
- s3: настройки хранилища S3.
  - assetsDataBucket: имя бакета S3 с подготовленными наборами данных, агрегатами и фильтрами.
  - userAssetsDataBucket: имя бакета S3 с наборами данных, агрегатами и фильтрами, созданными пользователем.
  - layerDataBucket: имя бакета S3 с подготовленными данными слоя.
  - snapshotBucket: имя бакета S3 для хранения моментальных снимков (snapshots) пошагового обновления данных.
  - resourcesBucket: имя бакета S3 для хранения статичных ресурсов.
- api: переменные окружения.
  - serviceAccount: учетная запись службы Kubernetes.
  - tempPath: путь к директории, используемой для временных данных.
  - allowAnyOrigin: политика CORS — разрешить любому источнику выполнять запросы к сервису Pro API.
  - loggingFormat: формат ведения журнала логирования. Возможные значения: default — компактный JSON, renderedCompactJson — отображаемый JSON, simple — простой текст.
- postgres: настройки доступа к серверу PostgreSQL.
  - connectionString: строка с данными для подключения к БД PostgreSQL вида Server=SERVER_URL;Database=DB_NAME;UID=USER_NAME;.
  - connectionStringReadonly: строка с данными для подключения к БД PostgreSQL, доступной только для чтения вида Server=SERVER_URL;Database=DB_NAME;UID=USER_NAME;.
  - password: пароль для подключения к БД PostgreSQL.
- keys: настройки доступа к сервису управления ключами.
  - url: URL-адрес сервиса keys.api для управления ключами. Пример: HTTP(S)://HOST.
  - token: токен доступа для keys.api.
- elastic: настройки ElasticSearch.
  - host: адрес хоста ElasticSearch. Пример: HTTP(S)://HOST:PORT.
  - credentials: имя пользователя и пароль для подключения к ElasticSearch вида USER_NAME:PASSWORD.
- redis: настройки Redis.
  - host: адрес хоста Redis. Пример: HTTP(S)://HOST.
  - port: номер порта.
- catalog: настройки доступа к Catalog APIs.
  - url: URL-адрес Catalog APIs. Пример: HTTP(S)://HOST.
  - key: ключ доступа к Catalog APIs.
- navi: настройки доступа к Isochrone API.
  - url: URL-адрес Isochrone API. Пример: HTTP(S)://HOST.
  - key: ключ доступа к Isochrone API.
- search: настройки доступа к Search API.
  - url: URL-адрес Search API. Пример: HTTP(S)://HOST.
- appAssetImporterName: имя cron-задания для импорта данных.
- appUserAssetImporterName: имя пользовательского cron-задания для импорта данных.
- assetImporter: настройки cron-задания для импорта данных.
  - repository: адрес репозитория с Docker-образом.
  - tag: метка Docker-образа.
  - schedule: расписание выполнения задания в cron-формате. Например: */10 * * * *.
  - backoffLimit: количество повторных попыток, после которых задание будет считаться неуспешным.
  - successfulJobsHistoryLimit: ограничение на размер истории выполненных заданий.
  - nodeSelector: селектор узлов Kubernetes.
  - maxParallelJobs: количество заданий импорта, которые могут быть запущены одновременно.
  - enabled: включен AssetImporter или нет.
  - startOnDeploy: импорт данных должен начинаться при установке или обновлении сервиса.
- resources: настройки вычислительных ресурсов для сервиса. Актуальная информация о рекомендуемых значениях настроек представлена в таблице с системными требованиями.
- ingress: конфигурация ресурса Ingress. Адаптируйте приведенную конфигурацию для соответствия используемому вами Ingress. URL, указанный в параметре ingress.hosts.host, должен быть доступен извне вашего кластера Kubernetes, чтобы пользователи из приватного сегмента сети могли получить доступ к ресурсам по этому URL.
Разверните сервис с помощью Helm, используя подготовленный конфигурационный файл values-pro-api.yaml:
```
helm upgrade --install --version=1.21.0 --atomic --values ./values-pro-api.yaml pro-api 2gis-on-premise/pro-api
```

Установите Pro UI

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

Пример файла уже заполнен всеми необходимыми данными, собранными на предыдущих этапах.
values-pro-ui.yaml
```
dgctlDockerRegistry: ''

dgctlStorage:
    host: artifacts.storage.example.local:443
    bucket: onpremise-artifacts
    accessKey: AKIAIOSFODNN7EXAMPLE
    secretKey: wJalrXUtnFEMIK7MDENGbPxRfiCYEXAMPLEKEY
    manifest: manifests/1640661259.json
    secure: false
    region: ''
    disablePayloadSigning: false

ui:
    appLocale: en_AE

    appInitialMapCenter: '[37.64, 55.74]'

    api:
        url: 'https://pro-api.example.com/'

    mapgl:
        host: 'mapgl-js-api.example.com'
        key: ''
        styleUrl: ''
        stylePreview: ''

    resources:
        requests:
            cpu: 300m
            memory: 256Mi
        limits:
            cpu: 1
            memory: 384Mi

    ingress:
        enabled: true
        className: nginx
        hosts:
            - host: pro-ui.example.com
              paths:
                  - path: /
                    pathType: Prefix
        tls: []
        #- hosts:
        #  - pro-ui.example.com
        #  secretName: secret.tls
```
Где:
- dgctlDockerRegistry: эндпоинт вашего реестра Docker, в котором находятся образы сервисов On-Premise. Пример: HOST:PORT.
- dgctlStorage: настройки хранилища артефактов развертывания.
  - Укажите общие настройки для доступа к хранилищу: endpoint, имя бакета, реквизиты для доступа.
  - manifest: укажите путь до файла с манифестом в формате manifests/1640661259.json. Этот файл содержит в себе описания фрагментов данных, которые требуются сервисам для работы. См. Жизненный цикл артефактов установки.
  - secure: использовать ли HTTPS для работы с S3-совместимым хранилищем. Значение по умолчанию: false.
  - region: регион S3-хранилища.
  - disablePayloadSigning: отключить ли проверку целостности данных. Если S3-совместимое хранилище не поддерживает AWS Signature Version 4 streaming, значение должно быть true. Значение по умолчанию: false.
- ui.appLocale: язык приложения. Возможные значения: en_AE, ru_RU.
- ui.appInitialMapCenter: координаты карты по умолчанию. Состоят из двух чисел в массиве: [lng, lat]. Например: [55.27, 25.2] для Дубая, [37.64, 55.74] для Москвы.
- ui.api.url: базовый URL для Pro API со слешем в конце. Пример: HTTP(S)://HOST/.
- ui.mapgl.host: хост сервиса MapGL JS API без протокола и без слеша в конце. Пример: HOST.
- ui.mapgl.key: API-ключ для сервиса MapGL JS API.
- ui.mapgl.styleUrl: путь к директории с конфигурационным файлом (styles.json) для управления стилями карты. Пример: //mapgl.ingress.host/style.
- ui.mapgl.stylePreview: URL для миниатюры изображения, которая будет отображаться в менеджере стилей карты для стиля по умолчанию.
- ui.resources: настройки вычислительных ресурсов для сервиса. Актуальная информация о рекомендуемых значениях настроек представлена в таблице с системными требованиями.
- ui.ingress: конфигурация ресурса Ingress. Адаптируйте приведенную конфигурацию для соответствия используемому вами Ingress. URL, указанный в параметре ingress.hosts.host, должен быть доступен извне вашего кластера Kubernetes, чтобы пользователи из приватного сегмента сети могли получить доступ к ресурсам по этому URL.
Разверните сервис с помощью Helm, используя подготовленный конфигурационный файл values-pro-ui.yaml:
```
helm upgrade --install --version=1.21.0 --atomic --values ./values-pro-ui.yaml pro-ui 2gis-on-premise/pro-ui
```

4. Проверьте работоспособность установленных сервисов

Выполните запрос с использованием cURL или аналогичного инструмента:

https://2GIS_API_HOST/building/items?bounds=POLYGON%20%28%2854.605596%2024.429549%2C%2054.539606%2024.429549%2C%2054.539606%2024.413378%2C%2054.605596%2024.413378%2C%2054.605596%2024.429549%29%29

Ответ должен иметь код состояния HTTP 200 и содержать список элементов в формате JSON.

Что дальше?

Узнайте, как обновить сервисы:

Обновление 2ГИС Про

Установите другие продукты программного комплекса 2ГИС: