インスタンスロール
StyleBookは、NetScalerインスタンスで以下の構成をサポートしています。
-
対称構成 - 複数のNetScalerインスタンスに構成パックが適用され、すべてのインスタンスに展開される構成が同じである場合。
-
非対称構成 - 複数のNetScalerインスタンスに構成パックが適用され、すべてのインスタンスに展開される構成が異なる場合。たとえば、デフォルトのMicrosoft Skype for Business StyleBookでは、各NetScalerインスタンスに異なる構成を展開する必要があります。
StyleBookの「インスタンスロール」機能は、非対称構成を作成するのに役立ちます。ここでは、構成パック内の各NetScalerインスタンスに異なるロールを割り当てることができます。ロールは、NetScalerインスタンスが受け取る構成パックの構成オブジェクトを決定します。
注意点:
-
StyleBook内のインスタンスロールのセットは、StyleBookの作成時に定義されます。
-
ロールは、構成パックの作成または更新時に特定のNetScalerインスタンスに割り当てられます。
Related information
ターゲットロールセクション
「target-roles」は通常、StyleBookの「import-StyleBooks」セクションの後、「parameters」セクションの前に配置されます。StyleBookでサポートされるすべてのロールは、「target-roles」セクションで宣言されます。
以下のStyleBookの例では、「target-roles」セクション内に2つのロール（AとB）が定義されています。
target-roles:
-
name: A
name: B
min-targets: 2
max-targets: 5
ロールBには、2つのオプションのサブプロパティ、
min-targets と max-targets も定義されていることがわかります。
min-targets は、このStyleBookから構成パックを作成する際に、このロールを割り当てるNetScalerインスタンスの最小必須数を指定します。max-targets は、このStyleBookから構成パックを作成する際に、このロールを割り当てることができるNetScalerインスタンスの最大数を指定します。
これらのサブプロパティが指定されていない場合、そのロールに構成できるNetScalerインスタンスの数に制限はありません。min-targets = 0 の場合、ロールに関連付けられた構成はオプションです。min-targets = 1 の場合、構成は必須であり、少なくとも1つのNetScalerインスタンスがそのロールに構成されている必要があります。
ロール「default」
明示的に定義されたロールに加えて、すべてのStyleBookが持つ暗黙的なロールがあります。この暗黙的なロールは「デフォルトロール」と呼ばれ、StyleBook内の他のロールと同様に使用されます。設定パックを作成する際、NetScalerインスタンスに特定のロールが割り当てられていない場合、そのインスタンスは暗黙的に「デフォルト」ロールに割り当てられます。その後、インスタンスは「デフォルト」ロールを持つコンポーネントによって生成された設定オブジェクトを受け取ります。
ロールを持つコンポーネント
StyleBookがサポートできるロール（「デフォルト」ロールを含む）が定義された後、それらのロールはStyleBookのコンポーネントセクションで使用できます。特定のロールを果たすNetScalerインスタンスにのみコンポーネントをデプロイしたい場合は、以下のコンポーネントの例に示すように、コンポーネントの一部としてroles属性を指定できます。
-
name: C1
type: ns::lbvserver
roles:
- A
properties:
name: lb1
servicetype: HTTP
ipv46: 1.1.1.1
port: 80
この例では、コンポーネントが生成する
lbvserverは、ロールAを果たすインスタンスにデプロイされます。コンポーネントのroles属性はlistであり、コンポーネントには複数のロールを割り当てることができます。これらのロールは、StyleBookのtarget-rolesセクションで宣言されているはずです。
注
StyleBook内のコンポーネントがロール属性を指定しない場合、そのコンポーネントによって生成される設定オブジェクトは、ロールに関係なくすべてのNetScalerインスタンスに作成されます。この機能を効果的に使用して、設定パックのすべてのインスタンスに適用できる設定オブジェクトを作成できます。
2つのロールと4つのコンポーネントを持つStyleBookを考えてみましょう。
-
コンポーネントC1はロールAとBを持ちます
-
コンポーネントC2はロールBを持ちます
-
コンポーネントC3にはロールが定義されていません
-
コンポーネントC4は「デフォルト」ロールを持ちます
このStyleBookのコンポーネントセクションは次のとおりです。
components:
-
name: C1
type: ns::lbvserver
roles:
- A
- B
properties:
name: lb1
servicetype: HTTP
ipv46: 1.1.1.1
port: 80
-
name: C2
type: ns::lbvserver
roles:
- B
properties:
name: lb2
servicetype: HTTP
ipv46: 12.12.12.12
port: 80
-
name: C3
type: ns::lbvserver
properties:
name: lb3
servicetype: HTTP
ipv46: 13.13.13.13
port: 80
-
name: C4
type: ns::lbvserver
roles:
- default
properties:
name: lb4
servicetype: HTTP
ipv46: 14.14.14.14
port: 80
コンポーネントC3にはロールが定義されていないため、そのロールに関係なくすべてのインスタンスにデプロイされます。一方、コンポーネントC4は「デフォルト」ロールを持つため、明示的なロールが割り当てられていないすべてのインスタンスに適用されます。
さて、このStyleBookを使用して設定パックを作成し、5つのNetScalerインスタンスにデプロイしたいとします。インスタンスへのロールの割り当ては、次の方法で行うことができます。
-
ロールAはインスタンスT1、T2、T3、T4に割り当てられます
-
ロールBはインスタンスT2、T3、T4に割り当てられています
-
インスタンスT5にはどのロールも割り当てられていません
次の図は、ロールの割り当てを要約し、結果として各NetScalerインスタンスが受け取る構成を示しています。
コンポーネントC3は、このコンポーネントには
roles属性がなかったため、ロールに関係なくすべてのインスタンスに展開されます。
「ドライラン」機能を使用して、以下を表示および確認します。
-
ロールの割り当て
-
各NetScalerインスタンスで作成された構成オブジェクト
StyleBookを構築する
StyleBook「demo-target-roles」の全内容は次のとおりです。
---
name: demo-target-roles
namespace: com.example.stylebooks
version: "1.2"
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
parameters:
-
name: appname
type: string
required: true
key: true
target-roles:
-
name: A
-
name: B
min-targets: 2
max-targets: 5
components:
-
name: C1
type: ns::lbvserver
roles:
- A
- B
properties:
name: lb1
servicetype: HTTP
ipv46: 1.1.1.1
port: 80
-
name: C2
type: ns::lbvserver
roles:
- B
properties:
name: lb2
servicetype: HTTP
ipv46: 12.12.12.12
port: 80
-
name: C3
type: ns::lbvserver
properties:
name: lb3
servicetype: HTTP
ipv46: 13.13.13.13
port: 80
-
name: C4
type: ns::lbvserver
roles:
- default
properties:
name: lb4
servicetype: HTTP
ipv46: 14.14.14.14
port: 80
次の図は、サンプル構成パック用に作成されたオブジェクトを示しています。
APIの使用
REST APIを使用する場合、構成パックを作成または更新する際に、各NetScalerインスタンスのロールを次のように指定できます。「targets」ブロックで、個々のコンポーネントを展開したい特定のNetScalerインスタンスのUUIDを指定します。
"targets": [
{
"id": "<ADC-UUID>",
"roles": ["A"]
},
]
完全なサンプルREST APIは参考のために提供されています。
POST /
<IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/1.2/demo-target-roles/configpacks
{
"configpack": {
"parameters": {
"appname": "app1"
},
"targets": [
{
"id": "f53c35c3-a6bc-4619-b4b4-ad7ab6a94ddb",
"roles": ["A"]
},
{
"id": "c08caa1c-1011-48aa-b8c7-9aed1cd38ed0",
"roles": ["A", "B"]
},
{
"id": "88ac90cb-a5cb-445b-8617-f83d0ef6174e",
"roles": ["A", "B"]
},
{
"id": "bf7b0f74-7a83-4856-86f4-dcc951d3141e",
"roles": ["A", "B"]
},
{
"id": "fa5d97ab-ca29-4adf-b451-06e7a234e3da",
"roles": ["default"]
}
]
}
}