Commit graph

363 commits

Author SHA1 Message Date
Kimberly Garmoe
c7b9c56a34 Refactors http doc (#2540)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 22:41:14 +01:00
Kimberly Garmoe
f32bcdb74d Adds glossary.md file (#2450)
* Adds glossary.md file

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* Adds glossary to sidebar and updates page formatting

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Changes glossary layout

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Replaces errant tic

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Requested changes

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Clarifies filter clause

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-08 10:00:51 +01:00
Kimberly Garmoe
f4d08fbb40 Refactors crontab docs & adds 'property examples' (#2513)
* Refactors crontab docs & adds 'property examples'

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* adds note about crontab-supported time strings

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 16:11:28 +01:00
Kimberly Garmoe
24120b9b26 Refactors dh_params resource and publishes (#2515)
* Refactors dh_params resource and publishes

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Adds dh_params resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes esc chars

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:35:04 +01:00
Kimberly Garmoe
4a203e647b Kg/csv (#2514)
* Refactors csv resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edits

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edit

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Clarifies property example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:25:42 +01:00
Kimberly Garmoe
36dd93701f Kg/etc fstab (#2523)
* Refactors etc_fstab resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Edits to fstab

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes duplicate line

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:24:49 +01:00
Kimberly Garmoe
7a47273f5f Refactors elasticsearch resource (#2522)
* Refactors elasticsearch resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:23:53 +01:00
Kimberly Garmoe
16d4f71d2e Refactors the bond docs (#2504)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 15:17:59 +01:00
Kimberly Garmoe
ecf6900e9f Kg/file (#2529)
* Refactors file docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Adds deprecations and differentiates OS

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 14:29:30 +01:00
Kimberly Garmoe
f5acd5d34e Kg/filesystem (#2530)
* Refactores filesystem doc.

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes file

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-07 14:27:48 +01:00
Kimberly Garmoe
be2216a1b8 Kg/etc hosts (#2528)
* Refactors etc_hosts docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edits

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:31:46 +01:00
Kimberly Garmoe
980a1329b2 Kg/gem (#2527)
* Refactors gem resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:31:11 +01:00
Kimberly Garmoe
1ce72eecd8 Refactors etc_hosts_allow docs (#2526)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:30:47 +01:00
Kimberly Garmoe
719783e2b2 Refactors etc_hosts_deny docs (#2525)
* Refactors etc_hosts_deny docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes typo

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Fixes terminal punctuation

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:30:09 +01:00
Kimberly Garmoe
ee18b7ef89 Refactors etc_group docs (#2524)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:29:15 +01:00
Kimberly Garmoe
15d4564c3a Updates directory resource (#2516)
* Updates directory resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Updates syntax example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-06 12:27:09 +01:00
Kimberly Garmoe
bc3c5039f3 Updates aide-conf docs (#2493)
* Updates aide-conf docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Removes 'matchers' language.

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Really resolves merge conflict

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-05 19:57:45 +01:00
Kimberly Garmoe
b33aecec0c Updates auditd_conf doc (#2497)
* Updates auditd_conf doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* resolves merge conflict

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Moves example

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-05 19:56:36 +01:00
Kimberly Garmoe
903ab396f0 Refactors docker_service docs (#2519)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:13:56 -05:00
Kimberly Garmoe
73f2eebea5 Refactors docker_image resource (#2518)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:13:04 -05:00
Kimberly Garmoe
288e9f2607 Refactors docker_container resource (#2517)
* Refactors docker_container resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Edits matchers to properties

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 08:10:47 -05:00
Kimberly Garmoe
3e7e806eba Updates cran resource doc (#2512)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 07:36:36 -05:00
Kimberly Garmoe
d3a2957766 Kg/cpan (#2511)
* Refactors cpan resource doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Copy edit

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-02 07:35:50 -05:00
Kimberly Garmoe
16325b8a9b Refactors the bridge property (#2505)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:45:33 -05:00
Kimberly Garmoe
c9a226c4ab Refactors 'bash' resource docs page (#2500)
* Refactors 'bash' resource docs page

Signed-off-by: kagarmoe <kgarmoe@chef.io>

* Changes 'exist' description

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:44:10 -05:00
Kimberly Garmoe
6ed7616ac9 Refactors bsd_service resource doc (#2507)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:43:16 -05:00
Kimberly Garmoe
66e25fab8d Refactors command resource (#2508)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 17:42:27 -05:00
Kimberly Garmoe
010ca42b2d Changes 'matcher' to 'property' in examples (#2499)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-01 11:51:12 +01:00
Kimberly Garmoe
7dc72c7491 Edits to audit_policy resource language (#2498)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-01-31 07:24:57 -05:00
Kimberly Garmoe
b45b77cd13 Simplifies 'matchers' language in docs (#2496)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-01-31 07:24:16 -05:00
Adam Leff
689fe34cc9 apache resource: document and deprecate (#2494)
* Docs for apache resource

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* Add deprecation warning to apache docs and resource, and clean up examples.

Signed-off-by: Adam Leff <adam@leff.co>

* Update apache_conf resource to remove dependency on apache resource

Signed-off-by: Adam Leff <adam@leff.co>

* Make conf_dir method public

Signed-off-by: Adam Leff <adam@leff.co>

* Removes unnecessary aide_conf commit, pulled in from e25f0a45

Signed-off-by: Adam Leff <adam@leff.co>

* Switch to Pathname to calculate conf_dir

Needed to avoid Windows adding `C:\` in unit tests when calling
File.expand_path.

Signed-off-by: Adam Leff <adam@leff.co>
2018-01-31 11:16:15 +01:00
Franklin Webber
2cc446a686 Doc fixes the apache_conf properties returns an array (#2479)
* Fixes the apache_conf Listen property returns an array

The result is an array and not a string even when there is one value.

Signed-off-by: Franklin Webber <franklin@chef.io>

* Updates the apache_conf timeout, allowoverride, and maxclients to include

It seems that all of these values are placed in an array of values so
the matcher needs to be `include`.

Signed-off-by: Franklin Webber <franklin@chef.io>

* Updates docs for apache_conf

* Uses the suggested `cmp` instead of `include`
* Adds the way to properly compare a list of multiple ports

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-01-29 13:03:36 -05:00
Jerry Aldrich
d96a6affa7 packages resource: Add architectures support (#2469)
This adds support for `architectures` to the `packages` resource.

Example:

```
describe packages(/compat-libstdc++-33/) do
  its('architectures') { should include 'x86_64' }
  its('architectures') { should include 'i686' }
end
```

This also adds documentation for the `packages` resource

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-01-25 23:57:34 -08:00
Vern Burton
55abdebdc9 filesystem resource: inspect linux filesystems (#2441)
* adding df resource

Signed-off-by: Vern Burton <me@vernburton.com>

* adding unit tests and required mocks for them, created integration test

Signed-off-by: Vern Burton <me@vernburton.com>

* cleaning up skip test to include only the filename and not full path

Signed-off-by: Vern Burton <me@vernburton.com>

* adding docs

Signed-off-by: Vern Burton <me@vernburton.com>

* size makes more sense than space

Signed-off-by: Vern Burton <me@vernburton.com>

* removing unneeded author lines

Signed-off-by: Vern Burton <me@vernburton.com>

* as the command changed, changing mock to the new sha

Signed-off-by: Vern Burton <me@vernburton.com>

* updating to address comments from #2441

* removing author lines
* using attr_reader functions
* using ruby string functions rather than pipe to sed
* adding os family detection
* using ResourceFailed as the pattern already existed for OS family detection
* using if for future case support for unix and unix-like (FreeBSD)

Signed-off-by: Vern Burton <me@vernburton.com>

* adding supports to resource metadata, and adding tests that show that resource says that it is not supported on windows/unix.

Signed-off-by: Vern Burton <me@vernburton.com>

* focusing on linux os family and removing logic for assumed future cases

Signed-off-by: Vern Burton <me@vernburton.com>

* changing df to filesystem

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-25 09:29:31 -05:00
Matt Kulka
c067798fc5 Docker Swarm service resource (#2456)
This change adds the `docker_service` resource for Docker swarm mode services. This
branches off some of the common elements (id, exists) into a `DockerObject` module along
with a utility function for parsing the image/repo string. That function was implemented
separately by `docker_image` and `docker_container`, now with a third resource, it made
sense to consolidate that into an included module. I used the most comprehensive
implementation. Existing classes had to be slightly modified for the genericization.

Signed-off-by: Matt Kulka <mkulka@parchment.com>
2018-01-23 12:30:14 -08:00
Markus Grobelin
dee94b6416 pip resource docs: mention custom path to pip as introduced by GH-2097 (#2459)
Signed-off-by: Markus Grobelin <grobi@koppzu.de>
2018-01-19 17:03:00 -05:00
djenniex-bene
2cfc0acaae SMTP example for the ini resource was incorrect and did not work (#2461)
* SMTP example for the ini resource was incorrect and did not work

Obvious fix.

* Fixed documentation and removed semicolons as the ini parser includes those semicolons

Obvious fix.
2018-01-17 11:41:33 -08:00
Vern Burton
175c3e1189 xml resource: support fetching attributes (#2423)
* adding database.xml with attributes to files and mocking it in the helper.rb

Signed-off-by: Vern Burton <me@vernburton.com>

* adding logic to test class returned by XPATH and using functions from respective classes to fill a array for return, and unit and integration tests to ensure functionality

Signed-off-by: Vern Burton <me@vernburton.com>

* updating docs to show how attributes are used

Signed-off-by: Vern Burton <me@vernburton.com>

* 'and' instead of 'or' makes more sense

Signed-off-by: Vern Burton <me@vernburton.com>

* adding default else for capturing unknown classes from REXML

Signed-off-by: Vern Burton <me@vernburton.com>

* removing extra newline

Signed-off-by: Vern Burton <me@vernburton.com>

* adding fail case with enough information to debug in future case

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-16 14:26:39 -08:00
Vern Burton
9b4a276e9f firewalld resource: prepend rule string only when necessary (#2430)
* adding control statement to add rule in front of string as long as it doesn't already contain rule.

Correcting resource name in firewalld from etc_hosts_deny

adding tests for both branches of the statement created in firewalld

Signed-off-by: Vern Burton <me@vernburton.com>

* moving to unless with a start_with

Signed-off-by: Vern Burton <me@vernburton.com>

* adding documentation that states that it is not needed to add `rule` string

Signed-off-by: Vern Burton <me@vernburton.com>
2018-01-16 14:20:58 -08:00
Nathen Harvey
65589f8f78 Markdown titles sometimes need _s escaped (#2451)
When a header includes two `_`s, they must be escaped, otherwise, the
text between the two `_`s is rendered with emphasis.  E.g.,

`<h1 id="etchostsallow">etc<em>hosts</em>allow</h1>`

Escaping the `_`s fixes this and the header is rendered properly.

This is a fix for:

* etc_hosts_allow
* etc_hosts_deny
* postgres_hba_conf
* postgres_ident_conf

This change also adds the `h1` title to the windows_hotfix resource
page.

Signed-off-by: Nathen Harvey <nharvey@chef.io>
2018-01-08 13:09:13 -05:00
Dominik Richter
be9ece65b9 load local dependencies in inspec shell (#2438)
* add --depends to inspec shell

for loading dependencies from local folders. mainly used for development.

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* depends is not defined...

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* much nicer description for --depends

kudos @adamleff

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* add documentation for inspec shell --depends

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2018-01-04 14:39:01 -05:00
Eammon Hanlon
f6c7bffe78 Add bonding mode matcher to bond resource (#2414)
* Add mode method to test the value of Bonding Mode

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Add test for bonding mode in bond unit test

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Add documentation on mode matcher for bond resource

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>

* Update example for 'Test parameters for bond0'

Signed-off-by: Eammon Hanlon <eammon.hanlon@microsoft.com>
2017-12-22 15:02:40 +01:00
Adam Leff
777c90e43a docs: fix XML resource example to use alternate syntax (#2395)
Signed-off-by: Adam Leff <adam@leff.co>
2017-12-22 14:56:18 +01:00
Jerry Aldrich
0178602d02 Correct .where usage in passwd documentation (#2419)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2017-12-21 22:59:20 -05:00
Franklin Webber
1cd7e1a120 Updates the docs for mysql_session (#2392)
* Fixes usage of 'output' to 'stdout'
* Adds examples for 'exit_status' and 'stderr'
* Modifies the matchers section to point to the command resource

Signed-off-by: Franklin Webber <franklin@chef.io>
2017-12-21 17:06:39 -05:00
Adam Leff
470582a84e xml resource: update docs with alternate syntax for keys with periods (#2389)
Signed-off-by: Adam Leff <adam@leff.co>
2017-12-12 16:31:50 +01:00
Andy Boutte
ac5ca9b5bc Added missing quote and removed extra bracket (#2386)
Signed-off-by: Andy Boutte <andy.boutte@reancloud.com>
2017-12-11 15:07:54 -05:00
Jordan Craig
d928c76702 Fix incorrect case in paragraph. (#2363)
Incorrect case used in paragraph to describe interactive debugging with Pry.

Obvious fix.
2017-12-04 11:55:33 -05:00
Patrick Münch
bd6a8fd980 kernel_module: correct docs style for code boxes (#2348)
Signed-off-by: Patrick Münch <patrick.muench1111@gmail.com>
2017-11-28 18:12:05 -05:00
David Alexander
71b90f1b22 file resource: fix NilClass error when using advanced windows permissions (#2344)
* Fixes #2343 (Windows file permissions regression)

Signed-off-by: David Alexander <opensource@thelonelyghost.com>

* Updates docs with missing info on `be_allowed()` matcher

Signed-off-by: David Alexander <opensource@thelonelyghost.com>
2017-11-28 09:18:49 +01:00