StyleBookの設定

カスタムStyleBookをインポートする

スタイルブックを作成したら、それをCitrix ADM にインポートして使用します。NetScaler ADM では、YAML形式の単一のスタイルブック、または複数のStyleBook YAMLファイルを.zip、.tgz、または.gz形式のバンドルとしてインポートできます。NetScaler ADM システムは、インポート時にスタイルブックを検証します。これで、StyleBookを使用して構成を作成する準備ができました。

NetScaler ADM には、StyleBook YAMLコンテンツの作成に使用できる組み込みのYAMLエディタもあります。YAMLエディタを使用すると、NetScaler ADM GUI自体から YAML 構造を検証できます。これらの検証チェックに個別のツールを使用する必要はありません。コンテンツはYAML標準に照らして検証され、偏差が強調表示されます。その後、コンテンツを修正して、StyleBookをCitrix ADM にインポートしてみることができます。ビルトインのYAMLエディターには、独自のStyleBookを作成する際に2つの利点があります。

  • 色分けされています。エディタには、YAMLガイドラインに従って解析されたStyleBookコンテンツが表示されます。色分けにより、YAML コンテンツで定義されているキーと値を簡単に区別できます。
  • YAML 検証です。入力時にコンテンツの YAML エラーが検証され、逸脱があればすぐに強調表示されます。この検証により、Citrix ADMにStyleBookをインポートする前でも、YAMLガイドラインに準拠したテキストを作成できます。

注:

現在、エディタは YAML ガイドラインに従ってコンテンツを検証します。コードの正確性と誤植は検証されません。

StyleBookの説明とヘッダーにHTMLフォーマットタグを使用する

StyleBookの定義には 、ヘッダーフィールドを含めたり、テキストにHTMLフォーマットタグを使用したりできます。ヘッダーの一部として画像を含めることもできます。ヘッダーフィールドの HTML コンテンツは、構成を作成または更新するときに、構成ページの上部に表示されます。この機能により、StyleBookの構成を理解するのに役立つインフォグラフィックを追加できます。ヘッダーに画像を使用する場合は、 <img> タグに必ず base64 でエンコードされた画像形式を使用してください。

HTML コンテンツで画像を使用するには、次の例のように画像をインラインにする必要があります。オンラインツールを使用して、画像を base64 でエンコードされた形式に変換できます。

name: cs-example
namespace: com.example.stylebooks
version: "1.2"
display-name: Content Switching Configuration
description: Example of a very simple content switching config that creates and binds an lb to a cs
header:  <img id="b64img" src="data:image/png;base64,…" />
     <h3>Operations performed by this StyleBook:</h3>
     <ul>
      <li style="list-style-type: circle"> Creates a Server </li>
      <li style="list-style-type: circle"> Creates a Service Group </li>
       <li style="list-style-type: circle"> Creates a LBVServer </li>
      <li style="list-style-type: circle"> Creates a CS Policy and Action </li>
     </ul>
schema-version: "1.0"
<!--NeedCopy-->

