3scaleをインストールしてみよう！

はじめに

前回の記事では、APIとAPI管理の基本的なことについて説明し、オープンソースのAPI管理製品である3scaleをご紹介しました。本記事では、API管理基盤となる3scaleのインストール方法をご紹介したいと思います。

前回記事にもある通り3scaleのソースコードはGitHubで公開され、コミュニティによる開発が進められています。3scaleを構成する主要モジュールは5つ（APIcast、Porta、Apisonator、Pisoni、Zync）あり、そこで使用されるシステムコンポーネントはすべてコンテナとして動作します。3scaleをインストールできる環境には、Kubernetesをベースとしたオープンソースのコンテナ管理プラットフォームであるOpenShiftがあります。

今回は簡単にインストールできるオールインワン構成のOpenShiftであるMinishiftを使って、3scaleの環境を構築していきます。

Minishiftのインストール

今回使用する環境はMacBook Pro（メモリ16GB）、macOS Sierra（10.12.6）ですが、他の環境の方は適宜読み替えて頂ければと思います。macOSでは、Homebrewを使用してMinishiftを簡単にインストールできます。なお、Minishiftのインストールと設定に関する情報の詳細は、「Overview - Getting Started | Minishift | OKD Latest」にも記載されています。

Minishiftのインストールが完了したら、さっそくMinishiftを起動してみましょう。なお、3scaleをローカルで動かす場合、Minishiftには最低でも6GB程度のメモリと2コア以上のCPUを割り当てた方がよいため、「–memory 6GB –cpus 2」のオプションを付けてMinishiftを起動します。

上記のようなメッセージが表示されていればOpenShiftは無事に起動しています。ログに表示されているURL（上記であればhttps://192.168.64.3:8443/console）にアクセスしてOpenShiftの管理コンソールにアクセスすることもできますが、ここでは3scaleのインストールを進めましょう。

3scaleのインストール

3scaleをインストールする前の下準備

3scaleの実行環境はOpenShiftのテンプレートとして提供されており、3scaleの環境構築担当者はそのテンプレートを用いて簡単に3scaleの実行環境を構築できるようになっています。3scaleのGitHubにはいくつかのテンプレートが用意されていますが、今回は評価用のテンプレート（amp-eval-tech-preview.yml）を使用しますので、事前にファイルをダウンロードしておきます。

3scaleのOpenShiftテンプレートを使用して3scaleをインストールするには、OpenShiftのCLIツールであるocコマンドを使用します。Minishiftをインストールするとocコマンドも一緒にインストールされますがPATHが通っていないため、以下のコマンドを使用してPATHを通します。

ocコマンドの設定が完了したら、まずはadminユーザとしてOpenShiftにログインします。

デフォルトで複数のOpenShiftプロジェクトが作られていますが、ここでは3scaleインストール用のプロジェクトを作成し、そこに3scaleの実行環境を構築していきましょう。

3scaleのコンテナイメージはregistry.redhat.ioにあるものを使用する必要があります。そのレジストリにアクセスするためにRegistry Service Accountを使用しますので、Registry Service Accountsのページでサービスアカウントを作成してください(Red Hatのアカウントがない場合にはRed Hatアカウントも作成してください)。

レジストリサービスのアカウントが用意できたら、以下のコマンドでdocker-registryのシークレットを作成します。なお、your-registry-service-account-usernameとyour-registry-service-account-passwordの値はRegistry Service Accountsのページに表示されているものと置き換えてください。

Registry Service Accountsの作成については、オンラインマニュアルも参照ください。

以上で準備は完了です。

3scaleのインストール

それでは、いよいよ3scaleをインストールしていきましょう。OpenShiftテンプレートを使用してアプリケーションをOpenShiftにデプロイするには「oc new-app」コマンドを使用します。以下のように引数を指定してoc new-appコマンドを実行すると、3scaleのOpenShiftテンプレートのデプロイが開始されます。

3scaleのコンテナはAPIゲートウェイ（APIcast）、管理ポータル、デベロッパーポータル、データベース、cron、インデックスエンジンなど役割ごとにKubernetesのPodとして個別にデプロイされており、それぞれ必要に応じて柔軟にスケールアウトできるモジュール構成となっています。すべてのPodのデプロイが完了するまで若干時間がかかりますので、すべてのPodが起動するまで少し待ちましょう（3scale 2.4では全部で15のPodがあります）。

OpenShiftの管理コンソールにアクセスして3scaleのプロジェクトを表示すると、そのステータスを確認できます。図1はすべてのPodがデプロイされ、3scaleの実行環境ができた状態を示しています。

OpenShift管理コンソールURL

https://$(minishift-ip):8443/console/project/3scale/overview

図1：すべてのPodがデプロイされ、3scaleの実行環境ができた状態

インストールが完了したら、さっそく3scaleが正しく動いているかどうか確認していきましょう。以下のURLにアクセスし、3scaleの管理ログイン画面を表示させます。

3scale管理コンソールURL

https://3scale-admin.$(minishift ip).nip.io/

ログインユーザ名は「admin」、パスワードは3scaleのOpenShiftテンプレートをデプロイした時のログに以下のように出力されています。パスワードは自動生成されるので、ログインする時にはその値を使用してください。

ログインすると図2のように、3scaleの仕組みを簡単に紹介するWizard画面が表示されます。

図2：3scaleの仕組みを簡単に紹介するWizard画面

[OK, how does 3scale work?]のボタンをクリックし、まずはWizardに従って3scaleの仕組みを理解していきましょう。基本的な動作としては、APIクライアントが3scaleのAPIゲートウェイに対してリクエストを投げると、3scaleで認証や流量制御が行われ、バックエンドのAPIが呼び出されてレスポンスがAPIクライアントに返されます（図3）。

図3：Wizardに沿って3scaleの仕組みを理解していく

[Got it! Lets add my API]をクリックすると、3scaleをインストールしてすぐに試せるように、サンプルのEcho API（https://echo-api.3scale.net/）を追加できるようになっていますので、Wizardに従ってAPIを追加してみてください（図4）。

図4：Wizardに従ってサンプルのEcho APIを追加

APIの追加が完了すると図5のように3scaleの管理画面が表示され、Echo APIが追加され、呼び出されていることをグラフで確認できます。

図5：追加したEcho APIが追加され、呼び出されていることが確認できる

以上で3scaleの環境を構築できましたので、APIの管理を行っていくことができます。

おわりに

次回は3scaleのコミッターとしても活躍している日立製作所の田畑さんより、3scaleの基本機能や一般的な使い方を紹介します。