構成パックの作成と編集
NetScaler Consoleでは、StyleBookから構成パックを作成できます。構成パックは、作成元のStyleBookに紐付けられます。構成パックへの更新は、紐付けられているStyleBookを介して行われます。
Related information
構成パックの作成
StyleBookから構成パックを作成するには、以下を実行します。
-
Applications > StyleBooks > Configurations に移動します。
-
Add をクリックします。
-
Choose StyleBooks で、構成パックを作成したい必要なStyleBookを選択します。このページでは、StyleBookがデフォルトとカスタムのStyleBookに分類されています。必要なStyleBookを見つけるには、それぞれのタブを選択します。
-
アプリケーション名、IPアドレス、ポート、プロトコルタイプなどの必要な詳細を指定します。GUIフィールドはStyleBookによって異なります。
-
Target Instances で、構成を実行したいインスタンスまたはインスタンスグループを選択します。注:必要な数のターゲットインスタンスを指定することで、複数のNetScalerに構成を展開できます。
-
Dry Run をクリックします。Objects ページには、NetScalerインスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
作成をクリックします構成パックは、StyleBook > Configurations ページに表示されます。
既存の構成パックを編集する場合は、構成パックを選択し、編集をクリックします。
StyleBook の外部で作成された構成を再利用し、ConfigPack 間で構成を共有する
特定の運用上のニーズやレガシーな設定が原因であるかどうかにかかわらず、NetScaler® 構成を Stylebook の外部で作成したことがあるかもしれません。これらの既存の構成を Stylebook 構成パックの一部として統合および管理できるようになり、より柔軟で一元的な管理が可能になります。
たとえば、この機能が導入される前は、NetScaler がすでに SSL プロファイルで構成されており、StyleBook の構成パック操作が同じ名前の SSL プロファイルを作成しようとすると、構成パック操作は「リソースがすでに存在します」というエラーで失敗していました。この機能が有効になったことで、構成パック操作は成功し、同じ名前の既存の SSL プロファイルを新しい構成パックで再利用できます。
同様に、ネットワーク設定、セキュリティポリシー、またはアプリケーション構成の一部などのリソースが、複数のアプリケーションまたは構成で必要とされるシナリオに直面することもあります。この機能により、複数の構成パック間で構成を共有できます。
この機能を有効にするには、次の手順に従います。
-
アプリケーション > 設定 > スタイルブック に移動します。
-
Stylebooks ページで、新しい構成パックの作成に使用する Stylebook、または編集中の構成パックに関連付けられている Stylebook を選択します。
-
-
設定を調整するには、次のいずれかまたは両方のオプションを選択します。
-
構成の作成時に NetScaler 上の既存のリソースの再利用を有効にするには、オプション 構成の作成時に NetScaler 上の既存のリソースの再利用を許可する を選択します。
-
構成の削除時に NetScaler 上の再利用されたリソースを保持するには、オプション 構成の削除時に NetScaler 上の再利用されたリソースを保持しますか？ を選択します。このオプションは、Stylebook の外部で作成されたリソースを NetScaler 上に保持し、それらを参照する最後の構成パックが削除された場合でも、それらの継続的な可用性を保証します。
-
-
「OK」をクリックします。
config packのStyleBookを変更する
機能を追加したり、問題を修正したりするために、StyleBookを更新する必要がある場合があります。以前のStyleBookを使用してconfig packをすでに作成している場合は、新しい更新されたStyleBookを使用するようにそれらを更新することをお勧めします。新しいStyleBookを使用するには、config packの既存のStyleBookを変更します。
NetScalerインスタンスに基本的なロードバランサー構成を展開する例のStyleBook「example-lb」を考えてみましょう。そして、このStyleBookからconfig pack CP1を作成します。
基本的なロードバランサー構成でモニターを構成したい場合は、新しいStyleBookが必要です。したがって、基本的なロードバランサー構成とともにモニターを構成する機能を含む「example-lb-mon」StyleBookを作成します。
StyleBookを作成したら、既存のconfig pack CP1を更新してモニターを追加します。そのためには、次の手順を実行します。
-
Applications > StyleBooks > Configurationsに移動します。
-
StyleBookを変更したいconfig packを選択します。この例では、リストからCP1を選択します。
-
「Change StyleBook」をクリックします。
-
リストから必要なStyleBookを選択します。その後、「Save Selection」をクリックします。
-
「Change」をクリックします。この例では、リストから「example-lb-mon」を選択します。config packのStyleBookを変更すると、新しいStyleBookのパラメーターは既存のStyleBookとは異なる構造を持つ場合があります。パラメーター構造が以前のStyleBookと類似している場合、パラメーターの値はそれぞれのフィールドに自動的に保持されます。そうでない場合、2つのStyleBook間で同じ構造を持つパラメーターのみが転送されます。例えば、同じパラメーター名、タイプ、パラメーター親などです。
新しいStyleBookで新しい必須パラメータが追加された場合、StyleBookの変更後、それらのパラメータの値を手動で指定する必要があります。この例では、example-lb StyleBookの構成ページに表示されるパラメータは次のとおりです。ロードバランシング構成パックの例(/en-us/netscaler-application-delivery-management-software/media/nmas-migrate-configpack-3.png)新しいexample-lb-mon StyleBookの構成ページに表示されるパラメータは次のとおりです。構成パック移行後のパラメータの例(/en-us/netscaler-application-delivery-management-software/media/nmas-migrate-configpack-4.png)この場合、新しいStyleBookは既存のパラメータを変更していないため、StyleBookは基本的なロードバランサー構成の古い値を保持します。そして、新しいパラメータのみを追加します。モニターパラメータについては、必要な値を手動で指定してください。 -
ターゲットインスタンスで、選択したインスタンスを確認し、必要に応じてリストを更新します。
-
ドライランをクリックします。オブジェクトページには、NetScalerインスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
OKをクリックします。StyleBook > 構成ページで、StyleBook名列には、選択した構成パックの新しいStyleBook名が表示されます。この場合、example-lb-monと表示されます。
複数の構成パックを持つStyleBookを変更する
複数の構成パックを持つ既存のStyleBookを変更する場合は、次の操作を行います。
-
新しいStyleBookをNetScaler Consoleにインポートします。通常、新しいStyleBookは、既存のStyleBookよりも高いバージョンで同じ名前と名前空間を持ちます。ただし、名前、名前空間、またはバージョンが異なる場合は、この手順をスキップできます。
-
既存のStyleBookに関連付けられているconfig packのStyleBookを変更します。選択したconfig packが同じStyleBookに関連付けられている場合にのみ、StyleBookの変更を選択できます。選択したconfig packの場合、次の条件が満たされたときにNetScaler ConsoleはStyleBookを正常に変更します。
-
既存のStyleBookのすべての構成パラメータは、選択したStyleBookに存在する必要があります。
-
選択したStyleBookからの新しいパラメータはオプションです。
選択したconfig packの進行状況を確認するには、構成ページで進行中/失敗した構成を選択します。 -
-
すべてのconfig packが新しいStyleBookに紐付けられたら、NetScaler Consoleから古いStyleBookを削除します。
config packのエクスポートまたはインポート
StyleBookと同様に、config packをエクスポートまたはインポートできます。この機能を使用すると、StyleBook構成を別のNetScaler Consoleに簡単に共有できます。config packをエクスポートすると、
tgzまたはzipバンドルがローカルコンピューターにダウンロードされます。このバンドルには、config packで定義されているすべてのパラメータを含むJSONファイルが含まれています。
構成のエクスポート
config packをエクスポートするには、次の手順を実行します。
-
アプリケーション > StyleBooks > 構成に移動します。
-
エクスポートするconfig packを選択します。
-
アクションの選択で、構成のエクスポートを選択します。構成のエクスポートオプション(/en-us/netscaler-application-delivery-management-software/media/export-configuration-pack.png)
-
「構成のエクスポート」ペインで、以下を指定します。
-
構成が展開されているターゲットインスタンスの情報: エクスポートバンドルにターゲットインスタンスの情報を含めるには、このオプションを選択します。
-
構成に関連付けられているStyleBook: エクスポートバンドルにStyleBookを含めるには、このオプションを選択します。
-
エクスポート構成データを保護するためのパスフレーズ: エクスポートバンドルを暗号化するためのパスフレーズを指定します。このパスフレーズは、構成パックの機密データを保護します。
-
圧縮ファイルの種類: ZIPまたはTGZファイルタイプを選択します。
構成パックのエクスポート(/en-us/netscaler-application-delivery-management-software/media/export-configuration-options.png) -
-
エクスポートをクリックします。エクスポートバンドルをローカルコンピューターに保存します。
構成のインポート
ローカルコンピューターから別のNetScaler Consoleに構成パックをインポートできます。構成パックをインポートするには、次の手順を実行します。
-
アプリケーション > StyleBooks > 構成に移動します。
-
構成のインポートを選択します。
-
コンピューターからインポートファイルバンドルを選択します。
-
エクスポート時に指定したパスフレーズを使用します。
-
オプションで、「詳細オプション」で「すべての構成オブジェクトがNetScalerに既に存在する場合にのみ、新しい構成の作成を許可する」を選択します。このオプションは、NetScalerインスタンスにすでに作成されているオブジェクトを変更しません。同じNetScalerインスタンスを2つのNetScaler Consoleサーバーに追加したとします。そして、あるNetScaler Consoleサーバーから別のサーバーに構成パックを移行したいとします。このオプションを使用して、NetScalerインスタンス上の構成オブジェクトを変更せずに構成パックをインポートします。重要このオプションを使用するには、指定された構成バンドルにターゲットインスタンス情報が含まれていることを確認してください。詳細については、「構成のエクスポート」を参照してください。このオプションは、すべてのオブジェクトがターゲットインスタンスに存在する場合にのみ構成を移行します。
-
インポートをクリックします。
構成パックをインポートすると、NetScaler Consoleは次のことを検証します。
-
関連付けられたStyleBook: 関連付けられたStyleBookがNetScaler Consoleにない場合、構成パックとともにStyleBookをインポートします。
-
ターゲットインスタンス: ターゲットインスタンスを確認し、指定されたターゲットインスタンスに構成を展開します。NetScaler Consoleに記載されているNetScalerインスタンスが存在しない場合、構成パックはターゲットインスタンスなしでインポートされます。
-
ソースNetScaler Console: 同じNetScaler Consoleサーバーに構成パックをインポートする場合、選択したバンドルは既存の構成パックを更新します。
構成パックを下書きとして保存する
構成パックの下書きとして保存オプションを使用すると、構成の変更を下書きとして保存できます。この機能は、NetScalerインスタンスにすぐに展開せずに変更を保存します。
構成パックを下書きとして保存するには：
-
アプリケーション > 構成 > 構成パックに移動します。
-
「Configurations」ページで、「Add」をクリックします。
-
目的のスタイルブックを選択し、「Select」をクリックします。
-
「Create Configuration」ページで、「Save as Draft」をクリックします。
設定パックがドラフトとして保存されると、設定の変更はNetScalerインスタンスに直接展開されません。代わりに、設定パックは「Pending Configurations」の下にある「Draft Configurations」タブにドラフトとして保存されます。
「Draft Configurations」タブで、次の操作を実行する設定パックを選択します。
-
設定パックの設定を編集します。
-
設定をNetScalerインスタンスに展開します。
-
展開せずに設定を削除するには、ドラフトを削除します。
保存したドラフトを展開するタイミングをスケジュールすることもできます。
詳細については、「設定パックのスケジュール」を参照してください。
設定パックのスケジュールを作成する
設定パックを作成すると、デフォルトでNetScalerインスタンスに自動的に展開されます。この機能を使用すると、設定パックを展開するタイミングをスケジュールできます。
設定パックのスケジュールを作成するには：
-
「アプリケーション > 構成 > 設定パック」に移動します。
-
「Configurations」ページで、「Add」をクリックします。
-
StyleBookを選択し、「Select」をクリックします。
-
「Create Configuration」ページで、「Execution」の下にある「Execution Mode」リストから「Later」を選択します。
-
スケジュールする希望の時間と日付を選択し、「Submit」をクリックします。
実行モード(/en-us/netscaler-application-delivery-management-software/media/execution-mode.png)
スケジュールされたすべての構成は、「Pending Configurations」の下にある「Scheduled configurations」タブに保存されます。作成されたスケジュールを選択して、編集、展開、またはキャンセルできます。
スケジュールされた構成(/en-us/netscaler-application-delivery-management-software/media/scheduled-config.png)
展開された構成パックの場合
展開された構成パックを編集および削除するためのスケジュールを作成することもできます。
構成パックの編集操作をスケジュールする
展開された構成パックを編集するためのスケジュールを作成するには：
-
「アプリケーション > 構成 > 設定パック」に移動します。
-
「Configurations」ページで、StyleBookを選択し、「Edit」をクリックします。
-
「Edit Configuration」ページで、構成パックを編集します。
-
「実行モード」リストで、「後で」を選択します。
-
スケジュールする希望の時間と日付を選択し、「送信」をクリックします。
設定パックの削除操作をスケジュールする
展開された設定パックを削除するスケジュールを作成するには：
-
アプリケーション > 構成 > 設定パックに移動します。
-
「構成ページ」で、StyleBookを選択し、「削除」をクリックします。
-
「実行モード」リストで、「後で」を選択します。
-
スケジュールする希望の時間と日付を選択し、「送信」をクリックします。
設定パックからターゲットインスタンスをデタッチする
設定パックからターゲットインスタンスをデタッチするには、次の手順を実行します。
-
アプリケーション > 構成 > 設定パックに移動します。
-
削除したいターゲットインスタンスを含む設定パックを選択します。
-
「アクションの選択」で、「ターゲットのデタッチ」を選択します。
-
「ターゲットのデタッチ」ペインで、設定パックから削除したいターゲットインスタンスを選択します。
-
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
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