4.3. カスタム 3scale APIcast ポリシー

手順

1. Creating a registry service accountで作成したクレデンシャルを使用して、docker-registry シークレットを作成します。その際に、以下の点に留意してください。

   • your-registry-service-account-username を 12345678|username のフォーマットで作成したユーザー名に置き換えてください。
   • your-registry-service-account-password を Token Information タブでユーザー名の下に表示されるパスワードの文字列に置き換えてください。

   • イメージストリームが存在し registry.redhat.io を使用するすべての新規 namespace について、docker-registry シークレットを作成します。

     以下のコマンドを実行して docker-registry シークレットを作成します。

     oc create secret docker-registry threescale-registry-auth \
       --docker-server=registry.redhat.io \
       --docker-username="your-registry-service-account-username" \
       --docker-password="your-registry-service-account-password"

     Copy to Clipboard Toggle word wrap
2. ポリシーの例が含まれる公開リポジトリー をフォークするか、そのコンテンツが含まれるプライベートリポジトリーを作成します。OpenShift がイメージをビルドするには、Git リポジトリーでカスタムポリシーのコードが必要です。プライベート Git リポジトリーを使用するには、OpenShift でシークレットを設定する必要がある点に注意してください。
3. リポジトリーをローカルにクローンし、ポリシーの実装を追加し、変更をご自分の Git リポジトリーにプッシュします。

4. openshift.yml テンプレートを更新します。具体的には、以下のパラメーターを変更します。

   1. spec.source.git.uri: https://github.com/3scale/apicast-example-policy.git (ポリシーの BuildConfig): ご自分の Git リポジトリーの場所に変更します。
   2. spec.source.images[0].paths.sourcePath: /opt/app-root/policies/example (カスタムポリシーの BuildConfig): example をリポジトリーの policies ディレクトリーに追加したカスタムポリシーの名前に変更します。
   3. オプションで、OpenShift オブジェクト名およびイメージタグを更新します。ただし、変更の一貫性が維持されるようにする必要があります。例: apicast-example-policy BuildConfig が apicast-policy:example イメージをビルドおよびプッシュし、それを apicast-custom-policies BuildConfig がソースとして使用する。これによりダグの一貫性が維持されます。

5. 以下のコマンドを実行して OpenShift オブジェクトを作成します。

   oc new-app -f openshift.yml --param AMP_RELEASE=2.13

   Copy to Clipboard Toggle word wrap

6. ビルドが自動的に開始されない場合には、以下の 2 つのコマンドを実行します。apicast-example-policy を変更している場合には、ご自分の BuildConfig 名に置き換えます (例: apicast-<name>-policy)。最初のコマンドが完了するのを待ってから、2 番目のコマンドを実行してください。

   oc start-build apicast-example-policy
   oc start-build apicast-custom-policies

   Copy to Clipboard Toggle word wrap

   Embedded APIcast のイメージに amp-apicast:latest イメージストリームの変更を追跡するトリガーがある場合には、APIcast の新しいデプロイメントが開始されます。apicast-staging が再開されたら Integration > Policies の順に移動し、Add Policy ボタンをクリックしてご自分のカスタムポリシーがリストに表示されるのを確認します。カスタムポリシーを選択して設定したら、Update Policy Chain をクリックし、カスタムポリシーをステージング APIcast で動作状態にします。

手順

1. Embedded APIcast にポリシーを追加します。
2. APIcast ゲートウェイをメインの OpenShift クラスターにデプロイしていない場合には、メインの OpenShift クラスター上の内部レジストリーへの アクセスを確立します。
3. 3scale 2.13 APIcast OpenShift テンプレートを ダウンロードします。

4. テンプレートを変更するには、デフォルトの image ディレクトリーを内部レジストリーの完全なイメージ名に置き換えます。

   image: <registry>/<project>/amp-apicast:latest

   Copy to Clipboard Toggle word wrap

5. カスタマイズしたイメージを指定し、OpenShift テンプレートを使用して APIcast をデプロイします。

   oc new-app -f customizedApicast.yml

   Copy to Clipboard Toggle word wrap

手順

1. カスタムポリシーが含まれるディレクトリーに、外部 Lua ライブラリーを識別するファイルを追加します。

   ファイルの名前は Roverfile である必要があります。JSON to XML カスタムポリシーの例では、Roverfile の内容は以下のようになります。

   luarocks {
   	group 'production' {
   		module { 'xml2lua' },
   	}
   }

   Copy to Clipboard Toggle word wrap

   lua-rover は、LuaRocks に関するラッパーです。lua-rover は、依存関係の推移ロックを提供します。LuaRocks は、Lua モジュールのパッケージマネージャーです。

2. カスタムポリシーが含まれるディレクトリーに、lua-rover ロックファイルを追加します。

   ファイルの名前は Roverfile.lock である必要があります。JSON to XML カスタムポリシーの例では、Roverfile.lock の内容は以下のようになります。

   xml2lua 1.5-2||productionbash-4.4

   Copy to Clipboard Toggle word wrap

   Roverfile および Roverfile.lock を併用することで、APIcast または 3scale operator が依存関係ライブラリーをフェッチできます。

3. カスタムポリシーを定義するファイルで、Lua 依存関係を指定する行を追加します。JSON to XML カスタムポリシーの例では、以下の行を指定します。

   local xml2lua = require("xml2lua")

   Copy to Clipboard Toggle word wrap

4. カスタムポリシーの構築に使用する Dockerfile で、Roverfile および Roverfile.lock をコピーし、rover install を実行します。JSON to XML カスタムポリシーの例では、以下の行を Dockerfile に追加します。

   COPY Roverfile .
   COPY Roverfile.lock .
   
   RUN rover install --roverfile=/opt/app-root/src/Roverfile

   Copy to Clipboard Toggle word wrap

   Dockerfile は、APIcast または 3scale operator を使用してポリシーをビルドすることができます。

5. カスタムポリシーの Makefile で、他のカスタムポリシーと同様に build ターゲットを指定します。

   たとえば、build ターゲットは以下のようになります。

   TARGET_IMAGE="apicast/json_to_xml:latest"
   # IP="http://localhost:8080"
   
   build:
   	docker build . --build-arg IMAGE=registry.redhat.io/3scale-amp2/apicast-gateway-rhel8:3scale2.13 -t $(TARGET_IMAGE)

   Copy to Clipboard Toggle word wrap