Commit graph

390 commits

Author SHA1 Message Date
Kerry Vance
729d9965ed fails loudly with unsupported options
Signed-off-by: Kerry Vance <vancelot@osuosl.org>
2019-09-05 12:14:36 -07:00
Kerry Vance
3454c830a7 add documentation
Signed-off-by: Kerry Vance <vancelot@osuosl.org>
2019-09-05 11:56:13 -07:00
David Gasper
3912fef458 Add path example to docs
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 14:22:39 -07:00
David Gasper
45556a0fdb Update docs
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 14:18:49 -07:00
David Gasper
52ae5e434b Add docs and unit tests, remove .travis.yml
Signed-off-by: David Gasper <dmgasper@osuosl.org>
2019-08-08 13:54:35 -07:00
Clinton Wolfe
02fafa9bed
Merge pull request #4360 from kclinden/patch-1
Fixed typo in umask example
2019-08-08 13:13:27 -04:00
Ryan Davis
d5f63691d9 Fixed syntax errors in wmi doco.
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-08-07 13:01:43 -07:00
Kasey Linden
34275b8c11
Fixed typo in umask example
changed login_def to login_defs
2019-08-04 11:08:19 -05:00
kekaichinose
e88468736a
Merge pull request #4314 from inspec/ja/add-shadow-example
Add SHA512 password example to `shadow` resource
2019-07-26 11:48:44 -07:00
Jerry Aldrich
74f0e7cf0e Correct example to use message in both places
Thanks @kclinden

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-18 10:06:59 -07:00
Jerry Aldrich
4a5103802a Change comment to be correct and fit on one line
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 22:38:43 -07:00
Jerry Aldrich
a9879544a9 Add SHA512 password example to shadow resource
Many thanks to @kclinden and @zenspider for helping make this possible

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-07-17 20:03:41 -07:00
Eike Waldt
68dd042bd0
use semi-realistic examples
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a775ca6b7
indent all code samples in docs/resources/sys_info.md.erb
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 21:02:52 +02:00
Eike Waldt
2a072ad852
add docs for resource sys_info.manufacturer and sys_info.model
Signed-off-by: Eike Waldt <waldt@b1-systems.de>
2019-07-16 20:39:38 +02:00
Miah Johnson
1541879f0b
Merge pull request #4269 from shoekstra/users_docs_example
Add allowed users example to Users resource
2019-07-08 12:03:22 -07:00
Miah Johnson
8272d0184b
Merge pull request #4236 from ramereth/ip6tables
Add ip6tables resource
2019-07-08 11:45:33 -07:00
Stephen Hoekstra
c2b4bb878b Add allowed users example to Users resource
This example shows how to check for expected users and to flag any other
users that should not be present.

Signed-off-by: Stephen Hoekstra <stephenhoekstra@gmail.com>
2019-07-08 20:30:20 +02:00
kekaichinose
352f149015 Update azure_resource_group.md.erb
* corrected documentation to reflect missing method of "_count" (correct) vs. "_counts" (wrong)
* corrected incorrect spelling of "Inspec" to "InSpec"

Signed-off-by: Keka Ichinose <rikoomi@hotmail.com>
2019-07-03 22:52:46 -07:00
Lance Albertson
3263d76627 Add ip6tables resource
This should resolve #1011 which provides an ip6tables resource to test IPv6
iptables rules. This is essentially a copy of the iptables resource with a few
renames.

In addition, I've pulled in the integration tests for iptables into ip6tables
and enabled it on docker so that it properly gets tested regularly. The test
cookbook recipe has been updated to support all of the current platforms that
are being tested.