StyleBookをインポートするには

  1. NetScaler ADM で、[ アプリケーション ]>[ 構成 ]>[ スタイルブック]の順に選択し、[ 新しいスタイルブックのインポート]をクリックします。

  2. StyleBookをインポートするには、次のオプションのいずれかをクリックします。

    • ファイル -ローカルストレージから必要なファイルまたはファイルのバンドルを選択します。

      注:

      この例では、 lb-vserver.ymlStyleBookで作成したStyleBookをインポートして、負荷分散仮想サーバーを作成します

      StyleBookファイルをインポートする

    • バンドル -NetScaler ADM では、多くのスタイルブックをYAML形式でインポートできます。zip(.zip)形式または tarball(.tgz、.gz)形式で圧縮された複数の YAML StyleBook ファイルをインポートできます。

      StyleBookバンドルをインポートする

      NetScaler ADM にインポートされたスタイルブックは、StyleBooks GUIにデフォルトのアイコンで表示されます。これらのデフォルトアイコンは、独自の画像でカスタマイズできます。

      必要な操作:

      • StyleBook YAMLファイルを含むフォルダーの下にresourcesの名前のフォルダーを作成します。
      • アイコンをresourcesフォルダーにアップロードします。

      注:

      resources フォルダの名前を他の名前に変更することはできません。

      • アイコンファイルとそれに対応するStyleBookファイルの名前が同じ場合、アイコンは自動的にStyleBookにマップされます。
      • アイコンファイルとそれに対応するスタイルブックファイル (exchange.yaml と exch.png など) が一致しない場合は、次のようにresourcesフォルダーに「icon_mapping.json」という名前の JSON ファイルを作成します。
       <StyleBook file name> : <icon file name>
       <StyleBook file1 name> : <icon file1 name>
       <StyleBook file2 name> : <icon file2 name>
       <!--NeedCopy-->
      

      StyleBookバンドルの例を次に示します。

      StyleBookバンドル (アイコン付き)

      resources フォルダーには必要なアイコンがあります。

      リソースフォルダ内のアイコン

      この例では、sharepoint.yamlおよびskype.yamlファイルはそれぞれsharepoint.jpegおよびskype.pngに自動的にマップされます。

      exchange.yamlexch.pngにマッピングするには、 icon_mapping.json ファイルに次のように指定します。

       {
       "exchange.yaml":"exch.png"
       }
       <!--NeedCopy-->
      

      StyleBookバンドルにアイコンがない場合は、デフォルトのアイコンが表示されます。

    • Raw -YAMLエディタでスタイルブックのコンテンツを作成します。

      StyleBookのコンテンツを検証して、StyleBookの文法エラーをチェックできます。 StyleBookのコンテンツを検証するには、「コンテンツを検証」をクリックします。

      :StyleBookを作成する際には、次の概念を必ず理解してください。

      • NITRO API
      • YAML

      独自のStyleBookを作成する方法について詳しくは、「 独自のStyleBookを作成する方法」を参照してください。

      NetScaler ADM YAML エディターを使用して StyleBook を作成する

      注:

      お気に入りのエディターでStyleBookを作成し、そのコンテンツをコピーしてYAMLエディターに貼り付け、検証とインポートを行うこともできます。

    • リポジトリを同期 -GitHubでStyleBookを作成および管理している場合は、このオプションを使用してCitrix ADM でリポジトリ内の新規または更新されたStyleBookを検索できます。NetScaler ADM と同期するリポジトリを選択します。

      NetScaler ADM のリポジトリを同期する

  3. 必要に応じて、StyleBookのアイコンを選択します。

    アプリケーション」>「構成」>「StyleBooks」では、インポートされたStyleBookがこのアイコンで表示されます。

    アイコン付きのスタイルブックをインポート

  4. [作成] をクリックします。

    NetScaler ADM は、StyleBookの文法に従って、すべての構文エラーと意味エラーについてStyleBookを検証するようになりました。エラーが発生した場合、StyleBookはCitrix ADM にインポートされません。

    エラーがなければ、StyleBookは正常にインポートされ、 StyleBooksページに表示されます 。StyleBookは、StyleBookのヘッダーセクションで定義した表示名で識別できます。

    StyleBookの例

    注:

    ファイルのバンドルをインポートする場合、NetScaler ADM は圧縮されたフォルダーを解凍し、すべてのStyleBookを検証します。 1つのStyleBookファイルが検証テストに失敗しても、バンドルはインポートされません。

    StyleBook の文法と、さまざまな構文と属性の構文について詳しくは、「 StyleBook 文法」を参照してください。

  5. このStyleBookから構成を作成するには、「構成の作成」リンクをクリックします。

    StyleBookページが開き 、このStyleBookで定義されているすべてのパラメータの値を入力できます。

  6. パラメータに必要な値を指定します。

    次の例では、

    1. アプリケーション名とロードバランサのIP アドレスの必須フィールドを指定します

    2. リストから [ 負荷分散アルゴリズム ] を選択します。デフォルトでは ROUNDROBIN が選択されています。

      構成デプロイの例

  7. ターゲットインスタンス]で、構成を展開するCitrix ADCインスタンスのIPアドレスを選択します。

    ターゲットインスタンスを必要な数だけ指定して、複数のCitrix ADC で構成を展開することもできます。

    NetScaler ADM で最近検出されたすべてのCitrix ADC インスタンスをターゲットインスタンスに追加するにはStyleBooksページに移動し 、ページの右側にある更新アイコンをクリックします。

  8. 構成を展開する前に、NetScaler(NITRO)構成オブジェクトをテストする場合は、[ ドライ実行]をクリックします。

    構成が有効な場合、設定オブジェクトは指定された値に基づいて作成されます。

    この例では、StyleBookはタイプlbvserverのオブジェクトを1つだけ作成します 。この負荷分散サーバーは、この基本的な例StyleBookで定義されている唯一のコンポーネントでした。

    その後、[ 作成 ]をクリックして、選択したCitrix ADCインスタンスに構成を展開します。

構成を正常に展開すると、[構成] ページに新しい構成パックが表示されます

カスタムStyleBookをインポートする