Gravitee.io API Management Self-Hosted¶
Components¶
SaaS Components¶
| Component | Description |
|---|---|
| Administration Console (for API producers) |
This web UI gives easy access to some key APIM API services. API Publishers can use it to publish APIs. Administrators can also configure global platform settings and specific portal settings. |
| Dev / API Portal (for API consumers) |
This web UI gives easy access to some key APIM API services. API Consumers can use it to search for, view, try out and subscribe to a published API. They can also use it to manage their applications. |
| Management API | This RESTful API exposes services to manage and configure the APIM Console and APIM Portal web UIs. All exposed services are restricted by authentication and authorization rules. For more information, see the API Reference section. |
| SaaS API Gateways | APIM Gateway is the core component of the APIM platform. You can think of it like a smart proxy. Unlike a traditional HTTP proxy, APIM Gateway has the capability to apply policies (i.e., rules) to both HTTP requests and responses according to your needs. With these policies, you can enhance request and response processing by adding transformations, security, and many other exciting features. |
| Bridge Gateways | A bridge API Gateway exposes extra HTTP services for bridging HTTP calls to the underlying repository (which can be any of our supported repositories: MongoDB, JDBC and so on) |
| Config Database | All the API Management platform management data, such as API definitions, users, applications and plans. |
| S3 Bucket + Analytics Database | Analytics and logs data |
| [Enterprise] Cockpit |
Cockpit is a centralized, multi-environments / organizations tool for managing all your Gravitee API Management and Access Management installations in a single place. |
| [Enterprise] API Designer |
Drag-and-Drop graphical (MindMap based) API designer to quickly and intuitively design your APIs (Swagger / OAS) and even deploy mocked APIs for quick testing. |
| [Enterprise] Alert Engine |
Alert Engine (AE) provides APIM and AM users with efficient and flexible API platform monitoring, including advanced alerting configuration and notifications sent through their preferred channels, such as email, Slack and using Webhooks. AE does not require any external components or a database as it does not store anything. It receives events and sends notifications under the conditions which have been pre-configured upstream with triggers. |
On-prem / Private cloud components¶
| Component | Description |
|---|---|
| Gravitee.io APIm Gaetway | APIM Gateway is the core component of the APIM platform, smartly proxing trafic applying policies. |
| Logstash | Collect and send local Gateways logs and metrics to the Gravitee.io APIM SaaS Control Plane. |
| Redis | Database use locally for rate limits synchronized counters (RateLimit, Quota, Spike Arrest) and optionnaly as an external cache for the Cache policy. |
Architecture Diagram¶
Self-Hosted to SaaS connections¶
Last update:
November 15, 2022
Created: November 15, 2022
Created: November 15, 2022