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
Christoph Hartmann
a48baf4ebd
move markdown docs to rst
2015-10-20 18:52:34 +02:00
jamescott
57e1abda10
update count and usernames matcher
2015-10-20 17:57:37 +02:00
jamescott
1a42e3fd19
add example to ntp_conf
2015-10-20 17:57:37 +02:00
jamescott
0ebcc5c5a6
add examples to audit_daemon_conf
2015-10-20 17:57:37 +02:00
jamescott
4e83383d84
add apache_conf and iptables
...
iptables only added to list of resources in intro
2015-10-20 17:57:36 +02:00
jamescott
6a655e14df
ssh => sshd
2015-10-20 17:57:36 +02:00
jamescott
a170927e3b
add more "done" resources
2015-10-20 17:57:36 +02:00
Christoph Hartmann
423bb09044
extend doc for service resource
2015-10-20 17:57:36 +02:00
Christoph Hartmann
2c2f396510
add doc for npm resource
2015-10-20 17:57:36 +02:00
Christoph Hartmann
9a600b8ffd
add doc for gem resource
2015-10-20 17:57:36 +02:00
Christoph Hartmann
40f474d387
add documentation for package resource
2015-10-20 17:57:36 +02:00
Christoph Hartmann
f50c8ac07a
rename audit to InSpec
2015-10-20 17:57:36 +02:00
Christoph Hartmann
b2edc2dde3
add apt resource
2015-10-20 17:57:36 +02:00
Christoph Hartmann
3e754e9ddf
split resources and template
2015-10-20 17:57:36 +02:00
jamescott
67c10f18a9
add first round of audit resource docs
2015-10-20 17:57:36 +02:00
Christoph Hartmann
cee48e8783
update docs
2015-10-07 16:57:56 +02:00
Dominik Richter
3ba8db9bb0
use blue color consistently on links
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:56 +02:00
Dominik Richter
7766a285c5
etc_group + inetd_conf update
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:55 +02:00
Dominik Richter
6faf271c5a
custom limits_conf paths
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:55 +02:00
Dominik Richter
b3973a43ba
clarify defaults
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:55 +02:00
Dominik Richter
70add8ca21
clarify custom paths
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:55 +02:00
Dominik Richter
47cfffdea1
initial
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2015-10-07 16:57:55 +02:00