ロードバランシング仮想サーバーを作成するためのStyleBook
ヘッダー
name: lb-vserver
description: This StyleBook defines a load balancing virtual server configuration.
display-name: Load Balancing Virtual Server (HTTP)
namespace: com.example.stylebooks
schema-version: "1.0"
version: "0.1"
-
name: このStyleBookの名前。
-
description: このStyleBookが何をするかを定義する説明。この説明はNetScaler Consoleに表示されます。
-
display-name: NetScaler Consoleに表示されるStyleBookのわかりやすい名前。
-
namespace: 名前空間は、名前の衝突を避けるためにStyleBookの一意の識別子の一部を形成します。
-
schema-version: このリリースでは常に「1.0」の値を取ります。
-
version: StyleBookのバージョン番号。StyleBookを更新するときにバージョン番号を変更できます。
StyleBookのインポート
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
パラメータ
parameters:
-
name: name
type: string
label: Application Name
description: Name of the application configuration.
required: true
-
name: ip
type: ipaddress
label: Application Virtual IP (VIP)
description: Application VIP that the clients access.
required: true
-
name: lb-alg
type: string
label: LoadBalancing Algorithm
description: Choose the load balancing algorithm (method) used for load balancing client request between the application servers.
allowed-values:
- ROUNDROBIN
- LEASTCONNECTION
default: ROUNDROBIN
-
type。これらのパラメータが取りうる値のタイプ。例えば、nameとlb-algは文字列値を取ることができ、ip値はIPアドレスタイプである必要があります。StyleBookのパラメータは、以下のいずれかの組み込みタイプにすることができます。
-
string。文字の配列。長さが指定されていない場合、文字列値は任意の数の文字を取ることができます。ただし、min-length属性とmax-length属性を使用することで、文字列タイプの長さを制限できます。
-
number。整数。min-value属性とmax-value属性を使用することで、このタイプが取りうる最小値と最大値を指定できます。
-
boolean。trueまたはfalseのいずれかになります。また、すべてのリテラルはYAMLによってブール値と見なされることに注意してください(例:YesまたはNo)。
-
ipaddress。有効なIPv4またはIPv6アドレスを表す文字列。
-
tcp-port。TCPまたはUDPポートを表す0から65535までの数値。
-
パスワード。不透明な/秘密の文字列値。NetScaler Console がこのパラメータの値を表示する場合、アスタリスク (*****) として表示されます。
-
certfile。証明書ファイル。
-
keyfile。証明書秘密鍵ファイル。
-
file。このタイプのパラメータは、ユーザーがファイル(例:証明書またはキーファイル)をアップロードすることを要求します。
-
object。複数の要素で構成され、これらの各要素はパラメータです。このタイプは、複数の関連するパラメータを1つの親パラメータの下にグループ化するために使用できます。
-
required。パラメータが必須かオプションかを示します。trueに設定されている場合、パラメータは必須であり、ユーザーはこのStyleBookを使用して構成を作成する際にこのパラメータの値を指定する必要があります。デフォルトでは、すべてのパラメータはオプションです。この例では、nameとipは必須パラメータであり、lb-algはオプションパラメータで、そのデフォルト値は「ROUNDROBIN」です。
コンポーネント
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: $parameters.name
servicetype: HTTP
ipv46: $parameters.ip
port: 80
lbmethod: $parameters.lb-alg
-
組み込みタイプ。このタイプはシステムによって提供され、定義する必要はありません。たとえば、NITROエンティティタイプ「lbvserver」または「servicegroup」などです。この例では、組み込みコンポーネントタイプを使用しています。
-
複合タイプ。このタイプは、作成してNetScaler ConsoleにインポートしたStyleBook、またはNetScaler Consoleに付属しているデフォルトのStyleBookです。複合StyleBookの詳細については、「複合StyleBookの作成」を参照してください。
StyleBookを構築する
name: lb-vserver
namespace: com.example.stylebook
version: "1.0"
display-name: Load Balancing Virtual Server (HTTP)
description: "This stylebook defines a very simple load balancing HTTP virtual server configuration"
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
version: "10.5"
prefix: ns
-
namespace: com.citrix.adc.stylebooks
version: "1.0"
prefix: stlb
parameters:
-
name: name
label: "Application Name"
description: "Give a name to the application configuration."
type: string
required: true
-
name: vip-ipaddress
label: "Load Balancer IP Address"
description: "The Application VIP that clients access"
type: ipaddress
required: true
-
name: lb-alg
label: LB Algorithm
description: Load Balancing Algorithm
type: string
default: ROUNDROBIN
allowed-values:
- ROUNDROBIN
- LEAST-CONNECTION
components:
-
name: lbvserver-comp
description: This StyleBook component (a Builtin Nitro StyleBook) builds a NetScaler load balancing virtual server configuration object.
type: ns::lbvserver
properties:
name: $parameters.name
ipv46: $parameters.vip-ipaddress
lbmethod: $parameters.lb-alg
servicetype: HTTP
port: 80