Commit graph

269 commits

Author SHA1 Message Date
Franklin Webber
6665555a73 Fixes the two incorrect examples in the YAML doc (#2875)
Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-28 13:20:56 -04:00
Mo Shark
fc3f1708c4 Porting over the singular rds resource from the aws-inspec git repo (#2866)
Signed-off-by: HackerShark <melsharkawi@mitre.org>
2018-03-28 11:23:44 -04:00
Nathan Haneysmith
002a589871 fix logic in examples for password used (#2874)
Signed-off-by: Nathan Haneysmith <nathan@chef.io>
2018-03-26 15:42:56 -04:00
Matthew Dromazos
0cbe5b60e5 New Skeletal Resource aws_config_delivery_channel (#2641)
* Initial commit of new skeletal resource aws_config_delivery_channel
* Changes delivery_frequency to be an integer and names delivery_frequency_in_hours
* Adds more documentation and clarifies descriptions
* Wraps API call in the aws_catch_errors function
* Changes config bucket name to use dashes instead of underscores
* Updates on master and changes directory location of build and integration files
* Fix integration tests to only create one ConfigRecorder

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-26 14:03:23 -04:00
Matthew Dromazos
603bef6f29 New Skeletal Resource aws_kms_key (#2746)
* Initial commit of skeletal resource aws_kms_key
* * Adds comments to rerun travis
* * Clarifies some parts of the doc.
* Changes matcher have_aws_key_manager to manged_by_aws
* Fixes copypasta
* Adds clarification to property names
* Fixes rescueing exceptions from the api
* raises exceptions in the unit tests

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-23 08:29:45 -04:00
Matthew Dromazos
9077a7b17b New Skeletal Resource aws_sns_subscription (#2697)
* Initial commit of skeletal resource aws_sns_subscription
* Fixes errors in documentation
* Clarifies documentation
* Wraps calls to aws api in catch_aws_errors metho
* Fixes integration tests

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-22 13:38:40 -04:00
Matthew Dromazos
1bb565c708 New Skeletal Resource aws_sns_topics (#2696)
* Initial commit of skeletal resource aws_sns_topics
* Adds clarification in documentation
* Adds functionality for calling the next token returned from aws api.
* Wraps api calls in the catch_aws_errs method

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-22 12:55:23 -04:00
Paul Welch
a32a85eae5 Remove incorrect example from documentation (#2851)
Owner and mode are provided by the file resource, not ssh_config.

Fixes #2471

Co-authored-by: Trevor Bramble tbramble@chef.io
Co-authored-by: Paul Welch pwelch@chef.io

Signed-off-by: Paul Welch <pwelch@chef.io>
2018-03-21 12:52:51 -04:00
Franklin Webber
87a28b56bb The resource is login_defs not login_def (#2845)
The main index is displaying the wrong resource name. The url to the resource
is not correct either. This should generate the correct entry and path in the
docs.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-20 13:01:34 -04:00
eramoto
a687479e6c Fix typo in some docs (#2841)
Also includes fixes such as PostgreSQL, TCPMUX, and etc.

Signed-off-by: ERAMOTO Masaya <eramoto.masaya@jp.fujitsu.com>
2018-03-20 08:43:30 -04:00
Matthew Dromazos
555de72912 Skelatal resource: aws_s3_bucket_object (#2620)
* Initial commit of new resource
* Makes changes to docs to match changes to the resources.
* Adds clarifications in docs and changes it to be an erb file.
* Simplifies some unit tests
* Wraps calls to the api in a aws_catch_errors method
* Removes provisioner terraform code

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-03-19 13:10:17 -04:00
Paul Welch
03edd0cd2b Add Info about nginx_conf param (#2831)
Add information about setting the path to the NGINX server configuration
file if it is not in the default path.

Signed-off-by: Paul Welch <pwelch@chef.io>
2018-03-19 12:52:44 -04:00
Thomas Petchel
a48aea53c5 Add additional links to Learn Chef Rally content (#2477)
* Fix under construction page
Previously, the content was hidden behind the banner. The buttons also
did not contain horizontal spacing.

* Add links to Learn Chef Rally content.
I also corrected a few caplitalization issues and edited a few sentences for clarity.

* ssh => SSH
* Update Slack URL
Was pointing to Habitat by mistake.

Signed-off-by: Thomas Petchel <tpetchel@gmail.com>
2018-03-14 11:01:12 -04:00
Franklin Webber
bb538bfb5c Updates the os resource to use dot notation for family (#2807)
The dot notation is supported for family on the os resource. That is
by far easier to type out and use.

Also fixes that the platform names returned are Strings and not Symbols.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-12 13:02:48 -04:00
Miah Johnson
75f39e74f2 Refine deprecated methods to be consisten with supported fields in (#2801)
shadow file.

After much thought the deprecations from #2642 were for the wrong methods.

Plural method names feel much more natural when working with this
resource because you can have more than a single result.

Consider a match like `shadow.user(/^www/)`, this could return multiple
users, so `shadow.users` feels more natural here.

The problem is that the fields we're matching in the shadow file itself
are singular. Each entry is for a user, which has a password, and some
other fields. A user never has `passwords` in the shadow file, only a
`password`.

This is made more obvious when you use the `filter` method.

When we use this filter: `shadow.filter(min_days: 20, max_days: 30)` we
are matching fields in the shadow file and not using our matcher
methods. This means that if there is a discrepancy between our matcher
methods, and the shadow fields the user could end up confused. Like I did =)

This PR changes:

Changed matchers to match shadow fields.
Updated documentation to reflect changes.
Updated tests to reflect changes.
Re-add `filter` method, and add a test for it.
Renamed variable for FilterTable to be less confusing.
Renamed query argument for methods to be consistent.
Cleanup docs based on comments from @jerryaldrichiii
Make Rubocop happy <3

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-03-08 17:26:08 -05:00
Miah Johnson
f6db0e345a Update shadow resource to use FilterTable (#2642)
* Change shadow resource to use FilterTable rather than custom filter
implementation.

Add tests for singluar aliased methods and other minor changes to work
with FilterTable output.
Coverage is at 100%

Signed-off-by: Miah Johnson <miah@chia-pet.org>

* merge master

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-03-07 15:31:30 +01:00
Louis Willcock
cd7f84f5e7 update docs to non-deprecated parameter syntax from name > username as per dep warnings (#2781)
Signed-off-by: JohnVonNeumann <louiswillcock@gmail.com>
2018-03-06 13:16:01 -05:00
Franklin Webber
c2f3dd4c61 Fixes docs for file example (#2552)
* Fixes docs for file example

* The version test should be a string
* There was a missing closing brace in the regex examples
* Some white-spaced got cleaned up
* I added the file name into the variable for the pg examples

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

* Updates docs file to use real postgre path

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

* Moves the 'real' example filepath to the describe

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-03-06 19:00:26 +01:00
Nicholas Duffy
0853e12cc3 Fix AWS IAM access keys example (#2756)
There is no `created_age`. This should
be `created_days_ago`.

Signed-off-by: Nicholas Duffy <duffn@outlook.com>
2018-03-05 16:05:10 -05:00
Kimberly Garmoe
77ee77c557 Removes errant articles (#2775)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 22:53:01 -05:00
Aleksey Tsalolikhin
50e952701d Add cautionary note to include leading zero in file mode specifications (#2606)
Signed-off-by: Aleksey Tsalolikhin <aleksey@verticalsysadmin.com>
2018-03-02 13:47:46 -05:00
Kimberly Garmoe
01357e1e29 Kg/az fix (#2763)
* Fixes typo
* Remove unclear phrase

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 09:18:01 -05:00
Kimberly Garmoe
d02ae42747 fixes ec2 reference (#2766)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-03-02 09:06:11 -05:00
Kimberly Garmoe
f4ea53c3a5 Kg/k module (#2626)
* Refactors kernel_module

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-28 17:12:37 -05:00
Kimberly Garmoe
f7d7f63b02 WIP: Docker resource docs first commit (#2521)
* Docker resource docs
Signed-off-by: kgarmoe <kgarmoe@chef.io>
2018-02-28 16:44:11 -05:00
Matthew Dromazos
4394c5efc8 New Resource aws_config_recorder (#2635)
* Initial commit of new resource
* Removes deprecated matcher in example
* Adds a new terraform file for config resources
* Fixes and clarifies documentation
* Wraps calls to api in catch_aws_errors method
* Changes the names of two matchers

Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
2018-02-27 13:15:04 -05:00
Kimberly Garmoe
118a056f43 Refactors host docs (#2539)
* Refactors host docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 19:21:32 -05:00
Kimberly Garmoe
a0db14485a Refactore json docs (#2551)
* Refactore json docs

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 17:48:35 -05:00
Kimberly Garmoe
2ed473dcbb Fixes dh_params doc (#2644)
* Fixes dh_params doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-26 17:47:36 -05:00
Franklin Webber
a359399fa0 Fixes partially indented blocks and unescaped underscores (#2731)
Moved 2 space examples 2 more spaces in. Don't be shy, show the world your code the way it was meant to be seen.

Underscores in markdown must be escaped otherwise the world goes crooked.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-02-26 11:11:06 -05:00
Jerry Aldrich
0240ab4f6e docs: Enhance http resource documentation (#2715)
* Simplify `http` resource example

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-23 16:49:22 -05:00
Kimberly Garmoe
bd7327b91c Spelling and punctuation check on Azure and AWS (#2657)
* Spelling and punctuation check

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 22:09:51 -05:00
Kimberly Garmoe
b6c60d11bb Normalizes resource (#2704)
* Normalizes resource

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:35:14 -05:00
Kimberly Garmoe
77ad71dc8b Refactors azure_virtual_machine doc (#2702)
* Refactors azure_virtual_machine doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:30:04 -05:00
Kimberly Garmoe
696dde39ef Refactors azure_virtual_machine_data_disk doc (#2701)
* Refactors azure_virtual_machine_data_disk doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 21:12:53 -05:00
Kimberly Garmoe
6bde79a39d Fixes formatting and words (#2703)
* Fixes formatting and words

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 20:54:42 -05:00
Kimberly Garmoe
9a7b9ccec0 Refactoring of azure generic resources doc (#2690)
* Refactoring of azure generic resources doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 08:43:12 -05:00
Kimberly Garmoe
4e71604ef5 Refactors the azure_resource_group doc (#2692)
* Refactors the azure_resource_group doc

Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-19 08:42:52 -05:00
Christoph Hartmann
4641978716 Update InSpec website (#2681)
* New styles

* Fundamental styles for home page

* Legal pages

* Community page, downloads page, tutorials page

* Docs page

* Content toggle and github badge

* Add code - highlighter

* Copy button

* Sliding content animation

* fix particle animatino on downloads page

* Scroll-to-top button

* docs sidebar links

* innocent comments on resources

* Fancy code animation

* Small update to diamond

* whatever slider

* Slider styles

* initial selection if no sliders are there

* add netifly config

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* inspec for provisioners

* fix incorrect text on aws ssm

* fix layout javascript

post-rebase

* resource grouping in docs

* introduce groups in docs/resources

* fix minor spelling issues and move download button in new features section

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* pass linting

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2018-02-17 07:44:42 -08:00
Kimberly Garmoe
d76ae9eae7 Fixes merge conflict messages (#2677)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-16 19:39:41 -05:00
Kimberly Garmoe
b0bcc35fda Add one comma in all docs & deletes two repeated sentences. (#2658)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 22:07:18 -05:00
Miah Johnson
75fb488d2c Add example properties from azure integration tests. (#2659)
Remove trailing whitespace.
Clean up formatting and some rubocop issues.

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2018-02-15 21:52:54 -05:00
Kimberly Garmoe
1e3df9d3bf Fixes obvious formatting (#2648)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 21:34:11 -05:00
Jerry Aldrich
947efd4064 Add platform tags and remove trailing whitespace (#2654)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-02-15 19:28:15 -05:00
Jared Quick
0837b1fb0d
Merge pull request #2650 from chef/kg/remove-os
removes OS metadata from headers
2018-02-15 17:06:27 -05:00
Jared Quick
fc990346f2
Merge pull request #2655 from chef/release-2.0
Add in release-2.0 changes to master
2018-02-15 16:57:25 -05:00
Jared Quick
3623454153 Remove ruby headers from azure docs.
Signed-off-by: Jared Quick <jquick@chef.io>
2018-02-15 13:24:21 -05:00
kagarmoe
dc0d2727bc removes OS metadata from headers
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:54:17 -08:00
Kimberly Garmoe
a966cbd2b5 Formatting on XML resource (#2647)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:33:56 -05:00
Kimberly Garmoe
1218949d86 Normalizes terms accross resources (#2649)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 09:33:22 -05:00