salt icon indicating copy to clipboard operation
salt copied to clipboard

Fix grains metadata on EC2

Open tomdoherty opened this issue 4 years ago • 9 comments

What does this PR do?

Fixes issue with grains.get meta-data and gzipped meta-data on AWS EC2

What issues does this PR fix or reference?

Fixes: #59541

Previous Behavior

salt crashes

New Behavior

salt continues to work and adds valuable meta-data to grains

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

  • [ ] Docs
  • [ ] Changelog - https://docs.saltproject.io/en/master/topics/development/changelog.html
  • [ ] Tests written/updated

Commits signed with GPG?

No

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

tomdoherty avatar Sep 17 '21 10:09 tomdoherty

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey. Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar. If you have additional questions, email us at [email protected]. We’re glad you’ve joined our community and look forward to doing awesome things with you!

welcome[bot] avatar Sep 17 '21 10:09 welcome[bot]

Hi @gtmanfred

Could you kindly take a look at this?

Thank you

tomdoherty avatar Sep 17 '21 10:09 tomdoherty

bump @tomdoherty did you see my review comments?

Ch3LL avatar Mar 09 '22 20:03 Ch3LL

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings! When I was created we had a lot of these. The documentation for these modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that you would be the most familiar with this module and be able to add some other examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you can't add those other examples, either because you're too busy, or unfamiliar, or you just aren't interested, we still appreciate the contributions that you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- duration: 1.35s
- exit code: 1

The function 'metadata' on 'salt/grains/metadata.py' does not have a docstring Found 1 errors


Thanks again!

github-actions[bot] avatar Mar 16 '22 20:03 github-actions[bot]

Thanks for approving this @Ch3LL! When can we expect it to make it into a release?

tomdoherty avatar Mar 16 '22 20:03 tomdoherty

The only 3 remaining items is:

  1. Get two more approvals. Since this PR does not have test coverage 2 other core members have to approve it not having test coverage. I have requested the other reviews.
  2. Tests pass
  3. Then we can merge and it will be included in the 3005 release if merged in before April 11th.

Ch3LL avatar Mar 16 '22 20:03 Ch3LL

Wonderful! Thanks for all the help with this

tomdoherty avatar Mar 16 '22 20:03 tomdoherty

Question: this definitely appears to be a fix, but is it the best fix?

Is it possible to check the headers and detect that the content is gzipped and un-gzip it? Is that something we're doing elsewhere?

waynew avatar Mar 16 '22 21:03 waynew

bump @tomdoherty did you see @waynew 's comment?

Ch3LL avatar Sep 21 '22 18:09 Ch3LL

closing due to inactivity. Please let me know if this needs to be re-opened or open a new PR with a response to @waynew 's feedback.

Ch3LL avatar Oct 11 '22 20:10 Ch3LL