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

clarify resource warming docs in xds protocol #22377

Merged
merged 10 commits into from
Aug 10, 2022
Merged
8 changes: 8 additions & 0 deletions docs/root/api-docs/xds_protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,14 @@ server does not provide EDS/RDS responses, Envoy will not initialize
itself during the initialization phase and the updates sent via CDS/LDS
will not take effect until EDS/RDS responses are supplied.

.. note::

Envoy specific implementation note: Warming of ``Cluster`` is completed only
when a new ``ClusterLoadAssignment`` response is supplied by management server
even though there is no change in endpoints. However, If Envoy is already aware of
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
even though there is no change in endpoints. However, If Envoy is already aware of
even if there is no change in endpoints. However, If Envoy is already aware of

?

``RouteConfiguration`` referenced by ``Listener``, it will use it otherwise Envoy will
initiate a new RDS request with the new route name referenced by ``Listener``.
Copy link
Member

Choose a reason for hiding this comment

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

I can't parse this. Is this related to Cluster or unrelated and a different note about warming? Can you clarify and if it's different move it to a separate note?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is about listener warming with route. It is under same resource warming category.

Copy link
Member

Choose a reason for hiding this comment

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

OK then I don't understand this and how it relates to the cluster part. Can you clarify? Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is not related to cluster warming. It is related to resource warming only but talks about how listeners are warmed.

Copy link
Member

Choose a reason for hiding this comment

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

Then please split it out into a separate note and/or make it a clearly separate statement. I'm having a hard time parsing what this means. Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I clarified it. PTAL


.. _xds_protocol_eventual_consistency_considerations:

Eventual consistency considerations
Expand Down