SSL証明書と証明書キーファイルをアップロードするためのStyleBookの作成
SSLプロトコルを使用するStyleBookの構成を作成する場合、SSL証明書ファイルと証明書キーファイルをStyleBookパラメーターの要求に応じてアップロードする必要があります。StyleBookでは、NetScalerコンソールGUIを使用してローカルシステムからSSLファイルとキーファイルを直接アップロードできます。また、NetScalerコンソールAPIを使用して、NetScalerコンソールが既に管理している証明書ファイルとキーファイルをアップロードすることもできます。
StyleBookの設定
このドキュメントは、 SSL証明書とキーファイルをアップロードするためのコンポーネントを備えた独自のStyleBook-負荷分散仮想サーバー(SSL) を作成するのに役立ちます。ここで例として提供しているStyleBookは、選択したNetScaler ADC インスタンス上に基本的な負荷分散仮想サーバー構成を作成します。この構成はSSLプロトコルを使用します。このStyleBookを使用して構成を作成するには、仮想サーバーの名前とIPアドレスを指定し、負荷分散方法のパラメーターを選択し、仮想サーバーの証明書ファイルと証明書キーファイルをアップロードするか、NetScaler Consoleに既に存在する証明書ファイルと証明書キーファイルを使用する必要があります。これらのパラメータは、次の「パラメータ」セクションで指定されています:
parameters:
-
name: name
type: string
required: true
-
name: ip
type: ipaddress
required: true
-
name: lb-alg
type: string
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
-
name: certificate
label: "SSL Certificate File"
description: "The file name of the SSL certificate file"
type: certfile
-
name: key
label: "SSL Certificate Key File"
description: "The file name of the server certificate's private key file"
type: keyfile
-
name: passphrase
label: "SSL Certificate Key Passphrase"
description: "The password used to protect the certificate's private key file"
type: password
<!--NeedCopy-->
次に、StyleBookのコンポーネントセクションに2つのコンポーネントが作成されます。my-lbvserver-comp
コンポーネントのタイプns::lbvserver
は次のとおりです。
- 「ns」は、
import-stylebooks
セクションで指定した組み込み名前空間 netscaler.nitro.config とバージョン 10.5 を指すプレフィックスです。 -
lbvserver
は、この名前空間に組み込みの StyleBook です。これは、同じ名前のNetScaler ADC NITROlbvserver
リソースに対応します。
2番目のコンポーネントlbvserver-certificate-comp
はタイプstlb::vserver-certs-binds
です。プレフィックスstlb
は、StyleBookのインポートStyleBook セクションで指定されている名前空間「com.citrix.adc.stylebooks」とバージョン 1.0 を指します。「com.citrix.adc.stylebooks」名前空間をフォルダと考えることができる場合、そのフォルダには別のStyleBook(またはファイル)vserver-certs-binds
があります。名前空間「com.citrix.adc.stylebooks」にあるStyleBook は、NetScaler Consoleの一部として出荷されます。
ユーザー定義のvserver-certs-binds
StyleBookで使用されるStyleBookを使用すると、証明書とキーファイルをターゲットのNetScaler ADCインスタンスにアップロードし、証明書とキーファイルを適切な仮想サーバーにバインドして構成することで、証明書を簡単に構成できます。このコンポーネントのプロパティーは、lb 仮想サーバーの名前と、構成パックの作成時に提供する SSL 証明書の名前です。
components:
-
name: my-lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name
servicetype: SSL
ipv46: $parameters.ip
port: 443
lbmethod: $parameters.lb-alg
-
name: lbvserver-certificate-comp
type: stlb::vserver-certs-binds
description: Binds lbvserver with server certificate
properties:
vserver-name: $components.my-lbvserver-comp.properties.name
certificates:
-
cert-name: $parameters.name + "-lb-cert"
cert-file: $parameters.certificate
ssl-inform: PEM
key-name: $parameters.name + "-key"
key-file: $parameters.key
cert-password: $parameters.passphrase
<!--NeedCopy-->
APIを使ってこういったStyleBookから構成を作成する場合は、ファイル名だけを使うようにしてください(フルファイルパスではなく)。これらのファイルは、NetScaler Consoleの証明書およびキーファイルフォルダーにすでに入手可能になっているはずです。アップロードされたSSL証明書ファイルはNetScaler Consoleの/var/mps/tenants/.../ns_ssl_certs
ディレクトリに保存され、SSL証明書キーファイルはNetScaler Consoleの/var/mps/tenants/.../ns_ssl_keys
ディレクトリに保存されます。
SSL ファイルをアップロードするための構成の作成
次の手順では、StyleBookの例にあるSSLプロトコルを使用して、選択したNetScalerインスタンスに基本的な負荷分散仮想サーバー構成を作成します。この手順を使用して、NetScaler ConsoleにSSL証明書ファイルと証明書キーファイルをアップロードできます。
ファイルをアップロードするための設定を作成するには:
-
NetScaler コンソールで、[ アプリケーション ] > [ 構成] > [StyleBook **] に移動します。 **StyleBookページには 、NetScalerコンソールで利用できるすべてのStyleBook が表示されます。
-
下にスクロールして [ 負荷分散仮想サーバー (SSL) ] を選択するか、検索フィールドに「 負荷分散仮想サーバー (SSL) 」と入力して Enter キーを押します。
-
StyleBook パネルの「 構成を作成 」をクリックします。
StyleBookパラメーターは、このStyleBookで定義されているすべてのパラメーターの値を入力できるユーザーインターフェイスページとして表示されます。
-
ロードバランサーの基本設定セクションにロードバランサーの名前と仮想 IP アドレスを入力します。
-
「 SSL 証明書設定」で、ローカルストレージフォルダからそれぞれのファイルを選択します。NetScaler コンソールにあるファイルを選択することもできます。
-
構成を作成する対象のNetScalerインスタンスを選択し、[ 作成]をクリックします。
注:
更新アイコンをクリックして、NetScaler Consoleで最近検出されたNetScalerインスタンスを、このウィンドウの使用可能なインスタンスリストに追加することもできます。
NetScaler Consoleでは、NetScalerコンソールの一部として付属している以下のデフォルトStyleBook を使用して、SSL証明書とキーをアップロードすることでSSLサポートを作成できます。
- HTTP/SSL負荷分散StyleBook(lb)
- HTTP/SSL負荷分散(モニタ付き)StyleBook (
lb-mon
)- HTTP/SSL コンテンツスイッチ付きアプリケーション (
cs-lb-mon
)- CS、LB、SSL機能を使用したサンプルアプリケーションStyleBook (
sample-cs-app
)
StyleBookを構築する
lb-vserver-ssl.yamlファイルのすべての内容を次に示します。
name: lb-vserver-ssl
namespace: com.example.ssl.stylebooks
version: "0.1"
description: "This stylebook defines a load balancing virtual server configuration."
display-name: "Load Balancing Virtual Server (SSL)"
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"
parameters:
-
name: name
type: string
required: true
-
name: ip
type: ipaddress
required: true
-
name: lb-alg
type: string
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
-
name: certificate
label: "SSL Certificate File"
description: "The file name of the SSL certificate file"
type: certfile
-
name: key
label: "SSL Certificate Key File"
description: "The file name of the server certificate's private key file"
type: keyfile
-
name: key
label: "SSL Certificate Key Passphrase"
description: "The password used to protect the certificate's private key file"
type: password
components:
-
name: my-lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name
servicetype: SSL
ipv46: $parameters.ip
port: 443
lbmethod: $parameters.lb-alg
-
name: lbvserver-certificate-comp
type: stlb::vserver-certs-binds
description: Binds lbvserver with server certificate
properties:
vserver-name: $ components.my-lbvserver-comp.properties.name
certificates:
-
cert-name: $parameters.name + "-lb-cert"
cert-file: $parameters.certificate
ssl-inform: PEM
key-name: $parameters.name + "-key"
key-file: $parameters.key
cert-password: $parameters.passphrase
<!--NeedCopy-->
NetScalerコンソールAPIを使用して構成パックを作成する:
NetScaler Console APIを使用して、選択したNetScalerインスタンスに証明書ファイルとキーファイルをアップロードする構成パックを作成することもできます。API の使用方法の詳細については、「 証明書とキーファイルをアップロードする構成を API を使用して作成する方法」を参照してください。
NetScaler インスタンスに定義されているオブジェクトの表示
NetScaler ConsoleでStyleBook構成(構成パック)を作成したら、[ 作成されたオブジェクトを表示]をクリックして、ターゲットのNetScalerインスタンスで作成されたすべてのNetScalerオブジェクトを表示します 。