用于创建基本负载均衡配置的 StyleBook
在本节中，您将设计一个 StyleBook，用于创建负载均衡配置，其中包括一个负载均衡虚拟服务器、一个服务组和一系列服务。该 StyleBook 将服务绑定到服务组，并将服务组绑定到虚拟服务器。
要创建基本的负载均衡配置，请使用您在 用于创建负载均衡虚拟服务器的 StyleBook 中创建的示例 StyleBook lb-vserver，并将其保存为 basic-lb-config.yaml。
标头
要构建此 StyleBook，请更新标头部分。此部分与您在 用于创建负载均衡虚拟服务器的 StyleBook 中创建的标头部分类似。
将 name 的值更改为 basic-lb-config。更新 description 和 display-name 以描述 StyleBook。您无需更改 namespace 和 version 的值。由于您已更改名称，因此将在系统中为此 StyleBook 创建一个唯一标识符。
name: basic-lb-config
namespace: com.example.stylebooks
version: "0.1"
display-name: Load Balancing Configuration
description: This StyleBook defines a simple load balancing configuration.
schema-version: "1.0"
导入 StyleBook
import-stylebooks 部分保持不变。它引用 netscaler.nitro.config 命名空间以使用 NITRO 配置对象。
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
参数
更新参数部分以添加另外两个参数。
这些参数定义了服务或服务器列表以及服务侦听的端口。前三个参数
name、ip 和 lb-alg 保持不变。
parameters:
-
name: name
type: string
label: Application Name
description: Give a name to the application configuration.
required: true
-
name: ip
type: ipaddress
label: Application Virtual IP (VIP)
description: The Application VIP that clients access
required: true
-
name: lb-alg
type: string
label: LoadBalancing Algorithm
description: Choose the loadbalancing algorithm (method) used for loadbalancing client requests between the application servers.
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
-
name: svc-servers
type: ipaddress[]
label: Application Server IPs
description: The IP addresses of all the servers of this application
required: true
-
name: svc-port
type: tcp-port
label: Server Port
description: The TCP port open on the application servers to receive requests.
default: 80
添加了参数 svc-servers 以接受应用程序后端服务器的 IP 地址列表。svc-servers 是一个强制参数，如 required: true 所示。
第二个参数 svc-port 表示服务器侦听的端口号。除非用户指定，否则默认端口号为 80。
组件
您还必须更新组件部分以定义更多组件，以便它们使用这两个新参数并构建完整的负载均衡配置。
对于此示例，您必须按如下方式编写组件部分：
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name + "-lb"
servicetype: HTTP
ipv46: $parameters.ip
port: 80
lbmethod: $parameters.lb-alg
components:
-
name: svcg-comp
type: ns::servicegroup
properties:
name: $parameters.name + "-svcgrp"
servicetype: HTTP
components:
-
name: lbvserver-svg-binding-comp
type: ns::lbvserver_servicegroup_binding
properties:
name: $parent.parent.properties.name
servicegroupname: $parent.properties.name
-
name: members-svcg-comp
type: ns::servicegroup_servicegroupmember_binding
repeat: $parameters.svc-servers
repeat-item: srv
properties:
ip: $srv
port: str($parameters.svc-port)
servicegroupname: $parent.properties.name
在此示例中，原始组件 lbvserver-comp（来自上一个示例）现在有一个名为 svcg-comp 的子组件。svcg-comp 组件内部也有两个子组件。将一个组件嵌套在另一个组件中，允许嵌套组件通过引用父组件中的属性来创建配置对象。嵌套组件可以为父组件中创建的每个对象创建一个或多个对象。
svcg-comp 组件用于通过使用为资源
servicegroup 的属性提供的值，在 NetScaler 实例上创建服务组。在此示例中，您正在为 servicetype 指定静态值，而 name 的值来自输入参数。通过使用 $parameters.name + "-svcgrp" 符号引用参数部分中定义的参数 name，其中“-svcgrp”附加（连接）到用户定义的名称。
组件 svcg-comp 有两个子组件：lbvserver-svg-binding-comp 和 members-svcg-comp。
第一个子组件 lbvserver-svg-binding-comp 用于在其父组件创建的服务组与父组件的父组件创建的负载均衡虚拟服务器 (
lbvserver) 之间绑定配置对象。$parent 符号（也称为父引用）用于引用父组件中的实体。例如，servicegroupname: $parent.properties.name 引用由父组件 svcg-comp 创建的服务组，而 name: $parent.parent.properties.name 引用由父组件的父组件 lbvserver-comp 创建的虚拟服务器。
members-svcg 组件用于在服务列表与父组件创建的服务组之间绑定配置对象。绑定配置对象的创建是通过使用 StyleBook 的 repeat 构造来迭代参数 svc-servers 中指定的服务器列表来实现的。在迭代过程中，此 StyleBook 组件会为服务组中的每个服务（在 repeat-item 构造中称为
srv）创建一个类型为 servicegroup_servicegroupmember_binding 的 NITRO 配置对象，并将其每个 NITRO 配置对象中的 ip 属性设置为相应服务器的 IP 地址。
通常，您可以在组件中使用 repeat 和 repeat-item 构造，使该组件构建多个相同类型的配置对象。您可以为 repeat-item 构造分配一个变量名，例如
srv，以指定迭代中的当前值。此变量名在同一组件的属性中或在子组件中被称为 $<varname>，例如 $srv。
在前面的示例中，组件的嵌套有助于轻松构建配置。您也可以在不嵌套的情况下构建配置，如下例所示：
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name + "-lb"
servicetype: HTTP
ipv46: $parameters.ip
port: 80
lbmethod: $parameters.lb-alg
-
name: svcg-comp
type: ns::servicegroup
properties:
servicegroupname: $parameters.name + "-svcgrp"
servicetype: HTTP
-
name: lbvserver-svg-binding-comp
type: ns::lbvserver_servicegroup_binding
properties:
name: $components.lbvserver-comp.properties.name
servicegroupname: $components.svcg-comp.properties.servicegroupname
-
name: members-svcg-comp
type: ns::servicegroup_servicegroupmember_binding
repeat: $parameters.svc-servers
repeat-item: srv
properties:
ip: $srv
port: 80
servicegroupname: $components.svcg-comp.properties.servicegroupname
在这里，即使组件没有嵌套，生成的 NetScaler 配置也与之前使用的嵌套组件的配置相同。
StyleBook 中组件的声明顺序不影响配置对象的创建顺序。在此示例中，组件 svcg-comp 和 lbvserver-comp 即使最后声明，也必须在构建第二个组件 lbvserver-svg-binding-comp 之前构建，因为第二个组件中存在对这些组件的前向引用。
注意
按照惯例，StyleBook、参数、替换、组件和输出的名称均为小写。当它们包含多个单词时，它们用“–”字符分隔。例如
lb-bindings、app-name、rewrite-config 等。另一个惯例是用 -comp 字符串作为组件名称的后缀。
输出
在本节中，您需要指定 StyleBook 在创建配置后向用户（或在其他 StyleBook 中）公开的内容。例如，您可以指定公开此 StyleBook 创建的
lbvserver 和 servicegroup 配置对象。
outputs:
-
name: lbvserver-comp
value: $components.lbvserver-comp
description: The component that builds the Nitro lbvserver configuration object
-
name: servicegroup-comp
value: $components.svcg-comp
description: The component that builds the Nitro servicegroup configuration object
StyleBook 的输出部分是可选的。StyleBook 不需要返回输出。但是，通过将一些内部组件作为输出返回，它允许任何导入此 StyleBook 的 StyleBook 具有更大的灵活性。此功能在创建复合 StyleBook 时非常有用。
注意
最佳实践是在输出部分公开 StyleBook 的整个组件，而不是仅公开组件的单个属性（例如，公开整个 $components.lbvserver-comp，而不仅仅是名称 $components.lbvserver-comp.properties.name）。此外，为输出添加描述，解释特定输出所代表的内容。
构建您的 StyleBook
既然您已经定义了此 StyleBook 的所有必需部分，请将它们整合在一起以构建您的第二个 StyleBook。您已将此 StyleBook 文件保存为 basic-lb-config.yaml。Citrix 建议您使用 StyleBooks 中内置的 YAML 验证器来验证和导入 YAML 内容。
文件 basic-lb-config.yaml 的完整内容如下所示：
name: basic-lb-config
namespace: com.example.stylebooks
version: "0.1"
display-name: Load Balancing Configuration
description: This StyleBook defines a simple load balancing configuration.
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
version: "10.5"
prefix: ns
parameters:
-
name: name
type: string
label: Application Name
description: Give a name to the application configuration.
required: true
-
name: ip
type: ipaddress
label: Application Virtual IP (VIP)
description: The Application VIP that clients access
required: true
-
name: lb-alg
type: string
label: LoadBalancing Algorithm
description: Choose the loadbalancing algorithm (method) used for loadbalancing client requests between the application servers.
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
-
name: svc-servers
type: ipaddress[]
label: Application Server IPs
description: The IP addresses of all the servers of this application
required: true
-
name: svc-port
type: tcp-port
label: Server Port
description: The TCP port open on the application servers to receive requests.
default: 80
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name + "-lb"
servicetype: HTTP
ipv46: $parameters.ip
port: 80
lbmethod: $parameters.lb-alg
-
name: svcg-comp
type: ns::servicegroup
properties:
servicegroupname: $parameters.name + "-svcgrp"
servicetype: HTTP
-
name: lbvserver-svg-binding-comp
type: ns::lbvserver_servicegroup_binding
properties:
name: $components.lbvserver-comp.properties.name
servicegroupname: $components.svcg-comp.properties.servicegroupname
-
name: members-svcg-comp
type: ns::servicegroup_servicegroupmember_binding
repeat: $parameters.svc-servers
repeat-item: srv
properties:
ip: $srv
port: 80
servicegroupname: $components.svcg-comp.properties.servicegroupname
outputs:
-
name: lbvserver-comp
value: $components.lbvserver-comp
description: The component that builds the Nitro lbvserver configuration object
-
name: servicegroup-comp
value: $components.svcg-comp
description: The component that builds the Nitro servicegroup configuration object
要开始使用您的 StyleBook 创建配置，您必须将其导入到 NetScaler Console，然后才能使用它。有关详细信息，请参阅 如何使用用户定义的 StyleBook。
您还可以将此 StyleBook 导入到其他 StyleBook 中，并按照下一节中的说明使用其属性。