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 shell script to gather log data via SSM #31

Merged
merged 7 commits into from
Mar 15, 2023

Conversation

dav3r
Copy link
Member

@dav3r dav3r commented Mar 8, 2023

πŸ—£ Description

This PR adds an "extras" directory containing a shell script that can be used to fetch the ClamAV scan log data from a list of AWS EC2 instances via SSM.

πŸ’­ Motivation and context

This addresses the issue raised in #30. I will leave it up to discussion whether or not this PR is enough for us to close out #30.

πŸ§ͺ Testing

I ran the script several times and verified that it worked as expected. I also tested the script with no arguments and with -h and with --help and confirmed that the usage text was displayed as intended.

βœ… Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • All new and existing tests pass.

βœ… Pre-merge checklist

  • Finalize version.

βœ… Post-merge checklist

  • Create a release.

@dav3r dav3r added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Mar 8, 2023
@dav3r dav3r requested a review from felddy as a code owner March 8, 2023 18:20
@dav3r dav3r self-assigned this Mar 8, 2023
extras/clamav_log_report.sh Show resolved Hide resolved
dav3r and others added 2 commits March 9, 2023 09:28
Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov>
Copy link
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

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

Seems like a reasonable path to provide this functionality. I will say, for the sake of discussion, that I don't think this resolves #30 as I would like native support in the package. We may want to explore offerings like community.aws.aws_ssm connection to support this kind of connectivity natively.

@dav3r
Copy link
Member Author

dav3r commented Mar 15, 2023

I will say, for the sake of discussion, that I don't think this resolves #30 as I would like native support in the package. We may want to explore offerings like community.aws.aws_ssm connection to support this kind of connectivity natively.

I'm fine with leaving #30 open. For what it's worth, I played around with community.aws.aws_ssm connection in the past and couldn't get it to work as I had hoped here, but it looks like there have been some updates since then. I updated the description in #30 to mention community.aws.aws_ssm connection in the "Implementation notes" section.

PS: I believe the issue was that community.aws.aws_ssm connection did not allow me to supply the --parameters data when attempting to start an SSM session.

@dav3r dav3r merged commit ae8d553 into develop Mar 15, 2023
@dav3r dav3r deleted the improvement/add-ssm-script branch March 15, 2023 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants