Skip to content

Repository files navigation

Async::Service::Supervisor::Envoy

Provides an Envoy xDS monitor for async-service-supervisor.

Development Status

Features

async-service-supervisor-envoy publishes supervised worker endpoints to Envoy:

  • xDS control plane - Runs an ADS server backed by async-grpc-xds.
  • 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 see the project documentation for more details.

  • Getting Started - This guide explains how to use async-service-supervisor-envoy to publish supervised worker endpoints to Envoy using xDS.

Releases

Please see the project releases for all releases.

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

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. 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.

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Contributors

Languages