Open buidav opened 3 months ago
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.
💡 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 inPowerShell/ScubaGear/Modules/Support/Support.psm1
UpdateNew-SCuBAConfig
for any missing parameters and clean up any artifacts thereI'm also noticing dead code located in that function.
Acceptance criteria
New-SCuBAConfig
is updated with dead code removed.