基本的なロードバランシング構成を作成するStyleBook
以前の例では、ロードバランシング仮想サーバーを作成するための基本的なStyleBookを構築しました。このStyleBookを別の名前で保存し、基本的なロードバランシング構成のための追加のパラメーターとコンポーネントを含めるように更新できます。このStyleBookファイルをbasic-lb-config.yamlとして保存します。
このセクションでは、ロードバランシング仮想サーバー、サービスグループ、およびサービスリストで構成されるロードバランシング構成を作成する新しいStyleBookを設計します。また、サービスをサービスグループにバインドし、サービスグループを仮想サーバーにバインドします。
ヘッダー
このStyleBookを構築するには、まずヘッダーセクションを更新する必要があります。このセクションは、ロードバランシング仮想サーバーStyleBook用に作成したものと同様です。ヘッダーセクションで、nameの値をbasic-lb-configに変更します。また、このStyleBookを適切に説明するようにdescriptionとdisplay-nameを更新します。namespaceとversionの値は変更する必要はありません。名前を変更したため、名前、ネームスペース、およびバージョンの組み合わせにより、システム内でこのStyleBookの一意の識別子が作成されます。
name: basic-lb-config
description: This StyleBook defines a simple load balancing configuration.
display-name: Load Balancing Configuration
namespace: com.example.stylebooks
schema-version: "1.0"
version: "0.1"
<!--NeedCopy-->
StyleBookのインポート
import-stylebooksセクションは変更ありません。これは、Nitro構成オブジェクトを使用するためにnetscaler.nitro.configネームスペースを参照します。
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
<!--NeedCopy-->
パラメーター
パラメーターセクションを更新して、サービスまたはサーバーのリストと、サービスがリッスンするポートを定義するための2つの追加パラメーターを追加する必要があります。最初の3つのパラメーター、name、ip、およびlb-algは変更ありません。
parameters:
-
name: name
type: string
label: Application Name
description: Name of the application configuration
required: true
-
name: ip
type: ipaddress
label: Application Virtual IP (VIP)
description: Application VIP that the clients access
required: true
-
name: lb-alg
type: string
label: LoadBalancing Algorithm
description: Choose the load balancing algorithm used for load balancing 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
<!--NeedCopy-->
この例では、アプリケーションのバックエンドサーバーを表すサービスのIPアドレスのリストを受け入れるために、パラメーターsvc-serversが追加されています。これはrequired: trueで示されているように必須パラメーターです。2番目のパラメーターsvc-portは、サーバーがリッスンするポート番号を示します。ユーザーによって指定されない場合、svc-portパラメーターのデフォルトポート番号は80です。
コンポーネント
また、コンポーネントセクションを更新して、2つの新しいパラメーターを使用し、完全なロードバランシング構成を構築する追加のコンポーネントを定義する必要があります。
この例では、コンポーネントセクションを次のように記述する必要があります。
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
<!--NeedCopy-->
この例では、元のコンポーネントlbvserver-comp（以前の例から）に、svcg-compという子コンポーネントが追加されました。そして、svcg-compコンポーネントには2つの子コンポーネントが含まれています。あるコンポーネント内に別のコンポーネントをネストすることで、ネストされたコンポーネントは親コンポーネントの属性を参照して構成オブジェクトを作成できます。ネストされたコンポーネントは、親コンポーネントで作成されたオブジェクトごとに1つ以上のオブジェクトを作成できます。
svcg-compコンポーネントは、リソース「servicegroup」の属性に指定された値を使用して、NetScalerインスタンス上にサービスグループを作成するために使用されます。この例では、servicetypeに静的な値を指定していますが、nameはその値を入力パラメーターから取得します。パラメーターセクションで定義されたパラメーターnameは、$parameters.name + “-svcgrp”という表記を使用して参照されます。ここで、-svcgrpはユーザー定義の名前に付加（連結）されます。
コンポーネントsvcg-compには、lbvserver-svg-binding-compとmembers-svcg-compの2つの子コンポーネントがあります。
最初の子コンポーネントである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: members-svcg-comp
type: ns::servicegroup\_servicegroupmember\_binding
repeat: $parameters.svc-servers
repeat-item: srv
properties:
ip: $srv
port: str($parameters.svc-port)
servicegroupname: $components.svcg-comp.properties.name
-
name: lbvserver-svg-binding-comp
type: ns::lbvserver\_servicegroup\_binding
properties:
name: $components.lbvserver-comp.properties.name
servicegroupname: $components.svcg-comp.properties.name
-
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:
name: $parameters.name + "-svcgrp"
servicetype: HTTP
<!--NeedCopy-->
ここでは、すべてのコンポーネントが同じレベル（つまり、ネストされていない）ですが、達成される結果（生成されるNetScaler構成）は、以前に使用されたネストされたコンポーネントの場合と同じです。また、StyleBookでコンポーネントが宣言される順序は、構成オブジェクトの作成順序には影響しません。この例では、コンポーネントsvcg-compとlbvserver-compは、最後に宣言されていますが、2番目のコンポーネントlbvserver-svg-binding-compを構築する前に構築する必要があります。これは、2番目のコンポーネントにこれらのコンポーネントへの前方参照があるためです。
注
慣例として、StyleBook、パラメーター、置換、コンポーネント、および出力の名前は小文字で記述されます。複数の単語を含む場合は、「-」文字で区切られます。たとえば、「lb-bindings」、「app-name」、「rewrite-config」などです。もう1つの慣例は、コンポーネント名に「-comp」文字列を接尾辞として付けることです。
出力
新しいStyleBookに追加できる最後のセクションは、このStyleBookが構成の作成後にそのユーザー（または他のStyleBook）に何を公開するかを指定する出力セクションです。たとえば、このStyleBookによって作成されるlbvserverおよびサービスグループ構成オブジェクトを公開するように出力セクションで指定できます。
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
<!--NeedCopy-->
StyleBookの出力セクションはオプションです。StyleBookは出力を返す必要はありません。ただし、一部の内部コンポーネントを出力として返すことで、複合StyleBookを作成する際にわかるように、このStyleBookをインポートするStyleBookにさらなる柔軟性をもたらします。
注
StyleBookの出力セクションでは、コンポーネントの単一のプロパティ（たとえば、$components.lbvserver-comp.properties.nameという名前だけでなく、$components.lbvserver-comp全体）を公開するのではなく、StyleBookのコンポーネント全体を公開することをお勧めします。また、特定の出力が何を表すかを説明する説明を出力に追加してください。
StyleBookの構築
このStyleBookのすべての必須セクションを定義したので、それらをすべてまとめて2番目のStyleBookを構築します。このStyleBookファイルはすでにbasic-lb-config.yamlとして保存されています。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
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
<!--NeedCopy-->
StyleBookを使用して構成の作成を開始するには、NetScaler Consoleにインポートしてから使用する必要があります。詳細については、「ユーザー定義StyleBookの使用方法」を参照してください。
このStyleBookを他のStyleBookにインポートし、次のセクションで説明するようにそのプロパティを使用することもできます。