Commit graph

307 commits

Author SHA1 Message Date
Nikita Mathur
80be8e0625 Added common errors page for inspec with only one error to get started
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-05-17 12:54:37 +05:30
Clinton Wolfe
d2665ed68a
Merge pull request #5514 from inspec/cw/toml-docs
Add basic docs for toml resource
2021-05-16 17:13:24 -04:00
Kannan Ramakrishnan
0745c3e183 Documentation wording changed. Added OS list link. Signed-off-by: @kannanr <kannaa.ram@gmail.com> 2021-05-16 02:43:51 +05:30
Kannan Ramakrishnan
19c624cf38 Support zfs_pool and zfs_dataset resources on Linux. Handled #5075. Signed-off-by: @kannanr <kannaa.ram@gmail.com> 2021-05-15 12:18:39 +05:30
Ian Maddaus
45356ca088 Docs editing
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
2021-05-10 14:48:43 -07:00
Clinton Wolfe
c52c60dea8
Merge pull request #5507 from inspec/im/netlify
Update Hugo and correct how build previews are generated
2021-05-10 16:48:14 -04:00
Clinton Wolfe
2bf2913a6c
Merge pull request #5504 from inspec/cw/document-reporter-opts
Document auxiliary reporter options on the reporter docs page
2021-05-10 16:42:55 -04:00
gscho
cccac97be6 Update example to use params properly
Signed-off-by: gscho <greg.c.schofield@gmail.com>
2021-05-10 09:16:38 -04:00
Clinton Wolfe
91c7568231 Add basic docs for toml resource
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-05-09 22:12:53 -04:00
Ian Maddaus
3b0ba2857b Convert headings to definition lists
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
2021-05-06 16:36:50 -07:00
Ian Maddaus
d1b84bda74 Update Hugo and correct how build previews are generated
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
2021-05-05 16:08:00 -07:00
Clinton Wolfe
e7cc5e94f2
Merge pull request #5490 from inspec/nm/inspec-automate
Added alias command `automate` for `inspec compliance`
2021-05-05 12:14:30 -04:00
Clinton Wolfe
f7ad4e6407 Document auxiliary reporter options on the reporter docs page
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-05-04 22:12:08 -04:00
Nikita Mathur
6d140b89b6 Review changes related to inspec compliance to be treated as backward compatible alias
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-05-04 19:04:54 +05:30
Ian Maddaus
d18520363b Fix bad link
Signed-off-by: Ian Maddaus <Ian.Maddaus@progress.com>
2021-05-03 10:48:11 -07:00
Nikita Mathur
072a8c438f Presenting automate command as alias in both the content and dev docs
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-05-03 13:45:56 +05:30
Nikita Mathur
a4d822ae43 Inspec automate command extended for compliances
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-30 17:20:03 +05:30
Clinton Wolfe
0fa00ed252
Merge pull request #5479 from inspec/nm/groups-members-fix
Added new property `members_array` for group & groups resources.
2021-04-28 12:33:02 -04:00
Clinton Wolfe
5f939ec0f9
Merge pull request #5483 from inspec/nm/groups-local-doc
Group & Groups doc updated - about using local and etc groups
2021-04-28 12:30:35 -04:00
Nikita Mathur
4d05db1a05 Doc review changes made for group and groups resource doc
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-28 12:25:10 +05:30
Nikita Mathur
03d72d4dc0 Doc change for groups related to members in non windows platform
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-27 21:16:47 +05:30
Nikita Mathur
52f1d6a002 Some doc improv added for group and groups resources
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-26 20:24:22 +05:30
Nikita Mathur
1a96a4f0a8 Group and groups doc updated clearly about local and etc groups
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-26 20:15:05 +05:30
Nikita Mathur
de718163e1 Doc review changes for group and groups resources
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-26 13:28:23 +05:30
Vasu1105
ecf60297b2 Updated docs as per review comments
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-26 12:42:51 +05:30
Nikita Mathur
b70f3166d4 New property members_array added for group and groups resources and updated documentation
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-23 13:48:29 +05:30
Vasu1105
622a4ed47c Few minor doc changes in the selinux readme
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-22 12:15:06 +05:30
Vasu1105
76dca7f97c Adds policy property, unit test and documentation for modules and booleans
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-22 11:40:32 +05:30
Clinton Wolfe
79aa03ae14
Merge pull request #5466 from inspec/nm/inputs-regex
New input option `pattern` added for DSL and metadata inputs
2021-04-21 19:34:07 -04:00
Nikita Mathur
ed312b07d3 Docs review changes in inputs doc for pattern
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-21 12:33:54 +05:30
Nikita Mathur
7fc144c4bf Doc changes for pattern flag in inputs
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-21 12:33:54 +05:30
Vasu1105
6f06669561 Integrated documentation review comments
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-21 11:43:03 +05:30
Vasu1105
790fe5612e Fixed copy paste
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-21 11:43:03 +05:30
Vasu1105
bd9d81314d Integrated review comments
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-21 11:43:02 +05:30
Vasu1105
cbe7e8c03f Add selinux resource with basic features support
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-04-21 11:43:02 +05:30
Clinton Wolfe
b3e367da57 Remove default of 3600 seconds for command timeout
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-04-20 13:32:33 -04:00
Clinton Wolfe
e673b332a3
Merge pull request #5465 from inspec/cw/source-in-reporter
Optionally include controls source code in CLI reporter
2021-04-20 13:24:15 -04:00
Tobias Balle-Petersen
73d0df4d02
Update postgres_ident_conf.md
pg_ident_conf.where changed to  postgres_ident.conf.where a few places.
2021-04-15 10:07:06 +02:00
Clinton Wolfe
bb8c51dbc7 Initial implementation of listing source in CLI reporter
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-04-13 21:05:53 -04:00
IanMadd
4c107b273d Docs editing
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
2021-04-12 16:35:54 -07:00
Nikita Mathur
6a5ad711ed Doc updated for shell on inputs from PR review
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-09 13:12:33 +05:30
Clinton Wolfe
c21055af62 Rename --ludicrous-speed to --filter-waived-controls and reword usage message
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-04-08 16:25:09 -04:00
Nikita Mathur
53810186dc Documentation for shell inputs added
Signed-off-by: Nikita Mathur <nikita.mathur@chef.io>
2021-04-08 13:54:12 +05:30
Clinton Wolfe
924ecd367f
Merge pull request #5445 from inspec/cw/add-docker-for-windows
Add --docker-url CLI option
2021-04-07 09:00:37 -04:00
Clinton Wolfe
ebc106c135
Merge pull request #5442 from inspec/im/update_platforms
Update platforms doc
2021-04-07 08:42:58 -04:00
Clinton Wolfe
8286ec8072
Merge pull request #5443 from inspec/cw/timeouts
Add timeout option to command resource
2021-04-04 22:25:09 -04:00
Clinton Wolfe
ee2f44e1cc Update docs-chef-io/content/inspec/cli.md
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
2021-04-04 21:50:41 -04:00
Clinton Wolfe
6ff6b9634a Add --docker-url CLI option
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-04-04 21:50:41 -04:00
Clinton Wolfe
2bba45f1a3
Apply docs suggestions from code review
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
2021-04-04 21:41:46 -04:00
IanMadd
56107c3312 Remove additional instances
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
2021-04-02 11:36:18 -07:00
Ian Maddaus
d20d8f9d90
Update inputs.md
Signed-off-by: Ian Maddaus <imaddaus@chef.io>

