Dominik Richter
5d1765c9bb
add inspec.profile.file(...)
for profile files
...
Fixes https://github.com/chef/inspec/issues/1396
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-05-03 20:39:27 +02:00
Adam Leff
bc2458bf5a
Fix YAML resource documentation
...
The `yaml` resource documentation was missing many clues that users
need to successfully use the resource.
Signed-off-by: Adam Leff <adam@leff.co>
2017-05-01 16:16:00 -05:00
Adam Leff
d95d666bc9
Fix ServerSpec migration doc rendering
...
RedCarpet table rendering was not enabled, and we need to treat
the resource names as code to avoid resources with two underscores
from being rendered as partial italics.
Signed-off-by: Adam Leff <adam@leff.co>
2017-05-01 15:18:49 -05:00
Grant Ridder
4daf948eec
Converge inspec doesn't have yet from comma seperated list to bullet list
...
Signed-off-by: Grant Ridder <shortdudey123@gmail.com>
2017-05-01 10:10:40 -07:00
Grant Ridder
82a478f2ba
Improve "Which Serverspec resources are available in InSpec?" doc
...
- Switch serverspec and inspec resource compare to a table and fix the links
- Add links for serverspec resources not in inspec
Serverspec to InSpec markdown table generated with:
```
mapping = {
bond: 'bond',
bridge: 'bridge',
command: 'command',
cron: 'crontab',
docker_container: 'docker_container',
docker_image: 'docker_image',
file: 'file',
group: 'group',
host: 'host',
interface: 'interface',
iis_website: 'iis_website',
iis_app_pool: 'iis_website',
iptables: 'iptables',
kernel_module: 'kernel_module',
linux_kernel_parameter: 'kernel_parameter',
mysql_config: 'mysql_conf',
package: 'package',
port: 'port',
ppa: 'apt',
process: 'processes',
service: 'service',
user: 'user',
windows_feature: 'windows_feature',
windows_registry_key: 'registry_key',
x509_certificate: 'x509_certificate',
yumrepo: 'yum',
zfs: 'zfs_pool'
}
serverspec_base = 'http://serverspec.org/resource_types.html# '
inspec_base = "https://www.inspec.io/docs/reference/resources/ "
serverspec_max = serverspec_base.length + mapping.max_by{|k,v| k.length}[0].length * 2 + 4
inspec_max = inspec_base.length + mapping.max_by{|k,v| v.length}[1].length * 2 + 5
serverspec_header_half = ' ' * ((serverspec_max - 'Serverspec'.length) / 2)
inspec_header_half = ' ' * ((inspec_max - 'InSpec'.length) / 2)
puts "| #{serverspec_header_half}Serverspec#{serverspec_header_half} | #{inspec_header_half}InSpec#{inspec_header_half} |"
puts "|:#{'-' * serverspec_max}:|:#{'-' * inspec_max}:|"
mapping.each do |serverspec, inspec|
serverspec_text = "[#{serverspec}](#{serverspec_base}#{serverspec})"
padding = serverspec_max - serverspec_text.length
serverspec_string = serverspec_text + ' ' * padding
inspec_text = "[#{inspec}](#{inspec_base}#{inspec}/)"
padding = inspec_max - inspec_text.length
inspec_string = inspec_text + ' ' * padding
puts "| #{serverspec_string} | #{inspec_string} |"
end
```
Signed-off-by: Grant Ridder <shortdudey123@gmail.com>
2017-04-28 15:03:04 -07:00
Adam Leff
a1769cc01b
Update inspec.io references in docs/code
...
The website is now at https://www.inspec.io - updating all inspec.io
references accordingly. :)
Signed-off-by: Adam Leff <adam@leff.co>
2017-04-27 18:05:51 -04:00
Adam Leff
5c63210390
Merge pull request #1726 from chef/dr/ports-doc-cmp
...
use cmp in port docs instead of eq
2017-04-26 18:22:27 -04:00
Dominik Richter
84a59cab50
use cmp in port docs instead of eq
...
Fixes https://github.com/chef/inspec/issues/438
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-27 00:17:34 +02:00
Dominik Richter
1dafe50bd9
rename SimpleConfig / parse_config / parse_config_file options
...
See https://github.com/chef/inspec/issues/1709
Fixes https://github.com/chef/inspec/issues/1709
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-26 23:18:40 +02:00
Dominik Richter
a7771a4ebc
describe the value ranges of impact
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-25 19:01:16 +02:00
Dominik Richter
6b2532224b
add podcast link to docs on serverspec-inspec
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-25 15:49:56 +02:00
Dominik Richter
ec05c16797
reference docs to other tools in readme
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-25 15:44:33 +02:00
Christoph Hartmann
218bda9c34
Docker resource ( #1566 )
...
* add docker, docker_container, and docker_image resources
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-04-24 10:47:03 -04:00
Richard Shade
532efccf0e
showing how to shellout in docs ( #1689 )
...
* showing how to shellout in docs
Signed-off-by: Richard Shade <rshade@rightscale.com>
2017-04-21 13:47:28 -04:00
Adam Leff
cdfabd9362
Fix docs pages for x509_certificate and key_rsa
...
These files were not named correctly and the docs rake task
was not picking them up.
Signed-off-by: Adam Leff <adam@leff.co>
2017-04-21 07:22:12 +02:00
Dominik Richter
02e435b6d0
add rabbitmq config resource
...
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-04-12 20:51:12 +02:00
Christoph Hartmann
afc7859fdb
add documentation for registry_key backslashes and #1281
...
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-04-07 10:57:02 +02:00
Dominik Richter
7562138248
Merge pull request #1623 from chef/adamleff/http-resource-warning
...
[www] Add warning to the http resource documentation
2017-04-05 16:41:08 +02:00
Doc Walker
692e660140
Fix #1617 Add dh_params resource ( #1618 )
...
* Fix #1617 Add dh_params resource
Signed-off-by: Doc Walker <4-20ma@wvfans.net>
2017-04-04 10:34:09 -04:00
Adam Leff
6b49303136
Add warning to the http resource documentation
...
Currently, the `http` resource only operates on the node on which
`inspec exec` is run, even if the user uses the `--target` flag.
This has caused some confusion in the community.
Until this can be fixed, this change adds a warning to the documentation.
Signed-off-by: Adam Leff <adam@leff.co>
2017-04-03 17:21:15 -04:00
Adam Leff
fba3c68281
Fix protocols matcher text on ssl resource docs
...
The `protocols` matcher section on the `ssl` resource
doc page fell victim to some copy/paste. This change
updates the text to the correct description.
Signed-off-by: Adam Leff <adam@leff.co>
2017-04-03 15:21:08 -04:00
Adam Leff
1cf80737ad
Yum resource fix for non-existent repos and repo info
...
If a repo did not exist, running matchers against it (such as `exist`)
were failing due to a bug in `#to_s` when fetching the repo name. The
`info` method would return nil and we'd still try to treat it as a hash.
This change ensures that info is always a hash, possibly empty if the
repo doesn't exist, and uses the repo name provided by the user rather
than shortening it to be consistent with our other resources which don't
manipulate the user input in the formatter.
Also added a method_missing to allow users to interrogate repo options,
such as baseurl or gpgcheck.
Signed-off-by: Adam Leff <adam@leff.co>
2017-03-29 10:42:25 +02:00
Adam Leff
5a12cddc9c
Add docs for habitat CLI commands
...
Adding a dedicated page for the InSpec/Habitat integration which
explains what it is, and details the commands a user needs to use
the integration.
Signed-off-by: Adam Leff <adam@leff.co>
2017-03-28 13:59:38 -04:00
joe.nuspl
1ab80ea052
Extend gem
to take an optional gem_binary
...
Allows one to test whether gems are installed into an omnibus environment.
Signed-off-by: Joe Nuspl <nuspl@nvwls.com>
2017-03-24 22:28:42 -07:00
Christoph Hartmann
d2f000e435
refactor x509 resources and rsa key
...
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-03-22 11:44:32 +01:00
Richard Nixon
f66f0b3a18
Initial support for x509_certificate and rsa_key
...
* Includes unit tests
* Includes 2 new resources
* Includes documentation
Signed-off-by: Richard Nixon <richard.nixon@btinternet.com>
2017-03-22 10:00:48 +01:00
Adam Leff
bf36c0a7a7
Merge pull request #1555 from nvtkaszpir/patch-1
...
Update file.md with example how to test symlinked files
2017-03-15 09:00:32 -05:00
Michał Sochoń
7a935a204e
Update file.md with example how to test symlinked files.
...
Added detailed example why and how.
Updated with suggestions from Adam Leff.
Signed-off-by: Michał Sochoń <kaszpir@gmail.com>
2017-03-15 07:53:14 +01:00
Adam Leff
8155357d0a
Add additional example for matching crontab commands
...
As raised in #1526 , adding an additional example showing how
a user can use the `where` accessor to find commands matching
a pattern and write a test using the results.
Signed-off-by: Adam Leff <adam@leff.co>
2017-03-14 22:16:39 +01:00
Adam Leff
7667c9cb0a
Merge pull request #1525 from spiffytech/patch-1
...
windows_task docs: Correct syntax error and misspelled word
2017-03-08 15:03:15 -07:00
Tristan Escalada
27d94c5037
Fixing a typo
...
changing paht to be path.
2017-03-03 14:03:54 -05:00
Christoph Hartmann
e8e34c2ffe
fix ident in cmp matcher docs
...
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-03-02 12:28:50 +01:00
spiffytech
152f056335
windows_task docs: Correct syntax error and misspelled word
2017-03-01 13:43:26 -05:00
Joseph Benden
1fdecc6680
Add FreeBSD support for ZFS datasets and pools
...
The following new resources have been added; however, they
presently only support FreeBSD and similar.
* `zfs_dataset`: tests if a named ZFS dataset is present
and/or has certain properties.
* `zfs_pool`: tests if a named ZFS pool is present and/or
has certain properties.
Additionally, the `mount` resource has been reworked to
include support for FreeBSD; while the existing class
was renamed to LinuxMountParser.
Unit-tests were added for all of the above.
Signed-off-by: Joseph Benden <joe@benden.us>
2017-02-22 10:29:49 -07:00
Adam Leff
417b791baa
Adding new crontab resource
...
The crontab resource parses a particular user's crontab file into
individual entries and allows the user to assert information about
each entry as needed.
Signed-off-by: Adam Leff <adam@leff.co>
2017-02-10 09:33:31 -05:00
Christoph Hartmann
78b7a2c680
Merge pull request #1435 from postgred/kernel_module_version
...
Version method for kernel_module
2017-01-27 17:49:23 +01:00
Andrey Aleksandrov
3783357e50
Add version method to kernel_module
...
Signed-off-by: Andrey Aleksandrov <postgred@gmail.com>
2017-01-27 13:33:41 +03:00
Christoph Hartmann
976e5d85e4
improve http header handling
...
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-01-26 17:16:37 +01:00
Guilhem Lettron
51ca98c468
Add an http test method
...
Signed-off-by: Guilhem Lettron <g.lettron@criteo.com>
2017-01-26 12:02:54 +01:00
Christoph Hartmann
791f2db2e5
Merge pull request #1407 from gscho/rhel-doc-fix
...
Fixed error in OS docs, added CentOS to redhat family docs.
2017-01-25 12:13:51 +01:00
Nathen Harvey
2eda02932f
'execution' is spelled correctly
...
Fixes a minor typo. The correct spelling is 'execution', not
'executation'
Signed-off-by: Nathen Harvey <nharvey@chef.io>
2017-01-24 23:19:30 -05:00
techraf
3741cbe9d4
Fix resource name
2017-01-20 22:19:02 +09:00
techraf
a86b438ce4
Use double quotes to prevent escaping backslash in the expected string
2017-01-16 12:30:57 +09:00
gscho
3b7711adbc
Update os.md.erb
2017-01-08 19:59:02 -05:00
Gregory Schofield
452b716591
Fixed error in OS docs, added CentOS to rehat family docs.
2017-01-08 19:51:33 -05:00
Alex Pop
607de99f75
mention inspec vendor for compliance dependency
...
Signed-off-by: Alex Pop <apop@chef.io>
2016-12-22 12:11:46 +00:00
Christoph Hartmann
fd2e29da38
add guidance for Serverspec migration
...
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2016-12-15 18:14:05 +01:00
Christoph Hartmann
71127cf33e
Merge pull request #1354 from jerryaldrichiii/fix-iis-site-example
...
Remove trailing `\\` from iis_site example
2016-12-12 11:06:32 +01:00
Jerry Aldrich III
f2e6577460
Remove trailing \\
from iis_site example
...
Signed-off-by: Jerry Aldrich III <jerry@chef.io>
2016-12-09 10:00:10 -05:00
Christoph Hartmann
a990d20fcd
Merge pull request #1306 from username-is-already-taken2/digitalgaz/windows_task
...
Adding windows_task resource
2016-11-25 11:46:42 -07:00