Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Развертывание

Для развертывания и управления конфигурациями компонентов, используются команды:

deploy

Применяет построенные конфигурации к компонентам.

Также возвращает информацию о текущей, последней стабильной и последней построенной конфигурациях для каждого компонента – те же данные, которые возвращает команда deploy-status (кроме информации о конфигурациях в кэше). Данные возвращаются, только если указан формат вывода json: --output-format json. Структура возвращаемых данных приведена в описании команды deploy-status.

При развертывании проверяются идентификаторы хранилища состояний и исполняющего компонента. Проверка идентификаторов хранилищ выполняется, чтобы при смене среды исполнения история не терялась из-за разных идентификаторов хранилищ. Проверка идентификаторов исполняющих компонентов выполняется, чтобы не допустить развертывания на узел домена с определенным адресом конфигурации от другого исполняющего компонента. Если в проекте уже были применены конфигурации для другого хранилища состояний или исполняющего компонента, то при развертывании потребуется подтверждение операции. При этом появится предупреждением с необходимостью ввести имя узла, к которому следует применить конфигурации.

Информация о конфигурациях выводится для того, чтобы можно было получить информацию о текущем состоянии без необходимости дополнительного вызова.

Команда в ОС Windows:

devstudio.cli deploy --solution-path PATH
  [--target TARGET]
  [--comment COMMENT]
  [--runtime-environment RTE]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--target TARGET

Указывает исполняющие компоненты в решении, для которых будет выполнена команда.

В качестве значения нужно указать квалификатор:

  • либо непосредственно исполняющего компонента – команда будет выполнена для этого компонента.
  • либо любого узла, содержащего исполняющие компоненты: модуля, домена и т.д. – команда будет выполнена для всех исполняющих компонентов, вложенных в указанный узел, к которым применима.

Можно указать более одного значения параметра: для этого каждое значение нужно передать в виде отдельного параметра --target TARGET.

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

--comment COMMENT Комментарий к применяемым конфигурациям. Сохраняется в кэше домена.
--runtime-environment RTE

Среда исполнения. Подробнее о настройке среды исполнения можно почитать в разделе Подготовка среды исполнения и хранилища состояния.

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

--output-folder FOLDER

Папка вывода.

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

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

Применить построенные конфигурации к компонентам в ОС Windows:

devstudio.cli deploy --solution-path C:\My-project\My-solution.solution

Применить построенные конфигурации к компонентам в ОС Linux:

./devstudio.cli deploy --solution-path /home/user/Projects/My-solution.solution

Применить построенную конфигурацию к конкретному компоненту в ОС Windows:

devstudio.cli deploy --solution-path C:\My-project\My-solution.solution --target My-project.Domain.PC-Name.Server

Применить построенную конфигурацию к конкретному компоненту в ОС Linux:

./devstudio.cli deploy --solution-path /home/user/Projects/My-solution.solution --target My-project.Domain.PC-Name.Server

Применить построенные конфигурации ко всем компонентам на конкретном компьютере (в ОС Windows):

devstudio.cli deploy --solution-path C:\My-project\My-solution.solution
  --target My-project.Domain.PC-Name

Применить построенные конфигурации ко всем компонентам на конкретном компьютере (в ОС Linux):

./devstudio.cli deploy --solution-path /home/user/Projects/My-solution.solution
  --target My-project.Domain.PC-Name

Применить построенные конфигурации ко всем компонентам на конкретном компьютере, а также к компоненту на другом компьютере (в ОС Windows):

devstudio.cli deploy --solution-path C:\My-project\My-solution.solution --target My-project.Domain.PC-Name --target My-project.Domain.PC-Name2.Server

Применить построенные конфигурации ко всем компонентам на конкретном компьютере, а также к компоненту на другом компьютере (в ОС Linux):

./devstudio.cli deploy --solution-path /home/user/Projects/My-solution.solution --target My-project.Domain.PC-Name --target My-project.Domain.PC-Name2.Server

Применить построенные конфигурации в среде NewEnvironment (в ОС Windows):

devstudio.cli deploy --solution-path C:\My-project\My-solution.solution --runtime-environment NewEnvironment

Применить построенные конфигурации в среде NewEnvironment (в ОС Linux):

./devstudio.cli deploy --solution-path /home/user/Projects/My-solution.solution --runtime-environment NewEnvironment

deploy-status

Возвращает информацию о текущих и доступных конфигурациях компонентов.

Команда проверяет идентификаторы хранилища состояний и исполняющего компонента. Проверка идентификаторов хранилищ выполняется, чтобы при смене среды исполнения история не терялась из-за разных идентификаторов хранилищ. Проверка идентификаторов исполняющих компонентов выполняется, чтобы не допустить развертывания на узел домена с определенным адресом конфигурации от другого исполняющего компонента. Если в проекте уже было развернуто решение для другого хранилища состояний или исполняющего компонента, то при развертывании потребуется подтверждение операции. При этом появится предупреждением с необходимостью ввести имя узла, для которого вы запрашиваете информацию.

