Jump To Close Expand all Collapse all Table of contents Installing 3scale Preface Making open source more inclusive 1. Registry service accounts for 3scale Expand section "1. Registry service accounts for 3scale" Collapse section "1. Registry service accounts for 3scale" 1.1. Creating a registry service account 1.2. Configuring container registry authentication 1.3. Modifying a registry service account 1.4. Additional resources 2. Installing 3scale on OpenShift Expand section "2. Installing 3scale on OpenShift" Collapse section "2. Installing 3scale on OpenShift" 2.1. System requirements for installing 3scale on OpenShift Expand section "2.1. System requirements for installing 3scale on OpenShift" Collapse section "2.1. System requirements for installing 3scale on OpenShift" 2.1.1. Environment requirements 2.1.2. Hardware requirements 2.2. Installing the 3scale Operator on OpenShift Expand section "2.2. Installing the 3scale Operator on OpenShift" Collapse section "2.2. Installing the 3scale Operator on OpenShift" 2.2.1. Creating a new OpenShift project 2.2.2. Installing and configuring the 3scale operator using the OLM Expand section "2.2.2. Installing and configuring the 3scale operator using the OLM" Collapse section "2.2.2. Installing and configuring the 3scale operator using the OLM" 2.2.2.1. Restrictions in disconnected environments 2.2.3. Upgrading the 3scale operator using the OLM Expand section "2.2.3. Upgrading the 3scale operator using the OLM" Collapse section "2.2.3. Upgrading the 3scale operator using the OLM" 2.2.3.1. Configuring automated application of micro releases 2.3. Installing the APIcast operator on OpenShift 2.4. Deploying 3scale using the operator Expand section "2.4. Deploying 3scale using the operator" Collapse section "2.4. Deploying 3scale using the operator" 2.4.1. Deploying the APIManager custom resource 2.4.2. Getting the Admin Portal URL 2.4.3. Getting the APIManager Admin Portal and Master Admin Portal credentials 2.4.4. External databases for 3scale using the operator 2.5. Deployment configuration options for 3scale on OpenShift using the operator Expand section "2.5. Deployment configuration options for 3scale on OpenShift using the operator" Collapse section "2.5. Deployment configuration options for 3scale on OpenShift using the operator" 2.5.1. Configuring proxy parameters for embedded APIcast 2.5.2. Injecting custom environments with the 3scale operator 2.5.3. Injecting custom policies with the 3scale operator 2.5.4. Configuring OpenTracing with the 3scale operator 2.5.5. Enabling TLS at the pod level with the 3scale operator 2.5.6. Proof of concept for evaluation deployment Expand section "2.5.6. Proof of concept for evaluation deployment" Collapse section "2.5.6. Proof of concept for evaluation deployment" 2.5.6.1. Default deployment configuration 2.5.6.2. Evaluation installation 2.5.7. External databases installation Expand section "2.5.7. External databases installation" Collapse section "2.5.7. External databases installation" 2.5.7.1. Backend Redis secret 2.5.7.2. System Redis secret 2.5.7.3. System database secret 2.5.7.4. Zync database secret 2.5.7.5. APIManager custom resources to deploy 3scale 2.5.8. Eabling pod affinity in the 3scale operator Expand section "2.5.8. Eabling pod affinity in the 3scale operator" Collapse section "2.5.8. Eabling pod affinity in the 3scale operator" 2.5.8.1. Customizing node affinity and tolerations at component level 2.5.9. Multiple clusters in multiple availability zones Expand section "2.5.9. Multiple clusters in multiple availability zones" Collapse section "2.5.9. Multiple clusters in multiple availability zones" 2.5.9.1. Prerequisites for multiple clusters installations 2.5.9.2. Active-passive clusters on the same region with shared databases 2.5.9.3. Configuring and installing shared databases 2.5.9.4. Manual failover shared databases 2.5.9.5. Active-passive clusters on different regions with synced databases 2.5.9.6. Configuring and installing synced databases 2.5.9.7. Manual failover synced databases 2.5.10. Amazon Simple Storage Service 3scale Filestorage installation Expand section "2.5.10. Amazon Simple Storage Service 3scale Filestorage installation" Collapse section "2.5.10. Amazon Simple Storage Service 3scale Filestorage installation" 2.5.10.1. Amazon S3 secret 2.5.11. PostgreSQL installation 2.5.12. Configuring SMTP variables (optional) 2.5.13. Customizing compute resource requirements at component level Expand section "2.5.13. Customizing compute resource requirements at component level" Collapse section "2.5.13. Customizing compute resource requirements at component level" 2.5.13.1. Default APIManager components compute resources Expand section "2.5.13.1. Default APIManager components compute resources" Collapse section "2.5.13.1. Default APIManager components compute resources" 2.5.13.1.1. CPU and memory units 2.5.14. Customizing node affinity and tolerations at component level 2.5.15. Reconciliation Expand section "2.5.15. Reconciliation" Collapse section "2.5.15. Reconciliation" 2.5.15.1. Resources 2.5.15.2. Backend replicas 2.5.15.3. APIcast replicas 2.5.15.4. System replicas 2.5.15.5. Zync replicas 2.6. Installing 3scale with the operator using Oracle as the system database Expand section "2.6. Installing 3scale with the operator using Oracle as the system database" Collapse section "2.6. Installing 3scale with the operator using Oracle as the system database" 2.6.1. Preparing the Oracle Database 2.6.2. Building a custom system container image 2.6.3. Installing 3scale with Oracle using the operator 2.7. Troubleshooting common 3scale installation issues Expand section "2.7. Troubleshooting common 3scale installation issues" Collapse section "2.7. Troubleshooting common 3scale installation issues" 2.7.1. Previous deployment leaving dirty persistent volume claims 2.7.2. Wrong or missing credentials of the authenticated image registry 2.7.3. Incorrectly pulling from the Docker registry 2.7.4. Permission issues for MySQL when persistent volumes are mounted locally 2.7.5. Unable to upload logo or images 2.7.6. Test calls not working on OpenShift 2.7.7. APIcast on a different project from 3scale failing to deploy 2.8. Additional resources 3. Installing APIcast Expand section "3. Installing APIcast" Collapse section "3. Installing APIcast" 3.1. APIcast deployment options 3.2. APIcast environments 3.3. Configuring the integration settings 3.4. Configuring your product Expand section "3.4. Configuring your product" Collapse section "3.4. Configuring your product" 3.4.1. Declaring the API backend 3.4.2. Configuring the authentication settings 3.4.3. Configuring the API test call 3.5. Deploying APIcast on the Docker containerized environment Expand section "3.5. Deploying APIcast on the Docker containerized environment" Collapse section "3.5. Deploying APIcast on the Docker containerized environment" 3.5.1. Installing the Docker containerized environment 3.5.2. Running the Docker containerized environment gateway Expand section "3.5.2. Running the Docker containerized environment gateway" Collapse section "3.5.2. Running the Docker containerized environment gateway" 3.5.2.1. The docker command options 3.5.2.2. Testing APIcast 3.5.3. Additional resources 3.5.4. Deploying APIcast on Podman Expand section "3.5.4. Deploying APIcast on Podman" Collapse section "3.5.4. Deploying APIcast on Podman" 3.5.4.1. Installing the Podman container environment 3.5.4.2. Running the Podman environment Expand section "3.5.4.2. Running the Podman environment" Collapse section "3.5.4.2. Running the Podman environment" 3.5.4.2.1. Testing APIcast with Podman 3.5.4.3. The podman command options 3.5.4.4. Additional resources 3.6. Deploying an APIcast gateway self-managed solution using the operator Expand section "3.6. Deploying an APIcast gateway self-managed solution using the operator" Collapse section "3.6. Deploying an APIcast gateway self-managed solution using the operator" 3.6.1. APICast deployment and configuration options Expand section "3.6.1. APICast deployment and configuration options" Collapse section "3.6.1. APICast deployment and configuration options" 3.6.1.1. Providing a 3scale system endpoint Expand section "3.6.1.1. Providing a 3scale system endpoint" Collapse section "3.6.1.1. Providing a 3scale system endpoint" 3.6.1.1.1. Verifying the APIcast gateway is running and available 3.6.1.1.2. Exposing APIcast externally via a Kubernetes Ingress 3.6.1.2. Providing a configuration secret Expand section "3.6.1.2. Providing a configuration secret" Collapse section "3.6.1.2. Providing a configuration secret" 3.6.1.2.1. Verifying APIcast gateway is running and available 3.6.1.3. Injecting custom environments with the APIcast operator 3.6.1.4. Injecting custom policies with the APIcast operator 3.6.1.5. Configuring OpenTracing with the APIcast operator 3.7. Additional resources 4. External Redis database configuration for high availability support in 3scale Expand section "4. External Redis database configuration for high availability support in 3scale" Collapse section "4. External Redis database configuration for high availability support in 3scale" 4.1. Setting up Redis for zero downtime 4.2. Configuring back-end components for 3scale Expand section "4.2. Configuring back-end components for 3scale" Collapse section "4.2. Configuring back-end components for 3scale" 4.2.1. Creating backend-redis and system-redis secrets 4.2.2. Deploying a fresh installation of 3scale for HA 4.2.3. Migrating a non-HA deployment of 3scale to HA Expand section "4.2.3. Migrating a non-HA deployment of 3scale to HA" Collapse section "4.2.3. Migrating a non-HA deployment of 3scale to HA" 4.2.3.1. Using Redis Enterprise 4.2.3.2. Using Redis Sentinel 4.3. Redis database sharding and replication 4.4. Additional information 5. Configuring an external MySQL database Expand section "5. Configuring an external MySQL database" Collapse section "5. Configuring an external MySQL database" 5.1. External MySQL database limitations 5.2. Externalizing the MySQL database 5.3. Rolling back 5.4. Additional information 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 Preface This guide will help you to install and configure 3scale Previous Next