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

Конфигурационный файл 2GIS CLI

Перед запуском утилиты 2GIS CLI необходимо создать конфигурационный файл.

Файл имеет следующую структуру:

key: <License key>
log-format: <text | json>

storage:
    type: <s3 | fs>

    # S3 storage settings
    host: <Installation Artifacts Storage host name and port>
    secure: <bool>
    bucket: <Installation Artifacts Storage bucket name>
    access-key: <Installation Artifacts Storage access key>
    secret-key: <Installation Artifacts Storage secret key>

    # FS (filesystem) storage settings
    directory: <target directory on a filesystem>

docker:
    registry:
        username: <Docker Registry username>
        password: <Docker Registry password>
        server-address: <Docker Registry URL>
        image-prefix: <Additional prefix (optional)>

# Для утилиты версии 3
components:
    core:
        version: <version>
    api-platform:
        version: <version>
    pro:
        version: <version>
    citylens:
        version: <version>
    gis-platform:
        version: <version>

Где:

  • key: Лицензия на программный комплекс 2ГИС.

  • log-format: формат логов — text или json. Все логи выводятся в стандартный поток вывода (stdout).

  • storage: настройки для используемого типа хранилища.

    • Для S3-совместимого хранилища:

      • type: тип хранилища. Значение должно быть s3.
      • host: FQDN endpoint-а S3-совместимого хранилища.
      • secure: использовать ли HTTPS для работы с S3-совместимым хранилищем. Значение по умолчанию: false.
      • bucket: имя бакета для хранения артефактов установки.
      • access-key: идентификатор ключа (S3 access key).
      • secret-key: секретный ключ (S3 secret key).

    • Для хранилища на файловой системе:

      • type: тип хранилища. Значение должно быть fs.

      • directory: целевая директория в файловой системе, куда будут загружаться артефакты установки.

        Монтирование директории к Docker-контейнеру выполняется с помощью аргумента -v <путь>:/dgctl-source при запуске утилиты, см. справку по командам и аргументам 2GIS CLI.

        Путь к директории следует указывать в том виде, в котором она доступна изнутри Docker-контейнера. Аргументы в справке по командам и аргументам 2GIS CLI подобраны так, чтобы работать с путём /dgctl-source (для режима pull) или /dgctl-target (для режима restore).

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

    В одном конфигурационном файле могут присутствовать настройки только для одного типа хранилища. Если требуется запускать 2GIS CLI для разных типов хранилища, создайте для каждого из них отдельные конфигурационные файлы.

  • docker.registry: настройки для доступа к реестру Docker.

    • username: имя пользователя.

    • password: пароль.

    • server-address: URL реестра.

    • image-prefix: дополнительный префикс, под которым будут храниться образы сервисов программного комплекса 2ГИС.

      Все образы сервисов, скачанные при помощи 2GIS CLI, имеют предустановленный префикс 2gis-on-premise. Его не нужно указывать здесь.

    Примечание:

    Если выбранный сценарий использования 2GIS CLI не предполагает использование реестра, эту секцию настроек конфигурационного файла можно опустить.

  • components: список компонентов и их версий для установки.

    • core: базовый компонент для работы любых других компонентов решения On-Premise, включает в себя сервис лицензий и сервис API-ключей. Номера версий компонента см. в разделе Релизы базовых сервисов.
    • api-platform: API-платформа, включает в себя API для работы с картами, поиском и навигацией, сервис сбора статистики, прокси для API пробок и Менеджер Платформы. Номера версий компонента см. в разделе Релизы API-платформы.
    • pro: 2ГИС Про, включает в себя сервисы Pro API и Pro UI. Номера версий компонента см. в разделе Релизы 2ГИС Про.
    • citylens: 2ГИС Ситискан, включает в себя сервисы CityLens API, CityLens Routing API и CityLens Routing UI. Номера версий компонента см. в разделе Релизы 2ГИС Ситискан.
    • gis-platform: GIS-платформа. Номера версий компонента см. в разделе Релизы GIS-платформы.

    Для каждого компонента укажите номер версии в параметре version. Не указывайте номера сервисов, входящих в состав компонента. Список компонентов и ссылки на описание релизов см. выше.