WARNING: This is very much a WIP
- Description
- Setup - The basics of getting started with cis_module_gen
- Usage - Configuration options and additional functionality
Briefly tell users why they might want to use your module. Explain what your module does and what kind of problems users can solve with it.
This should be a fairly short description helps the user decide if your module is what they want.
- Install the PDK
- Clone this repo locally
- Download the desired CIS benchmark .xls file. For example
CIS_Microsoft_Windows_Server_2016_RTM_Release_1607_Benchmark_v1.1.0.xls
- Change directory into the cloned module
pdk bundle install --with development
pdk bundle exec ruby lib/generate.rb
The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.
Run the following from within the cloned repo:
pdk bundle exec ruby lib/generate.rb -s ~/Downloads/CIS_Microsoft_Windows_Server_2016_RTM_Release_1607_Benchmark_v1.1.0.xls -v server2016 -n windows
This will parse the benchmark excel ~/Downloads/CIS_Microsoft_Windows_Server_2016_RTM_Release_1607_Benchmark_v1.1.0.xls
to create the following dir structure:
manifests/
└── server2016
├── level_1
│ ├── domain_controller
│ │ ├── account_policies.pp
│ │ ├── administrative_templates_computer.pp
│ │ ├── administrative_templates_user.pp
│ │ ├── advanced_audit_policy_configuration.pp
│ │ ├── local_policies.pp
│ │ └── windows_firewall_with_advanced_security.pp
│ └── member_server
│ ├── account_policies.pp
│ ├── administrative_templates_computer.pp
│ ├── administrative_templates_user.pp
│ ├── advanced_audit_policy_configuration.pp
│ ├── local_policies.pp
│ └── windows_firewall_with_advanced_security.pp
├── level_2
│ ├── domain_controller
│ │ ├── administrative_templates_computer.pp
│ │ ├── administrative_templates_user.pp
│ │ └── local_policies.pp
│ └── member_server
│ ├── administrative_templates_computer.pp
│ ├── administrative_templates_user.pp
│ └── local_policies.pp
└── next_generation_windows_securit
└── administrative_templates_computer.pp
In the Limitations section, list any incompatibilities, known issues, or other warnings.