Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: reword the example in the aggregate cluster docs #37872

Merged
merged 2 commits into from
Jan 7, 2025

Conversation

agrawroh
Copy link
Contributor

@agrawroh agrawroh commented Jan 4, 2025

Description

This PR rewords the example we have in the aggregate cluster to explain how the cluster level load balancer selects the cluster.

Rendered Docs Link


Commit Message: docs: reword the example in the aggregate cluster docs
Additional Description: Reword the example in aggregate cluster to make it more clear.
Risk Level: N/A
Testing: N/A
Docs Changes: N/A
Release Notes: N/A

Copy link

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/37872/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: #37872 was opened by agrawroh.

see: more, trace.

@agrawroh agrawroh force-pushed the agg_cluster_docs-2 branch 2 times, most recently from d72e6aa to c05d0ca Compare January 4, 2025 00:49
Signed-off-by: Rohit Agrawal <rohit.agrawal@databricks.com>
@agrawroh agrawroh force-pushed the agg_cluster_docs-2 branch from c05d0ca to e4a7250 Compare January 4, 2025 09:02
priority.
The aggregate cluster load balancer first calculates each priority's health score for every cluster, sums those up,
and then assigns traffic based on the overall total. If the total is at least ``100``, the combined traffic is capped at
``100%``. If it's below ``100``, Envoy scales (normalizes) it so that the final distribution sums to ``100%``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

our rules are pretty shakey on this, but i think the percentages dont want to be literals - just config settings, response codes, etc - these are actual literals rather than just numbers

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sense. So should we leave them as it or should I make them bold using **?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure would need to look at it rendered - generally i think boldening (which i like) is mostly useful for skim reading - so if it assists that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phlax I updated the style. Let me know if this looks better.

Signed-off-by: Rohit Agrawal <rohit.agrawal@databricks.com>
@agrawroh agrawroh requested a review from phlax January 4, 2025 12:56
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks @agrawroh

@phlax phlax merged commit 1dc8657 into envoyproxy:main Jan 7, 2025
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants