インスタンスロール
Citrix ADMでは、1つのアプリケーションに対して複数のCitrix ADCインスタンスを構成する必要があるが、各ADCインスタンスに異なる構成を展開する必要があるシナリオがある場合があります。このような場合の例は、Microsoft Skype for Businessスタイルブックのデフォルトです。
StyleBooksは現在、構成パックを作成し、複数のCitrix ADCインスタンスに同じ構成を適用する機能をサポートしています。構成がすべてのADCインスタンスで同一であるようなシナリオを対称構成と呼ぶことができます。
StyleBooksの「インスタンスロール」機能を使用すると、非対称構成、つまり複数のADCインスタンスに適用できる構成パックを作成できますが、異なるADCインスタンスには異なる構成を使用できます。
インスタンスロール機能を備えたStyleBookを使用して構成パックを作成すると、構成パック内の各ADCインスタンスに異なるロールを割り当てることができます。このロールは、ADC インスタンスが受け取る設定パックの設定オブジェクトを決定します。
注意事項:
- StyleBookのインスタンスロールのセットは、StyleBookの作成時に定義されます。
- ロールは、構成パックを作成または更新するときに、特定の ADC インスタンスに割り当てられます。
「ターゲットロール」セクション
StyleBookに「ターゲットロール」と呼ばれる新しいセクションが導入され、StyleBookでサポートされているすべてのロールが宣言されています。
このセクションは通常、StyleBookの「Import-StyleBooks」セクションの後とパラメータセクションの前に配置されます。
次の StyleBook の例では、「target-roles」セクション内で A と B の 2 つのロールが定義されています。
target-roles:
-
name: A
name: B
min-targets: 2
max-targets: 5
<!--NeedCopy-->
ロール B は、min-target と max-target という 2 つのオプションのサブプロパティも定義していることがわかります。
これらの2つのサブプロパティはオプションですが、最小ターゲットは、このStyleBookから構成パックを作成するときにこのロールを割り当てるADCインスタンスの最小必須数を指定します。max-targetsは、構成パックの作成時にこのロールを割り当てることができるADCインスタンスの最大数を指定しますこのStyleBookから。
これらのサブプロパティが指定されていない場合、そのロールに設定できる ADC インスタンスの数に制限はありません。min-targets = 0 の場合、そのロールに関連付けられた設定はオプションであり、min-targets = 1 の場合、その設定は必須であり、そのロールに対して少なくとも 1 つの ADC インスタンスを設定する必要があります。
ロール「デフォルト」
明示的に定義されたロールに加えて、すべてのStyleBookが持つ暗黙的なロールがあり、そのロールはデフォルトロールとして呼び出されます。このロールは、StyleBookの他のロールと同様に使用できます。設定パックを作成するときに、ADC インスタンスに特定のロールが割り当てられていない場合、インスタンスは「デフォルト」ロールに暗黙的に割り当てられます。インスタンスは、「default」ロールを持つコンポーネントによって生成された設定オブジェクトを受け取ります。
ロールを持つコンポーネント
StyleBookがサポートできるロール（ロール「デフォルト」を含む）を定義すると、StyleBookのコンポーネントセクションでそのロールを使用できます。コンポーネントを特定の役割を果たす ADC インスタンスにのみデプロイする場合は、次のコンポーネントの例に示すように、コンポーネントの一部として roles 属性を指定できます。
-
name: C1
type: ns::lbvserver
roles:
- A
properties:
name: lb1
servicetype: HTTP
ipv46: 1.1.1.1
port: 80
<!--NeedCopy-->
上記の例では、コンポーネントがlbvserverを生成し、ロール A のインスタンスにデプロイされます。コンポーネントの roles 属性はリストであり、コンポーネントに複数のロールを割り当てることができます。これらのロールは、StyleBookの「ターゲットロール」セクションで宣言されているでしょう。
注：StyleBookのコンポーネントでロール属性が指定されていない場合、コンポーネントによって生成された構成オブジェクトは、その役割に関係なく、すべてのCitrix ADCインスタンスに作成されます。この機能を効果的に使用して、構成パックのすべてのインスタンスに適用できる設定オブジェクトを作成できます。
AとBの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
<!--NeedCopy-->
コンポーネント C3 にはロールが定義されていないことに注意してください。つまり、コンポーネントはそのロールに関係なくすべてのインスタンスにデプロイされます。一方、コンポーネント C4 には「default」というロールがあります。つまり、明示的なロールが割り当てられていないインスタンスに適用されます。
ここで、この StyleBook を使用して構成パックを作成し、5 つの ADC インスタンスにデプロイすることを検討します。この段階では、次の方法でインスタンスにロールを割り当てることができます。
- ロール A はインスタンス T1、T2、T3、T4 に割り当てられます
- ロール B はインスタンス T2、T3、T4 に割り当てられます
- インスタンス T5 にはロールが割り当てられていません
次の図は、役割の割り当てをまとめたもので、各 ADC インスタンスが受け取る構成を示しています。
コンポーネント C3 は、ロールに関係なくすべてのインスタンスにデプロイされます。これは、このコンポーネントには roles 属性がないためです。
次の図は、サンプル構成パックを作成するときのロールの割り当てを示しています。
構成パックの作成時に「Dry Run」機能を使用して、各 ADC インスタンスに作成されるロールと設定オブジェクトの正しい割り当てを表示および検証することもできます。
スタイルブックを構築する
StyleBook「デモターゲットロール」の全コンテンツを以下に示します。
---
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
<!--NeedCopy-->
次の図は、サンプル構成パック用に作成されたオブジェクトを示しています。
API の使用
REST API を使用する場合、次のように設定パックを作成または更新するときに、各 ADC インスタンスに対してロールを指定できます。[targets] ブロックで、個々のコンポーネントをデプロイする特定のCitrix ADCインスタンスのUUIDを指定します。
"targets": [
{
"id": "<ADC-UUID>",
"roles": ["A"]
},
]
<!--NeedCopy-->
参考のために、完全なサンプル REST API が提供されています。
POST/<IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/1.2/demo-target-roles/configpack
{
"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"]
}
]
}
}
<!--NeedCopy-->