Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Cleaning up and streamlining config files #1137

Merged
merged 12 commits into from
Aug 1, 2024

Conversation

amart241
Copy link
Collaborator

@amart241 amart241 commented Jun 3, 2024

Cleaning up and streamlining config files

🗣 Description

I have formatted the sample config files to be more streamlined. I have also added the other EntraID exclusions that are now available for AAD

💭 Motivation and context

The sample configs have been updated and not streamlined in a while and needed a refresh.
I removed extra references to other baselines in baseline specific sample files and added a more detailed and standardized description. This resolves #1075

🧪 Testing

Sample config files no code was changed

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@amart241 amart241 added the documentation This issue or pull request improves or adds to documentation label Jun 3, 2024
@amart241 amart241 added this to the Halibut milestone Jun 3, 2024
@amart241 amart241 requested review from rgbrow1949 and schrolla June 3, 2024 17:16
@amart241 amart241 self-assigned this Jun 3, 2024
@james-garriss
Copy link
Collaborator

The previous config files are referenced in the new-and-improved readme. Please read through the readme to make sure that the documentation is still accurate. ATM, you can find this on the 877 branch:
https://github.com/cisagov/ScubaGear/tree/877-streamline-the-docs
Look in /docs/configuration/configuration.md
Thanks!

Copy link
Collaborator

@schrolla schrolla left a comment

Choose a reason for hiding this comment

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

@amart241 The pre-approval section of the checklist is not complete and the ones that are checked, I would argue, are not complete since the PR title doesn't yet reflect a human-readable title (still the default) and the branch has not yet been rebased against main. Recommend completing the pre-approval checklist and then re-requesting reviews at that time.

@schrolla schrolla modified the milestones: Halibut, Iceberg Jun 6, 2024
@amart241 amart241 force-pushed the 1075-clean-up-sample-config-files branch from 631a5a0 to e1a3d16 Compare June 13, 2024 14:13
@amart241 amart241 changed the title 1075 clean up sample config files Cleaning up and streamlining config files Jun 13, 2024
@schrolla schrolla force-pushed the 1075-clean-up-sample-config-files branch from 1c392a8 to 11c6991 Compare July 15, 2024 14:06
@schrolla
Copy link
Collaborator

@amart241 Any updates on this PR? It's been in "New" state with no updates for a month.

@amart241
Copy link
Collaborator Author

@amart241 Any updates on this PR? It's been in "New" state with no updates for a month.

Just got back this week from being sick and lots of trips. Working on this afternoon to get this resolved.

@amart241 amart241 force-pushed the 1075-clean-up-sample-config-files branch from 11c6991 to d0971bd Compare July 18, 2024 18:17
@schrolla schrolla force-pushed the 1075-clean-up-sample-config-files branch from d0971bd to d9b425f Compare August 1, 2024 14:00
Copy link
Collaborator

@schrolla schrolla left a comment

Choose a reason for hiding this comment

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

Re-reviewed and recommending a number of misspelling clean ups and clarifications. See below for details.

PowerShell/ScubaGear/Sample-Config-Files/aad-config.yaml Outdated Show resolved Hide resolved
PowerShell/ScubaGear/Sample-Config-Files/basic_config.yaml Outdated Show resolved Hide resolved
PowerShell/ScubaGear/Sample-Config-Files/creds_config.yaml Outdated Show resolved Hide resolved
PowerShell/ScubaGear/Sample-Config-Files/creds_config.yaml Outdated Show resolved Hide resolved
PowerShell/ScubaGear/Sample-Config-Files/full_config.yaml Outdated Show resolved Hide resolved
@amart241 amart241 force-pushed the 1075-clean-up-sample-config-files branch from 354e2c3 to bbb2314 Compare August 1, 2024 14:59
@amart241 amart241 requested a review from schrolla August 1, 2024 15:00
Copy link
Collaborator

@schrolla schrolla left a comment

Choose a reason for hiding this comment

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

Looks good after updates.

@schrolla schrolla requested a review from buidav August 1, 2024 19:50
@schrolla schrolla force-pushed the 1075-clean-up-sample-config-files branch from 2487f96 to c6a9092 Compare August 1, 2024 19:51
@buidav buidav removed the request for review from rgbrow1949 August 1, 2024 20:29
Copy link
Collaborator

@buidav buidav left a comment

Choose a reason for hiding this comment

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

Approving as the original issue was just to clean up the original config files.

However, I'm noticing how confusing our current documentation is and how the sample config file examples spread the currently available syntax for setting per product exclusions and omissions into multiple different files.

Created #1254 to create one unified file someone can look at to understand all the possible config file values they have to fill in order to pass certain policy checks for Dender and/or AAD and how to do policy omissions.

amart241 and others added 6 commits August 1, 2024 16:45
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
Co-authored-by: Addam Schroll <108814318+schrolla@users.noreply.github.com>
@schrolla schrolla force-pushed the 1075-clean-up-sample-config-files branch from c6a9092 to 4ad05d6 Compare August 1, 2024 21:45
@schrolla
Copy link
Collaborator

schrolla commented Aug 1, 2024

@nanda-katikaneni This PR is ready for merge.

@nanda-katikaneni nanda-katikaneni merged commit 6ed1b16 into main Aug 1, 2024
29 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1075-clean-up-sample-config-files branch August 1, 2024 22:34
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up sample config files
5 participants