Remove setting input from Audit Cookbook
2021-04-02 10:51:19 -07:00
Clinton Wolfe
37ffdd27cb Docs for command ressource timeout
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-03-29 21:46:25 -04:00
IanMadd
bcf20a32b3 Update platforms doc
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
2021-03-24 12:57:32 -07:00
IanMadd
87a745b245 Improve resource page menu titles
Signed-off-by: IanMadd <Ian.Maddaus@progress.com>
2021-03-22 10:58:00 -07:00
Clinton Wolfe
f1e118cbaa
Merge pull request #5430 from issue-3181-json-reporter-passthrough-data 2021-03-19 10:24:22 -04:00
Alexander Stein
7f15e3c572 Update docs-chef-io/content/inspec/reporters.md
Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
Signed-off-by: Alexander Stein <astein@flexion.us>
2021-03-18 17:45:43 -04:00
IanMadd
47cc46315b Minor edits
Signed-off-by: IanMadd <imaddaus@chef.io>
2021-03-16 13:57:15 -07:00
Alexander Stein
00df9db166 Remove clumsy wording.
Signed-off-by: Alexander Stein <astein@flexion.us>
2021-03-15 15:43:14 -04:00
Alexander Stein
b315e5a5f0 Add docs per PR feedback.
Signed-off-by: Alexander Stein <astein@flexion.us>
2021-03-15 15:42:38 -04:00
yarick
e88e92bb66 Merge branch 'master' of https://github.com/inspec/inspec into auditd_conf_readers 2021-03-14 18:58:44 -04:00
Yarick Tsagoyko
050ac9a131
Added params and examples
For consistency with other resources, added getters - `conf_path, content, params`
2021-03-14 18:55:28 -04:00
Clinton Wolfe
27e4854663
Merge pull request #5425 from option-to-skip-empty-profile-report
Fixes #5373 : Add option to filter empty profiles from report
2021-03-10 12:07:19 -05:00
Clinton Wolfe
c7c09641ec
Apply suggestions from code review
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
2021-03-10 11:28:50 -05:00
wmetaw
ada064c732 Fix google_project_alert_policy Examples in the README
Signed-off-by: Ryo Takashima <lio114514@gmail.com>
2021-03-05 16:29:33 +09:00
Vasu1105
7dba4fa641 Fixes #5373 : Add option to filter empty profiles from report
Signed-off-by: Vasu1105 <vasundhara.jagdale@chef.io>
2021-03-04 22:09:48 +05:30
Clinton Wolfe
a1fdb1e999 Clarify include matcher on crontab resource
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-02-25 14:41:38 -05:00
Clinton Wolfe
58cfc31421
Apply suggestions from code review
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
2021-02-17 15:20:19 -05:00
Clinton Wolfe
f6af8b0da6 Document the json-automate reporter
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-02-15 18:45:17 -05:00
Clinton Wolfe
e27e035bf0
Update homebrew install instructions 2021-02-12 11:35:04 -05:00
Clinton Wolfe
31eceac8bc
Add metadata to each page in docs.chef.io/inspec, update Edit on GitHub 2021-02-12 11:25:18 -05:00
IanMadd
5bb65ad292 another link
Signed-off-by: IanMadd <imaddaus@chef.io>
2021-02-11 15:54:45 -08:00
IanMadd
fbd6c8df92 replace edit on github links generate link from partial
Signed-off-by: IanMadd <imaddaus@chef.io>
2021-02-10 12:25:35 -08:00
IanMadd
f2e6fda102 add search metadata to every page in docs.chef.io/inspec
Signed-off-by: IanMadd <imaddaus@chef.io>
2021-02-10 12:23:45 -08:00
Tom Duffield
add57014c3
Update install.md
The cask command has been deprecated. The same command now works with just `brew install chef/chef/inspec`.
2021-02-08 09:51:54 -06:00
IanMadd
805826b7f4 Fix dead links
Signed-off-by: IanMadd <imaddaus@chef.io>
2021-01-29 12:31:04 -08:00
Clinton Wolfe
408af711dd
Add option for --winrm-shell-type 2021-01-26 16:06:42 -05:00
Clinton Wolfe
f7ec1799c2
Add method_missing to nginx_conf 2021-01-26 15:58:48 -05:00
chrisbirster
c117f18808 clarify the inspec check command
Signed-off-by: chrisbirster <me@chris.website>
2021-01-08 18:00:47 +00:00
David Marshall
874ee77791 add test for when run is not specified in waiver
The existing documentation explicitly claims that not specifying “run” in a waiver is equivalent to specifying “run: false.” It turns out to be the case that the claim is completely false. This commit includes a test for a new control 18_waivered_no_expiry_default_run that behaves exactly like the control 04_waivered_no_expiry_ran_fails. That is, not specifying run in a waiver is the same as specifying “run: true.”

