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 a sample config config file that includes all possible parameters including per product namespace parameters #1254

Open
buidav opened this issue Aug 1, 2024 · 1 comment
Labels
documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@buidav
Copy link
Collaborator

buidav commented Aug 1, 2024

💡 Summary

When looking at the full_config.yaml sample config file.

I expected to see a config file containing all possible config files values including per product namespace variables (aad, defender), omitting polices, etc.

However, it only contains all of our general parameters.
The "full" name now is misleading.

Motivation and context

The config file is required to meet policy checks in AAD and Defender.
We should have an example config file containing every possible value.
For ease of viewing and understanding.
Without having a user have to pull up multiple sample config files to understand the options available to them.

Implementation notes

Create a sample SCuBA Config file to stick in our sample folder and point to in our config file documentation.

Stick the sample config file in the current sample config file folder located here
PowerShell/ScubaGear/Sample-Config-Files

Our New-SCuBAConfig cmdlet can be used to generate this file.
It is located in PowerShell/ScubaGear/Modules/Support/Support.psm1
Update New-SCuBAConfig for any missing parameters and clean up any artifacts there

I'm also noticing dead code located in that function.
deadCode

Acceptance criteria

  • When an example of a full SCuBA config is in the sample config folder with documentation updated to point to it.
  • New-SCuBAConfig is updated with dead code removed.
@buidav buidav added documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality labels Aug 1, 2024
@schrolla
Copy link
Collaborator

schrolla commented Aug 1, 2024

Concur with this approach. I imagine a heavily commented config file presenting all available options and what each one means so it's self-documenting for the most part. If you've ever looked at something like an Apache httpd.conf, something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants