Jump To Close Expand all Collapse all Table of contents Deployment Options 1. APIcast Overview Expand section "1. APIcast Overview" Collapse section "1. APIcast Overview" 1.1. Prerequisites 1.2. Deployment options 1.3. Environments 1.4. Configuring the integration settings 1.5. Configuring your service Expand section "1.5. Configuring your service" Collapse section "1.5. Configuring your service" 1.5.1. Configuring the authentication settings 1.6. Mapping rules 1.7. Mapping rules workflow 1.8. Host Header 1.9. Production deployment 1.10. Public Base URL 1.11. Protecting your API backend 1.12. Using APIcast with private APIs 1.13. Configuring APIcast with OpenTracing Expand section "1.13. Configuring APIcast with OpenTracing" Collapse section "1.13. Configuring APIcast with OpenTracing" 1.13.1. Prerequisites 1.13.2. Procedure 1.13.3. Additional information 1.13.4. Installing Jaeger on your OpenShift instance 2. APIcast on the Docker containerized environment Expand section "2. APIcast on the Docker containerized environment" Collapse section "2. APIcast on the Docker containerized environment" 2.1. Prerequisites 2.2. Step 1: Install the Docker containerized environment 2.3. Step 2: Run the Docker containerized environment gateway Expand section "2.3. Step 2: Run the Docker containerized environment gateway" Collapse section "2.3. Step 2: Run the Docker containerized environment gateway" 2.3.1. The Docker command options 2.4. Step 3: Testing APIcast 2.5. Step 4: Troubleshooting APIcast on the Docker containerized environment Expand section "2.5. Step 4: Troubleshooting APIcast on the Docker containerized environment" Collapse section "2.5. Step 4: Troubleshooting APIcast on the Docker containerized environment" 2.5.1. Cannot connect to the Docker daemon error 2.5.2. Basic Docker command-line interface commands 3. Running APIcast on Red Hat OpenShift Expand section "3. Running APIcast on Red Hat OpenShift" Collapse section "3. Running APIcast on Red Hat OpenShift" 3.1. Prerequisites 3.2. Step 1: Set up OpenShift Expand section "3.2. Step 1: Set up OpenShift" Collapse section "3.2. Step 1: Set up OpenShift" 3.2.1. Install the Docker containerized environment 3.2.2. Start OpenShift cluster Expand section "3.2.2. Start OpenShift cluster" Collapse section "3.2.2. Start OpenShift cluster" 3.2.2.1. Setting up OpenShift cluster on a remote server 3.3. Step 2: Deploy APIcast using the OpenShift template 3.4. Step 3: Create routes in OpenShift console 4. Advanced APIcast Configuration Expand section "4. Advanced APIcast Configuration" Collapse section "4. Advanced APIcast Configuration" 4.1. Define a secret token 4.2. Credentials 4.3. Error messages 4.4. Configuration History 4.5. Debugging 4.6. Path routing 5. APIcast Policies Expand section "5. APIcast Policies" Collapse section "5. APIcast Policies" 5.1. APIcast Standard Policies Expand section "5.1. APIcast Standard Policies" Collapse section "5.1. APIcast Standard Policies" 5.1.1. 3scale Auth Caching policy 5.1.2. 3scale Batcher Policy 5.1.3. Anonymous Access Policy 5.1.4. CORS Request Handling Policy 5.1.5. Echo Policy 5.1.6. Edge Limiting Policy Expand section "5.1.6. Edge Limiting Policy" Collapse section "5.1.6. Edge Limiting Policy" 5.1.6.1. Types of limits 5.1.6.2. Limit definition 5.1.6.3. Liquid templating 5.1.6.4. Applying conditions 5.1.6.5. Configuring the store 5.1.6.6. Error handling 5.1.7. Header Modification Policy 5.1.8. IP Check Policy 5.1.9. Liquid Context Debug Policy 5.1.10. Logging Policy 5.1.11. OAuth 2.0 Token Introspection Policy 5.1.12. Referrer Policy 5.1.13. RH-SSO/Keycloak Role Check Policy 5.1.14. Prometheus Metrics 5.1.15. SOAP Policy 5.1.16. Upstream Policy 5.1.17. URL Rewriting Policy Expand section "5.1.17. URL Rewriting Policy" Collapse section "5.1.17. URL Rewriting Policy" 5.1.17.1. Commands for rewriting the path 5.1.17.2. Commands for rewriting the query string 5.1.18. URL Rewriting with Captures Policy 5.2. Enabling a standard policy 5.3. Creating custom APIcast policies 5.4. Adding custom policies to APIcast Expand section "5.4. Adding custom policies to APIcast" Collapse section "5.4. Adding custom policies to APIcast" 5.4.1. Adding custom policies to APIcast built-in 5.4.2. Adding custom policies to APIcast on another OpenShift Container Platform 5.5. Creating a policy chain in the AMP 5.6. Creating a policy chain JSON configuration file 6. Integrating a policy chain with APIcast native deployments Expand section "6. Integrating a policy chain with APIcast native deployments" Collapse section "6. Integrating a policy chain with APIcast native deployments" 6.1. Using variables and filters in policies 7. APIcast Environment Variables Legal Notice 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 Deployment Options Red Hat 3scale API Management 2.4Deploy APIcast API Gateway on OpenShift, natively, or using Docker.Red Hat Customer Content Services Legal NoticeAbstract This guide documents deployment options for Red Hat 3scale API Management 2.4. Next