Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-09-21 06:51:56 +00:00
Code Issues Projects Releases Packages Wiki Activity
3810 commits 430 branches 1882 tags 70 MiB
Commit graph

272 commits

Author SHA1 Message Date
Dominik Richter
f9248033c3 render resource docs 2016-09-22 16:47:58 +02:00
Dominik Richter
dba8638e3a ignore auto-generated docs 2016-09-22 16:47:54 +02:00
Dominik Richter
67c990d19c add all partials for resources 2016-09-22 15:23:21 +02:00
Dominik Richter
5a5fa03321 add ruby usage in inspec as markdown 2016-09-22 15:06:04 +02:00
Dominik Richter
f179c88074 improve cli docs styling 2016-09-22 13:49:56 +02:00
Dominik Richter
a4982fc4f1 generate docs for cli 2016-09-22 13:43:57 +02:00
Christoph Hartmann
0e7c534ea7 1.0.0.beta2 2016-09-22 11:33:43 +02:00
Dominik Richter
c8638f9917 update docs to markdown 
run 2/3
 2016-09-22 10:16:16 +02:00
Jake Gage
6de1c47b72 Fix minor typo in documentation 2016-09-15 15:27:44 -05:00
Michał Sochoń
52b5b59b87 Extend Inspec DSL docs (#1006) 
Update dsl_inspec.rst
 2016-09-01 23:11:10 +02:00
Alex Pop
fd676ceb5c promote cmp usage as it provides results with octal mode 2016-08-30 18:23:47 +01:00
Steven Danna
f9952d922a Reformat service resource docs for discoverability 
This makes the service-manager-specific resources stand out a bit more
in the documentation.

Signed-off-by: Steven Danna <steve@chef.io>
 2016-08-26 11:23:59 +02:00
Steven Danna
91fa58f421
Generate documentation for the vendor command 
This was generated using `rake docs:cli`.
 2016-08-26 09:33:19 +01:00
Victoria Jeffrey
eb3b80ff87 document ini resource 2016-08-26 09:54:40 +02:00
Tim Smith
0dbe816f57 Docs should reference family not platform 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Tim Smith
86247c012f Add missing platforms to the docs 
Signed-off-by: Tim Smith <tsmith@chef.io>
 2016-08-19 20:14:03 +02:00
Kartik Null Cating-Subramanian
83d9deda4f inspec shell documentation 2016-08-19 19:29:32 +02:00
Peter Burkholder
69a96665de Document awesome where syntax for port 2016-08-18 12:29:23 -04:00
Chris Evett
3df98b7a19 add iis_site tests and refactor post code review 2016-08-17 06:57:48 -04:00
Chris Evett
4d63afc1f8 add documentation to resources.rst for iis_site and fix comment 2016-08-17 06:57:48 -04:00
Dominik Richter
e637067c43 auto-genreate inspec cli docs 2016-08-12 13:40:59 +02:00
Patrick Münch
216a6aeac1 FIX: file(hba_config_file) test in documentation, it is not working and rubocop detect some issues 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-14 13:06:41 +02:00
Patrick Münch
19c449b158 change the Test for risky database entries example 
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
 2016-07-06 16:07:32 +02:00
Montague, Brent
faffc236dd Add array documentation to yaml / json resource 2016-06-21 18:06:27 -04:00
Nick Rycar
820cd1ae86 Updating ctl docs to include the init command 2016-06-21 11:27:56 -07:00
Christoph Hartmann
e2b707f51d add documentation for bash resource 2016-06-19 23:46:20 +02:00
Tim Smith
b2876bf2f4 Update documentation for matching output of commands 2016-05-31 13:56:31 -07:00
Christoph Hartmann
7515b488fd Merge pull request #754 from jeremymv2/sudo_command 
add sudo_command option
 2016-05-16 15:32:29 +02:00
Christoph Hartmann
9896278599 remove string quotes from regex 2016-05-16 11:33:13 +02:00
Lamont Granquist
452047011d remove string quotes around regexp 2016-05-16 11:31:58 +02:00
Jeremy J. Miller
cfcc06a379 fix spelling 2016-05-15 11:04:23 -04:00
Jeremy J. Miller
9795879628 add sudo_command option 2016-05-15 07:22:18 -04:00
Christoph Hartmann
48d8694789 Revert "fix contain_match, add none_match" 
This reverts commit 54b397f3a5.
 2016-05-11 23:47:24 +02:00
Alex Pop
54b397f3a5 fix contain_match, add none_match 
update matchers doc and add more integration tests
allow non-string data types and non-arrays
 2016-05-11 12:47:36 +01:00
Alex Pop
cef1856cdf sym to strings 2016-05-06 14:27:42 +01:00
Alex Pop
04411a1033 fix typo and resolve |json| 2016-05-06 14:27:42 +01:00
Alex Pop
7c0e9129fd remove requires and break things up a bit 2016-05-06 14:27:42 +01:00
Alex Pop
ed613da2d2 even more backticks 2016-05-06 14:27:42 +01:00
Alex Pop
f062c9c9d9 more backticks 2016-05-06 14:27:42 +01:00
Alex Pop
3893393f16 backticks 2016-05-06 14:27:42 +01:00
Alex Pop
dd0d32472f Added how to use ruby in inspec doc 2016-05-06 14:27:42 +01:00
Alex Pop
f78afe0d75 Use only strings in resource examples, docs and tests 2016-05-03 23:27:18 +01:00
Dominik Richter
9b199c9223 add regexp to cmp matcher 
i.e. `123 should { cmp /2+/ }`
 2016-04-20 11:57:31 -04:00
Dominik Richter
8da3157098 add grub_conf to docs 2016-04-17 10:57:31 -04:00
Christoph Hartmann
27357c8630 update documentation for json resource 2016-04-16 20:16:32 -04:00
Christoph Hartmann
7112ebbfec fix errors introduced in #593 2016-03-28 00:48:15 +02:00
Aaron Lippold
e846385866 Updated documentation and examples to include tags and references 2016-03-27 12:40:34 -04:00
Christoph Hartmann
f4180780d1 document tags and refs 2016-03-25 00:58:27 +01:00
Christoph Hartmann
e2466d0dbb rename script to powershell 2016-03-18 15:41:54 +01:00
Dominik Richter
94061a1b4b add documentation for describe.one 2016-02-25 14:30:27 +01:00
Dominik Richter
04d297f64d update docs for modified passwd resource 2016-02-18 16:10:42 +01:00
Dominik Richter
301a39d4f0 add matchers docs 2016-02-18 13:58:46 +01:00
Stephan Renatus
defd5b3fa6 docs for sysv runlevels and service{mgr,ctl} overrides 2016-02-17 12:55:09 +01:00
Dominik Richter
971d651551 change version constraints 
Move to a more mathematical representation of version numbers comparisons. The existing one is semantically correct, but may lead to slight confusion.
 2016-02-09 11:51:52 +01:00
Stephan Renatus
e5b88fc486 auditd_rules: suppress warning for centos 5; improve docs wording 2016-02-09 11:51:52 +01:00
Stephan Renatus
a5afbe7814 docs: typo in auditd_rules 2016-02-09 11:51:52 +01:00
Stephan Renatus
cbf8f3a2b1 update auditd_rules resource documentation 2016-02-09 11:51:52 +01:00
GeoFruck
128bd1fafe Update dsl_inspec.rst 
Corrected spelling, desrcibed -> described line 14
 2016-02-05 22:09:32 -06:00
Jeff Zohrab
b6ba1ad46c add doc links 2016-01-25 12:44:48 -05:00
Jeff Zohrab
10b760ff79 add doc code formatting 2016-01-25 12:44:48 -05:00
Jeff Zohrab
477ca568c9 fix typos 2016-01-25 12:44:48 -05:00
Tim Smith
820da7f943 Fix ssh_config example 2016-01-14 22:26:10 -05:00
Christoph Hartmann
7e7cf5a724 add documentation for mount resource 2016-01-03 00:03:24 +01:00
Dominik Richter
372ccb4e53 add supports RFC to profile docs 2015-12-31 16:30:26 +01:00
Dominik Richter
3c37ed02e0 add example links 2015-12-30 21:55:23 +01:00
Dominik Richter
3ed1ebeb9e add a description for custom resources 2015-12-29 21:05:22 +01:00
Dominik Richter
e5d424674c add standalone notice and remove filename pattern for controls 2015-12-28 12:53:42 +01:00
Dominik Richter
95382b5363 restructure profiles RFC document 2015-12-28 12:53:42 +01:00
Christoph Hartmann
a97b05bfc6 remove namespace form inspec.yml example 2015-12-28 12:53:42 +01:00
Christoph Hartmann
0ab46ff5b1 rename metadata.yml to inspec.yml 2015-12-28 12:53:42 +01:00
Christoph Hartmann
c1d2970c4a add documentation for manifest 2015-12-28 12:53:42 +01:00
Christoph Hartmann
ec4286d4ee docs: use tar.gz as default 2015-12-28 12:53:42 +01:00
Christoph Hartmann
42a102e3b4 docs: add documentation for profiles 2015-12-28 12:53:42 +01:00
troyready
0fc5a7a249 correct small typo 2015-12-11 13:05:22 -08:00
Christoph Hartmann
1ce1f26d76 update docs for auditd_conf 2015-12-11 17:28:51 +01:00
Christoph Hartmann
82b63bbce2 update documentation for auditd_conf and sshd_config 2015-12-11 17:10:17 +01:00
Stephan Renatus
1f1b035589 [resource/port] update documentation 2015-12-08 20:33:36 +01:00
Stephan Renatus
7a1cd660c3 [resources/processes] add users, states attribute; update docs 
processes('bash').user does not actually make much sense for a resource
that is a list -- different entries can belong to different users.
Analogous for processes('bash').state.

The attributes 'users' and 'states' expose the unique values
corresponding to that property of entries in the process list.

Fixes #295.
 2015-12-08 13:06:27 +01:00
Stephan Renatus
ae4420a736 add --json-config= and --diagnose flags to inspect configurations 
Because of the way per-command arguments are handled, this is a little
different from the way e.g. kitchen handles it: any inspec command can
take the flag `--diagnose` to have it dump configuration first.

This add support for a JSON configuration file, where both

  inspec detect --json-config=config.json

and

  inspec detect --json-config=- <config.json

allow for reading the JSON config. There is no validation of its keys
in place.
 2015-12-07 16:10:15 +01:00
Christoph Hartmann
cca75c5e8c align cli documentation with cli 2015-12-01 11:19:04 +01:00
Christoph Hartmann
5018e1e03e remove json doc for windows_feature 2015-11-30 15:18:26 +01:00
alexmanly
c114d2bcd2 Add -p alias for --port like ssh 2015-11-25 14:55:06 +01:00
Jason Reed
79eba9b4fa Add -i alias for --key_files like ssh 2015-11-25 07:10:11 -05:00
JJ Asghar
d1e35b37ec Added links to the different sections. 
- Reading the Doc probably want to use the list as an Table of Contents
  to jump to another section. This does that.
- Group isn't considered Unique in the doc, so the link goes to the same
  page.
 2015-11-19 15:22:15 +01:00
Stuart Preston
3ddd8e8243 OS resource requires a Symbol not a String 2015-11-07 11:56:01 +00:00
Zach Malone
0d35ead5b4 Fix should contain / should match confusion 
If attempting to use "contain" here, you get 
         [UNSUPPORTED] `contain` matcher. Please use the following syntax `its('content') { should match('value') }`.

it looks like this should say "should match".  This may effect other resources, but I've only tried file.
 2015-11-04 10:35:35 -07:00
Julian C. Dunn
8764dd0194 Fix doc typos 2015-11-04 11:38:39 +00:00
Fletcher Nichol
50930dc520 Fix package resource documentation example. 2015-11-04 00:30:02 +01:00
Dominik Richter
7dd7f29dee fix formatting of list 2015-11-03 19:30:50 +01:00
Dominik Richter
326965e7dc add inspec and friends, thank you @chris-rock, @nathenharvey, @colincam, @juliandunn 2015-11-03 19:29:13 +01:00
Christoph Hartmann
43194819e4 rename to control 2015-11-02 23:24:14 +00:00
jamescott
03303b4aba formatting, mostly ... also package => oneget 2015-11-02 00:55:05 -08:00
Dominik Richter
4c3dce0aec fix key-files option in docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
ee3e56adae update ssh docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
ad73a606ff update script and ssh docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
4e1029f65f update postgres and script docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
d44a917385 update port description 2015-11-02 02:06:14 +01:00
Christoph Hartmann
dc1959327f update description for passwd docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
ed092b6c0f update parse_config & passwd 2015-11-02 02:06:14 +01:00
Christoph Hartmann
bfcfe747a7 fix resource doc typos 2015-11-02 02:06:14 +01:00
Christoph Hartmann
64f1e5ee1e fix resource doc typos 2015-11-02 02:06:14 +01:00
Christoph Hartmann
e52e3b6753 update examples in docs 2015-11-02 02:06:14 +01:00
Christoph Hartmann
789b6cf83f fix typo in readme 2015-11-02 02:06:14 +01:00
Christoph Hartmann
afb9c2441a update cli options 2015-11-02 02:06:10 +01:00
Christoph Hartmann
f8302b6383 use ssh_config instead of sshd_conf 2015-11-02 01:53:49 +01:00
Dominik Richter
00e2d800e4 adjust documentation for api change to --sudo 2015-11-02 01:05:00 +01:00
Christoph Hartmann
2a400c37f7 update resource examples 2015-11-01 22:58:31 +01:00
jamescott
ca77f1285c add draft version of InSpec DSL topic 2015-11-01 22:58:31 +01:00
Christoph Hartmann
1941606b9e deactivate group policy for now 2015-11-01 22:39:30 +01:00
Christoph Hartmann
9e53556379 fix os_env example 2015-10-31 11:55:10 +01:00
Christoph Hartmann
e08f0b4d88 add abbreviations 2015-10-30 14:29:19 +01:00
jcreedcmu
801bc9700f Update ctl_inspec.rst 
Documentation appears to have been describing the state of the world before a62ce0e14b
 2015-10-30 12:44:30 +01:00
Jason Reed
5b6397fc25 Fix docs so they at least compile with rst2html.py 2015-10-30 07:28:40 -04:00
jamescott
5c22048caa sync words 
|inspec resource| = InSpec audit resource
 2015-10-27 23:26:42 +01:00
Christoph Hartmann
438dca1d28 improve docs for parse_config_file 2015-10-27 21:34:09 +01:00
Christoph Hartmann
178cf2564d remove postgres and mysql from resource docs for now 2015-10-27 21:34:09 +01:00
Christoph Hartmann
0e6a6296a3 remove to_i in its docs 2015-10-27 21:34:09 +01:00
Christoph Hartmann
7f3082f103 introduce stability index for resources 2015-10-27 21:34:08 +01:00
Christoph Hartmann
ebeac09036 extend docs introduction 2015-10-27 21:34:08 +01:00
Christoph Hartmann
164aad5b86 update index of resource docs 2015-10-27 02:26:19 +01:00
Christoph Hartmann
c9defc90c7 add reference to docker 2015-10-27 02:26:19 +01:00
Christoph Hartmann
a1943296cf docs cli change replacements 2015-10-27 02:26:19 +01:00
Christoph Hartmann
7443b388c2 remove docs done flag 2015-10-27 02:26:19 +01:00
jamescott
88ed679572 resource => audit resource 2015-10-26 16:29:57 -07:00
chef-delivery
040d745de1 Merge pull request #154 from chef/jscott/editresources 
Merged change d5d0afee-1500-49de-b7c4-0d8aadfff508

From review branch jscott/editresources into master

Signed-off-by: drichter <drichter@chef.io>
 2015-10-26 09:36:18 -07:00
jamescott
2186df2ea4 oops, postgresql only 2015-10-26 09:23:43 -07:00
jamescott
ecb2804529 update query syntax 2015-10-26 09:21:37 -07:00
Dominik Richter
6dc0a3b638 rename inetd_config -> inetd_conf 
be consistent with the filename
 2015-10-26 16:21:51 +01:00
Christoph Hartmann
25783ea283 fail with warning, if users use contain matcher 2015-10-24 11:15:53 +02:00
jamescott
e33008aee5 json => exec 2015-10-23 10:30:37 -07:00
jamescott
f34997c487 add InSpec CLI reference topic 2015-10-23 14:31:17 +02:00
jamescott
803efcdddc edit out words 
makes them more accurate in the unknown future
 2015-10-23 12:04:51 +02:00
jamescott
be367718b5 add iptables resource 2015-10-22 12:00:05 -07:00
jamescott
39323e278c add command resource 2015-10-22 10:39:52 -07:00
jamescott
5970473b9f add audit_policy resource 2015-10-22 10:10:13 -07:00
jamescott
e332c84db0 add auditd_rules resource 2015-10-21 23:11:46 -07:00
jamescott
b677e9840a add auditd_conf resource 2015-10-21 22:49:59 -07:00
jamescott
642024fc42 some review notes 2015-10-21 22:33:09 -07:00
jamescott
68f3a47500 add bond resource 2015-10-21 21:14:48 -07:00
jamescott
9707f8e911 remove "For example:" in front of syntax, matchers ... everywhere 2015-10-21 21:13:17 -07:00
jamescott
f5c928c0fc add directory resource 2015-10-21 19:52:52 -07:00
jamescott
8183ad6266 edit sentence for etc_group 2015-10-21 19:52:44 -07:00
jamescott
500aa5f2df add file resource + lots of matchers 2015-10-21 19:29:50 -07:00
jamescott
669245bf8f edit 2015-10-20 17:39:48 -07:00
jamescott
0dbcf0e282 add group_policy resource 2015-10-20 17:36:10 -07:00
jamescott
e26ed7e83b add group resource 2015-10-20 17:20:47 -07:00
jamescott
6ed5b7badd add etc_group resource 2015-10-20 16:51:48 -07:00
jamescott
d0a9438224 add CSV resource 2015-10-20 15:02:57 -07:00
jamescott
95559e7326 fix the header structure 2015-10-20 14:16:47 -07:00
jamescott
bd2d256726 add resources, sync matcher patterns 2015-10-20 14:04:07 -07:00