Async::Service::Supervisor::Envoy
Provides an Envoy xDS monitor for async-service-supervisor.
Features
async-service-supervisor-envoy publishes supervised worker endpoints to Envoy:
- Cluster and endpoint discovery - Runs dedicated CDS and EDS services backed by
async-grpc-xds, leaving ADS free for listener, route, and other configuration. - Supervisor integration - Registers and removes endpoints from supervisor worker lifecycle events.
- Multiple clusters - Groups workers by
state[:name]by default. - Endpoint contract - Converts concrete post-bind worker listeners into Envoy upstream endpoints, including grouped IP or Unix socket addresses.
- Delegate mapping - Uses a delegate object for endpoint selection, cluster grouping, and health without active probing.
- Load-aware balancing - Optionally reports per-worker CPU utilization and request throughput to Envoy using out-of-band ORCA.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide explains how to use async-service-supervisor-envoy to publish supervised worker clusters and endpoints to Envoy using xDS.
Releases
Please browse the releases for more details.
v0.5.0
- Serve clusters and endpoints through dedicated CDS and EDS services instead of the aggregated discovery service, leaving ADS available for listener, route, and other configuration.
- Allow cluster publication to be disabled when clusters are owned by another control plane.
- Configure generated clusters to obtain endpoint assignments from the dedicated EDS service.
- Publish endpoint assignments only when they change, instead of on every reconciliation.
- Use normalized processor utilization from
process-metricsv0.13.
v0.4.0
- Publish configured active health checks with Envoy clusters.
v0.3.1
- Add Bake tasks for inspecting Envoy monitor status, clusters, and endpoints.
v0.3.0
- Add supervisor-driven out-of-band ORCA load reporting for independently addressable workers.
v0.2.0
- Accept the required Falcon listener as a positional worker preparation argument.
v0.1.0
- Deduplicate immutable endpoint values reported by multiple supervised workers and aggregate their health.
v0.0.1
- Register concrete Falcon cluster listeners as Envoy upstream endpoint state after binding.
- Publish grouped IP and Unix-domain-socket endpoint addresses to Envoy.
- Configure generated clusters from each endpoint's supported HTTP protocol names.
See Also
- async-service-supervisor - Supervisor for managed Async service workers.
- async-grpc-xds - xDS support for Async::GRPC.
- Envoy xDS - Envoy dynamic configuration protocol.
Contributing
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create new Pull Request.
Running Tests
To run the test suite:
bundle exec sus
Making Releases
To make a new release:
bundle exec bake gem:release:patch # or minor or major
Developer Certificate of Origin
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
Community Guidelines
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.