Signed-off-by: David Marshall <dmarshall@gmail.com>
2020-12-28 16:26:19 -08:00
Tim Smith
d2afc7c2f7 Replace DK with Workstation in docs
DK goes full EOL 12/31/2020

Signed-off-by: Tim Smith <tsmith@chef.io>
2020-12-16 16:08:54 -08:00
Clinton Wolfe
f5466687cc
parse_config - accept array notation to handle dots 2020-12-15 16:53:34 -05:00
IanMadd
a9a41240b6 Clean up docs previews
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-12-10 18:53:19 -08:00
mjingle
70ccecba90 Apply suggestions from the doc review
Signed-off-by: Raphael Geissert <atomo64@gmail.com>
2020-12-08 10:40:51 +01:00
Raphael Geissert
53a49aac64 Add missing options section to the parse_config documentation
Obvious fix, the section was missing. Complete it with an example
from parse_config_file.
2020-12-08 10:40:51 +01:00
Raphael Geissert
d76a5d4345 Move the options documentation under the correct section
Obvious fix, the options are not related to the matchers.
2020-12-08 10:40:51 +01:00
Raphael Geissert
4872ddb780 Accept arrays in parse_config's method_missing
A single-element array allows Rspec's its behaviour to be worked around
and allow options containing dots to be tested using its.

