Создание пакета приложения

  • Статья

В этой статье описывается, как упаковать приложение Service Fabric и подготовить его для развертывания.

Макет пакета

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

tree /f .\MyApplicationType

D:\TEMP\MYAPPLICATIONTYPE
│   ApplicationManifest.xml
│
└───MyServiceManifest
    │   ServiceManifest.xml
    │
    ├───MyCode
    │       MyServiceHost.exe
    │
    ├───MyConfig
    │       Settings.xml
    │
    └───MyData
            init.dat

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

Использование SetupEntryPoint

Типичные сценарии использования SetupEntryPoint относятся к ситуации, когда необходимо запустить исполняемый файл перед запуском службы или выполнить операцию с повышенными привилегиями. Например:

  • Настройка и инициализация переменных среды, необходимых исполняемому файлу службы. Это касается не только исполняемых файлов, написанных с использованием моделей программирования Service Fabric. Например, npm.exe нужны определенные переменные среды, настроенные для развертывания приложения Node.js.
  • Настройка контроля доступа посредством установки сертификатов безопасности.

Дополнительные сведения о настройке SetupEntryPoint см. в статье Настройка политик безопасности для приложения.

Настройка

Создание пакета с помощью Visual Studio

При использовании Visual Studio для создания приложения вы можете использовать команду Package, чтобы автоматически создать пакет, который будет соответствовать вышеописанному макету.

Чтобы создать пакет, щелкните правой кнопкой проект приложения в обозревателе решений и выберите команду Package:

Создание пакета приложения с помощью Visual Studio

После завершения создания пакета в окне Вывод отобразятся сведения о расположении пакета. Шаг создания пакета выполняется автоматически при развертывании или отладке вашего приложения в Visual Studio.

Создание пакета с помощью командной строки

Приложение можно также упаковать программным способом, используя msbuild.exe. Этот файл выполняется в Visual Studio, так что результат будет тем же.

D:\Temp> msbuild HelloWorld.sfproj /t:Package

Тестирование пакета

Структуру пакета можно проверить локально средствами PowerShell, используя команду Test-ServiceFabricApplicationPackage . Эта команда проверит манифест на наличие ошибок при анализе, а также все ссылки. Эта команда позволяет проверить только правильность структуры каталогов и файлов в пакете. Она не проверяет содержимое пакетов кода или данных, а только наличие всех необходимых файлов.

Test-ServiceFabricApplicationPackage .\MyApplicationType

False
Test-ServiceFabricApplicationPackage : The EntryPoint MySetup.bat is not found.
FileName: C:\Users\servicefabric\AppData\Local\Temp\TestApplicationPackage_7195781181\nrri205a.e2h\MyApplicationType\MyServiceManifest\ServiceManifest.xml

Эта ошибка показывает, что файл MySetup.bat , на который ссылается манифест служб SetupEntryPoint , отсутствует в пакете кода. После добавления нужного файла будет выполнена проверка приложения.

tree /f .\MyApplicationType

D:\TEMP\MYAPPLICATIONTYPE
│   ApplicationManifest.xml
│
└───MyServiceManifest
    │   ServiceManifest.xml
    │
    ├───MyCode
    │       MyServiceHost.exe
    │       MySetup.bat
    │
    ├───MyConfig
    │       Settings.xml
    │
    └───MyData
            init.dat

Test-ServiceFabricApplicationPackage .\MyApplicationType

True

Если для приложения определены параметры приложения, их можно передать в командлет Test-ServiceFabricApplicationPackage для полной проверки.

Если вы уже знаете, в какой кластер будет развернуто приложение, мы советуем передать параметр ImageStoreConnectionString. В этом случае для пакета будет выполнена проверка на совместимость с предыдущими версиями приложения, уже запущенными в кластере. Например, такая проверка позволит обнаружить, если пакет имеет одинаковую версию, но разное содержимое с развернутым ранее пакетом.

Как только приложение будет упаковано должным образом и пройдет проверку, попробуйте сжать пакет для ускорения операций развертывания.

Сжатие пакета

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

Для сжатых и несжатых пакетов используется одинаковый механизм развертывания. Если пакет сжат, он хранится в хранилище образов кластера именно в таком виде, а перед запуском приложения распаковывается на целевом узле. Сжатие заменяет допустимый пакет Service Fabric его сжатой версией. Для этого нужны права на запись в папку. Если выполнить сжатие для уже сжатого пакета, никаких изменений не происходит.

Чтобы сжать пакет, выполните команду PowerShell Copy-ServiceFabricApplicationPackage с параметром CompressPackage. Чтобы распаковать сжатый пакет, выполните эту же команду с параметром UncompressPackage.

Следующая команда сжимает пакет, не копируя его в хранилище образов. Сжатый пакет можно скопировать в один или несколько кластеров Service Fabric, выполняя по мере необходимости командлет Copy-ServiceFabricApplicationPackage без флага SkipCopy. Теперь пакет содержит ZIP-файлы для пакетов code, config и data. Манифест приложения и манифесты служб не упаковываются в ZIP-файлы, так как они требуются для многих внутренних операций. Например, при совместном использовании пакетов, извлечении имени типа приложения и версии для определенных проверок всегда требуется доступ к манифестам. Сжатие манифеста снизит эффективность таких операций.

