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

Add IMDS backup url #1630

Merged
merged 13 commits into from Oct 4, 2019
Merged

Add IMDS backup url #1630

merged 13 commits into from Oct 4, 2019

Conversation

ghost
Copy link

@ghost ghost commented Sep 11, 2019

Description

Calls to metadata service can fallback to the wireserver ip address in scenarios where customer is blocking the primary metadata service ip address.


PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which has an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes in the description.
  • New Unit tests were added for the changes made and Travis.CI is passing.

Quality of Code and Contribution Guidelines


This change is Reviewable

@ghost
Copy link
Author

ghost commented Sep 11, 2019

Related to #1249

@codecov
Copy link

codecov bot commented Sep 12, 2019

Codecov Report

❗ No coverage uploaded for pull request base (develop@1c453e8). Click here to learn what that means.
The diff coverage is 92.68%.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop    #1630   +/-   ##
==========================================
  Coverage           ?   66.94%           
==========================================
  Files              ?       78           
  Lines              ?    11263           
  Branches           ?     1575           
==========================================
  Hits               ?     7540           
  Misses             ?     3400           
  Partials           ?      323
Impacted Files Coverage Δ
azurelinuxagent/common/protocol/util.py 72.77% <33.33%> (ø)
azurelinuxagent/common/protocol/imds.py 96.29% <97.36%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c453e8...35c8451. Read the comment docs.

tests/protocol/test_imds.py Outdated Show resolved Hide resolved
Copy link
Contributor

@larohra larohra left a comment

Choose a reason for hiding this comment

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

LGTM but you should make sure that this PR is reviewed by Norberto first before merging.

Copy link
Contributor

@pgombar pgombar left a comment

Choose a reason for hiding this comment

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

LGTM

@ghost ghost requested review from pgombar, larohra and narrieta September 25, 2019 18:57
Copy link
Member

@narrieta narrieta left a comment

Choose a reason for hiding this comment

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

A few comments, thanks

azurelinuxagent/common/protocol/imds.py Outdated Show resolved Hide resolved
azurelinuxagent/common/protocol/imds.py Outdated Show resolved Hide resolved
try:
resp = self._http_get(endpoint=endpoint, resource_path=resource_path, headers=headers)
except HttpError as e:
logger.warn("Unable to connect to primary IMDS endpoint {0}", endpoint)
Copy link
Member

Choose a reason for hiding this comment

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

how often is get_matada invoked? this may have to be a periodic message to avoid flooding the log/serial console if the endpoint can't be reached

Copy link
Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

Done.

Copy link
Author

Choose a reason for hiding this comment

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

There are log messages that can potentially be made periodic in monitor.py that logs with IMDS is healthy or not.

I think it would require a new feature of periodic logging that accounts for state change where IMDS health can change states (flip between healthy and unhealthy). We'd want to capture that state change in the logs, which should be rare making periodic logging meaningful and desirable most of the time.

Let me know your thoughts. Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I have also seen sections of the code where periodic logging with state changes is needed. Currently the state flip and logging is handled explicitly in that code. Next time I touch it I'll try to refactor this functionality to the logger.

azurelinuxagent/common/protocol/imds.py Outdated Show resolved Hide resolved
logger.warn("Unable to connect to backup IMDS endpoint {0}", endpoint)
if not self._regex_imds_ioerror.match(str(e)):
raise e
return False, "IMDS error in /metadata/{0}: Unable to connect to endpoint".format(resource_path)
Copy link
Member

Choose a reason for hiding this comment

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

should we add the HttpError to this message?

Copy link
Author

Choose a reason for hiding this comment

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

I don't feel that verbosity would help since the HttpError message is long and only provides "IOError timed out" within it and seems to be vague and not 100% accurate. There was no wait and the return was almost instant when running my tests on a VM.

I try to summarize the connection issue with a (possibly too simple) "Unable to connect to endpoint" message. I can change this as desired but I don't think the HttpError message adds value.

Copy link
Member

Choose a reason for hiding this comment

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

If we need to debug an error here, is there anything useful we can add on top of "Unable to connect to endpoint"?

Copy link
Author

Choose a reason for hiding this comment

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

This currently captures everything IMDS team needs for troubleshooting. Please provide an example of what you have an mind.

Any additional info that can potentially help with root cause analysis is always welcome and appreciated.

tests/protocol/test_imds.py Show resolved Hide resolved
tests/protocol/test_imds.py Outdated Show resolved Hide resolved
@ghost ghost requested review from larohra and narrieta October 2, 2019 17:21
Copy link
Contributor

@larohra larohra left a comment

Choose a reason for hiding this comment

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

LGTM
Please wait for Norberto's approval before merging

@narrieta narrieta merged commit 6a970c9 into Azure:develop Oct 4, 2019
@ghost ghost deleted the hs_fallback branch October 5, 2019 03:38
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.

4 participants