Руководство. Упаковка и развертывание контейнеров в виде приложений Service Fabric с помощью Yeoman
Это руководство представляет собой вторую часть цикла. В нем описывается, как с помощью инструмента создания шаблонов (Yeoman) создать определение приложения Service Fabric. Это приложение затем можно использовать для развертывания контейнеров в Service Fabric. Из этого руководства вы узнаете, как выполнить следующие задачи:
- установка Yeoman;
- создание пакета приложения с помощью Yeoman;
- настройка параметров в пакете приложения для контейнеров;
- Сборка приложения
- развертывание и запуск приложения;
- очистка приложения.
Необходимые компоненты
- Образы контейнеров, переданные в реестр контейнеров Azure при изучении первой части этого цикла руководств.
- Настроенная среда разработки Linux.
установка Yeoman;
Service Fabric предоставляет средства формирования шаблонов, которые позволяют создавать приложения из терминала с помощью генератора шаблонов Yeoman. Выполните приведенные ниже действия, чтобы получить генератор шаблонов Yeoman.
Установите Node.js и диспетчер пакетов узла на компьютере. Если вы используете macOS X, вам придется использовать диспетчер пакетов Homebrew.
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash nvm install node
Установите на компьютере генератор шаблонов Yeoman из диспетчера пакетов узла.
npm install -g yo
Установите генератор контейнеров Yeoman для Service Fabric.
npm install -g generator-azuresfcontainer
Упаковка контейнера образов Docker с помощью Yeoman
Чтобы создать приложение-контейнер Service Fabric, выполните приведенную ниже команду в каталоге container-tutorial клонированного репозитория.
yo azuresfcontainer
Введите TestContainer в качестве имени приложения.
Введите azurevotefront в качестве имени службы приложения.
Укажите путь к образу контейнера в записи контроля доступа (ACR) для репозитория внешнего интерфейса. Пример: <acrName>.azurecr.io/azure-vote-front:v1. В поле <acrName> нужно указать то же значение, что и при работе с предыдущим руководством.
Нажмите клавишу ВВОД, чтобы оставить раздел "Команды" пустым.
Укажите число экземпляров — 1.
Ниже показаны входные и выходные данные выполнения команды yo.
? Name your application TestContainer
? Name of the application service: azurevotefront
? Input the Image Name: <acrName>.azurecr.io/azure-vote-front:v1
? Commands:
? Number of instances of guest container application: 1
create TestContainer/TestContainer/ApplicationManifest.xml
create TestContainer/TestContainer/azurevotefrontPkg/ServiceManifest.xml
create TestContainer/TestContainer/azurevotefrontPkg/config/Settings.xml
create TestContainer/TestContainer/azurevotefrontPkg/code/Dummy.txt
create TestContainer/install.sh
create TestContainer/uninstall.sh
Чтобы добавить службу контейнеров в приложение, созданное с использованием Yeoman, выполните следующие действия:
- Измените один уровень каталога на TestContainer, например ./TestContainer.
- Выполнить
yo azuresfcontainer:AddService
- Присвойте службе имя azurevoteback.
- Укажите путь к образу контейнера для Redis — redis:alpine.
- Нажмите клавишу ВВОД, чтобы оставить раздел "Команды" пустым.
- Укажите число экземпляров — 1.
Показаны все введенные данные для добавления службы.
? Name of the application service: azurevoteback
? Input the Image Name: redis:alpine
? Commands:
? Number of instances of guest container application: 1
create TestContainer/azurevotebackPkg/ServiceManifest.xml
create TestContainer/azurevotebackPkg/config/Settings.xml
create TestContainer/azurevotebackPkg/code/Dummy.txt
В оставшейся части этого руководства мы выполняем действия в каталоге TestContainer. Например ./TestContainer/TestContainer. Содержимое этого каталога должно быть следующим:
$ ls
ApplicationManifest.xml azurevotefrontPkg azurevotebackPkg
Настройка учетных данных для реестра контейнера Azure в манифесте приложения
Чтобы платформа Service Fabric могла извлекать образы контейнеров из реестра контейнеров Azure, необходимо предоставить учетные данные в файле ApplicationManifest.xml.
Выполните вход в свой экземпляр Реестра контейнеров Azure. Используйте команду az acr login, чтобы выполнить операцию. Укажите уникальное имя реестра контейнеров, заданное при его создании.
az acr login --name <acrName>
После выполнения эта команда возвращает сообщение Login Succeeded (Вход выполнен).
Затем выполните следующую команду, чтобы получить пароль реестра контейнеров. Этот пароль используется Service Fabric, чтобы проходить аутентификацию в реестре контейнеров Azure для извлечения образов контейнеров.
az acr credential show -n <acrName> --query passwords[0].value
Добавьте приведенный ниже фрагмент кода в файл ApplicationManifest.xml после элемента ServiceManifestImport для внешней службы. Вставьте значение acrName в поле Имя учетной записи, а пароль, возвращенный предыдущей командой, укажите в поле Пароль. Полный пример файла ApplicationManifest.xml приведен в конце этого документа.
<Policies>
<ContainerHostPolicies CodePackageRef="Code">
<RepositoryCredentials AccountName="<acrName>" Password="<password>" PasswordEncrypted="false"/>
</ContainerHostPolicies>
</Policies>
Настройка обмена данными и сопоставления порта контейнера с портом узла
Настройка порта связи
Настройте конечную точку HTTP, чтобы клиенты могли обмениваться данными со службой. Откройте файл ./TestContainer/azurevotefrontPkg/ServiceManifest.xml и объявите ресурс конечной точки в элементе ServiceManifest. Добавьте протокол, порт и имя. В этом руководстве служба ожидает передачи данных через порт 80. Следующий фрагмент кода помещается под тегом ServiceManifest в ресурсе.
<Resources>
<Endpoints>
<!-- This endpoint is used by the communication listener to obtain the port on which to
listen. Please note that if your service is partitioned, this port is shared with
replicas of different partitions that are placed in your code. -->
<Endpoint Name="azurevotefrontTypeEndpoint" UriScheme="http" Port="80" Protocol="http"/>
</Endpoints>
</Resources>
Соответствующим образом измените манифест для внутренней службы. Откройте файл ./TestContainer/azurevotebackPkg/ServiceManifest.xml и объявите ресурс конечной точки в элементе ServiceManifest. В этом руководстве используется порт Redis по умолчанию — 6379. Следующий фрагмент кода помещается под тегом ServiceManifest в ресурсе.
<Resources>
<Endpoints>
<!-- This endpoint is used by the communication listener to obtain the port on which to
listen. Please note that if your service is partitioned, this port is shared with
replicas of different partitions that are placed in your code. -->
<Endpoint Name="azurevotebackTypeEndpoint" Port="6379" Protocol="tcp"/>
</Endpoints>
</Resources>
Если указать UriScheme, конечная точка контейнера будет автоматически зарегистрирована в службе именования Service Fabric, что обеспечит ее обнаружение. Полный пример файла ServiceManifest.xml для внутренней службы приведен в конце этой статьи.
Сопоставление портов контейнера со службой
Чтобы предоставить контейнеры в кластере, необходимо также создать привязку порта в ApplicationManifest.xml. В политике PortBinding указаны конечные точки, определенные в файле ServiceManifest.xml. Входящие запросы к этим конечным точкам сопоставляются с портами контейнера, которые открыты и привязаны с помощью данного файла. Добавьте приведенный ниже код в файл ApplicationManifest.xml, чтобы привязать порты 80 и 6379 к конечным точкам. Полный пример файла ApplicationManifest.xml доступен в конце этого документа.
<ContainerHostPolicies CodePackageRef="Code">
<PortBinding ContainerPort="80" EndpointRef="azurevotefrontTypeEndpoint"/>
</ContainerHostPolicies>
<ContainerHostPolicies CodePackageRef="Code">
<PortBinding ContainerPort="6379" EndpointRef="azurevotebackTypeEndpoint"/>
</ContainerHostPolicies>
Добавление DNS-имени для внутренней службы
Чтобы платформа Service Fabric назначила DNS-имя внутренней службе, оно должно быть указано в файле ApplicationManifest.xml. Добавьте атрибут ServiceDnsName в элемент Service, как показано ниже.
<Service Name="azurevoteback" ServiceDnsName="redisbackend.testapp">
<StatelessService ServiceTypeName="azurevotebackType" InstanceCount="1">
<SingletonPartition/>
</StatelessService>
</Service>
Внешняя служба считывает переменную среды, чтобы узнать DNS-имя экземпляра Redis. Эта переменная среды уже определена в файле Dockerfile, использованном для создания образа Docker. Поэтому на текущем этапе никакие действия не требуются.
ENV REDIS redisbackend.testapp
В следующем фрагменте кода показано, как в коде Python внешнего интерфейса получить переменную среды, описанную в Dockerfile. На этом этапе никакие действия не требуются.
# Get DNS Name
redis_server = os.environ['REDIS']
# Connect to the Redis store
r = redis.StrictRedis(host=redis_server, port=6379, db=0)
На этом этапе данного руководства шаблон для приложения пакета службы доступен для развертывания в кластере. В следующем руководстве это приложение развертывается и запускается в кластере Service Fabric.
Создание кластера Service Fabric
Чтобы развернуть приложение в Azure, требуется кластер Service Fabric, в котором будет выполняться приложение. С помощью следующих команд можно создать кластер из пяти узлов в Azure. Команды также создают самозаверяющий сертификат, добавляют его в хранилище ключей и скачивают сертификат в виде PEM-файла на локальный компьютер. Новый сертификат используется для защиты кластера во время развертывания и для проверки подлинности клиентов.
#!/bin/bash
# Variables
ResourceGroupName="containertestcluster"
ClusterName="containertestcluster"
Location="eastus"
Password="q6D7nN%6ck@6"
Subject="containertestcluster.eastus.cloudapp.azure.com"
VaultName="containertestvault"
VmPassword="Mypa$$word!321"
VmUserName="sfadminuser"
# Login to Azure and set the subscription
az login
az account set --subscription <mySubscriptionID>
# Create resource group
az group create --name $ResourceGroupName --location $Location
# Create secure five node Linux cluster. Creates a key vault in a resource group
# and creates a certficate in the key vault. The certificate's subject name must match
# the domain that you use to access the Service Fabric cluster.
# The certificate is downloaded locally as a PEM file.
az sf cluster create --resource-group $ResourceGroupName --location $Location \
--certificate-output-folder . --certificate-password $Password --certificate-subject-name $Subject \
--cluster-name $ClusterName --cluster-size 5 --os UbuntuServer1804 --vault-name $VaultName \
--vault-resource-group $ResourceGroupName --vm-password $VmPassword --vm-user-name $VmUserName
Примечание.
Служба веб-интерфейса ожидает передачи данных через порт 80 для входящего трафика. По умолчанию порт 80 открыт в виртуальных машинах кластера и в подсистеме балансировки нагрузки Azure.
См. дополнительные сведения о создании кластера Service Fabric в Azure.
Выполнение сборки приложения и его развертывание в кластере
Приложение можно развернуть в кластере Azure с помощью интерфейса командной строки Service Fabric. На вашем компьютере не установлен интерфейс командной строки Service Fabric, следуйте этим инструкциям, чтобы установить его.
Подключитесь к кластеру Service Fabric в Azure. Замените конечную точку собственной. Конечная точка должна быть в формате полного URL-адреса, как показано ниже. PEM-файл — это самозаверяющий сертификат, который был создан ранее.
sfctl cluster select --endpoint https://containertestcluster.eastus.cloudapp.azure.com:19080 --pem containertestcluster22019013100.pem --no-verify
С помощью сценария установки в каталоге TestContainer скопируйте пакет приложения в хранилище образов кластера, зарегистрируйте тип приложения и создайте экземпляр приложения.
./install.sh
Откройте браузер и перейдите к Service Fabric Explorer по адресу https://containertestcluster.eastus.cloudapp.azure.com:19080/Explorer. Разверните узел Applications. Вы увидите одну запись для типа приложения и еще одну — для его экземпляра.
Чтобы подключиться к работающему приложению, откройте браузер и перейдите по URL-адресу кластера (например, http://containertestcluster.eastus.cloudapp.azure.com:80.). Вы должны увидеть приложение Voting в пользовательском веб-интерфейсе.
Очистка
Чтобы удалить экземпляр приложения из кластера и отменить регистрацию типа приложения, используйте скрипт удаления, предоставленный в шаблоне. Очистка экземпляра займет некоторое время. Поэтому не следует выполнять команду install.sh сразу же после выполнения сценария удаления.
./uninstall.sh
Примеры готовых манифестов
ApplicationManifest.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ApplicationManifest ApplicationTypeName="TestContainerType" ApplicationTypeVersion="1.0.0" xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<ServiceManifestImport>
<ServiceManifestRef ServiceManifestName="azurevotefrontPkg" ServiceManifestVersion="1.0.0"/>
<Policies>
<ContainerHostPolicies CodePackageRef="Code">
<RepositoryCredentials AccountName="myaccountname" Password="<password>" PasswordEncrypted="false"/>
<PortBinding ContainerPort="80" EndpointRef="azurevotefrontTypeEndpoint"/>
</ContainerHostPolicies>
</Policies>
</ServiceManifestImport>
<ServiceManifestImport>
<ServiceManifestRef ServiceManifestName="azurevotebackPkg" ServiceManifestVersion="1.0.0"/>
<Policies>
<ContainerHostPolicies CodePackageRef="Code">
<PortBinding ContainerPort="6379" EndpointRef="azurevotebackTypeEndpoint"/>
</ContainerHostPolicies>
</Policies>
</ServiceManifestImport>
<DefaultServices>
<Service Name="azurevotefront">
<StatelessService ServiceTypeName="azurevotefrontType" InstanceCount="1">
<SingletonPartition/>
</StatelessService>
</Service>
<Service Name="azurevoteback" ServiceDnsName="redisbackend.testapp">
<StatelessService ServiceTypeName="azurevotebackType" InstanceCount="1">
<SingletonPartition/>
</StatelessService>
</Service>
</DefaultServices>
</ApplicationManifest>
ServiceManifest.xml для внешнего интерфейса
<?xml version="1.0" encoding="utf-8"?>
<ServiceManifest Name="azurevotefrontPkg" Version="1.0.0"
xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" >
<ServiceTypes>
<StatelessServiceType ServiceTypeName="azurevotefrontType" UseImplicitHost="true">
</StatelessServiceType>
</ServiceTypes>
<CodePackage Name="code" Version="1.0.0">
<EntryPoint>
<ContainerHost>
<ImageName>acrName.azurecr.io/azure-vote-front:v1</ImageName>
<Commands></Commands>
</ContainerHost>
</EntryPoint>
<EnvironmentVariables>
</EnvironmentVariables>
</CodePackage>
<Resources>
<Endpoints>
<!-- This endpoint is used by the communication listener to obtain the port on which to
listen. Please note that if your service is partitioned, this port is shared with
replicas of different partitions that are placed in your code. -->
<Endpoint Name="azurevotefrontTypeEndpoint" UriScheme="http" Port="80" Protocol="http"/>
</Endpoints>
</Resources>
</ServiceManifest>
ServiceManifest.xml для Redis
<?xml version="1.0" encoding="utf-8"?>
<ServiceManifest Name="azurevotebackPkg" Version="1.0.0"
xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" >
<ServiceTypes>
<StatelessServiceType ServiceTypeName="azurevotebackType" UseImplicitHost="true">
</StatelessServiceType>
</ServiceTypes>
<CodePackage Name="code" Version="1.0.0">
<EntryPoint>
<ContainerHost>
<Commands></Commands>
</ContainerHost>
</EntryPoint>
<EnvironmentVariables>
</EnvironmentVariables>
</CodePackage>
<Resources>
<Endpoints>
<!-- This endpoint is used by the communication listener to obtain the port on which to
listen. Please note that if your service is partitioned, this port is shared with
replicas of different partitions that are placed in your code. -->
<Endpoint Name="azurevotebackTypeEndpoint" Port="6379" Protocol="tcp"/>
</Endpoints>
</Resources>
</ServiceManifest>
Следующие шаги
В этом руководстве несколько контейнеров было упаковано в приложение Service Fabric с помощью Yeoman. Затем это приложение было развернуто и запущено в кластере Service Fabric. Были выполнены следующие действия:
- установка Yeoman;
- создание пакета приложения с помощью Yeoman;
- настройка параметров в пакете приложения для контейнеров;
- Сборка приложения
- развертывание и запуск приложения;
- очистка приложения.
Перейдите к следующему руководству, чтобы изучить отработку отказа и масштабирование приложения в Service Fabric.