App Suite Proxy: Smart Request Routing

App Suite Proxy is a subsystem designed to handle all ingress HTTP traffic to OX App Suite and other HTTP-based services being part of the OX email platform. It provides a L7 reverse proxy with advanced routing and load balancing features. Its initial main goal is, to enable sharding of an App Suite deployment into multiple dedicated clusters by routing each incoming HTTP request to its correct destination.

Admin Guide

• Installation
  • Docker
• HTTP Server
  • TLS
  • Compression
  • PROXY Protocol
  • WebSockets
• Request Routing
  • Virtual Hosts
  • Routing Actions
  • Restrictions
  • Response Headers
  • Full Example
• Proxy Headers
  • Configuration
  • Headers
• Backend Pools
  • Configuration
  • Load Balancing
  • TLS
  • Health Checks
• Backend Sharding
  • Shard detectors
  • Shard bootstrap handler
  • Configuration
• Filter Overview
  • Filter deactivation
  • Incoming/Inbound filters
  • Endpoint filters
  • Outgoing/Outbound filters
• Management Interface
  • HTTP REST Endpoint
  • CLI
• Troubleshooting
  • Http Round Trip
  • TLS errors

Developer Guide

• Deployment
  • 3rd party licenses report
• Smoke Tests
  • Configuration
  • Run locally
  • Jenkins Pipeline
  • Automatic config generation
  • Debug logging
• Zuul Upstream
  • Prepare Workspace
  • Release Builds
• Access restrictions
  • IP-based access restrictions
• Filters
• Sharding
  • Shard detector
  • Shard bootstrap handler
• Microbenchmarks
  • Setup
  • Configuration
  • Global configuration
  • Properties
  • Local configuration
• Metrics
  • Overview
  • Concept & Example
• Coverity and Blackduck checks
  • Setup
  • Pipeline configuration
• Health Checks
  • Create default Health Check
  • Create custom Health Check Endpoint
• Command Line Interface (CLI)
  • Package Structure
  • Scenario
  • CLI Docker Image
• Build Process
  • Build plugins
• Plugin Development - Preview -
  • Extension Points
  • Development
  • Plugin Enabling
  • Plugin Loading

Software and System Architecture

• Introduction and Goals
• System Scope and Context
  • Business Context
  • Technical Context
• Solution Strategy
  • Quality Requirements
  • Architecture Constraints
• Runtime View
  • Request-Response Roundtrip
  • Server Request Processing
  • Client Request Processing
• About arc42