Установочные скрипты. Назначение и ключи


Введение

Для быстрого развёртывания, обновления, запуска, остановки и удаления Comindware Platform компания Comindware предоставляет дистрибутив со скриптами, настраивающими необходимое программное обеспечение.

Здесь представлены сведения о скриптах настройки конфигурации ПО и их ключах.

Пути к файлам и директориям

Используемые по умолчанию пути к файлам Comindware Platform см. в статье «Пути и содержимое директорий экземпляра ПО».

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

Скрипты для Linux и Windows

Для большинства операций в Linux и Windows предусмотрены одинаковые скрипты с соответствующим расширением: .sh или .ps1.

Если скрипты или синтаксис ключей для Linux и Windows отличаются, здесь представлены соответствующие ключи и примеры.

В зависимости от версии ПО, некоторые скрипты могут отсутствовать для той или иной операционной системы, если они для неё не требуются.

Обязательные ключи для скриптов

Если не указать обязательный ключ для любого скрипта, он запросит его после запуска.

Для некоторых скриптов не требуется указывать ключи и примеры их запуска здесь не представлены, так как для запуска достаточно указать имя скрипта в терминале.

Вызов справки для скриптов

Для ознакомления с ключами (если таковые имеются) и назначением большинства скриптов можно использовать ключ -h (Linux и Windows), --help (Linux) или -help (Windows) без указания каких-либо других ключей, например:

bash prerequisites_install.sh -h 
.\instance_upgrade.ps1 -h 

Далее ключ -h повторно не упоминается, так как он действует одинаково для всех скриптов.

Справка имеется не у всех скриптов

Для некоторых служебных, не предназначенных для вызова пользователем и не требующих объяснения скриптов ключ -h не предусмотрен.

Условные обозначения

Здесь используются следующие обозначения:

  • <instanceName> — имя экземпляра ПО.
  • <versionNumber> — номер версии ПО.
  • <portNumber> — номер порта.
  • <osname> — название ОС.
  • <versionPath> — путь к директории с версией ПО.
  • <hostName> — имя хоста экземпляра ПО.
  • <value> — значение, подставляемое пользователем.
  • <path/to> — путь к файлу или директории, подставляемый пользователем.

Скрипты для установки вспомогательного ПО

Скрипты для установки вспомогательного ПО расположены в следующей директории распакованного дистрибутива вспомогательного ПО:

  • Linux: X.X-release-ru-<versionNumber>.prerequisites.<osname>/CMW_<osname>/scripts
  • Windows: X.X-release-ru-<versionNumber>.prerequisites.Windows\CMW_Windows<versionNumber>\scripts

Скрипты для Linux и Windows

prerequisites_install

Назначение: установка и настройка вспомогательного ПО и зависимостей Comindware Platform.

Ключи:

  • Linux

    • -u=<user>, --user=<user> — указать пользователя для установки компонентов.
    • -g=<group>, --group=<group> — указать группу для установки компонентов.
    • -k, --kafka — установить Kafka.
    • -kc, --kafkaClient — установить клиентские библиотеки Kafka.
    • -d, --dotnet — установить .NET.
    • -o, --opensearch — установить OpenSearch.
    • -p, --platform — установить компоненты Comindware Platform.

    Пример:

    sh prerequisites_install.sh -p -d -k 
  • Windows

    • Используйте скрипт без ключей:
    .\prerequisites_install.ps1 

prerequisites_list

Назначение: вывод списка установленных компонентов вспомогательного ПО.

version_check

Назначение: проверка состояния среды и компонентов вспомогательного ПО.

version_check_environment

Назначение: проверка состояния среды — выводит статус и версию установленных компонентов, необходимых для работы вспомогательного ПО и Comindware Platform.

version_list

Назначение: вывод списка установленных версий Comindware Platform.

version_upgrade_onetime

Назначение: обновление установленной версии ПО Comindware Platform до новой с переносом файлов, остановкой и удалением старых сервисов, обновлением конфигураций и запуском новой версии.

Скрипты только для Windows

files_unblock

Назначение: разблокировка установочных файлов, скачанных из Интернета (снятие метки безопасности Zone.Identifier).

Ключ:

  • -path <path/to/distribution> — путь к распакованной директории с установочными файлами, которые требуется разблокировать. Если не указать этот ключ, скрипт разблокирует файлы в текущей директории.

Пример:

.\files_unblock.ps1 -path С:\Downloads\prerequisites 

Скрипты только для Linux

prerequisites_uninstall

Назначение: удаление выбранных компонентов вспомогательного ПО.

