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 relationship btw MeshNetworks and ENABLE_HCM_INTERNAL_NET #3433

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

jaellio
Copy link
Contributor

@jaellio jaellio commented Feb 6, 2025

Add comments explaining the ability to use MeshNetworks to configure Envoy's internal_address_config via
ENABLE_HCM_INTERNAL_NETWORK

istio/istio#53402

Related: istio/istio#52037

Add comments explaining the ability to use MeshNetworks to
configure Envoy's internal_address_config via
ENABLE_HCM_INTERNAL_NETWORK

Signed-off-by: Jackie Elliott <[email protected]>
@jaellio jaellio added the cherrypick/release-1.25 Set this label on a PR to auto-merge it to the release-1.25 branch label Feb 6, 2025
@jaellio jaellio requested a review from a team as a code owner February 6, 2025 18:00
@istio-policy-bot
Copy link

😊 Welcome @jaellio! This is either your first contribution to the Istio api repo, or it's been
a while since you've been here.

You can learn more about the Istio working groups, Code of Conduct, and contribution guidelines
by referring to Contributing to Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 6, 2025
Signed-off-by: Jackie Elliott <[email protected]>
@istio-testing istio-testing added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 6, 2025
@@ -114,6 +114,9 @@ message Network {
// locality: us-east-1a
// ```
//
// If `ENABLE_HCM_INTERNAL_NETWORKS` is set to true, MeshNetworks can be used to
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think we need an example of how to do this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If Networks defaults to all mesh IPs then maybe not, but I need to clarify the default value of Networks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From my quick investigation, I don't think there is a default Network configured. I had previously thought it defaulted to all mesh IPs. @ramaraochavali Since you are more familiar with this configuration could confirm this and review an additional example?

Copy link
Contributor

Choose a reason for hiding this comment

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

I the documentation is correct. But I would hesitate to add the temporary feature flag reference here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we update this documentation when the feature flag is removed?

Copy link
Contributor

Choose a reason for hiding this comment

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

But nothing is changed in network API. So not sure why we have to update here. Why is n't the main istio release notes not sufficient?

Copy link
Contributor Author

@jaellio jaellio Feb 13, 2025

Choose a reason for hiding this comment

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

I liked having the information here so it would be clearly displayed in our api docs on istio.io. Otherwise, the only documentation on how to utilize MeshNetworks to preserve envoy internal headers. I could modify/simplify the description and link to the upgrade note?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think specifying MeshNetworks can also be used to define "internal" addresses of mesh and provide an example is fine.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with @jaellio that the feature flag + example is useful//necessary here. Users who run into the Envoy behavior change are going to come to Istio documentation to tell them what to do. We should have a clear answer for them

and configuring MeshNetworks.

Signed-off-by: Jackie Elliott <[email protected]>
@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 6, 2025
@jaellio jaellio assigned howardjohn and unassigned howardjohn Feb 19, 2025
@jaellio jaellio requested a review from howardjohn February 19, 2025 00:59
@istio-testing istio-testing merged commit f4ae20b into istio:master Feb 19, 2025
5 checks passed
@istio-testing
Copy link
Collaborator

In response to a cherrypick label: new pull request created: #3444

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick/release-1.25 Set this label on a PR to auto-merge it to the release-1.25 branch size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants