StyleBookの設定

GitHubリポジトリからのスタイルブックのインポートと同期

開発に CI/CD プロセスを使用しているシナリオを考えてみましょう。あるいは、すべてのアプリケーションソースコードとデプロイアーティファクトを GitHub で管理しているシナリオです。

GitHubリポジトリでは、Citrix ADC構成を展開し、これらのStyleBookを管理するために、複数のStyleBookを管理しているかもしれません。これらのスタイルブックはCitrix ADM にアップロードする必要があります。この機能を使用すると、GitHubにあるStyleBookをCitrix ADM に直接インポートできます。GitHub から手動でコピーして NetScaler ADM にアップロードする必要はありません。または、NetScaler ADM と GitHub の両方のファイルを手動で同期します。また、GitHub から設定パックをインポートして同期することもできます。

StyleBooksと構成パックをインポートするには、GitHubリポジトリを表すリポジトリをCitrix ADMで定義します。GitHub リポジトリの URL と、GitHub で作成したユーザ名と API トークンを指定します。つまり、GitHubで有効なアカウントを持つ権限のあるユーザーのみがStyleBookをインポートおよび同期できます。

リポジトリを作成したら、NetScaler ADM をGitHubリポジトリと同期できます。NetScaler ADM は GitHub に接続し、そのリポジトリにあるスタイルブックと構成パックをインポートします。次に、NetScaler ADM はスタイルブックを検証し、NetScaler ADM のスタイルブックのリストに追加します。検証に失敗した場合、スタイルブックはCitrix ADM に追加されません。StyleBookのエラーを特定して修正できます。次に、更新されたバージョンを GitHub リポジトリにコミットします。その後、それらをインポートするか、NetScaler ADM に再度同期してみてください。

重要

  • StyleBooks ファイルは、GitHub リポジトリのどのブランチからでもインポートおよび同期できます。

  • 依存関係にあるStyleBookが関連付けられているStyleBookをインポートして同期することもできます。これらの依存StyleBookは、Githubリポジトリにある場合もあれば、NetScaler ADM にすでに存在している場合もあります。

  • GitHubリポジトリからのStyleBooksの同期は、NetScaler ADM GUIまたはAPIから手動で開始する必要があります。つまり、現時点では、StyleBooksのインポートと同期は、GitHubのコミットアクティビティに基づいて自動的に行われていません。

  • インポートする構成パックファイルは JSON 形式である必要があります。また、構成ファイルの内容は、エクスポートされた構成形式に従う必要があります。GitHub リポジトリの下では、設定パックに関連するファイルがconfigpacksフォルダにある必要があります。

StyleBookファイルは、GitHubリポジトリのどのフォルダからでもCitrix ADM にインポートできます。構成パックをインポートするには、次の操作を行います。

  1. ルートディレクトリの下に名前configpacksの付いたフォルダを作成します。構成に関連するすべてのファイルがこのフォルダーにあることを確認してください。

  2. configpacks フォルダーに、構成パックのペイロードを含む JSON ファイルを作成します。このペイロードは構成パックの同期に使用されます。ペイロードの例を以下に示します。

    {
        "config_key": "unique-key-for-configpack",
    
        "parameters": {
            "param-name1": "param-value1",
            "param-name": "param-value2",
            "param-namen": "param-valuen"
        },
        "stylebook": {
            "namespace": "some namespace",
            "name": "somename",
            "version": "spme-version"
        }
    }
    <!--NeedCopy-->
    
    • config_key -NetScaler ADM の構成パックを識別する一意のIDまたは名前。config_keyを指定しない場合、NetScaler ADM は構成パックの作成時にIDを自動生成します。

      指定されたIDがCitrix ADM GUIで見つかった場合、同期アクションによってCitrix ADM GUI内の構成パックが更新されます。それ以外の場合は、指定した ID で構成パックを作成します。

    • parameters -構成パックの作成または更新に必要なすべてのパラメータが含まれています。

    • stylebook -JSON ファイルの必須プロパティです。これには、構成パックを関連付ける名前空間、バージョン、StyleBook名が含まれています。

  3. configpacks このフォルダーには、証明書、署名ファイル、XML ファイルなど、構成パックに関連するすべてのファイルを保管します。

リポジトリを追加

  1. NetScaler ADM で、[ アプリケーション]>[構成]>[リポジトリ]に移動します。[追加] をクリックします。

  2. リポジトリの追加 」ウィンドウで、次のパラメータを入力します。

    • [名前 ]-リポジトリの名前を入力します。この名前は、GitHub のリポジトリ名と同じでもかまいません。

    • [リポジトリ URL ]-GitHub リポジトリの URL を入力します。

      GitHub のエンタープライズ URL を指定できます。GitHubのエンタープライズアカウントからStyleBookや設定パックをインポートまたは同期するのに役立ちます。

    • ユーザー名 -GitHub アカウントまたはエンタープライズアカウントへのアクセスに使用するユーザー名を入力します。

    • API トークン -このトークンは、GitHub リポジトリにアクセスするために使用されます。GitHub リポジトリの API トークンを作成する方法については、 個人アクセストークンの作成に関するGitHub ドキュメントを参照してください。

    GitHub リポジトリを追加する

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

    リポジトリはCitrix ADM で作成されます。

リポジトリオプション

リポジトリの追加オプションは次のとおりです。

  • 編集 -リポジトリの URL、ユーザー名、API トークンを編集できます。

  • 削除 -リポジトリと、そのGitHubリポジトリから以前にインポートされたCitrix ADM に存在するすべてのStyleBookを削除できます。

    注:

    構成パックが関連付けられているStyleBookがある場合は、NetScaler ADM からリポジトリを削除することはできません。まず、これらのStyleBookのすべての構成パックを削除します。後でCitrix ADM からリポジトリを削除して、そのリポジトリからStyleBooksをクリーンアップできます。

  • リセット -リポジトリエントリを実際に削除しなくても、そのリポジトリから同期されたCitrix ADM 内のすべてのStyleBookを削除できます。

  • ファイルのリスト -NetScaler ADM に存在する GitHub リポジトリから作成されたすべての StyleBook のリストを表示できます。

GitHub リポジトリのリスト

GitHub から StyleBook と設定パックをインポートする手順

前提条件を満たしたら、手順に従って GitHub リポジトリから StyleBook と設定パックをインポートします。

  1. オプションで、 まだ追加していない場合はリポジトリを追加してください
  2. リポジトリページでリポジトリを選択します
  3. 同期をクリックします
GitHubリポジトリからのスタイルブックのインポートと同期