Jump To Close Expand all Collapse all Table of contents 3scale の操作 多様性を受け入れるオープンソースの強化 1. 3scale の一般的な設定オプション Expand section "1. 3scale の一般的な設定オプション" Collapse section "1. 3scale の一般的な設定オプション" 1.1. 有効なログインセッションの長さの設定 2. 3scale の操作とスケーリング Expand section "2. 3scale の操作とスケーリング" Collapse section "2. 3scale の操作とスケーリング" 2.1. APIcast の再デプロイ 2.2. オンプレミス型 3scale のスケールアップ Expand section "2.2. オンプレミス型 3scale のスケールアップ" Collapse section "2.2. オンプレミス型 3scale のスケールアップ" 2.2.1. 方法 1:永続ボリュームのバックアップおよびスワップ 2.2.2. 方法 2:3scale のバックアップおよび再デプロイ 2.2.3. パフォーマンスのスケールアップ 2.2.4. オンプレミス型 3scale デプロイメントの設定 Expand section "2.2.4. オンプレミス型 3scale デプロイメントの設定" Collapse section "2.2.4. オンプレミス型 3scale デプロイメントの設定" 2.2.4.1. OCP コマンドラインインターフェイスを使用したスケーリング 2.2.4.2. ハードウェアの垂直スケーリングと水平スケーリング 2.2.4.3. ルーターのスケールアップ 2.3. 操作のトラブルシューティング Expand section "2.3. 操作のトラブルシューティング" Collapse section "2.3. 操作のトラブルシューティング" 2.3.1. OpenShift での 3scale 監査ロギングの設定 2.3.2. 監査ロギングの有効化 2.3.3. EFK ロギングの設定 2.3.4. ログへのアクセス 2.3.5. ジョブキューの確認 2.3.6. 単調増加の防止 3. 3scale のモニターリング Expand section "3. 3scale のモニターリング" Collapse section "3. 3scale のモニターリング" 3.1. 3scale のモニターリングの有効化 3.2. 3scale を監視するための Prometheus の設定 3.3. 3scale を監視するための Grafana の設定 3.4. 3scale のメトリクスの表示 3.5. Prometheus に公開される 3scale システムメトリクス 4. Webhook を使用した 3scale 自動化 Expand section "4. Webhook を使用した 3scale 自動化" Collapse section "4. Webhook を使用した 3scale 自動化" 4.1. Webhook の概要 4.2. Webhook の設定 4.3. Webhook のトラブルシューティング 5. 3scale toolbox Expand section "5. 3scale toolbox" Collapse section "5. 3scale toolbox" 5.1. toolbox のインストール Expand section "5.1. toolbox のインストール" Collapse section "5.1. toolbox のインストール" 5.1.1. toolbox コンテナーイメージのインストール 5.2. サポートされる toolbox コマンド 5.3. サービスのインポート 5.4. サービスのコピー 5.5. サービス設定のみのコピー 5.6. OpenAPI 定義のインポート 5.7. OpenAPI 定義からの 3scale バックエンドのインポート 5.8. リモートアクセスクレデンシャルの管理 Expand section "5.8. リモートアクセスクレデンシャルの管理" Collapse section "5.8. リモートアクセスクレデンシャルの管理" 5.8.1. リモートアクセスクレデンシャルの追加 5.8.2. リモートアクセスクレデンシャルの一覧表示 5.8.3. リモートアクセスクレデンシャルの削除 5.8.4. リモートアクセスクレデンシャルの名前変更 5.9. アプリケーションプランの作成 Expand section "5.9. アプリケーションプランの作成" Collapse section "5.9. アプリケーションプランの作成" 5.9.1. 新しいアプリケーションプランの作成 5.9.2. アプリケーションプランの作成または更新 5.9.3. アプリケーションプランの一覧表示 5.9.4. アプリケーションプランの表示 5.9.5. アプリケーションプランの削除 5.9.6. アプリケーションプランのエクスポート/インポート Expand section "5.9.6. アプリケーションプランのエクスポート/インポート" Collapse section "5.9.6. アプリケーションプランのエクスポート/インポート" 5.9.6.1. ファイルへのアプリケーションプランのエクスポート 5.9.6.2. ファイルからのアプリケーションプランのインポート 5.9.6.3. URL からのアプリケーションプランのインポート 5.10. メトリクスの作成 Expand section "5.10. メトリクスの作成" Collapse section "5.10. メトリクスの作成" 5.10.1. メトリクスの作成または更新 5.10.2. メトリクスの一覧表示 5.10.3. メトリクスの削除 5.11. メソッドの作成 Expand section "5.11. メソッドの作成" Collapse section "5.11. メソッドの作成" 5.11.1. メソッドの作成 5.11.2. メソッドの作成または更新 5.11.3. メソッドの一覧表示 5.11.4. メソッドの削除 5.12. サービスの作成 Expand section "5.12. サービスの作成" Collapse section "5.12. サービスの作成" 5.12.1. 新しいサービスの作成 5.12.2. サービスの作成または更新 5.12.3. サービスの一覧表示 5.12.4. サービスの表示 5.12.5. サービスの削除 5.13. ActiveDocs の作成 Expand section "5.13. ActiveDocs の作成" Collapse section "5.13. ActiveDocs の作成" 5.13.1. 新しい ActiveDocs の作成 5.13.2. ActiveDocs の作成または更新 5.13.3. ActiveDocs の一覧表示 5.13.4. ActiveDocs の削除 5.14. プロキシー設定の一覧表示 Expand section "5.14. プロキシー設定の一覧表示" Collapse section "5.14. プロキシー設定の一覧表示" 5.14.1. プロキシー設定の表示 5.14.2. プロキシー設定のプロモート 5.14.3. プロキシー設定のエクスポート 5.14.4. プロキシー設定のデプロイ 5.14.5. プロキシー設定の更新 5.14.6. プロキシー設定の表示 5.14.7. プロキシー設定のデプロイ (非推奨) 5.15. ポリシーレジストリーのコピー 5.16. アプリケーションの一覧表示 Expand section "5.16. アプリケーションの一覧表示" Collapse section "5.16. アプリケーションの一覧表示" 5.16.1. アプリケーションの作成 5.16.2. アプリケーションの表示 5.16.3. アプリケーションの作成または更新 5.16.4. アプリケーションの削除 5.17. プロダクトのエクスポート 5.18. プロダクトのインポート 5.19. プロダクトポリシーチェーンのエクスポートおよびインポート 5.20. API バックエンドのコピー 5.21. API プロダクトのコピー 5.22. SSL および TLS に関する問題のトラブルシューティング 6. 3scale での API 環境のマッピング Expand section "6. 3scale での API 環境のマッピング" Collapse section "6. 3scale での API 環境のマッピング" 6.1. 環境ごとのプロダクト 6.2. オンプレミス型 3scale インスタンス Expand section "6.2. オンプレミス型 3scale インスタンス" Collapse section "6.2. オンプレミス型 3scale インスタンス" 6.2.1. 環境ごとの 3scale インスタンスの分離 6.2.2. 環境ごとの 3scale テナントの分離 6.3. 3scale の混合アプローチ 6.4. 3scale と APIcast ゲートウェイの組み合わせ Expand section "6.4. 3scale と APIcast ゲートウェイの組み合わせ" Collapse section "6.4. 3scale と APIcast ゲートウェイの組み合わせ" 6.4.1. APIcast の組み込みデフォルトゲートウェイ 6.4.2. 追加の APIcast ゲートウェイ 7. Automating API lifecycle with 3scale toolbox Expand section "7. Automating API lifecycle with 3scale toolbox" Collapse section "7. Automating API lifecycle with 3scale toolbox" 7.1. API ライフサイクルステージの概要 Expand section "7.1. API ライフサイクルステージの概要" Collapse section "7.1. API ライフサイクルステージの概要" 7.1.1. API プロバイダーサイクル 7.1.2. API 利用者サイクル 7.2. サンプル Jenkins CI/CD パイプラインのデプロイ Expand section "7.2. サンプル Jenkins CI/CD パイプラインのデプロイ" Collapse section "7.2. サンプル Jenkins CI/CD パイプラインのデプロイ" 7.2.1. サンプル Jenkins CI/CD パイプライン 7.2.2. ホスト型 3scale 環境の設定 7.2.3. オンプレミス型 3scale 環境の設定 7.2.4. OpenID Connect 向け Red Hat Single Sign-On のデプロイ 7.2.5. 3scale toolbox のインストールおよびアクセスの有効化 7.2.6. API バックエンドのデプロイ 7.2.7. Self-managed APIcast インスタンスのデプロイ 7.2.8. サンプルパイプラインのインストールとデプロイ 7.2.9. 3scale toolbox を使用した API ライフサイクル自動化の制約 7.3. 3scale Jenkins 共有ライブラリーを使用したパイプラインの作成 7.4. Jenkinsfile を使用したパイプラインの作成 8. 3scale Operator を使用した 3scale の設定とプロビジョニング Expand section "8. 3scale Operator を使用した 3scale の設定とプロビジョニング" Collapse section "8. 3scale Operator を使用した 3scale の設定とプロビジョニング" 8.1. 一般的な前提条件 8.2. 3scale operator を使用したアプリケーション capabilities 8.3. 最初の 3scale プロダクトおよびバックエンドのデプロイ 8.4. 製品の APIcast 設定のプロモート 8.5. 3scale Operator が、カスタムリソースのリンク先となるテナントを識別する方法 8.6. 3scale OpenAPI カスタムリソースのデプロイ Expand section "8.6. 3scale OpenAPI カスタムリソースのデプロイ" Collapse section "8.6. 3scale OpenAPI カスタムリソースのデプロイ" 8.6.1. シークレットから OAS ドキュメントをインポートする 3scale OpenAPI カスタムリソースのデプロイ 8.6.2. 3scale OpenAPI カスタムリソース定義の機能 8.6.3. OpenAPI カスタムリソースを定義する際のインポートルール 8.6.4. URL から OAS ドキュメントをインポートする 3scale OpenAPI カスタムリソースのデプロイ 8.6.5. 関連情報 8.7. 3scale ActiveDoc カスタムリソースのデプロイ Expand section "8.7. 3scale ActiveDoc カスタムリソースのデプロイ" Collapse section "8.7. 3scale ActiveDoc カスタムリソースのデプロイ" 8.7.1. シークレットから OAS ドキュメントをインポートする 3scale ActiveDoc カスタムリソースのデプロイ 8.7.2. 3scale ActiveDoc カスタムリソース定義の機能 8.7.3. シークレットから OAS ドキュメントをインポートする 3scale OpenAPI カスタムリソースのデプロイ 8.7.4. 関連情報 8.8. capabilities に関連するバックエンドカスタムリソース Expand section "8.8. capabilities に関連するバックエンドカスタムリソース" Collapse section "8.8. capabilities に関連するバックエンドカスタムリソース" 8.8.1. capabilities に関連するバックエンドカスタムリソースのデプロイ 8.8.2. バックエンドメトリクスの定義 8.8.3. バックエンドメソッドの定義 8.8.4. バックエンドマッピングルールの定義 8.8.5. バックエンドカスタムリソースのステータス 8.8.6. テナントアカウントにリンクされたバックエンドカスタムリソース 8.8.7. バックエンドカスタムリソースの削除 8.9. capabilities に関連するプロダクトカスタムリソース Expand section "8.9. capabilities に関連するプロダクトカスタムリソース" Collapse section "8.9. capabilities に関連するプロダクトカスタムリソース" 8.9.1. capabilities に関連するプロダクトカスタムリソースのデプロイ Expand section "8.9.1. capabilities に関連するプロダクトカスタムリソースのデプロイ" Collapse section "8.9.1. capabilities に関連するプロダクトカスタムリソースのデプロイ" 8.9.1.1. 基本的なプロダクトカスタムリソースのデプロイ 8.9.1.2. Hosted APIcast を使用するプロダクトのデプロイ 8.9.1.3. Self-managed APIcast を使用するプロダクトのデプロイ 8.9.2. プロダクトのアプリケーションプランの定義 8.9.3. プロダクトアプリケーションプランの制限の定義 8.9.4. プロダクトアプリケーションプランの課金ルールの定義 8.9.5. OpenID Connect を使用したプロダクト認証の定義 8.9.6. プロダクトメトリクスの定義 8.9.7. プロダクトメソッドの定義 8.9.8. プロダクトマッピングルールの定義 8.9.9. プロダクトバックエンドの使用状況の定義 8.9.10. 3scale プロダクトカスタムリソースでのゲートウェイ応答の設定 8.9.11. 3scale プロダクトカスタムリソースでのポリシーチェーンの設定 8.9.12. プロダクトカスタムリソースのステータス 8.9.13. テナントアカウントにリンクされたプロダクトカスタムリソース 8.9.14. Product カスタムリソースの削除 8.10. 3scale CustomPolicyDefinition カスタムリソースのデプロイ 8.11. カスタムリソースのデプロイによる 3scale 開発者の管理 Expand section "8.11. カスタムリソースのデプロイによる 3scale 開発者の管理" Collapse section "8.11. カスタムリソースのデプロイによる 3scale 開発者の管理" 8.11.1. 前提条件 8.11.2. DeveloperAccount カスタムリソースのデプロイによる 3scale の開発者アカウントの管理 8.11.3. DeveloperUser カスタムリソースのデプロイによる 3scale 開発者ユーザーの管理 8.11.4. DeveloperAccount または DeveloperUser カスタムリソースの削除 8.12. 3scale Operator の機能の制限 8.13. 関連情報 9. 3scale のバックアップと復元 Expand section "9. 3scale のバックアップと復元" Collapse section "9. 3scale のバックアップと復元" 9.1. operator を使用した 3scale のバックアップ Expand section "9.1. operator を使用した 3scale のバックアップ" Collapse section "9.1. operator を使用した 3scale のバックアップ" 9.1.1. バックアップの可能なシナリオ 9.1.2. バックアップシナリオのスコープ 9.1.3. バックアップされるデータ 9.1.4. 3scale のバックアップ 9.1.5. 3scale カスタムリソースのバックアップ 9.2. operator を使用した 3scale の復元 Expand section "9.2. operator を使用した 3scale の復元" Collapse section "9.2. operator を使用した 3scale の復元" 9.2.1. 復元の可能なシナリオ 9.2.2. 復元シナリオのスコープ 9.2.3. 復元されるデータ 9.2.4. 3scale の復元 10. 3scale 用 reCAPTCHA の設定 Expand section "10. 3scale 用 reCAPTCHA の設定" Collapse section "10. 3scale 用 reCAPTCHA の設定" 10.1. 3scale のスパム保護用 reCAPTCHA の設定 11. API インフラストラクチャーに関するトラブルシューティング Expand section "11. API インフラストラクチャーに関するトラブルシューティング" Collapse section "11. API インフラストラクチャーに関するトラブルシューティング" 11.1. インテグレーションに関する典型的な問題 Expand section "11.1. インテグレーションに関する典型的な問題" Collapse section "11.1. インテグレーションに関する典型的な問題" 11.1.1. インテグレーションの問題 Expand section "11.1.1. インテグレーションの問題" Collapse section "11.1.1. インテグレーションの問題" 11.1.1.1. Hosted APIcast 11.1.1.2. Self-managed APIcast 11.1.2. 実稼働環境の問題 Expand section "11.1.2. 実稼働環境の問題" Collapse section "11.1.2. 実稼働環境の問題" 11.1.2.1. 可用性の問題 11.1.3. デプロイ後の問題 11.2. API インフラストラクチャーに関する問題への対応 Expand section "11.2. API インフラストラクチャーに関する問題への対応" Collapse section "11.2. API インフラストラクチャーに関する問題への対応" 11.2.1. 接続の可否確認 11.2.2. サーバー接続の問題 11.2.3. DNS での問題の有無確認 11.2.4. SSL での問題の有無確認 11.3. API へのリクエストに関する問題の特定 Expand section "11.3. API へのリクエストに関する問題の特定" Collapse section "11.3. API へのリクエストに関する問題の特定" 11.3.1. API 11.3.2. API ゲートウェイ > API 11.3.3. API ゲートウェイ Expand section "11.3.3. API ゲートウェイ" Collapse section "11.3.3. API ゲートウェイ" 11.3.3.1. API ゲートウェイの起動および稼働確認 11.3.3.2. ゲートウェイログでのエラーの有無確認 11.3.4. API ゲートウェイ > 3scale Expand section "11.3.4. API ゲートウェイ > 3scale" Collapse section "11.3.4. API ゲートウェイ > 3scale" 11.3.4.1. API ゲートウェイでの 3scale へのアクセスの可否確認 11.3.4.2. API ゲートウェイが 3scale のアドレスを正しく解決していることの確認 11.3.4.3. API ゲートウェイが 3scale を正しく呼び出していることの確認 11.3.5. 3scale Expand section "11.3.5. 3scale" Collapse section "11.3.5. 3scale" 11.3.5.1. 3scale が利用可能か確かめる 11.3.5.2. 3scale がエラーを返しているか調べる 11.3.5.3. 3scale デバッグヘッダーの使用 11.3.5.4. インテグレーションエラーの確認 11.3.6. クライアント API ゲートウェイ Expand section "11.3.6. クライアント API ゲートウェイ" Collapse section "11.3.6. クライアント API ゲートウェイ" 11.3.6.1. 一般のインターネットから API ゲートウェイにアクセスできるか調べる 11.3.6.2. クライアントから API ゲートウェイにアクセスできるかの確認 11.3.7. クライアント Expand section "11.3.7. クライアント" Collapse section "11.3.7. クライアント" 11.3.7.1. 別のクライアントを使用した同じ呼び出しのテスト 11.3.7.2. クライアントから送信されたトラフィックの確認 11.4. ActiveDocs の問題 Expand section "11.4. ActiveDocs の問題" Collapse section "11.4. ActiveDocs の問題" 11.4.1. petstore.swagger.io の使用 11.4.2. ファイアウォールが ActiveDocs プロキシーからの接続を許可していることの確認 11.4.3. 無効なクレデンシャルを使用した API の呼び出し 11.4.4. 呼び出しの比較 11.5. NGINX でのロギング Expand section "11.5. NGINX でのロギング" Collapse section "11.5. NGINX でのロギング" 11.5.1. デバッグログの有効化 11.6. 3scale のエラーコード Settings Close Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF 3scale の操作 Red Hat 3Scale 2-saasデプロイメントの自動化、環境のスケーリング、および問題のトラブルシューティングを行う方法概要 本書では、Red Hat 3scale 2-saas のデプロイメント操作について説明します。 Next