Azure 云服务定义 WorkerRole 架构

• 11/06/2017
• 作者
  • 
  • 

Azure 辅助角色对普通开发非常有用，可为 web 角色执行后台处理。

服务定义文件的默认扩展名为 .csdef。

辅助角色的基本服务定义架构。

对于包含辅助角色的服务定义文件，其基本格式如下所示。

<ServiceDefinition …>
  <WorkerRole name="<worker-role-name>" vmsize="<worker-role-size>" enableNativeCodeExecution="[true|false]">
    <Certificates>
      <Certificate name="<certificate-name>" storeLocation="[CurrentUser|LocalMachine]" storeName="[My|Root|CA|Trust|Disallow|TrustedPeople|TrustedPublisher|AuthRoot|AddressBook|<custom-store>" />
    </Certificates>
    <ConfigurationSettings>
      <Setting name="<setting-name>" />
    </ConfigurationSettings>
    <Endpoints>
      <InputEndpoint name="<input-endpoint-name>" protocol="[http|https|tcp|udp]" localPort="<local-port-number>" port="<port-number>" certificate="<certificate-name>" loadBalancerProbe="<load-balancer-probe-name>" />
      <InternalEndpoint name="<internal-endpoint-name" protocol="[http|tcp|udp|any]" port="<port-number>">
         <FixedPort port="<port-number>"/>
         <FixedPortRange min="<minium-port-number>" max="<maximum-port-number>"/>
      </InternalEndpoint>
     <InstanceInputEndpoint name="<instance-input-endpoint-name>" localPort="<port-number>" protocol="[udp|tcp]">
         <AllocatePublicPortFrom>
            <FixedPortRange min="<minium-port-number>" max="<maximum-port-number>"/>
         </AllocatePublicPortFrom>
      </InstanceInputEndpoint>
    </Endpoints>
    <Imports>
      <Import moduleName="[RemoteAccess|RemoteForwarder|Diagnostics]"/>
    </Imports>
    <LocalResources>
      <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    </LocalResources>
    <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    <Runtime executionContext="[limited|elevated]">
      <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
      </Environment>
      <EntryPoint>
         <NetFxEntryPoint assemblyName="<name-of-assembly-containing-entrypoint>" targetFrameworkVersion="<.net-framework-version>"/>
         <ProgramEntryPoint commandLine="<application>" setReadyOnProcessStart="[true|false]" "/>
      </EntryPoint>
    </Runtime>
    <Startup priority="<for-internal-use-only>”>
      <Task commandLine="" executionContext="[limited|elevated]" taskType="[simple|foreground|background]">
        <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
        </Environment>
      </Task>
    </Startup>
    <Contents>
      <Content destination="<destination-folder-name>" >
        <SourceDirectory path="<local-source-directory>" />
      </Content>
    </Contents>
  </WorkerRole>
</ServiceDefinition>

架构元素

服务定义文件包括以下元素，本主题的后续部分将进行详细说明：

WorkerRole

ConfigurationSettings

设置

LocalResources

LocalStorage

Endpoints

InputEndpoint

InternalEndpoint

InstanceInputEndpoint

AllocatePublicPortFrom

FixedPort

FixedPortRange

Certificates

Certificate

Imports

Import

Runtime

Environment

EntryPoint

NetFxEntryPoint

ProgramEntryPoint

Variable

RoleInstanceValue

ServiceDefinition.csdef

Task

Contents

Content

SourceDirectory

WorkerRole

WorkerRole 元素描述一个对普通开发非常有用并且可为 web 角色执行后台处理的角色。 一个服务可能包含零个或多个辅助角色。

下表描述 WorkerRole 元素的属性。

ConfigurationSettings

ConfigurationSettings 元素描述辅助角色的配置设置集。 此元素是 Setting 元素的父级。

Setting

Setting 元素描述用于为角色实例指定配置设置的名称和值对。

下表描述 Setting 元素的属性。

角色的配置设置是在服务定义文件中声明并在服务配置文件中设置的名称-值对。

LocalResources

LocalResources 元素描述辅助角色的本地存储资源集。 此元素是 LocalStorage 元素的父级。

LocalStorage

LocalStorage 元素标识用于在运行时为服务提供文件系统空间的本地存储资源。 一个角色可以定义零个或多个本地存储资源。

下表描述 LocalStorage 元素的属性。

分配给本地存储资源的目录的名称对应于为名称属性提供的值。

Endpoints

Endpoints 元素描述角色的输入（外部）、内部和实例输入终结点的集合。 此元素是 InputEndpoint、InternalEndpoint 和 InstanceInputEndpoint 元素的父级。

输入和内部终结点是单独分配的。 一个服务可共有 25 个输入、内部和实例输入终结点，这些终结点可在一个服务中允许存在的 25 个角色间分配。 例如，如果有 5 个角色，则可以向每个角色分配 5 个输入终结点，或者向一个角色分配 25 个输入终结点，或者可以向 25 个角色中的每个角色分配 1 个输入终结点。

可以定义由 HTTP、HTTPS、UDP 和 TCP 终结点组成的多个终结点。 可以指定为输入终结点选择的任意端口号，但为服务中每个角色指定的端口号必须唯一。 例如，如果指定一个角色将端口 80 用于 HTTP，将端口 443 用于 HTTPS，则之后可能会指定第二个角色将端口 8080 用于 HTTP，将端口 8043 用于 HTTPS。