Команда в ОС Windows:

devstudio.cli deploy-status --solution-path PATH
  [--enum-versions]
  [--target TARGET]
  [--runtime-environment RTE]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Данные возвращаются, только если указан формат вывода json: --output-format json.

Информация, которую возвращает команда, выводится также при вызове всех других команд deploy*. Таким образом остальные команды выполняют основное действие и возвращают информацию о конфигурациях, а команда deploy-status – только возвращает информацию о конфигурациях. Дополнительно команда deploy-status позволяет получить информацию о доступных конфигурациях, которые хранятся в кэше домена (с помощью параметра --enum-versions).

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--enum-versions Если указан, для каждого исполняющего компонента вернется список версий конфигураций, хранящихся в кэше домена.
--target TARGET

Указывает исполняющие компоненты в решении, для которых будет выполнена команда.

В качестве значения нужно указать квалификатор:

  • либо непосредственно исполняющего компонента – команда будет выполнена для этого компонента.
  • либо любого узла, содержащего исполняющие компоненты: модуля, домена и т.д. – команда будет выполнена для всех исполняющих компонентов, вложенных в указанный узел, к которым применима.

Можно указать более одного значения параметра: для этого каждое значение нужно передать в виде отдельного параметра --target TARGET.

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

--runtime-environment RTE

Среда исполнения. Подробнее о настройке среды исполнения можно почитать в разделе Подготовка среды исполнения и хранилища состояния.

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

--output-folder FOLDER

Папка вывода.

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

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

Получить информацию о текущих и доступных конфигурациях компонентов в ОС Windows:

devstudio.cli deploy-status --solution-path C:\My-project\My-solution.solution
  --enum-versions --output-format json

Получить информацию о текущих и доступных конфигурациях компонентов в ОС Linux:

./devstudio.cli deploy-status --solution-path /home/user/Projects/My-solution.solution
  --enum-versions --output-format json

Структура возвращаемых данных:

{
  "source": "deploy-status",
  "deploy-status": [
    {
      "qualifier": QUALIFIER,
      "last-build": LAST_BUILD_INFO,
      "active-build": ACTIVE_BUILD_INFO,
      "stable-build": STABLE_BUILD_INFO,
      CACHED_BUILDS,
      ERROR
    },
    ...
  ]
}

, где:

  • QUALIFIER – квалификатор элемента, по которому возвращена информация.
  • LAST_BUILD_INFO – информация о последней сборке:

    • Если отсутствует – null.
    • Если есть – структура вида:

      {
        "version": "<версия сборки>",
        "artifacts-folder": "<папка сборки конфигурации>",
        "artifacts": [
          {
            "type": "cfg",
            "file-path": "<имя файла конфигурации>",
            "timestamp": <метка времени сборки>
          }
        ]
      }
  • ACTIVE_BUILD_INFO – информация о текущей конфигурации:

    • Если отсутствует, или ее не удалось запросить – null.
    • Если есть – структура вида:

      {
        "version": "<версия сборки>",
        "timestamp": <метка времени сборки>,
        "comment": "<комментарий>"
      }
  • STABLE_BUILD_INFO – информация о последней стабильной конфигурации:

    • Если отсутствует, или ее не удалось запросить – null.
    • Если есть – структура вида:

      {
        "version": "<версия сборки>",
        "timestamp": <метка времени сборки>,
        "comment": "<комментарий>"
      }
  • CACHED_BUILDS – информация о версиях конфигураций в кэше домена:

    "cached-builds": [
      {
        "version": "<версия сборки>",
        "timestamp": <метка времени сборки>,
        "comment": "<комментарий>"
      },
      ...
    ]

    Добавляется только если команда выполняется с параметром --enum-versions, иначе отсутствует.

  • ERROR – информация об ошибке в формате

    "error": "<message>"

    Добавляется только если произошла ошибка, иначе отсутствует.

Пример возвращаемых данных в ОС Windows:

{
  "source": "deploy-status",
  "deploy-status": [{
    "qualifier": "My-project/Domain.host.Server",
    "last-build": {
      "version": "1.0.1.d1",
      "artifacts-folder": "E:\\Projects\\My-project\\bin\\локальная\\Domain\\host\\Server",
      "artifacts": [{
        "type": "cfg",
        "file-path": "alpha.server.cfg",
        "timestamp": 637928642380000000
      }]
    },
    "active-build": {
      "version": "1.0.1.d1"
      "timestamp": 637928642380000000
    },
    "stable-build": {
      "version": "1.0.0.d1"
      "timestamp": 637928429520000000
    },
    "cached-builds": [
      {
        "version": "1.0.1.d1"
        "timestamp": 637928642380000000
      },
      {
        "version": "1.0.0.d1"
        "timestamp": 637928429520000000
      }
    ]
  }]
}