This is already implemented by resources such as `json` and those based
on it (e.g. xml).

Related to issue #875.

Signed-off-by: Raphael Geissert <atomo64@gmail.com>
2020-12-08 10:40:51 +01:00
Raphael Geissert
c4d3dadfad Apply grammar suggestions from doc review
Obvious fix.

Co-authored-by: mjingle <mjinglewski@chef.io>
2020-12-08 10:38:56 +01:00
Raphael Geissert
cb8cf42185 Fix the example of the nginx_conf resource
Obvious fix.
2020-12-08 10:38:56 +01:00
Raphael Geissert
0bde654b3a Add method_missing helpers to nginx_conf
This allows a similar syntax to that available on other resources.

Signed-off-by: Raphael Geissert <atomo64@gmail.com>
2020-12-08 10:38:56 +01:00
superyarick
eb44673c37 Addressed comments under PR Review
Signed-off-by: superyarick <yarick@yarick.net>
2020-12-01 18:25:10 -05:00
superyarick
c653ce343a added platform-name wildcard support
added unit test for platform-name wildcard
added doc for release wildcard
added doc for platform-name wildcard

Signed-off-by: superyarick <yarick@yarick.net>
2020-11-08 15:24:43 -05:00
Konrad Schieban
1158e51dac replace deprecated attributes section with inputs
Signed-off-by: Konrad Schieban <kschieban@google.com>
2020-11-02 11:47:04 -05:00
Pete Higgins
e11031351b Fix links on plugins docs page.
Signed-off-by: Pete Higgins <pete@peterhiggins.org>
2020-10-22 16:53:15 -07:00
IanMadd
1fca289f85 Update Hugo version to 0.76.4
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-10-13 14:31:06 -07:00
Nick Schwaderer
19992035e9
Merge pull request #5269 from unixengineer/master
Added another example to illustrate use for only_if
2020-10-13 08:48:18 +01:00
Ramprasad Prabhakar
1136972fd4 Added another example to illustrate use for only_if
Signed-off-by: Ramprasad Prabhakar <unixengineer@gmail.com>
2020-10-02 16:43:43 -07:00
unixengineer
40a64ad0cd
Update dsl_inspec.md 2020-09-29 13:25:09 -07:00
IanMadd
651b95183e Fix Edit on GitHub links
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-29 09:27:10 -07:00
Catriona Malone
36f4289441 Add option for winrm-shell-type
Signed-off-by: Catriona Malone <cmalone@chef.io>
2020-09-25 15:38:11 +01:00
Clinton Wolfe
b3f72f5854 Implement a corrected junit2 reporter that can be validated
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2020-09-22 11:40:01 +01:00
IanMadd
6a592a6db2 Update various readmes and docs
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 14:09:23 -07:00
IanMadd
5b3e16aa63 PR #5211
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:49 -07:00
IanMadd
4715770693 PR #5054
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:49 -07:00
IanMadd
b03d3f54f8 PR #5040
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:49 -07:00
IanMadd
18af8bbfb1 PR #4979
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:49 -07:00
IanMadd
322f262d57 PR #5171
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:49 -07:00
IanMadd
08a8b9e509 Move docs from www to docs-chef-io
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 13:53:40 -07:00