構成パックを作成および編集する
NetScaler コンソールでは、StyleBook から構成パックを作成できます。構成パックは、作成元のStyleBookに関連付けられています。構成パックの更新は、関連付けられているStyleBookを通じて行われます。
構成パックを作成する
StyleBookから構成パックを作成するには、次の操作を行います。
-
[ アプリケーション] > [構成] > [構成パック] に移動します。
-
[追加] をクリックします。
-
「StyleBook」で、構成パックを作成する必要なStyleBookを選択します。
このページでは、StyleBookをデフォルト、エンタープライズ、カスタムStyleBookに分類しています。それぞれのタブを選択して、必要なStyleBookを見つけます。
-
オプションで、 構成パックに一意の構成キーを指定します 。このキーは、 この構成パックの表示キーとして表示されます 。
-
存在する構成キーを指定した場合 、NetScaler Consoleは構成パックを作成できません。
-
構成キーを指定しない場合、NetScaler Consoleは構成パックIDを自動的に割り当てます。ただし、 この値はディスプレイキーとしては表示されません。
-
構成キーを指定せず 、 StyleBookパラメーターのいずれかが
key
属性を設定している場合、 そのパラメーター値が表示キーとして表示されます。詳細については、「 パラメータ」を参照してください。
-
-
アプリケーション名、IPアドレス、ポート、プロトコルタイプなど、必要な詳細を指定します。
GUIフィールドは、あるStyleBookから別のStyleBookによって異なります。
-
[ ターゲットインスタンス] で、設定を実行するインスタンスまたはインスタンスグループを選択します。
注:
必要な数のターゲットインスタンスを指定することで、構成を複数のNetScalerに展開できます。
-
[ ドライラン] をクリックします。
[ オブジェクト ] ページには、NetScaler インスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
[作成] をクリックします
構成パックは、 StyleBook > [構成] ページに表示されます。
既存の構成パックを編集する場合は、構成パックを選択し、「 編集」をクリックします。
構成パックのStyleBookを変更する
機能を追加したり、問題を解決したりするために、StyleBookを更新する必要がある場合があります。古いStyleBookを使用して構成パックを既に作成している場合は、新しく更新されたStyleBookを使用するように構成パックを更新することをお勧めします。新しいStyleBookを使用するには、構成パックの既存のStyleBookを変更します。
NetScalerインスタンスに基本的なロードバランサー構成を展開するStyleBookのexample-lbの例を考えてみましょう 。そして、このStyleBookから構成パックCP1を作成します。
基本的なロードバランサー構成でモニターを構成するには、新しいStyleBookが必要です。そのためには、 基本的なロードバランサー構成に加えてモニターを構成する機能を含むexample-lb-mon StyleBookを作成します。
StyleBookを作成したら、既存の構成パックCP1を更新してモニターを追加します。構成パックを更新するには、次の操作を行います。
-
[ アプリケーション] > [構成] > [構成パック] に移動します。
-
StyleBookを変更する構成パックを選択します。
この例では、リストから CP1 を選択します。
-
「 StyleBookの変更」をクリックします。
-
リストから必要なStyleBookを選択します。次に、[ 選択を保存] をクリックします。
-
[変更]をクリックします。
この例では、リストから example-lb-mon を選択します。
構成パックのStyleBookを変更すると、新しいStyleBookのパラメータが既存のStyleBookとは異なる構造になることがあります。パラメータ構造が以前のStyleBookに似ている場合、パラメータの値はそれぞれのフィールドに自動的に保持されます。それ以外の場合は、2つのStyleBook間で同じ構造を持つパラメータのみが転送されます。たとえば、同じパラメータ名、タイプ、パラメータの親など。
注意:
StyleBook互換性ページには 、パラメーターの違いが表示されます。このページは、StyleBookを変更するか、既存のStyleBookを続行するかを決定するのに役立ちます。StyleBookを変更する場合は、変更内容を確認して、「 次へ」をクリックします。
新しいStyleBookに新しいパラメータが追加された場合、StyleBookを変更した後、そのようなパラメータの値を手動で指定する必要があります。
この例では、 example-lb StyleBook の設定ページに表示されるパラメータは次のとおりです:
新しい example-lb-mon StyleBook の設定ページに表示されるパラメーターは次のとおりです:
この場合、新しいStyleBookは既存のパラメーターを変更していないため、StyleBookは基本的なロードバランサー構成の古い値を保持します。そして、それは新しいパラメータだけを追加します。モニタパラメータの場合は、必要な値を手動で指定します。
-
[ ターゲットインスタンス] で、選択したインスタンスを確認し、必要に応じてリストを更新します。
-
[ ドライラン] をクリックします。
[ オブジェクト ] ページには、NetScaler インスタンスから作成、変更、または削除されるオブジェクトが表示されます。
-
[OK] をクリックします。
「 StyleBook」>「構成」 ページの「 StyleBook名 」列に、選択した構成パックの新しいStyleBook名が表示されます。この場合、 example-lb-monと表示されます。
複数の構成パックを含むStyleBookを変更する
複数の構成パックを含む既存のStyleBookを変更する場合は、次の操作を行います:
-
新しいStyleBook をNetScalerコンソールにインポートします。
通常、新しいStyleBookの名前と名前空間は、既存のStyleBookよりも高いバージョンを持ちます。ただし、名前、名前空間、またはバージョンが異なる場合は、この手順を省略できます。
-
既存のStyleBook に関連付けられている構成パックのStyleBook を変更します。
「 StyleBook を変更 」を選択できるのは、選択した構成パックが同じStyleBook に関連付けられている場合のみです。
選択した構成パックについて、以下の条件が満たされると、NetScaler ConsoleはStyleBookを正常に変更します:
-
既存のStyleBookの設定パラメータはすべて、選択したStyleBookに存在する必要があります。
-
選択したStyleBookの新しいパラメータはオプションです。
選択した構成パックの進行状況を確認するには、構成ページで「 進行中の構成/失敗 」を選択します。
-
-
すべての構成パックが新しいStyleBook に関連付けられたら、NetScaler Consoleから古いStyleBook を削除します。
構成パックのエクスポートまたはインポート
StyleBookのような構成パックをエクスポートまたはインポートできます。この機能を使用すると、StyleBook構成を別のNetScalerコンソールサーバーと簡単に共有できます。構成パックをエクスポートすると、 tgz
またはzip
バンドルがローカルコンピュータにダウンロードされます。このバンドルには、構成パックで定義されたすべてのパラメーターを含む JSON ファイルが含まれます。
設定のエクスポート
構成パックをエクスポートするには、次の手順を実行します。
-
[ アプリケーション] > [構成] > [構成パック] に移動します。
-
エクスポートする構成パックを選択します。
-
「アクションの選択」で、「 構成のエクスポート」を選択します。
-
[ 構成のエクスポート ] ペインで、次の項目を指定します。
-
設定がデプロイされるターゲットインスタンス情報: エクスポートバンドルにターゲットインスタンスの情報を含めるには、このオプションを選択します。
-
設定に関連付けられたStyleBook: StyleBookをエクスポートバンドルに含めるには、このオプションを選択します。
-
エクスポート設定データを保護するためのパスフレーズ:エクスポートバンドルを暗号化するためのパスフレーズを指定します。このパスフレーズは、構成パックの機密データを保護します。
-
圧縮ファイルの種類: ZIP または TGZ ファイルタイプを選択します。
-
-
[エクスポート] をクリックします。
エクスポートバンドルをローカルコンピューターに保存します。
構成をインポート
構成パックは、ローカルコンピューターから別のNetScaler Consoleサーバーにインポートできます。構成パックをインポートするには、次の手順を実行します。
-
[ アプリケーション] > [構成] > [構成パック] に移動します。
-
[ 構成のインポート] を選択します。
-
コンピュータからインポートファイルバンドルを選択します。
-
エクスポート時に指定したパスフレーズを使用します。
-
オプションで、「詳細オプション」で、「 すべての構成オブジェクトがNetScalerにすでに存在する場合にのみ、新しい構成の作成を許可する」を選択します。
このオプションでは、NetScalerインスタンスですでに作成されているオブジェクトは変更されません。
同じNetScalerインスタンスを2台のNetScalerコンソールサーバーに追加したとします。また、構成パックをあるNetScaler Consoleサーバーから別のサーバーに移行する必要があります。このオプションを使用すると、NetScalerインスタンス上の構成オブジェクトを変更せずに構成パックをインポートできます。
重要:
このオプションを使用するには、指定した設定バンドルにターゲットインスタンス情報が含まれていることを確認してください。「設定のエクスポート」を参照してください。
このオプションは、すべてのオブジェクトがターゲットインスタンスに存在する場合のみ、設定を移行します。
-
[インポート] をクリックします。
構成パックをインポートすると、NetScaler Consoleは以下を確認します。
-
関連するStyleBook:関連するStyleBook がNetScalerConsoleにない場合は、構成パックとともにStyleBook がインポートされます。
-
ターゲットインスタンス: ターゲットインスタンスをチェックし、指定したターゲットインスタンスに設定をデプロイします。上記のNetScalerインスタンスがNetScalerコンソールに存在しない場合、構成パックはターゲットインスタンスなしでインポートされます。
-
ソースNetScalerコンソール:同じNetScaler Consoleサーバーに構成パックをインポートする場合、選択したバンドルによって既存の構成パックが更新されます。
設定パックをドラフトとして保存する
構成パックの「 ドラフトとして保存 」オプションを使用すると、構成の変更をドラフトとして保存できます。この機能は、NetScalerインスタンスにすぐに展開しなくても変更を保存します。
設定パックをドラフトとして保存するには、次の手順に従います:
- [ アプリケーション] > [構成] > [構成パック] に移動します。
- 「 構成 」ページで、「 追加」をクリックします。
- 目的のStyleBookを選択し、[選択] をクリックします。
- 「 構成を作成 」ページで、「 下書きとして保存」をクリックします。
構成パックをドラフトとして保存すると、構成の変更はNetScalerインスタンスに直接展開されません。代わりに、構成パックは「 保留中の構成 」の「 ドラフト構成」タブにドラフトとして保存されます。
「 ドラフト構成 」タブで、次の操作を実行する構成パックを選択します:
- ドラフトの設定を編集します。
- 構成をNetScalerインスタンスにデプロイします。
- 下書きを削除します。
保存した下書きをいつリリースするかをスケジュールすることもできます。
詳細については、「 構成パックのスケジュールの作成」を参照してください。
構成パックのスケジュールの作成
構成パックを作成すると、構成パックはデフォルトでNetScalerインスタンスに自動的に展開されます。この機能により、構成パックのデプロイをスケジュールできます。
構成パックのスケジュールを作成するには、次の手順に従います:
- [ アプリケーション] > [構成] > [構成パック] に移動します。
- 「 構成 」ページで、「 追加」をクリックします。
- StyleBookを選択し、[選択] をクリックします。
- 「 構成の作成」ページの 「 実行」で、「 実行モード 」リストから「 後で 」を選択します。
- スケジュールを設定したい日時を選択し、[ 送信] をクリックします。
スケジュールされたすべての構成は、 **保留中の構成の 「スケジュールされた構成**」タブに保存されます。作成したスケジュールを選択して、設定パラメータを編集したり、スケジュールをデプロイまたはキャンセルしたりできます。
注:
スケジュールされた構成パックをデプロイすると、スケジュールがキャンセルされ、構成がすぐに実行されます。
デプロイされた構成パックの場合
デプロイされた構成パックを編集および削除するスケジュールを作成することもできます。
構成パックの編集操作をスケジュールする
デプロイされた構成パックを編集するスケジュールを作成するには、次の手順に従います:
- [ アプリケーション] > [構成] > [構成パック] に移動します。
- [構成] ページで、StyleBookを選択し、[編集] をクリックします。
- 「 構成の編集」 ページで、構成パックを編集します。
- 「 実行モード 」リストで、「 後で」を選択します。
- スケジュールを設定したい日時を選択し、[ 送信] をクリックします。
設定パックの削除操作をスケジュールする
デプロイされた構成パックを削除するスケジュールを作成するには、次の手順に従います:
- [ アプリケーション] > [構成] > [構成パック] に移動します。
- [構成] ページで、StyleBookを選択し、[削除] をクリックします。
- 「 実行モード 」リストで、「 後で」を選択します。
- スケジュールしたい日時を選択し、「 OK」をクリックします。
ターゲットインスタンスを構成パックからデタッチする
ターゲットインスタンスを構成パックからデタッチするには、次の操作を行います。
-
[ アプリケーション] > [構成] > [構成パック] に移動します。
-
削除するターゲットインスタンスが含まれる構成パックを選択します。
-
「アクションを選択」で、「 ターゲットをデタッチ」を選択します。
-
Detach Targets ペインで、構成パックから削除するターゲットインスタンスを選択します。
-
[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-->