Chapter 2. 3scale API Management operations and scaling Note This document is not intended for local installations on laptops or similar end user equipment. This section describes operations and scaling tasks of a Red Hat 3scale API Management 2.15 installation. Prerequisites An installed and initially configured 3scale On-premises instance on a supported OpenShift version . To carry out 3scale operations and scaling tasks, perform the steps outlined in the following sections: Redeploying APIcast Scaling up 3scale API Management on-premise Operations troubleshooting 2.1. Redeploying APIcast You can test and promote system changes through the 3scale Admin Portal. Prerequisites A deployed instance of 3scale On-premises. You have chosen your APIcast deployment method. By default, APIcast deployments on OpenShift, both embedded and on other OpenShift clusters, are configured to allow you to publish changes to your staging and production gateways through the 3scale Admin Portal. To redeploy APIcast on OpenShift: Procedure Make system changes. In the Admin Portal, deploy to staging and test. In the Admin Portal, promote to production. By default, APIcast retrieves and publishes the promoted update once every 5 minutes. If you are using APIcast on the Docker containerized environment or a native installation, configure your staging and production gateways, and indicate how often the gateway retrieves published changes. After you have configured your APIcast gateways, you can redeploy APIcast through the 3scale Admin Portal. To redeploy APIcast on the Docker containerized environment or a native installations: Procedure Configure your APIcast gateway and connect it to 3scale On-premises. Make system changes. In the Admin Portal, deploy to staging and test. In the Admin Portal, promote to production. APIcast retrieves and publishes the promoted update at the configured frequency. 2.2. Scaling up 3scale API Management On-premise As your APIcast deployment grows, you may need to increase the amount of storage available. How you scale up storage depends on which type of file system you are using for your persistent storage. If you are using a network file system (NFS), you can scale up your persistent volume (PV) using this command: USD oc edit pv <pv_name> If you are using any other storage method, you must scale up your persistent volume manually using one of the methods listed in the following sections. 2.2.1. Method 1: Backing up and swapping persistent volumes Procedure Back up the data on your existing persistent volume. Create and attach a target persistent volume, scaled for your new size requirements. Create a pre-bound persistent volume claim, specify: The size of your new PVC (PersistentVolumeClaim) and the persistent volume name using the volumeName field. Restore data from your backup onto your newly created PV. Modify your deployment configuration with the name of your new PV: USD oc edit deployment/system-app Verify your new PV is configured and working correctly. Delete your PVC to release its claimed resources. 2.2.2. Method 2: Backing up and redeploying 3scale API Management Procedure Back up the data on your existing persistent volume. Shut down your 3scale pods. Create and attach a target persistent volume, scaled for your new size requirements. Restore data from your backup onto your newly created PV. Create a pre-bound persistent volume claim. Specify: The size of your new PVC The persistent volume name using the volumeName field. Deploy your amp.yml . Verify your new PV is configured and working correctly. Delete your PVC to release its claimed resources. 2.2.3. Configuring 3scale API Management on-premise deployments The key deployment configurations to be scaled for 3scale are: APIcast production Backend listener Backend worker 2.2.3.1. Scaling via the OCP Via OpenShift Container Platform (OCP) using an APIManager CR, you can scale the deployment configuration either up or down. To scale a particular deployment configuration, use the following: Scale up an APIcast production deployment configuration with the following APIManager CR: apiVersion: apps.3scale.net/v1alpha1 kind: APIManager metadata: name: example-apimanager spec: apicast: productionSpec: replicas: X Scale up the backend listener, backend worker, and backend cron components of your deployment configuration with the following APIManager CR: apiVersion: apps.3scale.net/v1alpha1 kind: APIManager metadata: name: example-apimanager spec: backend: listenerSpec: replicas: X workerSpec: replicas: Y cronSpec: replicas: Z Set the appropriate environment variable to the desired number of processes per pod. PUMA_WORKERS for backend-listener pods: USD oc set env deployment/backend-listener --overwrite PUMA_WORKERS=<number_of_processes> UNICORN_WORKERS for system-app pods: USD oc set env deployment/system-app --overwrite UNICORN_WORKERS=<number_of_processes> 2.2.3.2. Vertical and horizontal hardware scaling You can increase the performance of your 3scale deployment on OpenShift by adding resources. You can add more compute nodes as pods to your OpenShift cluster, as horizontal scaling or you can allocate more resources to existing compute nodes as vertical scaling. Horizontal scaling You can add more compute nodes as pods to your OpenShift. If the additional compute nodes match the existing nodes in your cluster, you do not have to reconfigure any environment variables. Vertical scaling You can allocate more resources to existing compute nodes. If you allocate more resources, you must add additional processes to your pods to increase performance. Note Avoid the use of computing nodes with different specifications and configurations in your 3scale deployment. 2.2.3.3. Scaling up routers As traffic increases, ensure your Red Hat OCP routers can adequately handle requests. If your routers are limiting the throughput of your requests, you must scale up your router nodes. 2.3. Operations troubleshooting This section explains how to configure 3scale audit logging to display on OpenShift, and how to access 3scale logs and job queues on OpenShift. 2.3.1. Configuring 3scale API Management audit logging on OpenShift This enables all logs to be in one place for querying by Elasticsearch, Fluentd, and Kibana (EFK) logging tools. These tools provide increased visibility on changes made to your 3scale configuration, who made these changes, and when. For example, this includes changes to billing, application plans, application programming interface (API) configuration, and more. Prerequisites A 3scale 2.15 deployment. Procedure Configure audit logging to stdout to forward all application logs to standard OpenShift pod logs. Some considerations: By default, audit logging to stdout is disabled when 3scale is deployed on-premises; you need to configure this feature to have it fully functional. Audit logging to stdout is not available for 3scale hosted. 2.3.2. Enabling audit logging 3scale uses a features.yml configuration file to enable some global features. To enable audit logging to stdout , you must mount this file from a ConfigMap to replace the default file. The OpenShift pods that depend on features.yml are system-app and system-sidekiq . Prerequisites You must have administrator access for the 3scale project. Procedure Enter the following command to enable audit logging to stdout : USD oc patch configmap system -p '{"data": {"features.yml": "features: &default\n logging:\n audits_to_stdout: true\n\nproduction:\n <<: *default\n"}}' Export the following environment variable: USD export PATCH_SYSTEM_VOLUMES='{"spec":{"template":{"spec":{"volumes":[{"emptyDir":{"medium":"Memory"},"name":"system-tmp"},{"configMap":{"items":[{"key":"zync.yml","path":"zync.yml"},{"key":"rolling_updates.yml","path":"rolling_updates.yml"},{"key":"service_discovery.yml","path":"service_discovery.yml"},{"key":"features.yml","path":"features.yml"}],"name":"system"},"name":"system-config"}]}}}}' Enter the following command to apply the updated deployment configuration to the relevant OpenShift pods: USD oc patch deployment system-app -p USDPATCH_SYSTEM_VOLUMES USD oc patch deployment system-sidekiq -p USDPATCH_SYSTEM_VOLUMES 2.3.3. Configuring logging for Red Hat OpenShift When you have enabled audit logging to forward 3scale application logs to OpenShift, you can use logging tools to monitor your 3scale applications. For details on configuring logging on Red Hat OpenShift, see the following: Understanding the logging subsystem for Red Hat OpenShift 2.3.4. Accessing your logs Each component's deployment configuration contains logs for access and exceptions. If you encounter issues with your deployment, check these logs for details. Follow these steps to access logs in 3scale: Procedure Find the ID of the pod you want logs for: USD oc get pods Enter oc logs and the ID of your chosen pod: USD oc logs <pod> The system pod has two containers, each with a separate log. To access a container's log, specify the --container parameter with the system-provider and system-developer pods: USD oc logs <pod> --container=system-provider USD oc logs <pod> --container=system-developer 2.3.5. Checking job queues Job queues contain logs of information sent from the system-sidekiq pods. Use these logs to check if your cluster is processing data. You can query the logs using the OpenShift CLI: USD oc get jobs USD oc logs <job> 2.3.6. Preventing monotonic growth To prevent monotonic growth, 3scale schedules by default, automatic purging of the following tables: user_sessions Clean up is triggered once a week and deletes records older than two weeks. audits Clean up is triggered once a day and deletes records older than three months. log_entries Clean up triggered once a day and deletes records older than six months. event_store_events Clean up is triggered once a week and deletes records older than a week. With the exception of the above listed tables, the following table requires manual purging by the database administrator: alerts Table 2.1. SQL purging commands Database type SQL command MySQL DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL 14 DAY; PostgreSQL DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL '14 day'; Oracle DELETE FROM alerts WHERE timestamp <= TRUNC(SYSDATE) - 14; Additional resources OCP documentation Automatically scaling pods Adding Compute Nodes Optimizing Routing