Пример возвращаемых данных в ОС Linux:

{
  "source": "deploy-status",
  "deploy-status": [{
    "qualifier": "My-project/Domain.host.Server",
    "last-build": {
      "version": "1.0.1.d1",
      "artifacts-folder": "\/home\/user\/Projects\/My-project\/bin\/локальная\/Domain\/host\/Server",
      "artifacts": [{
        "type": "cfg",
        "file-path": "alpha.server.cfg",
        "timestamp": 637928642380000000
      }]
    },
    "active-build": {
      "version": "1.0.1.d1"
      "timestamp": 637928642380000000
    },
    "stable-build": {
      "version": "1.0.0.d1"
      "timestamp": 637928429520000000
    },
    "cached-builds": [
      {
        "version": "1.0.1.d1"
        "timestamp": 637928642380000000
      },
      {
        "version": "1.0.0.d1"
        "timestamp": 637928429520000000
      }
    ]
  }]
}

deploy-commit

Подтверждает стабильность текущих конфигураций компонентов.

Также возвращает информацию о текущей, последней стабильной и последней построенной конфигурациях для каждого компонента – те же данные, которые возвращает команда deploy-status (кроме информации о конфигурациях в кэше). Данные возвращаются, только если указан формат вывода json: --output-format json. Структура возвращаемых данных приведена в описании команды deploy-status.

При развертывании проверяются идентификаторы хранилища состояний и исполняющего компонента. Проверка идентификаторов хранилищ выполняется, чтобы при смене среды исполнения история не терялась из-за разных идентификаторов хранилищ. Проверка идентификаторов исполняющих компонентов выполняется, чтобы не допустить развертывания на узел домена с определенным адресом конфигурации от другого исполняющего компонента. Если в проекте уже были применены конфигурации для другого хранилища состояний или исполняющего компонента, то при развертывании потребуется подтверждение операции. При этом появится предупреждением с необходимостью ввести имя узла, к которому следует применить конфигурации.

Информация о конфигурациях выводится для того, чтобы можно было получить информацию о текущем состоянии без необходимости дополнительного вызова.

Команда в ОС Windows:

devstudio.cli deploy-commit --solution-path PATH
  [--target TARGET]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--target TARGET

Указывает исполняющие компоненты в решении, для которых будет выполнена команда.

В качестве значения нужно указать квалификатор:

  • либо непосредственно исполняющего компонента – команда будет выполнена для этого компонента.
  • либо любого узла, содержащего исполняющие компоненты: модуля, домена и т.д. – команда будет выполнена для всех исполняющих компонентов, вложенных в указанный узел, к которым применима.

Можно указать более одного значения параметра: для этого каждое значение нужно передать в виде отдельного параметра --target TARGET.

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

--output-folder FOLDER

Папка вывода.

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

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

Подтвердить стабильность текущих конфигураций для всех компонентов в решении в ОС Windows:

devstudio.cli deploy-commit --solution-path C:\My-project\My-solution.solution

Подтвердить стабильность текущих конфигураций для всех компонентов в решении в ОС Linux:

./devstudio.cli deploy-commit --solution-path /home/user/Projects/My-solution.solution

deploy-rollback

Применяет к компонентам последние стабильные конфигурации.

Также возвращает информацию о текущей, последней стабильной и последней построенной конфигурациях для каждого компонента – те же данные, которые возвращает команда deploy-status (кроме информации о конфигурациях в кэше). Данные возвращаются, только если указан формат вывода json: --output-format json. Структура возвращаемых данных приведена в описании команды deploy-status.

При развертывании проверяются идентификаторы хранилища состояний и исполняющего компонента. Проверка идентификаторов хранилищ выполняется, чтобы при смене среды исполнения история не терялась из-за разных идентификаторов хранилищ. Проверка идентификаторов исполняющих компонентов выполняется, чтобы не допустить развертывания на узел домена с определенным адресом конфигурации от другого исполняющего компонента. Если в проекте уже были применены конфигурации для другого хранилища состояний или исполняющего компонента, то при развертывании потребуется подтверждение операции. При этом появится предупреждением с необходимостью ввести имя узла, к которому следует применить конфигурации.

Информация о конфигурациях выводится для того, чтобы можно было получить информацию о текущем состоянии без необходимости дополнительного вызова.

Команда в ОС Windows:

devstudio.cli deploy-rollback --solution-path PATH
  [--target TARGET]
  [--runtime-environment RTE]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--target TARGET

Указывает исполняющие компоненты в решении, для которых будет выполнена команда.