Ключи:

  • -d, --dotnet — удалить .NET.
  • -j, --java — удалить Java.
  • -k, --kafka — удалить Kafka.
  • -m, --mono — удалить Mono.
  • -n, --nginx — удалить Nginx.

Пример:

bash prerequisites_uninstall.sh -d -j 

Скрипты для установки Comindware Platform

Скрипты для установки ПО Comindware Platform расположены в следующей директории с распакованным дистрибутивом Comindware Platform:

  • Linux: X.X-release-ru-<versionNumber>.<osname>/CMW_<osname>_<versionNumber>/scripts
  • Windows: X.X-release-ru-<versionNumber>.Windows\CMW_Windows<versionNumber>\scripts

Кросс-платформенные скрипты

instance_check

Назначение: проверка состояния экземпляра ПО.

Ключ:

  • <instanceName> — имя экземпляра ПО (обязательный).

Пример:

bash instance_check.sh my_company_instance 

instance_create

Назначение: создание нового экземпляра Comindware Platform, генерация конфигурационных файлов, а также развёртывание демонстрационной базы данных.

Ключи:

  • Linux

    • -n=<instanceName>, --name=<instanceName> — указать имя экземпляра ПО (обязательный).
    • -p=<portNumber>, --port=<portNumber> — назначить порт экземпляру ПО (обязательный). По умолчанию: 80.
    • -v=<versionNumber>, --version=<versionNumber> — развернуть ПО указанной версии (обязательный).
    • -fqdn=<hostName>, --instance-fqdn=<hostName> — указать имя хоста для экземпляра ПО. По умолчанию: localhost.
    • -el=<value>, --elasticsearch-url=<value> — указать ссылку или IP-адрес службы Elasticsearch.
    • -kf=<value>, --kafka-url=<value> — указать ссылку или IP-адрес службы Kafka.
    • -d, --demoDB — создать экземпляр ПО c демонстрационной базой данных.

    Пример:

    bash instance_create.sh -n=my_company_instance -p=8080 -v=5.0.1234.0 
  • Windows

    • -name <instanceName> — указать имя экземпляра ПО (обязательный).
    • -port <portNumber> — назначить порт экземпляру ПО. По умолчанию: 80.
    • -version <versionNumber> — развернуть ПО указанной версии вида X.X.XXXX.X.
    • -versionPath <versionPath> — развернуть ПО из указанной папки <versionPath> с версией ПО.
    • -fqdn <hostName> — имя хоста для экземпляра ПО (опционально, по умолчанию: localhost).
    • -demoDB — создать экземпляр ПО c демонстрационной базой данных.

    Пример:

    .\instance_create.ps1 -name my_company_instance -port 8080 -version 5.0.1234.0 

instance_delete

Назначение: удаление экземпляра Comindware Platform, его конфигурационных файлов, а также пользовательских данных и всех связанных файлов.

Ключи:

  • Linux

    • -n=<instanceName>, --name=<instanceName> — указать имя экземпляра ПО (обязательный).
    • --deleteData — удалить базу данных и пользовательские файлы экземпляра ПО.
    • --deleteLogs — удалить журналы экземпляра ПО.
    • --deleteBackups — удалить резервные копии экземпляра ПО.

    Пример:

    bash instance_delete.sh -n=my_company_instance 
  • Windows

    • -name <instanceName> — указать имя экземпляра ПО (обязательный). Если не указать другие ключи, будет удалена только служба comindware<instanceName>.
    • -deleteData — удалить базу данных из папки вида и пользовательские файлы экземпляра ПО. Без указания этого ключа или ключа -clear база данных экземпляра ПО не будет удалена.
    • -clear — удалить все файлы, папки, базу данных и пользовательские файлы, а также службы экземпляра ПО, сайт и пул из IIS.

    Пример:

    .\instance_delete.ps1 -name my_company_instance -clear 

instance_list

Назначение: вывод списка установленных экземпляров ПО.

Ключи не требуются

instance_upgrade

Назначение: обновление экземпляра ПО.

Ключи:

  • Linux

    • -n=<instanceName>, --name=<instanceName> — указать имя экземпляра ПО (обязательный).
    • -vp=<path/to>, --versionPath=<path/to> — путь к папке с новой версией ПО (обязательный).

    Пример:

    bash instance_upgrade.sh -n=my_company_instance -vp=/comindware/5.0.1234.0 
  • Windows

    • -name <instanceName> — указать имя экземпляра ПО (обязательный).
    • -version <versionNumber> — указать номер версии, до которой необходимо обновить экземпляр ПО (обязательный).
    • -versionPath <path/to> — обновить экземпляр ПО до версии из указанной папки.

    Пример:

    .\instance_upgrade.ps1 -name my_company_instance -version 5.0.1234.0 