Commands:
oc edit pv <pv_name>
oc edit deployment/system-app
apiVersion: apps.3scale.net/v1alpha1 kind: APIManager metadata: name: example-apimanager spec: apicast: productionSpec: replicas: X
apiVersion: apps.3scale.net/v1alpha1 kind: APIManager metadata: name: example-apimanager spec: backend: listenerSpec: replicas: X workerSpec: replicas: Y cronSpec: replicas: Z
oc set env deployment/backend-listener --overwrite PUMA_WORKERS=<number_of_processes>
oc set env deployment/system-app --overwrite UNICORN_WORKERS=<number_of_processes>
oc patch configmap system -p '{"data": {"features.yml": "features: &default\n logging:\n audits_to_stdout: true\n\nproduction:\n <<: *default\n"}}'
export PATCH_SYSTEM_VOLUMES='{"spec":{"template":{"spec":{"volumes":[{"emptyDir":{"medium":"Memory"},"name":"system-tmp"},{"configMap":{"items":[{"key":"zync.yml","path":"zync.yml"},{"key":"rolling_updates.yml","path":"rolling_updates.yml"},{"key":"service_discovery.yml","path":"service_discovery.yml"},{"key":"features.yml","path":"features.yml"}],"name":"system"},"name":"system-config"}]}}}}'
oc patch deployment system-app -p USDPATCH_SYSTEM_VOLUMES oc patch deployment system-sidekiq -p USDPATCH_SYSTEM_VOLUMES
oc get pods
oc logs <pod>
oc logs <pod> --container=system-provider oc logs <pod> --container=system-developer
oc get jobs
oc logs <job>
DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL 14 DAY;
DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL '14 day';
DELETE FROM alerts WHERE timestamp <= TRUNC(SYSDATE) - 14;