Jump To Close Expand all Collapse all Table of contents Operating 3scale Making open source more inclusive 1. 3scale general configuration options Expand section "1. 3scale general configuration options" Collapse section "1. 3scale general configuration options" 1.1. Configuring a valid login session length 2. 3scale operations and scaling Expand section "2. 3scale operations and scaling" Collapse section "2. 3scale operations and scaling" 2.1. Redeploying APIcast 2.2. Scaling up 3scale on-premise Expand section "2.2. Scaling up 3scale on-premise" Collapse section "2.2. Scaling up 3scale on-premise" 2.2.1. Method 1: Backing up and swapping persistent volumes 2.2.2. Method 2: Backing up and redeploying 3scale 2.2.3. Scaling up performance 2.2.4. Configuring 3scale on-premise deployments Expand section "2.2.4. Configuring 3scale on-premise deployments" Collapse section "2.2.4. Configuring 3scale on-premise deployments" 2.2.4.1. Scaling via the OCP command line interface 2.2.4.2. Vertical and horizontal hardware scaling 2.2.4.3. Scaling up routers 2.3. Operations troubleshooting Expand section "2.3. Operations troubleshooting" Collapse section "2.3. Operations troubleshooting" 2.3.1. Configuring 3scale audit logging on OpenShift 2.3.2. Enabling audit logging 2.3.3. Configuring EFK logging 2.3.4. Accessing your logs 2.3.5. Checking job queues 2.3.6. Preventing monotonic growth 3. Monitoring 3scale Expand section "3. Monitoring 3scale" Collapse section "3. Monitoring 3scale" 3.1. Enabling monitoring for 3scale 3.2. Configuring Prometheus to monitor 3scale 3.3. Configuring Grafana to monitor 3scale 3.4. Viewing metrics for 3scale 3.5. 3scale system metrics exposed to Prometheus 4. 3scale automation using webhooks Expand section "4. 3scale automation using webhooks" Collapse section "4. 3scale automation using webhooks" 4.1. Overview of webhooks 4.2. Configuring webhooks 4.3. Troubleshooting webhooks 5. The 3scale toolbox Expand section "5. The 3scale toolbox" Collapse section "5. The 3scale toolbox" 5.1. Installing the toolbox Expand section "5.1. Installing the toolbox" Collapse section "5.1. Installing the toolbox" 5.1.1. Installing the toolbox container image 5.2. Supported toolbox commands 5.3. Importing services 5.4. Copying services 5.5. Copying service settings only 5.6. Importing OpenAPI definitions 5.7. Importing a 3scale backend from an OpenAPI definition 5.8. Managing remote access credentials Expand section "5.8. Managing remote access credentials" Collapse section "5.8. Managing remote access credentials" 5.8.1. Adding remote access credentials 5.8.2. Listing remote access credentials 5.8.3. Removing remote access credentials 5.8.4. Renaming remote access credentials 5.9. Creating application plans Expand section "5.9. Creating application plans" Collapse section "5.9. Creating application plans" 5.9.1. Creating a new application plan 5.9.2. Creating or updating application plans 5.9.3. Listing application plans 5.9.4. Showing application plans 5.9.5. Deleting application plans 5.9.6. Exporting/importing application plans Expand section "5.9.6. Exporting/importing application plans" Collapse section "5.9.6. Exporting/importing application plans" 5.9.6.1. Exporting an application plan to a file 5.9.6.2. Importing an application plan from a file 5.9.6.3. Importing an application plan from a URL 5.10. Creating metrics Expand section "5.10. Creating metrics" Collapse section "5.10. Creating metrics" 5.10.1. Creating or updating metrics 5.10.2. Listing metrics 5.10.3. Deleting metrics 5.11. Creating methods Expand section "5.11. Creating methods" Collapse section "5.11. Creating methods" 5.11.1. Creating methods 5.11.2. Creating or updating methods 5.11.3. Listing methods 5.11.4. Deleting methods 5.12. Creating services Expand section "5.12. Creating services" Collapse section "5.12. Creating services" 5.12.1. Creating a new service 5.12.2. Creating or updating services 5.12.3. Listing services 5.12.4. Showing services 5.12.5. Deleting services 5.13. Creating ActiveDocs Expand section "5.13. Creating ActiveDocs" Collapse section "5.13. Creating ActiveDocs" 5.13.1. Creating new ActiveDocs 5.13.2. Creating or updating ActiveDocs 5.13.3. Listing ActiveDocs 5.13.4. Deleting ActiveDocs 5.14. Listing proxy configurations Expand section "5.14. Listing proxy configurations" Collapse section "5.14. Listing proxy configurations" 5.14.1. Showing proxy configurations 5.14.2. Promoting proxy configurations 5.14.3. Exporting proxy configurations 5.14.4. Deploying proxy configurations 5.14.5. Updating proxy configurations 5.14.6. Showing proxy configurations 5.14.7. Deploying proxy configurations (Deprecated) 5.15. Copying a policy registry 5.16. Listing applications Expand section "5.16. Listing applications" Collapse section "5.16. Listing applications" 5.16.1. Creating applications 5.16.2. Showing applications 5.16.3. Creating or updating applications 5.16.4. Deleting applications 5.17. Exporting products 5.18. Importing products 5.19. Export and import a product policy chain 5.20. Copying API backends 5.21. Copying API products 5.22. Troubleshooting issues with SSL and TLS 6. Mapping API environments in 3scale Expand section "6. Mapping API environments in 3scale" Collapse section "6. Mapping API environments in 3scale" 6.1. Product per environment 6.2. 3scale On-premises instances Expand section "6.2. 3scale On-premises instances" Collapse section "6.2. 3scale On-premises instances" 6.2.1. Separating 3scale instances per environment 6.2.2. Separating 3scale tenants per environment 6.3. 3scale mixed approach 6.4. 3scale with APIcast gateways Expand section "6.4. 3scale with APIcast gateways" Collapse section "6.4. 3scale with APIcast gateways" 6.4.1. APIcast built-in default gateways 6.4.2. Additional APIcast gateways 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. Overview of the API lifecycle stages Expand section "7.1. Overview of the API lifecycle stages" Collapse section "7.1. Overview of the API lifecycle stages" 7.1.1. API provider cycle 7.1.2. API consumer cycle 7.2. Deploying the sample Jenkins CI/CD pipelines Expand section "7.2. Deploying the sample Jenkins CI/CD pipelines" Collapse section "7.2. Deploying the sample Jenkins CI/CD pipelines" 7.2.1. Sample Jenkins CI/CD pipelines 7.2.2. Setting up your 3scale Hosted environment 7.2.3. Setting up your 3scale On-premises environment 7.2.4. Deploying Red Hat Single Sign-On for OpenID Connect 7.2.5. Installing the 3scale toolbox and enabling access 7.2.6. Deploying the API backends 7.2.7. Deploying self-managed APIcast instances 7.2.8. Installing and deploying the sample pipelines 7.2.9. Limitations of API lifecycle automation with 3scale toolbox 7.3. Creating pipelines using the 3scale Jenkins shared library 7.4. Creating pipelines using a Jenkinsfile 8. Using the 3scale operator to configure and provision 3scale Expand section "8. Using the 3scale operator to configure and provision 3scale" Collapse section "8. Using the 3scale operator to configure and provision 3scale" 8.1. General prerequisites 8.2. Application capabilities via the 3scale operator 8.3. Deploying your first 3scale product and backend 8.4. Promoting a product’s APIcast configuration 8.5. How the 3scale operator identifies the tenant that a custom resource links to 8.6. Deploying 3scale OpenAPI custom resources Expand section "8.6. Deploying 3scale OpenAPI custom resources" Collapse section "8.6. Deploying 3scale OpenAPI custom resources" 8.6.1. Deploying a 3scale OpenAPI custom resource that imports an OAS document from a secret 8.6.2. Features of 3scale OpenAPI custom resource definitions 8.6.3. Import rules when defining OpenAPI custom resources 8.6.4. Deploying a 3scale OpenAPI custom resource that imports an OAS document from a URL 8.6.5. Additional resources 8.7. Deploying 3scale ActiveDoc custom resources Expand section "8.7. Deploying 3scale ActiveDoc custom resources" Collapse section "8.7. Deploying 3scale ActiveDoc custom resources" 8.7.1. Deploying a 3scale ActiveDoc custom resource that imports an OAS document from a secret 8.7.2. Features of 3scale ActiveDoc custom resource definitions 8.7.3. Deploying a 3scale ActiveDoc custom resource that imports an OAS document from a URL 8.7.4. Additional resources 8.8. Backend custom resources related to capabilities Expand section "8.8. Backend custom resources related to capabilities" Collapse section "8.8. Backend custom resources related to capabilities" 8.8.1. Deploying backend custom resources related to capabilities 8.8.2. Defining backend metrics 8.8.3. Defining backend methods 8.8.4. Defining backend mapping rules 8.8.5. Status of the backend custom resource 8.8.6. The backend custom resource linked to a tenant account 8.8.7. Deleting Backend custom resources 8.9. Product custom resources related to capabilities Expand section "8.9. Product custom resources related to capabilities" Collapse section "8.9. Product custom resources related to capabilities" 8.9.1. Deploying product custom resources related to capabilities Expand section "8.9.1. Deploying product custom resources related to capabilities" Collapse section "8.9.1. Deploying product custom resources related to capabilities" 8.9.1.1. Deploying a basic product custom resource 8.9.1.2. Deploying a product with APIcast hosted 8.9.1.3. Deploying a product with APIcast self-managed 8.9.2. Defining product application plans 8.9.3. Defining limits for product application plans 8.9.4. Defining pricing rules for product application plans 8.9.5. Defining product authentication using OpenID Connect 8.9.6. Defining product metrics 8.9.7. Defining product methods 8.9.8. Defining product mapping rules 8.9.9. Defining product backend usage 8.9.10. Configuring gateway responses in 3scale Product custom resources 8.9.11. Configuring policy chains in 3scale Product custom resources 8.9.12. Status of the product custom resource 8.9.13. The product custom resource linked to a tenant account 8.9.14. Deleting Product custom resources 8.10. Deploying 3scale CustomPolicyDefinition custom resources 8.11. Managing 3scale developers by deploying custom resources Expand section "8.11. Managing 3scale developers by deploying custom resources" Collapse section "8.11. Managing 3scale developers by deploying custom resources" 8.11.1. Prerequisites 8.11.2. Managing 3scale developer accounts by deploying DeveloperAccount custom resources 8.11.3. Managing 3scale developer users by deploying DeveloperUser custom resources 8.11.4. Deleting DeveloperAccount or DeveloperUser custom resources 8.12. Limitations of 3scale operator capabilities 8.13. Additional resources 9. 3scale backup and restore Expand section "9. 3scale backup and restore" Collapse section "9. 3scale backup and restore" 9.1. Backing up 3scale using the operator Expand section "9.1. Backing up 3scale using the operator" Collapse section "9.1. Backing up 3scale using the operator" 9.1.1. Backup compatible scenarios 9.1.2. Backup scenarios scope 9.1.3. Backed up data 9.1.4. Backing up 3scale 9.1.5. Backing up 3scale custom resources 9.2. Restoring 3scale using the operator Expand section "9.2. Restoring 3scale using the operator" Collapse section "9.2. Restoring 3scale using the operator" 9.2.1. Restore compatible scenarios 9.2.2. Restore scenarios scope 9.2.3. Restored data 9.2.4. Restoring 3scale 10. Configuring reCAPTCHA for 3scale Expand section "10. Configuring reCAPTCHA for 3scale" Collapse section "10. Configuring reCAPTCHA for 3scale" 10.1. Configuring reCAPTCHA for spam protection in 3scale 11. Troubleshooting the API infrastructure Expand section "11. Troubleshooting the API infrastructure" Collapse section "11. Troubleshooting the API infrastructure" 11.1. Common integration issues Expand section "11.1. Common integration issues" Collapse section "11.1. Common integration issues" 11.1.1. Integration issues Expand section "11.1.1. Integration issues" Collapse section "11.1.1. Integration issues" 11.1.1.1. APIcast Hosted 11.1.1.2. APIcast self-managed 11.1.2. Production issues Expand section "11.1.2. Production issues" Collapse section "11.1.2. Production issues" 11.1.2.1. Availability issues 11.1.3. Post-deploy issues 11.2. Handling API infrastructure issues Expand section "11.2. Handling API infrastructure issues" Collapse section "11.2. Handling API infrastructure issues" 11.2.1. Can we connect? 11.2.2. Server connection issues 11.2.3. Is it a DNS issue? 11.2.4. Is it an SSL issue? 11.3. Identifying API request issues Expand section "11.3. Identifying API request issues" Collapse section "11.3. Identifying API request issues" 11.3.1. API 11.3.2. API Gateway > API 11.3.3. API gateway Expand section "11.3.3. API gateway" Collapse section "11.3.3. API gateway" 11.3.3.1. Is the API gateway up and running? 11.3.3.2. Are there any errors in the gateway logs? 11.3.4. API gateway > 3scale Expand section "11.3.4. API gateway > 3scale" Collapse section "11.3.4. API gateway > 3scale" 11.3.4.1. Can the API gateway reach 3scale? 11.3.4.2. Is the API gateway resolving 3scale addresses correctly? 11.3.4.3. Is the API gateway calling 3scale correctly? 11.3.5. 3scale Expand section "11.3.5. 3scale" Collapse section "11.3.5. 3scale" 11.3.5.1. Is 3scale available? 11.3.5.2. Is 3scale returning an error? 11.3.5.3. Use the 3scale debug headers 11.3.5.4. Check the integration errors 11.3.6. Client API gateway Expand section "11.3.6. Client API gateway" Collapse section "11.3.6. Client API gateway" 11.3.6.1. Is the API gateway reachable from the public internet? 11.3.6.2. Is the API gateway reachable by the client? 11.3.7. Client Expand section "11.3.7. Client" Collapse section "11.3.7. Client" 11.3.7.1. Test the same call using a different client 11.3.7.2. Inspect the traffic sent by client 11.4. ActiveDocs issues Expand section "11.4. ActiveDocs issues" Collapse section "11.4. ActiveDocs issues" 11.4.1. Use petstore.swagger.io 11.4.2. Check that firewall allows connections from ActiveDocs proxy 11.4.3. Call the API with incorrect credentials 11.4.4. Compare calls 11.5. Logging in NGINX Expand section "11.5. Logging in NGINX" Collapse section "11.5. Logging in NGINX" 11.5.1. Enabling debugging log 11.6. 3scale error codes 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 Operating 3scale Red Hat 3scale 2-saasHow to automate deployment, scale your environment, and troubleshoot issuesRed Hat Customer Content Services Legal NoticeAbstract This guide documents development operations with Red Hat 3scale 2-saas. Next