Deployment Options
1. APIcast Overview
Expand section "1. APIcast Overview" Collapse section "1. APIcast Overview"
1. 1.1. Prerequisites
2. 1.2. Deployment options
3. 1.3. Environments
4. 1.4. Configuring the integration settings
5. 1.5. Configuring your service
  Expand section "1.5. Configuring your service" Collapse section "1.5. Configuring your service"
  1. 1.5.1. Configuring the authentication settings
6. 1.6. Mapping rules
7. 1.7. Mapping rules workflow
8. 1.8. Host Header
9. 1.9. Production deployment
10. 1.10. Public Base URL
11. 1.11. Protecting your API backend
12. 1.12. Using APIcast with private APIs
13. 1.13. Configuring APIcast with OpenTracing
  Expand section "1.13. Configuring APIcast with OpenTracing" Collapse section "1.13. Configuring APIcast with OpenTracing"
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"
1. 2.1. Prerequisites
2. 2.2. Step 1: Install the Docker containerized environment
3. 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"
  1. 2.3.1. The Docker command options
4. 2.4. Step 3: Testing APIcast
5. 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"
  1. 2.5.1. Cannot connect to the Docker daemon error
  2. 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"
1. 3.1. Prerequisites
2. 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"
  1. 3.2.1. Install the Docker containerized environment
  2. 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.3. Step 2: Deploy APIcast using the OpenShift template
4. 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"
5. APIcast Policies
Expand section "5. APIcast Policies" Collapse section "5. APIcast Policies"
1. 5.1. APIcast Standard Policies
  Expand section "5.1. APIcast Standard Policies" Collapse section "5.1. APIcast Standard Policies"
  1. 5.1.1. 3scale Auth Caching policy
  2. 5.1.2. 3scale Batcher Policy
  3. 5.1.3. Anonymous Access Policy
  4. 5.1.4. CORS Request Handling Policy
  5. 5.1.5. Echo Policy
  6. 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
  7. 5.1.7. Header Modification Policy
  8. 5.1.8. IP Check Policy
  9. 5.1.9. Liquid Context Debug Policy
  10. 5.1.10. Logging Policy
  11. 5.1.11. OAuth 2.0 Token Introspection Policy
  12. 5.1.12. Referrer Policy
  13. 5.1.13. RH-SSO/Keycloak Role Check Policy
  14. 5.1.14. Prometheus Metrics
  15. 5.1.15. SOAP Policy
  16. 5.1.16. Upstream Policy
  17. 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
  18. 5.1.18. URL Rewriting with Captures Policy
2. 5.2. Enabling a standard policy
3. 5.3. Creating custom APIcast policies
4. 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"
  1. 5.4.1. Adding custom policies to APIcast built-in
  2. 5.4.2. Adding custom policies to APIcast on another OpenShift Container Platform
5. 5.5. Creating a policy chain in the AMP
6. 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"
1. 6.1. Using variables and filters in policies
7. APIcast Environment Variables
Legal Notice

Deployment Options

Red Hat 3scale API Management 2.4

Deploy APIcast API Gateway on OpenShift, natively, or using Docker.

Red Hat Customer Content Services

Legal Notice

Abstract

This guide documents deployment options for Red Hat 3scale API Management 2.4.

Select Your Language

Infrastructure and Management

Cloud Computing

Storage

Runtimes

Integration and Automation

Deployment Options

Deploy APIcast API Gateway on OpenShift, natively, or using Docker.