構成パックの作成と編集
NetScaler® Application Delivery Management (ADM) では、StyleBook から構成パックを作成できます。構成パックは、作成元の StyleBook に関連付けられています。構成パックへの更新は、関連付けられている StyleBook を介して行われます。
構成パックの作成
StyleBook から構成パックを作成するには、次の手順を実行します。
-
Applications > StyleBooks > Configurations に移動します。
-
追加 をクリックします。
-
StyleBook の選択 で、構成パックを作成する必要な StyleBook を選択します。
このページでは、StyleBook がデフォルト StyleBook とカスタム StyleBook に分類されます。必要な StyleBook を見つけるには、それぞれのタブを選択します。
-
アプリケーション名、IP アドレス、ポート、プロトコルタイプなどの必要な詳細を指定します。
GUI フィールドは StyleBook ごとに異なります。
-
ターゲットインスタンス で、構成を実行するインスタンスまたはインスタンスグループを選択します。
注
必要な数のターゲットインスタンスを指定することで、複数の NetScaler に構成を展開できます。
-
ドライラン をクリックします。
オブジェクト ページには、NetScaler インスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
作成 をクリックします。
構成パックが StyleBook > 構成 ページに表示されます。
既存の構成パックを編集する場合は、構成パックを選択し、編集 をクリックします。
構成パックの StyleBook の変更
StyleBook に機能を追加したり、問題を修正したりするために、StyleBook を更新する必要がある場合があります。古い StyleBook を使用して構成パックを既に作成している場合は、新しい更新された StyleBook を使用するようにそれらを更新したい場合があります。新しい StyleBook を使用するには、構成パックの既存の StyleBook を変更します。
ADC インスタンスに基本的なロードバランサー構成を展開する StyleBook example-lb の例を考えてみましょう。そして、この StyleBook から構成パック CP1 を作成します。
基本的なロードバランサー構成でモニターを構成したい場合は、新しい StyleBook が必要です。したがって、基本的なロードバランサー構成とともにモニターを構成する機能を含む example-lb-mon StyleBook を作成します。
StyleBook を作成したら、既存の構成パック CP1 を更新してモニターを追加します。これを行うには、次の手順を実行します。
-
Applications > StyleBooks > Configurations に移動します。
-
StyleBook を変更する構成パックを選択します。
この例では、リストから CP1 を選択します。
-
StyleBook の変更 をクリックします。
-
リストから必要な StyleBook を選択します。次に、選択を保存 をクリックします。
-
変更 をクリックします。
この例では、リストから example-lb-mon を選択します。
構成パックの StyleBook を変更すると、新しい StyleBook のパラメーターは既存の StyleBook とは異なる構造を持つ場合があります。パラメーター構造が以前の StyleBook と類似している場合、パラメーターの値はそれぞれのフィールドに自動的に保持されます。そうでない場合、2 つの StyleBook 間で同じ構造を持つパラメーターのみが転送されます。たとえば、同じパラメーター名、タイプ、パラメーターの親などです。
新しい StyleBook に新しい必須パラメーターが追加された場合、StyleBook の変更後、それらのパラメーターの値を手動で指定する必要があります。
この例では、example-lb StyleBook の構成ページに表示されるパラメーターは次のとおりです。
新しい example-lb-mon StyleBook の構成ページに表示されるパラメーターは次のとおりです。
この場合、新しい StyleBook は既存のパラメーターを変更しておらず、新しいパラメーターのみを追加しているため、StyleBook は基本的なロードバランサー構成の古い値を保持します。モニターパラメーターについては、必要な値を手動で指定します。
-
ターゲットインスタンス で、選択したインスタンスを確認し、必要に応じてリストを更新します。
-
ドライラン をクリックします。
オブジェクト ページには、NetScaler インスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
OK をクリックします。
StyleBook > 構成 ページで、StyleBook 名 列に、選択した構成パックの新しい StyleBook 名が表示されます。この場合、example-lb-mon と表示されます。
複数の構成パックを持つ StyleBook の変更
複数の構成パックを持つ既存の StyleBook を変更する場合は、次の手順を実行します。
-
新しい StyleBook を ADM にインポートします。
通常、新しい StyleBook は、既存の StyleBook よりも高いバージョンで同じ名前と名前空間を持ちます。ただし、名前、名前空間、またはバージョンが異なる場合は、この手順をスキップできます。
-
既存の StyleBook に関連付けられている構成パックの StyleBook を変更します。
選択した構成パックが同じ StyleBook に関連付けられている場合にのみ、StyleBook の変更 を選択できます。
選択した構成パックの場合、次の条件が満たされると、ADM は StyleBook を正常に変更します。
-
既存の StyleBook のすべての構成パラメーターが、選択した StyleBook に存在している必要があります。
-
選択した StyleBook の新しいパラメーターはオプションです。
選択した構成パックの進行状況を確認するには、構成 ページで 進行中/失敗した構成 を選択します。
-
-
すべての構成パックが新しい StyleBook に関連付けられたら、古い StyleBook を ADM から削除します。
構成パックのエクスポートまたはインポート
StyleBook と同様に、構成パックをエクスポートまたはインポートできます。この機能を使用すると、StyleBook 構成を別の ADM サーバーに簡単に共有できます。構成パックをエクスポートすると、tgz または zip バンドルがローカルコンピューターにダウンロードされます。このバンドルには、構成パックで定義されているすべてのパラメーターを含む JSON ファイルが含まれています。
構成のエクスポート
構成パックをエクスポートするには、次の手順を実行します。
-
Applications > StyleBooks > Configurations に移動します。
-
エクスポートする構成パックを選択します。
-
アクションの選択 で、構成のエクスポート を選択します。
-
構成のエクスポート ペインで、次を指定します。
-
構成が展開されているターゲットインスタンスの情報: このオプションを選択すると、エクスポートバンドルにターゲットインスタンスの情報が含まれます。
-
構成に関連付けられた StyleBook: このオプションを選択すると、エクスポートバンドルに StyleBook が含まれます。
-
エクスポート構成データを保護するためのパスフレーズ: エクスポートバンドルを暗号化するためのパスフレーズを指定します。このパスフレーズは、構成パックの機密データを保護します。
-
圧縮ファイルタイプ: ZIP または TGZ ファイルタイプを選択します。
-
-
エクスポート をクリックします。
エクスポートバンドルをローカルコンピューターに保存します。
構成のインポート
ローカルコンピューターから別の ADM サーバーに構成パックをインポートできます。構成パックをインポートするには、次の手順を実行します。
-
Applications > StyleBooks > Configurations に移動します。
-
構成のインポート を選択します。
-
コンピューターからインポートファイルバンドルを選択します。
-
エクスポート時に指定したパスフレーズを使用します。
-
オプションで、詳細オプション で、すべての構成オブジェクトが ADC に既に存在する場合にのみ新しい構成の作成を許可する を選択します。
このオプションは、ADC インスタンスに既に作成されているオブジェクトを変更しません。
同じ ADC インスタンスを 2 つの ADM サーバーに追加したとします。そして、ある ADM サーバーから別のサーバーに構成パックを移行したいとします。このオプションを使用して、ADC インスタンス上の構成オブジェクトを変更せずに構成パックをインポートします。
重要
このオプションを使用するには、指定された構成バンドルにターゲットインスタンスの情報が含まれていることを確認してください。構成のエクスポート を参照してください。
このオプションは、すべてのオブジェクトがターゲットインスタンスに存在する場合にのみ構成を移行します。
-
インポート をクリックします。
構成パックをインポートすると、ADM は次のことを検証します。
-
関連付けられた StyleBook: 関連付けられた StyleBook が ADM にない場合、構成パックとともに StyleBook をインポートします。
-
ターゲットインスタンス: ターゲットインスタンスを確認し、指定されたターゲットインスタンスに構成を展開します。記載されている ADC インスタンスが ADM にない場合、構成パックはターゲットインスタンスなしでインポートされます。
-
ソース ADM: 同じ ADM サーバーに構成パックをインポートする場合、選択したバンドルは既存の構成パックを更新します。
構成パックからのターゲットインスタンスのデタッチ
構成パックからターゲットインスタンスをデタッチするには、次の手順を実行します。
-
Applications > Configuration > Config Packs に移動します。
-
削除するターゲットインスタンスを持つ構成パックを選択します。
-
アクションの選択 で、ターゲットのデタッチ を選択します。
-
ターゲットのデタッチ ペインで、構成パックから削除するターゲットインスタンスを選択します。
-
OK をクリックします。
ターゲットインスタンスが削除された重複構成パックの作成を確認するメッセージが表示されます。
StyleBook の構築
example-lb StyleBook の全内容は、参考として以下に示します。
name: example-lb
namespace: examples.stylebooks
version: "1.0"
display-name: Basic Load Balancer App
description: This is an example StyleBook that creates a load balancer application
schema-version: "1.0"
import-stylebooks:
-
namespace: com.citrix.adc.stylebooks
prefix: stlb
version: "1.0"
parameters-default-sources:
- stlb::lb
components:
-
name: lb-comp
type: stlb::lb
description: Uses the default lb StyleBook to build the typical lb configuration objects
properties-default-sources:
- $parameters
<!--NeedCopy-->
example-lb-mon StyleBook の全内容は、参考として以下に示します。
name: example-lb-mon
namespace: examples.stylebooks
version: "1.0"
description: This is an example StyleBook that creates a load balancer application with monitors
display-name: Basic Load Balancer App with Monitors
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
-
namespace: com.citrix.adc.stylebooks
prefix: stlb
version: "1.0"
-
namespace: com.citrix.adc.commontypes
prefix: cmtypes
version: "1.0"
parameters-default-sources:
- stlb::lb
parameters:
-
name: monitors
label: "List of Monitors"
description: "List of Monitors to monitor Application Servers"
type: cmtypes::monitor[]
substitutions:
mon-name(appname, monname): $appname + "-mon-" + $monname
components:
-
name: lb-comp
type: stlb::lb
description: Uses the default lb StyleBook to build the typical lb configuration objects
properties-default-sources:
- $parameters
-
name: monitors-comp
type: cmtypes::monitor
condition: $parameters.monitors
repeat: $parameters.monitors
repeat-item: mon
repeat-index: ndx
description: Builds a list of NetScaler monitor objects and binds them to the servicegroup of this LB config
properties-default-sources:
- $mon
properties:
monitorname: $substitutions.mon-name($parameters.lb-appname, $mon.monitorname)
components:
-
name: monitor-svcg-binding-comp
condition: $parameters.svc-servers
type: ns::servicegroup_lbmonitor_binding
properties:
servicegroupname: $components.lb-comp.outputs.servicegroup.properties.servicegroupname
monitor_name: $parent.properties.monitorname
<!--NeedCopy-->