version_check

Назначение: проверка состояния среды и компонентов Comindware Platform.

Ключи не требуются

version_check_environment

Назначение: проверка состояния среды и компонентов Comindware Platform — выводит статус и версию установленных компонентов, необходимых для работы Comindware Platform.

version_delete

Назначение: удаление указанной версии ПО.

Ключи:

  • Linux

    • -v=<versionNumber>, --version=<versionNumber> — указать номер версии ПО (обязательный).

    Пример:

    sh version_delete.sh -v=5.0.1234.0 
  • Windows

    • -version <versionNumber> — указать номер версии ПО (обязательный).

    Пример:

    .\version_delete.ps1 -version 5.0.1234.0 

version_install

Назначение: установка версии ПО из текущей директории с дистрибутивом.

Ключи не требуются

version_list

Назначение: вывод списка установленных версий ПО.

Ключи не требуются

version_upgrade_onetime

Назначение: обновление установленной версии Comindware Platform до новой с переносом файлов, остановкой и удалением старых сервисов, обновлением конфигураций и запуском новой версии.

Ключи не требуются

Скрипты только для Windows

files_unblock

Назначение: разблокировка установочных файлов, скачанных из Интернета (снятие метки безопасности Zone.Identifier).

Ключ:

  • -path <path/to/distribution> — путь к распакованной директории с установочными файлами, которые требуется разблокировать. Если не указать этот ключ, скрипт разблокирует файлы в текущей директории.

Пример:

.\files_unblock.ps1 -path С:\Downloads\CMW 

instance_restore_from_backup

Назначение: восстановление данных экземпляра ПО из архивной резервной копии (файл .cdbbz) в указанные каталоги Database и Streams.

Ключи:

  • -zipPath <path/to> — указать путь к архиву резервной копии .cdbbz (обязательный).
  • -dataPath <path/to> — указать путь к каталогу Database для восстановления (обязательный).
  • -streamsPath <path/to> — указать путь к каталогу Streams для восстановления (обязательный).
  • -tempDir <path/to> — указать временный каталог для распаковки архива.
  • -deleteOldData — удалить старые данные перед восстановлением.

Пример:

.\instance_restore_from_backup.ps1 -zipPath C:\Documents\CMW_backup -dataPath C:\Documents\CMW\Database -streamsPath C:\Documents\CMW\Streams 

instance_start

Назначение: запуск экземпляра ПО.

Ключ:

  • -name <instanceName> — указать имя экземпляра ПО (обязательный).

Пример:

.\instance_start.ps1 -name my_company_instance 

instance_stop

Назначение: остановка экземпляра ПО.

Ключи:

  • -name <instanceName> — указать имя экземпляра ПО (обязательный).

Пример:

.\instance_stop.ps1 -name my_company_instance 

Служебные скрипты

Служебные скрипты являются вспомогательными и служат для вызова другими скриптами. Они не предназначены для самостоятельного запуска пользователем.

Список служебных скриптов (может измениться в зависимости от версии ПО):

Для Windows

Имя скрипта Назначение
adapterhost_config Генерация конфигурационного файла adapterhost.yml для экземпляра.
adapterhost_register Регистрация службы Adapterhost.
adapterhost_start Запуск службы Adapterhost.
adapterhost_stop Остановка службы Adapterhost.
adapterhost_unregister Удаление службы Adapterhost.
apigateway_register Регистрация службы Apigateway .
apigateway_start Запуск службы Apigateway.
apigateway_stop Остановка службы Apigateway.
apigateway_unregister Удаление службы Apigateway.
upgrade_config_file Обновление конфигурационных файлов при обновлении версии ПО.

Для Linux

Служебные скрипты для Linux организованы по директориям для работы с соответствующими службами.

Директория Назначение
components/adapterhost/ Управление службой AdapterHost
components/apigateway/ Управление службой ApiGateway
components/kafka/ Установка и настройка Kafka
components/nginx/ Установка и настройка Nginx
components/opensearch/ Установка и настройка OpenSearch
components/elasticsearch/ Установка и настройка Elasticsearch
К началу


Номер Статьи: 5122
Размещено: Thu, Oct 12, 2023
Последнее обновление: Tue, Jul 29, 2025

Online URL: https://kb.comindware.ru/article/ustanovochnye-skripty-naznachenie-i-klyuchi-5122.html