KONGの運用を楽にするKONG Admin API用GUI 「KONGA」

2017.06.12Update

堀

Webサービス開発部の堀です。

　オープンソースのAPI Gateway「Kong」はお使いでしょうか？
弊社のサービスでもKongを使用していますが、各種設定を行うときにKong Admin APIを叩くのではなく、GUIで操作したいと思うときもあります。（自動化する分にはAPIのほうが都合が良いのですが）

公式のGUIというものはありませんが、いくつか非公式のGUIがあります。今回はそのうちの１つ「Konga」をご紹介します。KongaはライセンスがMIT LICENSE、使用ライブラリはBootstrap,AngularJS,Sails.js、サポートしているDBはMySQL,MongoDB,PostgresSQL,SQL Serverと扱いやすい構成になっています。

インストール

必要なパッケージをインストールします。どれもyum/npmで簡単にインストールできます。

1 2	$ sudo yum install npm $ sudo npm install bower gulp sails -g

Konga本体はgithubからインストールします。

$ git clone https://github.com/pantsel/konga.git

$ cd konga

$ npm install

konga/config/に設定ファイルの雛形local_example.jsがありますので、これをコピーしてKong Admin APIのURIとDBを指定します。npm startで起動すると、http://localhost:1337で設定画面が見えるようになります。

$ cd konga/config

$ cp -pr local_example.js local.js

$ vim local.js

$ npm start

Kongaで出来ること

v.70現在でKong Admin APIでの操作は全てサポートしています。ログインすると以下にようなDashboardが表示され、APIの利用状況やKongの情報、Kongに組み込まれているpluginなどを見ることができます。

Kong Nodeの登録

ログインアイコンのところにあるメニューリストの「Settings」からKong Nodeの登録ができます。

「+ NEW NODE」でノード登録フォームがポップアップしますので、以下の項目を登録します。

　Name ：ノード名はユニークでなければならない
　kong admin IP ： kongが稼動しているサーバのIPアドレス
　kong admin port ： kong用に割り当てたport番号

kong admin IPやkong admin portなどを間違えて登録するとDashboardなどが表示されなくなったりしますので、登録後にDashboardが表示されなくなったときは一度登録内容を確認すると良いでしょう。

正しく登録できていれば、画面上部メニューリストNode Infoで登録したKongの細かい設定を確認できるようになります。

API登録

画面上部メニューリストの「APIs」からAPIの登録ができます。

「+ ADD NEW API」ボタンでノード登録フォームがポップアップしますので、以下の項目を登録します。

　Name ： API名
　Requset Host ：example.com など
　Request Path ： /exampleなどendpointのPath
　Strip Request Path ： YESにするとプロキシする前にrequest_path値を削除する。「example/hoge」に対するリクエストは「Upstream URL/hoge」になる
　Preserve Host ： YESにするとクライアントが送信した元のHostヘッダーを、Upstream URLのホスト名に置き換ずに保持する
　Upstream URL ：プロキシリクエストに使用されるURL