tree /f .\MyApplicationType

D:\TEMP\MYAPPLICATIONTYPE
│   ApplicationManifest.xml
│
└───MyServiceManifest
    │   ServiceManifest.xml
    │
    ├───MyCode
    │       MyServiceHost.exe
    │       MySetup.bat
    │
    ├───MyConfig
    │       Settings.xml
    │
    └───MyData
            init.dat

Copy-ServiceFabricApplicationPackage -ApplicationPackagePath .\MyApplicationType -CompressPackage -SkipCopy
tree /f .\MyApplicationType

D:\TEMP\MYAPPLICATIONTYPE
│   ApplicationManifest.xml
│
└───MyServiceManifest
       ServiceManifest.xml
       MyCode.zip
       MyConfig.zip
       MyData.zip

Кроме того, сжатие и копирование пакета можно выполнить одним действием, используя командлет Copy-ServiceFabricApplicationPackage. Если пакет имеет большой размер, обеспечьте достаточное время ожидания для сжатия пакета и его отправки в кластер.

Copy-ServiceFabricApplicationPackage -ApplicationPackagePath .\MyApplicationType -ApplicationPackagePathInImageStore MyApplicationType -ImageStoreConnectionString fabric:ImageStore -CompressPackage -TimeoutSec 5400

Для внутренней проверки Service Fabric вычисляет контрольные суммы для пакетов приложений. Если используется сжатие, контрольные суммы вычисляются для ZIP-версий каждого пакета. При создании нового ZIP-файла из одного и того же пакета приложения получаются разные контрольные суммы. Чтобы избежать ошибок проверки, используйте подготовку diff. В этом режиме не следует включать пакеты без изменений в новую версию. Вместо этого на них нужно непосредственно ссылаться в новом манифесте службы.

Если подготовку diff выполнить нельзя и необходимо включить пакеты, создайте новые версии для пакетов code, config и data, чтобы избежать несовпадения контрольной суммы. Создание новых версий для пакетов без изменений необходимо, когда используется сжатый пакет, независимо от того, выполнено ли сжатие в предыдущей версии.

Теперь пакет правильно упакован, проверен и сжат (если нужно), так что все готово для развертывания в один или несколько кластеров Service Fabric.

Сжатие пакетов при развертывании с помощью Visual Studio

Можно настроить Visual Studio для сжатия пакетов при развертывании, добавив элемент CopyPackageParameters в профиль публикации, а также задав для атрибута CompressPackage значение true.

    <PublishProfile xmlns="http://schemas.microsoft.com/2015/05/fabrictools">
        <ClusterConnectionParameters ConnectionEndpoint="mycluster.westus.cloudapp.azure.com" />
        <ApplicationParameterFile Path="..\ApplicationParameters\Cloud.xml" />
        <CopyPackageParameters CompressPackage="true"/>
    </PublishProfile>

Создание пакета sfpkg

Начиная с версии 6.1 Service Fabric позволяет выполнять подготовку из внешнего хранилища. В этом режиме нет необходимости копировать пакет приложения в хранилище образов. Вместо этого можно создать файл sfpkg и отправить его во внешнее хранилище, а затем указать URI для Service Fabric во время подготовки. Один и тот же пакет можно подготовить в нескольких кластерах. Подготовка из внешнего хранилища экономит время, необходимое для копирования пакета в каждый кластер.

Файл sfpkg — это ZIP-архив, содержащий изначальный пакет приложения с расширением .sfpkg. Внутри ZIP-архива пакет приложения может быть сжатым или несжатым. Сжатие пакета приложения внутри ZIP-архива выполняется на уровнях кода, конфигурации и пакетов данных, как упоминалось ранее.

Чтобы создать файл sfpkg, начните с папки, содержащей исходный пакет приложения, будь он сжатым или нет. Затем с помощью любой программы упакуйте папку в ZIP-архив с расширением .sfpkg. Например, используйте метод ZipFile.CreateFromDirectory.

ZipFile.CreateFromDirectory(appPackageDirectoryPath, sfpkgFilePath);

sfpkg необходимо отправить во внешнее хранилище за пределами диапазона — за пределами Service Fabric. Внешним хранилищем может быть любое хранилище, предоставляющее конечную точку REST HTTP или HTTPS. Во время подготовки Service Fabric выполняет операцию GET для скачивания пакета приложения sfpkg. Поэтому хранилище должно разрешать доступ на чтение к пакету.

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

Примечание.

Сейчас подготовка на основе относительного пути в хранилище образов не поддерживает файлы sfpkg. Таким образом, sfpkg не следует копировать в хранилище образов.

Следующие шаги

В статье Развертывание и удаление приложений представлены сведения об управлении экземплярами приложений с помощью PowerShell.

В статье Управление параметрами приложения для нескольких сред описано, как настроить параметры и переменные среды для различных экземпляров приложений.

В статье Настройка политик безопасности для приложения содержатся данные о работе служб в соответствии с политиками безопасности, ограничивающими доступ.