下表描述 InputEndpoint 元素的属性。

InternalEndpoint

InternalEndpoint 元素描述辅助角色的内部终结点。 只向服务中运行的其他角色实例提供内部终结点，而不向服务外部的客户端提供。 辅助角色最多具有五个 HTTP、UDP 或 TCP 内部终结点。

下表描述 InternalEndpoint 元素的属性。

InstanceInputEndpoint

InstanceInputEndpoint 元素描述辅助角色的实例输入终结点。 实例输入终结点通过使用负载均衡器中的端口转接，关联到特定的角色实例。 每个实例输入终结点映射到一系列可能端口中的特定端口。 此元素是 AllocatePublicPortFrom 元素的父级。

仅当使用 Azure SDK 1.7 或更高版本时，才提供 InstanceInputEndpoint 元素。

下表描述 InstanceInputEndpoint 元素的属性。

AllocatePublicPortFrom

AllocatePublicPortFrom 元素描述可供外部客户用来访问每个实例输入终结点的公共端口范围。 公共 (VIP) 端口号在此范围中分配，并在租户部署和更新过程中分配给每个单独的角色实例终结点。 此元素是 FixedPortRange 元素的父级。

仅当使用 Azure SDK 1.7 或更高版本时，才提供 AllocatePublicPortFrom 元素。

FixedPort

FixedPort 元素指定内部终结点的端口，用于在该终结点上实现负载均衡的连接。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 FixedPort 元素。

下表描述 FixedPort 元素的属性。

FixedPortRange

FixedPortRange 元素指定分配给内部终结点或实例输入终结点的端口的范围，并设置用于在终结点上建立负载均衡连接的端口。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 FixedPortRange 元素。

下表描述 FixedPortRange 元素的属性。

Certificates

Certificates 元素描述辅助角色的证书集。 此元素是 Certificate 元素的父级。 一个角色可以包含任意数目的关联证书。 有关使用 certificates 元素的详细信息，请参阅使用证书修改服务定义文件。

Certificate

Certificate 元素描述与辅助角色关联的证书。

下表描述 Certificate 元素的属性。

Imports

Imports 元素描述辅助角色的导入模块集，它会向来宾操作系统添加组件。 此元素是 Import 元素的父级。 此元素是可选的，一个角色只能有一个运行时块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Imports 元素。

Import

Import 元素指定要添加到来宾操作系统的模块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Import 元素。

下表描述 Import 元素的属性。

Runtime

Runtime 元素描述辅助角色的环境变量设置集，这些设置用于控制 Azure 主机进程的运行时环境。 此元素是 Environment 元素的父级。 此元素是可选的，一个角色只能有一个运行时块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Runtime 元素。

下表描述 Runtime 元素的属性：

Environment

Environment 元素描述辅助角色的环境变量设置集。 此元素是 Variable 元素的父级。 一个角色可以包含任意数目的环境变量集。

Variable

Variable 元素指定要在来宾操作系统中设置的环境变量。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Variable 元素。

下表描述 Variable 元素的属性：

RoleInstanceValue

RoleInstanceValue 元素指定要从其中检索变量值的 xPath。

下表描述 RoleInstanceValue 元素的属性。

EntryPoint

EntryPoint 元素指定角色的入口点。 此元素是 NetFxEntryPoint 元素的父级。 借助这些元素，可以指定默认 WaWorkerHost.exe 以外的应用程序充当角色入口点。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 EntryPoint 元素。

NetFxEntryPoint

NetFxEntryPoint 元素指定要为角色运行的程序。

下表描述 NetFxEntryPoint 元素的属性。

ProgramEntryPoint

ProgramEntryPoint 元素指定要为角色运行的程序。 ProgramEntryPoint 元素允许你指定不基于 .NET 程序集的程序入口点。

下表描述 ProgramEntryPoint 元素的属性。

Startup

Startup 元素描述角色启动时运行的任务的集合。 此元素可以是 Variable 元素的父级。 有关使用角色启动任务的详细信息，请参阅如何配置启动任务。 此元素是可选的，一个角色只能有一个启动块。

下表描述 Startup 元素的属性。

Task

Task 元素指定在角色启动时发生的启动任务。 启动任务可用于执行准备角色以运行的任务，如安装软件组件或运行其他应用程序。 这些任务会按照它们在 Startup 元素块中出现的顺序执行。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Task 元素。

下表描述 Task 元素的属性。

Contents

Contents 元素描述辅助角色的内容集。 此元素是 Content 元素的父级。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 Contents 元素。

Content

Content 元素定义要复制到 Azure 虚拟机的内容的源位置，以及要复制到的目标路径。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 Content 元素。

下表描述 Content 元素的属性。

此元素是 SourceDirectory 元素的父元素。

SourceDirectory

SourceDirectory 元素定义要从中复制内容的本地目录。 使用此元素指定要复制到 Azure 虚拟机的本地内容。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 SourceDirectory 元素。

下表描述 SourceDirectory 元素的属性。

另请参阅

云服务（经典）定义架构