ποΈ Certificate Management
This page is scoped to the lynx.tls and lynx.tls.auto part of lynx/conf/boot-example.yml.
ποΈ Database Plugin
Lynx does not expose one generic lynx.db config block or runtime plugin. SQL is enabled through the concrete plugins lynx-mysql, lynx-pgsql, and lynx-mssql, while shared pool, reconnect, health-check, and provider behavior comes from lynx-sql-sdk.
ποΈ HTTP Service
This page documents the fields shown in lynx-http/conf/example_config.yml, then cross-checks them against the current runtime code.
ποΈ gRPC Service
This page is based on these templates:
ποΈ Polaris Service Governance
Polaris is Lynx's broadest control-plane plugin. In this repository it is driven by two different YAML files:
ποΈ Tracer Plugin
lynx-tracer/conf/example_config.yml is still a legacy reference file. The current runtime does not scan that top-level shape directly. It scans only lynx.tracer.
ποΈ Distributed Transaction Plugin
lynx-seata only does two things inside Lynx: decide whether the Seata client should start, and tell Seata which external config file to load. Registry, coordinator, namespace, auth, and transport settings still live in the file pointed to by configfilepath.
ποΈ Redis Plugin
The Redis plugin is the runtime-owned Redis client used by Lynx services and by higher-level packages such as Redis Lock. This page is intentionally scoped to the keys that appear in lynx-redis/conf/example_config.yml, because that file is still present in the repo even though parts of it are now legacy.
ποΈ Plugin Ecosystem
This page is a map, not a plugin config reference. Use it to decide which plugin page to read next and to understand where one plugin's responsibility ends and another system or dependency begins.
ποΈ Nacos Plugin
Nacos is a control-plane plugin for service registration, discovery, and remote configuration. One runtime can enable any subset of those three capabilities, but the YAML fields have different effects depending on which client is actually initialized.
ποΈ Kafka Plugin
This page explains the YAML fields from lynx-kafka/conf/example_config.yml. The repository example uses a standalone kafka: block; when you merge it into a Lynx bootstrap file, the same fields live under lynx.kafka.
ποΈ MongoDB Plugin
lynx-mongodb is the runtime-owned MongoDB client for Lynx. This page documents the fields that appear in lynx-mongodb/conf/example_config.yml, including when each key matters, how defaults behave, and where users commonly misread the template.
ποΈ Sentinel Plugin
lynx-sentinel adds flow control, circuit breaking, system protection, in-process metrics, and a lightweight dashboard to Lynx. The current runtime consumes the flattened conf/sentinel.yaml shape shown below; older nested examples with log.output, metrics.export, datasource.nacos, or datasource.apollo do not match the code that currently boots.
ποΈ Swagger Plugin
This page covers the three shipped templates:
ποΈ Elasticsearch Plugin
lynx-elasticsearch owns the runtime Elasticsearch client for Lynx. This page stays aligned with lynx-elasticsearch/conf/example_config.yml and explains what each YAML key actually changes, when it matters, and where the sample is easy to misuse.
ποΈ RabbitMQ Plugin
This page explains the YAML fields from lynx-rabbitmq/conf/example_config.yml. The runtime prefix is rabbitmq, so the example can be copied into a Lynx bootstrap file without adding a lynx. parent block.
ποΈ RocketMQ Plugin
This page explains the YAML fields from lynx-rocketmq/conf/example_config.yml. The runtime prefix is rocketmq, so the example shape can be dropped directly into a Lynx bootstrap file.
ποΈ Pulsar Plugin
This page explains the YAML fields from lynx-pulsar/conf/example_config.yml. The example already matches the runtime prefix and lives under lynx.pulsar.
ποΈ Apollo Plugin
Apollo is Lynx's configuration-center plugin. It is the fit for teams that already manage config rollout through Apollo namespaces and clusters, and do not expect the same backend to provide service registration or discovery.
ποΈ Etcd Plugin
Etcd can serve two roles in Lynx: configuration center and service registry/discovery backend. It is also the required upstream client for Etcd Lock.
ποΈ Redis Lock Plugin
lynx-redis-lock is a Redis-backed locking library that sits on top of the runtime client from lynx-redis. It is not an independently configured runtime plugin, and this repo does not ship a separate conf/example_config.yml for it.
ποΈ Etcd Lock Plugin
github.com/go-lynx/lynx-etcd-lock is Lynx's etcd-backed distributed lock layer. It is a runtime plugin, but it does not ship an independent configuration schema or standalone example_config.yml.
ποΈ DTM Plugin
lynx-dtm is Lynx's runtime wrapper around a DTM server. It exposes the HTTP endpoint, optional gRPC connection, helper constructors, and transaction metrics, but the actual branch APIs and business orchestration still belong to your service.
ποΈ Lynx Project Template (Layout)
lynx-layout is the official Lynx service template repository. It is not an independently configurable runtime plugin, and this page intentionally documents repository boundaries and real entry points instead of inventing a fake layout runtime schema.
ποΈ SQL SDK
lynx-sql-sdk is the shared SQL capability layer used by lynx-mysql, lynx-pgsql, and lynx-mssql. It is not an independently configured runtime plugin, and it does not own its own YAML block or example_config.yml.
ποΈ Eon ID Distributed ID Generator
lynx-eon-id generates Snowflake-style 64-bit IDs inside Lynx. Its most important operational choice is whether worker IDs are assigned manually or registered through a shared Redis plugin.