Skip to content

APK Documentation 1.1.0

Overview

APK Documentation 1.1.0

Home
Get Started
Get Started
- Quick Start
- Quick Start With Control Plane
  Quick Start With Control Plane
  - Developer-Driven Design First
  - Portal-Driven Design First
API Management
API Management
- Overview - API Management in APK Dataplane
  Overview - API Management in APK Dataplane
- Develop and Deploy API
  Develop and Deploy API
  - Rest APIs
    Rest APIs
    
    Via REST API
    
    Via CRs
  - GraphQL APIs
    GraphQL APIs
    
    Via REST API
    
    Via CRs
- Undeploy API
  Undeploy API
  - Via REST API
  - Via CRs
- Manage Endpoint
  Manage Endpoint
  - Define Endpoint
  - Manage Certificate
  - Manage Security
    Manage Security
    
    Via REST API
    
    Via CRs
  - Manage Resiliency
    Manage Resiliency
    
    Timeout
    
    Retry Policy
    
    Circuit Breaker
- API Policies
  API Policies
  - Overview
  - Interceptor Service
    Interceptor Service
    
    Overview
    
    Via REST API
    
    Via CRs
  - Backend JWT Token Manipulation
    Backend JWT Token Manipulation
    
    Overview
    
    Via REST API
    
    Via CRs
  - CORS
    CORS
    
    Via REST API
    
    Via CRs
- Rate Limiting
  Rate Limiting
  - Overview
  - Simple Rate Limiting
    Simple Rate Limiting
    
    Via REST API
    
    Via CRs
  - Custom Rate Limiting
- API Security
  API Security
  - Generate Access Token
  - Authentication
    Authentication
    
    Enable API Security
    Enable API Security
    
    OAuth2
    
    Mutual SSL
- API Versions
  API Versions
- API Properties
- API Scopes
- API Definition Endpoint
- Token Issuers
Control Plane
Control Plane
- APK Control Plane
  APK Control Plane
  - Overview
  - API Management
    API Management
    
    Overview
    
    Develop and Deploy API
    Develop and Deploy API
    
    Create REST APIs
    
    Create GraphQL APIs
    
    Add APK Gateway
    
    Create Application and Subscribe
- APK as a Gateway in API Manager
  APK as a Gateway in API Manager
  - Overview
  - Quick Start Guide
  - API Management
    API Management
    
    Overview
    
    Develop and Deploy API
    Develop and Deploy API
    
    Create REST APIs
    
    Create GraphQL APIs
    
    Add APK Gateway
    
    Create Application and Subscribe
- Advanced Configuration
  Advanced Configuration
  - API Manager Control Plane
  - APK Data Plane
  - APIM APK Agent
    APIM APK Agent
    
    Deployment
    
    Prometheus Configuration
Catalogs
Catalogs
- CRD Catalog
  CRD Catalog
- API Catalog
  API Catalog
- Helm Configuration Catalog
- API Configuration Catalog
Setup
Setup
- Prerequisites
- Install Dataplane
- Install Control plane with Dataplane
- Install Enterprise Products
  Install Enterprise Products
  - Install APK Dataplane
  - Install APIM APK Agent
- Uninstall
- Deployment Patterns
  Deployment Patterns
- CI/CD
  CI/CD
  - CI/CD for APIs - Overview
  - Building a GitOps Workflow for APIs With WSO2 APK
- Migration
- Customize Configurations
- Production Deployment Guidelines
- Configure HPA for gateway
- Deploy in OpenShift
- Multi-environment Deployment on Gateway
Administration
Administration
- Configure Identity Provider
  Configure Identity Provider
- Configure Analytics
  Configure Analytics
- Configure Listeners
  Configure Listeners
  - Configure Gateway Listeners
- Configure Logs
  Configure Logs
  - Overview
  - Adapter
  - Enforcer
  - Router
- Configure Distributed Tracing
- Configure Prometheus Metric Support
About APK
About APK
- What is APK?
- About This Release
- Architecture
- Performance Test Results
  Performance Test Results
Reach Out
Reach Out
FAQ
FAQ
- FAQs

APK Deployment Patterns¶

This document outlines the recommended deployment patterns for the WSO2 APK. There are three primary deployment patterns for APK