Files
Olares/docs/developer/develop/mw-overview.md
Meow33 839133fc27 docs: add middleware data access and integration guides (#2444)
* docs: add guides to view middleware data

* docs: add guide for grafana

* docs: add guide for otel and integration guides for other middleware

* docs: add guide for elasticsearch

* docs: update based on suggestions

* Update zh.ts

* docs: update content

* docs: resolve conflict
2026-02-05 23:34:59 +08:00

2.5 KiB

outline, description
outline description
2
3
Learn what middleware is in Olares and navigate to access and integration guides for each supported service.

Middleware in Olares

Middleware refers to infrastructure services that sit between your application and the system, providing data storage, messaging, and other common capabilities.

Our middleware documentation is organized into two types of guides:

  • Access and manage data: Connect to a running service to inspect data and troubleshoot issues.
  • App integrate: Configure your app to use a middleware service in Olares using OlaresManifest.yaml.

Document types

Access and manage data

Access and manage data guides explain how to connect to a running middleware service for administration.

Use these guides when you want to:

  • Inspect stored data or indexes.
  • Run queries or commands.
  • Debug application behavior.
  • Verify service status.

The access method (e.g., CLI, Dashboard, or Bytebase) depends on the service.

App integration

App integration guides explain how to connect your application to a middleware service.

Use these guides when you want your application to:

  • Declare dependencies in OlaresManifest.yaml.
  • Request service resources.
  • Read system-injected connection values in your application.

Integration is declarative and handled by Olares at deployment time.

Supported services

Databases and caching

Service Access and manage data App integration
Elasticsearch Access Integrate
MariaDB Access Integrate
MongoDB Access Integrate
MySQL Access Integrate
PostgreSQL Access Integrate
Redis Access Integrate

Messaging and streaming

Service Access and manage data App integration
RabbitMQ Access Integrate
NATS Access

Storage and observability

Service Access and manage data App integration
MinIO Access Integrate
Grafana Access
OpenTelemetry Access