StyleBookの設定

GitHubリポジトリからのStyleBook のインポートと同期

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

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

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

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

重要

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

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

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

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

StyleBook ファイルは、GitHubリポジトリ内の任意のフォルダーからNetScaler Consoleにインポートできます。構成パックをインポートするには、次の操作を行います:

  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 コンソールで構成パックを識別するための一意のIDまたは名前。config_keyを指定しない場合、NetScaler Consoleは構成パックの作成時にIDを自動的に生成します。

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

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

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

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

リポジトリを追加

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

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

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

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

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

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

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

    GitHub リポジトリを追加する

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

    リポジトリはNetScalerコンソールで作成されます。

リポジトリオプション

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

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

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

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

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

  • リストファイル-NetScaler ConsoleにあるGitHubリポジトリにあるすべてのStyleBook のリストを表示できます。

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

前提条件を満たしたら、手順に従ってStyleBooksと構成パックをGitHubリポジトリからインポートします:

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