Signed-off-by: Lance Albertson <lance@osuosl.org>
2019-06-24 17:01:34 -07:00
Mary Jinglewski
8003305caf Fixing docs so Warning note appears
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-06-04 13:44:41 -04:00
Clinton Wolfe
82cafccebb Remove enclosing HTML and re-render
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:56:34 -04:00
Clinton Wolfe
3cb3ca9f94 Remove two misrendering hyperlinks
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-06-03 11:35:48 -04:00
Miah Johnson
2a1b1d8e88 Remove all leading newlines.
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-31 11:43:44 -07:00
Clinton Wolfe
06de2dc941 Update azure gr sunset notice
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:40:05 -04:00
Clinton Wolfe
c4d7a52b94 Update apache resource sunset notice
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 11:39:20 -04:00
Ryan Davis
f36a7c8061 No tabs.
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-05-25 03:40:36 -07:00
Miah Johnson
dafd91898d
Merge branch 'master' into changeInSpecText 2019-05-08 12:32:04 -07:00
Miah Johnson
5c00a44d71 Update resource registry_key documentation example
ref: https://github.com/inspec/inspec/issues/4003

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-04-30 17:04:12 -07:00
Unknown
5c1467dfe9 Update software name from InSpec to Chef Inspec
Signed-off-by: IanMadd <maddaus@protonmail.com>
2019-04-29 15:16:56 -04:00
Mary Jinglewski
70db730b48 Remove be_immutable
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-04-23 13:52:48 -04:00
Clinton Wolfe
7aeb1763a9
Merge pull request #3897 from mattlqx/interface-addresses
Support address matchers on interface resource
2019-04-17 11:57:29 -04:00
Clinton Wolfe
0c884b1415
Merge pull request #3895 from mitre/al-mitre/more-permissive-than
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-04-16 14:41:43 -04:00
Matt Kulka
633cea6673 support address matchers on interface resource
Adds missing functionality to `interface`. Fixes #1830

```
describe interface("eth0") do
  its(ipv4_addresses) { should include 1.2.3.4 }
end
```

And so on... see diff/docs for additional matchers.

Signed-off-by: Matt Kulka <mkulka@parchment.com>
2019-04-12 08:24:13 -07:00
Clinton Wolfe
082882d98d
Merge pull request #3915 from nqb/docs/apt-resource
apt: correct docs to clarify that it matches repositories not packages
2019-04-08 11:22:35 -04:00
nqb
79078d611c
fix: apt resource matchs repositories not packages
Obvious fix.

Signed-off-by: nqb <nqb+git@azyx.fr>
2019-04-03 08:50:08 +02:00
Aaron Lippold
e312b44563 Addressing review items.
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-27 09:55:48 -04:00
Stuart Paterson
5accfa5391
Add protection for crontab resource path and document it.
Signed-off-by: Stuart Paterson <spaterson@chef.io>
2019-03-21 15:49:00 +00:00
Aaron Lippold
9a8ed4d3e5 move the advanced use-case to the tips and tricks
Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-18 21:56:00 -04:00
Aaron Lippold
a2a86860d6 This adds the more_permissive_than?(mode) matcher to the file resource.
Fixes #3893

Signed-off-by: Aaron Lippold <lippold@gmail.com>
2019-03-18 18:10:13 -04:00
Keith Walters
c2bd0616fe Allow http resource to follow redirects
By specifying a `max_redirects` attribute, the `http` resource worker
will follow any HTTP Redirect response (301, 302, etc...) up to the
limit defined by this attribute. For a local worker, exceeding that
limit will raise a `FaradayMiddleware::RedirectLimitReached` exception.
For a remote worker, the curl command will exit without populating the
`status` and `body` properties.

Signed-off-by: Keith Walters <keith.walters@cattywamp.us>
2019-03-16 20:54:52 -04:00
jtimberman
d2d4c9605f add json example from http request
I was looking for an example of how to do this, but I didn't find
anything in the documentation. This is a simple examle in the `json`
resource that returns a JSON blob back from an `http` request to a
"`/health`" endpoint.

Signed-off-by: Joshua Timberman <joshua@chef.io>
2019-02-21 10:23:52 -07:00
Clinton Wolfe
48711fa7bb
Merge pull request #3778 from inspec/team/filesystem-free-percent
filesystem: Add free_kb, size_kb, type, and percent_free properties
2019-02-06 17:40:10 -05:00
Clinton Wolfe
2b836a35c1
Merge pull request #3781 from EmFl/patch-2
package: Correct contradictory docs examples
2019-02-06 14:22:30 -05:00
Clinton Wolfe
dd3d3cbd2f Add deprecation hook for size()
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:02:17 -05:00
Clinton Wolfe
02cb799ee6 Rename free to free_kb
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
Clinton Wolfe
5bbd4c16d6 Add size_kb, and correct Powershell code to return KB for both total size and free space, rather than total in GB and free space in bytes
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
Clinton Wolfe
fef637a6c6 Add percent_free property
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-02-06 14:01:04 -05:00
James Massardo
83c0c18fca Add free space and type to filesystem resource
Signed-off-by: James Massardo <jmassardo@chef.io>
2019-02-06 14:01:04 -05:00
EmFl
785430ec3f
Update package.md.erb
Some contradictory description vs code example
2019-02-06 09:45:38 +01:00