第3章 3scale API Management モニタリングの有効化

手順

1. OperatorHub から Grafana 4 コミュニティー Operator をインストールします。

   • OpenShift 管理者の認証情報を使用して、OpenShift Container Platform (OCP) にログインします。

   • Grafana コミュニティー Operator をインストールするプロジェクトを Project リストから選択します。

     重要

     3scale Operator をインストールしたのと同じプロジェクトに Grafana コミュニティー Operator をインストールします。

   • Operators > OperatorHub に移動します。
   • "grafana" を検索し、Grafana Operator をクリックします。

   • Grafana Community Operator ページで Install をクリックします。Create Operator Subscription ページが表示されます。Grafana Operator のサブスクリプションを作成するには、次の手順を実行します。

     1. A specific namespace on the cluster をクリックし、Grafana コミュニティー Operator をインストールするプロジェクトを選択します。
     2. Subscribe をクリックします。
     3. Approve をクリックします。

2. OperatorHub から最新の Prometheus コミュニティー Operator をインストールします。

   • OpenShift 管理者の認証情報を使用して、OpenShift Container Platform (OCP) にログインします。

   • Prometheus コミュニティー Operator をインストールするプロジェクトを Project リストから選択します。

     重要

     3scale Operator をインストールしたのと同じプロジェクトに Prometheus コミュニティー Operator をインストールします。

   • Operators > OperatorHub に移動します。
   • "prometheus" を検索し、Prometheus Operator をクリックします。

   • Prometheus Community Operator ページで Install をクリックします。Create Operator Subscription ページが表示されます。Prometheus Operator のサブスクリプションを作成するには、次の手順を実行します。

     1. A specific namespace on the cluster をクリックし、Prometheus Operator をインストールするプロジェクトを選択します。
     2. Subscribe をクリックします。
     3. Approve をクリックします。

3. 3scale デプロイメント YAML の spec.monitoring.enabled パラメーターを true に設定して、モニタリングを有効にします。以下に例を示します。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata: ...
   spec:
     monitoring:
       enabled: true
     ...

   Copy to Clipboard Toggle word wrap

   1. OpenShift クラスターにログインします。3scale の OpenShift プロジェクトのクラスター 編集 ロールを持つユーザーとしてログインする必要があります (例: cluster-admin)。

      $ oc login

      Copy to Clipboard Toggle word wrap

   2. 3scale プロジェクトに切り替えます。

      $ oc project <project_name>

      Copy to Clipboard Toggle word wrap

4. Prometheus の新しいサービスアカウントを作成します。

   $ oc create serviceaccount prometheus-monitoring

   Copy to Clipboard Toggle word wrap

5. ClusterRoleBinding を作成して、メトリクスをスクレイピングするために必要なロールベースのアクセス制御 (RBAC) 権限を Prometheus ServiceAccount に付与します。ClusterRoleBinding を作成する前に、ServiceAccount namespace を更新します。

   $ oc adm policy add-cluster-role-to-user cluster-monitoring-view -z prometheus-monitoring -n "<3scale_namespace>

   Copy to Clipboard Toggle word wrap

6. prometheus-monitoring ServiceAccount のトークンを作成します。

   $ oc create token prometheus-monitoring

   Copy to Clipboard Toggle word wrap

   このトークンの有効期限が切れると、Prometheus は必要なリソースにアクセスできなくなります。トークンの有効期間を指定するには、--duration X[s|m|h] を追加します。

7. 生成したトークンを使用して、ファイル 3scale-scrape-configs.yaml の bearer_token フィールドを更新します。

8. additional-scrape-config シークレットを作成します。

   $ oc create secret generic additional-scrape-configs --from-file=3scale-scrape-configs.yaml=./3scale-scrape-configs.yaml

   Copy to Clipboard Toggle word wrap

9. Prometheus をデプロイします。

   • Prometheus.yaml ファイルで、spec.externalUrl フィールドに外部 URL を入力します。URL テンプレートは次のようになります。

     spec:
       ...
       externalUrl: https://prometheus.<namespace-name>.apps.<cluster-domain>

     Copy to Clipboard Toggle word wrap

10. Prometheus サーバーをデプロイします。

    $ oc apply -f prometheus.yaml

    Copy to Clipboard Toggle word wrap

11. Prometheus ルートを作成します。

    $ oc expose service prometheus-operated --hostname prometheus.<namespace-name>.apps.<cluster-name>

    Copy to Clipboard Toggle word wrap

12. Grafana データソースをデプロイします。

    $ oc apply -f datasource-v4.yaml

    Copy to Clipboard Toggle word wrap

13. Grafana のデプロイメント

    $ oc apply -f grafana-v4.yaml

    Copy to Clipboard Toggle word wrap