Application Delivery Management

カスタムStyleBookの作成と使用

デプロイメント用の独自のStyleBookを作成し、NetScaler Consoleにインポートして、構成オブジェクトを作成できます。APIを使用してStyleBookから構成を作成することもできます。

このドキュメントには、次の情報が含まれています。

はじめに

StyleBookの作成を開始する前に、次の知識があることを確認してください。

StyleBookファイルはYAML形式を使用します。YAML形式の詳細については、YAML構文を参照してください。

StyleBookを作成する際に注意すべきYAMLガイドラインのリストを次に示します。

  • YAMLは大文字と小文字を区別します。
  • YAMLには適切なインデントが必要です。
  • 適切なインデントを作成するには、<spacebar>キーを使用します。<tab>キーは使用しないでください。<tab>キーを使用すると、StyleBookをMAサービスにインポートする際にコンパイルエラーが発生します。
  • 引用符内に文字列を使用しないでください。文字列に句読点(ダッシュ、コロンなど)が含まれている場合にのみ、引用符内に文字列を含めます。数値を文字列として解釈したい場合は、数値を引用符で囲むか、StyleBookの組み込み関数str()を使用します。
  • YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off、TRUE/true/truthy/FALSE/False/false/falselyのようなリテラルはブール値と見なされ、それぞれtrueとfalseに相当します。これらを文字列として解釈するには、引用符で囲みます。例:

    • “YES”
    • “No”
    • “True”
    • “False”など。

StyleBookファイルをNetScaler Consoleにインポートする前に、ファイルがYAML形式に準拠していることを検証することをお勧めします。YAMLコンテンツを検証およびインポートするには、StyleBookに組み込まれているYAMLバリデーターを使用することをお勧めします。

StyleBookを構成する際、作成および削除操作(POSTおよびDELETE HTTPメソッド)をサポートするNitro構成リソースのみを使用できます。詳細については、Nitro APIドキュメントを参照してください。

StyleBookの構造

StyleBookを作成するには、StyleBookの文法、構文、および構造を理解する必要があります。一般的なStyleBookには、次のセクションがあります。

  • ヘッダー: このセクションでは、StyleBookのIDを定義し、その機能について説明します。これは必須セクションです。
  • StyleBookのインポート: このセクションでは、現在のStyleBookから参照する他のStyleBookを宣言できます。StyleBookを作成するには、NetScaler NITRO構成StyleBookまたは他のStyleBookをインポートする必要があります。これは必須セクションです。
  • パラメーター: このセクションでは、構成を作成するためにStyleBookで必要となるパラメーターを定義できます。StyleBookが受け取る入力を記述します。これはオプションのセクションです。
  • コンポーネント: このセクションでは、特定の構成のためにStyleBookによって作成されるエンティティ(構成オブジェクト)を定義できます。このセクションはStyleBookの核と見なされます。コンポーネントは通常、パラメーターセクションで提供された入力を使用して、StyleBookによって生成される構成を調整します。これはオプションのセクションです。

    StyleBookには、パラメーターセクション、コンポーネントセクション、またはその両方を含めることができます。パラメーターセクションのみを持つStyleBookは、他のStyleBookで使用できるパラメーターのリストを定義するのに役立ちます。これにより、一連のStyleBook間でパラメーターグループの再利用性が促進されます。コンポーネントセクションのみを持つStyleBookは、ユーザー入力を受け取るパラメーターを定義する代わりに、StyleBook内の属性の値を指定したい場合に使用できます。

  • 出力: パラメーターセクションがStyleBookの入力を定義するのに対し、このオプションのセクションは出力を定義します。このオプションの出力セクションでは、このStyleBookから構成を作成するユーザーや、このStyleBookをインポートする他のStyleBookに公開したいコンポーネントを指定できます。ユーザーやインポートするStyleBookは、公開されたコンポーネントのプロパティを参照できます。
  • 操作: StyleBookには、StyleBookの一部である仮想サーバーでNetScaler ConsoleのAnalyticsを有効にするためのオプションセクションを含めることができます。

次の図は、StyleBookの簡単な概要を示しています。

ローカライズされた画像

次の例は、StyleBookの文法と構造、および複雑さが増すStyleBookの作成方法について学ぶのに役立ちます。

カスタムStyleBookの作成と使用