В качестве значения нужно указать квалификатор:

  • либо непосредственно исполняющего компонента – команда будет выполнена для этого компонента.
  • либо любого узла, содержащего исполняющие компоненты: модуля, домена и т.д. – команда будет выполнена для всех исполняющих компонентов, вложенных в указанный узел, к которым применима.

Можно указать более одного значения параметра: для этого каждое значение нужно передать в виде отдельного параметра --target TARGET.

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

--runtime-environment RTE

Среда исполнения. Подробнее о настройке среды исполнения можно почитать в разделе Подготовка среды исполнения и хранилища состояния.

Проверяет с каким хранилищем и исполняющим компонентом были построены активная и стабильная конфигурации.

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

--output-folder FOLDER

Папка вывода.

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

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

Откатить конфигурацию компонента до последней стабильной версии в ОС Windows:

devstudio.cli deploy-rollback --solution-path C:\My-project\My-solution.solution --target My-project.Domain.PC-Name.Server

Откатить конфигурацию компонента до последней стабильной версии в ОС Linux:

./devstudio.cli deploy-rollback --solution-path /home/user/Projects/My-solution.solution --target My-project.Domain.PC-Name.Server

deploy-select

Применяет к компонентам указанные версии конфигураций.

Также возвращает информацию о текущей, последней стабильной и последней построенной конфигурациях для каждого компонента – те же данные, которые возвращает команда deploy-status (кроме информации о конфигурациях в кэше). Данные возвращаются, только если указан формат вывода json: --output-format json. Структура возвращаемых данных приведена в описании команды deploy-status.

При развертывании проверяются идентификаторы хранилища состояний и исполняющего компонента. Проверка идентификаторов хранилищ выполняется, чтобы при смене среды исполнения история не терялась из-за разных идентификаторов хранилищ. Проверка идентификаторов исполняющих компонентов выполняется, чтобы не допустить развертывания на узел домена с определенным адресом конфигурации от другого исполняющего компонента. Если в проекте уже были применены конфигурации для другого хранилища состояний или исполняющего компонента, то при развертывании потребуется подтверждение операции. При этом появится предупреждением с необходимостью ввести имя узла, к которому следует применить конфигурации.

Информация о конфигурациях выводится для того, чтобы можно было получить информацию о текущем состоянии без необходимости дополнительного вызова.

Команда в ОС Windows:

devstudio.cli deploy-select --solution-path PATH
  [--version VERSION]
  [--target TARGET [--target-version TARGET_VERSION]]
  [--runtime-environment RTE]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--version VERSION

Версия, выбираемая по умолчанию для тех пар --target TARGET, для которых не переопределена с помощью параметра --target-version.

Если параметр не указан, для каждой пары --target TARGET нужно указать версию с помощью параметра --target-version.

--target TARGET

Указывает исполняющие компоненты в решении, для которых будет выполнена команда.

В качестве значения нужно указать квалификатор:

  • либо непосредственно исполняющего компонента – команда будет выполнена для этого компонента.
  • либо любого узла, содержащего исполняющие компоненты: модуля, домена и т.д. – команда будет выполнена для всех исполняющих компонентов, вложенных в указанный узел, к которым применима.

Можно указать более одного значения параметра: для этого каждое значение нужно передать в виде отдельного параметра --target TARGET.

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

--target-version TARGET_VERSION

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

По умолчанию используется версия, указанная с помощью параметра --version. Если она также не указана, вернется сообщение о том, что версия не выбрана.

--runtime-environment RTE

Среда исполнения. Подробнее о настройке среды исполнения можно почитать в разделе Подготовка среды исполнения и хранилища состояния.

Проверяет с каким хранилищем и исполняющим компонентом построена активная версия конфигурации и конфигурация, указанная вами.

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

--output-folder FOLDER

Папка вывода.

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

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

Применить ко всем компонентам указанную версию конфигураций в ОС Windows:

devstudio.cli deploy-select --solution-path C:\My-project\My-solution.solution --version 1.0.0

Применить ко всем компонентам указанную версию конфигураций в ОС Linux:

./devstudio.cli deploy-select --solution-path /home/user/Projects/My-solution.solution --version 1.0.0

Применить ко всем компонентам в проекте указанную версию конфигураций, и к конкретному компоненту – другую версию (в ОС Windows):

devstudio.cli deploy-select --solution-path C:\My-project\My-solution.solution --version 1.0.0
  --target My-project --target My-project.Domain.PC-Name.Server --target-version 2.0.0

Применить ко всем компонентам в проекте указанную версию конфигураций, и к конкретному компоненту – другую версию (в ОС Linux):

./devstudio.cli deploy-select --solution-path /home/user/Projects/My-solution.solution --version 1.0.0
  --target My-project --target My-project.Domain.PC-Name.Server --target-version 2.0.0