API Control Plane Components

Edit online
API Control Plane consists of the following microservices and components.
components
The following table lists the purpose and characteristics of API Control Plane microservices and components.
Microservices or Components Purpose Characteristics
Ingress This service acts as the gateway to API Control Plane. It filters and authenticates all requests that are directed to API Control Plane, then routes them to the appropriate internal services, and finally sends the responses that are received from these services back to the client. Also, it plays a crucial role in user management.
  • Authentication and authorization
  • Security filters (IP restrictions or Rate Limiting)
  • Session management
  • Routing
  • User management
Asset Catalog This service is responsible for overseeing most of the business assets that are used by API Control Plane.
  • Data plane management
  • Runtime management
  • API management
Control Plane UI This service hosts the UI web application and communicates with other services like Asset Catalog and Engine to display assets and metrics data in the UI for management and visualization.
  • Data plane management
  • Runtime management
  • API management
  • User management
  • User preferences
  • Analytics and monitoring
Engine This service is responsible for storing the metrics and heartbeats that are received from the runtimes.
  • Storing API and runtime metrics
  • Metrics aggregation and calculation
OpenSearch This service acts as the persistence layer for assets, metrics, and user data. All services use the same instance for storage in different indices.
  • Stateful persistence
  • Clustered to support high availability
  • Sharded to support horizontal scaling
  • Data is eventually consistent
  • Policies enabled for Index State Management (ISM)
Note: All the components can run in containers.