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. API configuration 1.5. Configure the integration settings 1.6. Configure your service 1.7. Mapping rules 1.8. Mapping rules workflow 1.9. Host Header 1.10. Production deployment 1.11. Public Base URL 1.12. Protecting your API backend 1.13. Using APIcast with private APIs 2. APIcast Hosted Expand section "2. APIcast Hosted" Collapse section "2. APIcast Hosted" 2.1. Prerequisites 2.2. Step 1: Deploy your API with APIcast hosted in a staging environment 2.3. Step 2: Deploy your API with the APIcast hosted into production Expand section "2.3. Step 2: Deploy your API with the APIcast hosted into production" Collapse section "2.3. Step 2: Deploy your API with the APIcast hosted into production" 2.3.1. Bear in mind 3. APIcast Self-Managed Expand section "3. APIcast Self-Managed" Collapse section "3. APIcast Self-Managed" 3.1. Prerequisites 3.2. Step 1: Install OpenResty and dependencies 3.3. Step 2: Deploy and run APIcast 4. APIcast on the Docker containerized environment Expand section "4. APIcast on the Docker containerized environment" Collapse section "4. APIcast on the Docker containerized environment" 4.1. Prerequisites 4.2. Step 1: Install the Docker containerized environment 4.3. Step 2: Run the Docker containerized environment gateway Expand section "4.3. Step 2: Run the Docker containerized environment gateway" Collapse section "4.3. Step 2: Run the Docker containerized environment gateway" 4.3.1. The Docker command options 4.4. Step 3: Testing APIcast 4.5. Step 4: Troubleshooting APIcast on the Docker containerized environment Expand section "4.5. Step 4: Troubleshooting APIcast on the Docker containerized environment" Collapse section "4.5. Step 4: Troubleshooting APIcast on the Docker containerized environment" 4.5.1. Cannot connect to the Docker daemon error 4.5.2. Basic Docker command-line interface commands 4.6. Step 5: Customising the Gateway Expand section "4.6. Step 5: Customising the Gateway" Collapse section "4.6. Step 5: Customising the Gateway" 4.6.1. Custom Lua logic 4.6.2. Customising the configuration files 5. Running APIcast on Red Hat OpenShift Expand section "5. Running APIcast on Red Hat OpenShift" Collapse section "5. Running APIcast on Red Hat OpenShift" 5.1. Prerequisites 5.2. Step 1: Set up OpenShift Expand section "5.2. Step 1: Set up OpenShift" Collapse section "5.2. Step 1: Set up OpenShift" 5.2.1. Install the Docker containerized environment 5.2.2. Start OpenShift cluster 5.3. Step 2: Deploy APIcast using the OpenShift template 5.4. Step 3: Create routes in OpenShift console Expand section "5.4. Step 3: Create routes in OpenShift console" Collapse section "5.4. Step 3: Create routes in OpenShift console" 5.4.1. Configure wildcard domains (technical preview) 6. Advanced APIcast Configuration Expand section "6. Advanced APIcast Configuration" Collapse section "6. Advanced APIcast Configuration" 6.1. Define a secret token 6.2. Credentials 6.3. Error messages 6.4. Configuration History 6.5. Debugging 6.6. Extending the gateway 7. APIcast and OAuth 2.0 Expand section "7. APIcast and OAuth 2.0" Collapse section "7. APIcast and OAuth 2.0" 7.1. Prerequisites 7.2. APIcast Configuration in 3scale Admin Portal 7.3. Running APIcast with OAuth 7.4. Testing the Flow Expand section "7.4. Testing the Flow" Collapse section "7.4. Testing the Flow" 7.4.1. Requesting an Authorization Code 7.4.2. Exchanging the Authorization Code for an Access Token 8. Code Libraries Expand section "8. Code Libraries" Collapse section "8. Code Libraries" 8.1. Python 8.2. Ruby gem 8.3. Perl 8.4. PHP 8.5. Java 8.6. .NET 8.7. Node.js 9. Plugin Setup Expand section "9. Plugin Setup" Collapse section "9. Plugin Setup" 9.1. How plugins work 9.2. Step 1: Select your language and download the plugin 9.3. Step 2: Check the metrics you’ve set for your API 9.4. Step 3: Install the plugin code to your application 9.5. Step 4: Add calls to authorize as API traffic arrives Expand section "9.5. Step 4: Add calls to authorize as API traffic arrives" Collapse section "9.5. Step 4: Add calls to authorize as API traffic arrives" 9.5.1. Usage on authrep mode 9.6. Step 5: Deploy and run traffic Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Deployment Options Red Hat 3Scale 2.0For Use with Red Hat 3Scale 2.0Red Hat Customer Content Services Legal NoticeAbstract This guide documents deployment options for Red Hat 3Scale 2.0. Next