inspec 1.51.0 → 1.51.6

data/docs/resources/{dh_params.md → dh_params.md.erb}

@@ -22,8 +22,9 @@ A `dh_params` resource block declares a parameter file to be tested.
       its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
     end
 
+<br>
 
-## Supported Properties
+## Resource Parameter Examples
 
 ### dh_params?
 
@@ -33,13 +34,15 @@ Verify whether file contains DH parameters:
       it { should be_dh_params }
     end
 
-### valid?
+<br>
 
-Verify whether DH parameters are valid:
+## Supported Resource Properties
 
-    describe dh_params('/path/to/file.dh_pem') do
-      it { should be_valid }
-    end
+generator, modulus, prime_length, pem, text
+
+<br>
+
+## Property Examples
 
 ### generator (Integer)
 
@@ -190,3 +193,24 @@ Verify via `openssl dhparam` command:
             4c:f6:c5:e3:a1:52:af:01:c1:4f:c7:42:a0:be:ed:
             cd:13
         generator: 2 (0x2)
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### valid?
+
+Verify whether DH parameters are valid:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      it { should be_valid }
+    end
+
+### be\_dh\_params
+
+    describe dh_params('/path/to/file.dh_pem') do
+        it { should be_dh_params}
+    end
+

data/docs/resources/directory.md.erb

@@ -4,20 +4,25 @@ title: About the directory Resource
 
 # directory
 
-Use the `directory` InSpec audit resource to test if the file type is a directory. This is equivalent to using the `file` resource and the `be_directory` matcher, but provides a simpler and more direct way to test directories. All of the matchers available to `file` may be used with `directory`.
+Use the `directory` InSpec audit resource to test if the file type is a directory. This is equivalent to using the `file` resource and the `be_directory` matcher, but provides a simpler and more direct way to test directories. 
 
 <br>
 
 ## Syntax
 
-A `directory` resource block declares the location of the directory to be tested, and then one (or more) matchers:
+A `directory` resource block declares the location of the directory to be tested, and then one (or more) matchers.
 
     describe directory('path') do
-      it { should MATCHER 'value' }
+      its('property') { should cmp 'value' }
     end
 
 <br>
 
+## Supported Resource Properties
+
+All of the properties available to `file` may be used with `directory`.
+
+<br>
 ## Matchers
 
-This resource may use any of the matchers available to the `file` resource that may be useful when testing a directory. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/docker.md.erb

@@ -109,7 +109,7 @@ Or execute the profile directly via URL:
 
 ## Matchers
 
-This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### containers
 

data/docs/resources/docker_container.md.erb

@@ -23,7 +23,11 @@ A `docker_container` resource block declares the configuration data to be tested
       its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
     end
 
-The container name can also be passed with the `name` argument:
+## Resource Parameter Examples 
+
+### container
+
+The container name can also be passed with the `name` resource parameter:
 
     describe docker_container(name: 'an-echo-server') do
       it { should exist }
@@ -39,55 +43,57 @@ Alternatively, you can pass in the container id:
 
 <br>
 
-## Examples
+## Property Examples
 
 The following examples show how to use this InSpec resource.
 
-### Verify an running container:
-
-    describe docker_container('an-echo-server') do
-      it { should exist }
-      it { should be_running }
-      its('id') { should_not eq '' }
-      its('image') { should eq 'busybox:latest' }
-      its('repo') { should eq 'busybox' }
-      its('tag') { should eq 'latest' }
-      its('ports') { should eq [] }
-      its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
 ### id
 
-The `id` matcher tests the container id:
+The `id` property tests the container id:
 
     its('id') { should eq 'sha:71b5df59...442b' }
 
 ### repo
 
-The `repo` matcher tests the value of the image repository:
+The `repo` property tests the value of the image repository:
 
     its('repo') { should eq 'busybox' }
 
 ### tag
 
-The `tag` matcher tests the value of the image tag:
+The `tag` property tests the value of the image tag:
 
     its('tag') { should eq 'latest' }
 
 ### ports
 
-The `ports` matcher tests the value the docker ports:
+The `ports` property tests the value the docker ports:
 
     its('ports') { should eq '0.0.0.0:1234->1234/tcp' }
 
 ### command
 
-The `command` matcher tests the value of the container run command:
+The `command` property tests the value of the container run command:
 
     its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
+
+
+### Verify a running container:
+
+    describe docker_container('an-echo-server') do
+      it { should exist }
+      it { should be_running }
+      its('id') { should_not eq '' }
+      its('image') { should eq 'busybox:latest' }
+      its('repo') { should eq 'busybox' }
+      its('tag') { should eq 'latest' }
+      its('ports') { should eq [] }
+      its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+

data/docs/resources/docker_image.md.erb

@@ -19,6 +19,10 @@ A `docker_image` resource block declares the image:
       its('tag') { should eq 'latest' }
     end
 
+<br>
+
+## Resource Parameter Examples
+
 The resource allows you to pass in an image id:
 
     describe docker_image(id: alpine_id) do
@@ -39,9 +43,31 @@ You can also pass in repository and tag as separate values
 
 <br>
 
-## Examples
+## Property Examples
 
-The following examples show how to use this InSpec `docker_image` resource.
+### id
+
+The `id` property returns the full image id:
+
+    its('id') { should eq 'sha256:4a415e3663882fbc554ee830889c68a33b3585503892cc718a4698e91ef2a526' }
+
+### image
+
+The `image` property tests the value of the image. It is a combination of `repository/tag`:
+
+    its('image') { should eq 'alpine:latest' }
+
+### repo
+
+The `repo` property tests the value of the repository name:
+
+    its('repo') { should eq 'alpine' }
+
+### tag
+
+The `tag` property tests the value of image tag:
+
+    its('tag') { should eq 'latest' }
 
 ### Test a docker image
 
@@ -57,7 +83,7 @@ The following examples show how to use this InSpec `docker_image` resource.
 
 ## Matchers
 
-This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### exist
 
@@ -65,26 +91,3 @@ The `exist` matcher tests if the image is available on the node:
 
     it { should exist }
 
-### id
-
-The `id` matcher returns the full image id:
-
-    its('id') { should eq 'sha256:4a415e3663882fbc554ee830889c68a33b3585503892cc718a4698e91ef2a526' }
-
-### image
-
-The `image` matcher tests the value of the image. It is a combination of `repository/tag`:
-
-    its('image') { should eq 'alpine:latest' }
-
-### repo
-
-The `repo` matcher tests the value of the repository name:
-
-    its('repo') { should eq 'alpine' }
-
-### tag
-
-The `tag` matcher tests the value of image tag:
-
-    its('tag') { should eq 'latest' }

data/docs/resources/docker_service.md.erb

@@ -19,6 +19,10 @@ A `docker_service` resource block declares the service by name:
       its('tag') { should eq 'latest' }
     end
 
+<br>
+
+## Resource Parameter Examples
+
 The resource allows you to pass in a service id:
 
     describe docker_service(id: '2ghswegspre1') do
@@ -33,75 +37,77 @@ You can also pass in the fully-qualified image:
 
 <br>
 
-## Examples
-
-The following examples show how to use this InSpec `docker_service` resource.
-
-### Test a docker service
+## Property Examples
 
-    describe docker_service('foo') do
-      it { should exist }
-      its('id') { should eq '2ghswegspre1' }
-      its('repo') { should eq 'alpine' }
-      its('tag') { should eq 'latest' }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-The `exist` matcher tests if the image is available on the node:
-
-    it { should exist }
+The following examples show how to use InSpec `docker_service` resource.
 
 ### id
 
-The `id` matcher returns the service id:
+The `id` property returns the service id:
 
     its('id') { should eq '2ghswegspre1' }
 
 ### image
 
-The `image` matcher tests the value of the image. It is a combination of `repository:tag`:
+The `image` property tests the value of the image. It is a combination of `repository:tag`:
 
     its('image') { should eq 'alpine:latest' }
 
 ### mode
 
-The `mode` matcher tests the value of the service mode:
+The `mode` property tests the value of the service mode:
 
     its('mode') { should eq 'replicated' }
 
 ### name
 
-The `name` matcher tests the value of the service name:
+The `name` property tests the value of the service name:
 
     its('name') { should eq 'foo' }
 
 ### ports
 
-The `ports` matcher tests the value of the service's published ports:
+The `ports` property tests the value of the service's published ports:
 
     its('ports') { should include '*:8000->8000/tcp' }
 
 ### repo
 
-The `repo` matcher tests the value of the repository name:
+The `repo` property tests the value of the repository name:
 
     its('repo') { should eq 'alpine' }
 
 ### replicas
 
-The `replicas` matcher tests the value of the service's replica count:
+The `replicas` property tests the value of the service's replica count:
 
     its('replicas') { should eq '3/3' }
 
 ### tag
 
-The `tag` matcher tests the value of image tag:
+The `tag` property tests the value of image tag:
 
     its('tag') { should eq 'latest' }
+
+### Test a docker service
+
+    describe docker_service('foo') do
+      it { should exist }
+      its('id') { should eq '2ghswegspre1' }
+      its('repo') { should eq 'alpine' }
+      its('tag') { should eq 'latest' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### exist
+
+The `exist` matcher tests if the image is available on the node:
+
+    it { should exist }
+
+

data/docs/resources/elasticsearch.md.erb

@@ -1,12 +1,12 @@
 ---
-title: The Elasticsearch Resource
+title: About the Elasticsearch Resource
 ---
 
 # elasticsearch
 
-The `elasticsearch` resource allows testing of a node status against a running
-Elasticsearch cluster. InSpec will retrieve the node list from the cluster node URL
-provided (defaults to `http://localhost:9200`) and provide the ability to query
+Use the  `elasticsearch` resource to test the status of a node against a running
+Elasticsearch cluster. InSpec retrieves the node list from the cluster node URL
+provided (defaults to `http://localhost:9200`) and provides the ability to query
 a variety of settings and statuses.
 
 ## Syntax
@@ -15,7 +15,9 @@ a variety of settings and statuses.
       its('property') { should cmp 'value' }
     end
 
-The `elasticsearch` resource accepts a number of optional values:
+## Supported Resource parameters
+
+The `elasticsearch` resource accepts a number of optional resource parameters:
 
  * `url`: the top-level URL of an Elasticsearch node in the cluster. If your Elasticsearch installation is not served out of the top-level directory at the host, be sure to specific the full URL; for example: `http://my-load-balancer/elasticsearch`. Default: `http://localhost:9200`
  * `username`: a username to use to log in with HTTP-Basic authentication. If `username` is provided, a `password` must also be provided.
@@ -38,33 +40,13 @@ To simply check if nodes exist that match the criteria, use the `exist` matcher:
       it { should exist }
     end
 
-## Supported Properties
+## Supported Resource Properties
 
 The following properties are provided:
 
-* build_hash
-* cluster_name
-* host
-* http
-* ingest
-* ip
-* jvm
-* module_list
-* modules
-* node_name
-* node_id
-* os
-* plugin_list
-* plugins
-* process
-* roles
-* settings
-* total_indexing_buffer
-* transport
-* transport_address
-* version
-
-Since the `elasticsearch` resource is meant for use on a cluster, each property will return an array of the values for each node that matches any provided search criteria. Using InSpec's `cmp` matcher will help avoid any issues when trying to compare values for when a single match is returned (i.e. when the cluster only contains a single node, or the `where` filter criteria provided only returns a single node).
+* build\_hash cluster\_name, host, http, ingest, ip, jvm, module\_list, modules, node\_name, node\_id, os, plugin\_list, plugins, process, roles, settings, total\_indexing\_buffer, transport, transport\_address, version
+
+Since the `elasticsearch` resource is meant for use on a cluster, each property will return an array of the values for each node that matches any provided search criteria. Using InSpec's `cmp` matcher helps avoid issues when comparing values when there is only a single match (i.e. when the cluster only contains a single node, or the `where` filter criteria provided only returns a single node).
 
 ## Property Examples
 
@@ -86,7 +68,7 @@ Returns the cluster names of each of the nodes.
 
 ### host
 
-Returns the hostname of each of the nodes. This may return an IP address of the node is not properly performing DNS resolution or has no hostname set.
+Returns the hostname of each of the nodes. This may return an IP address, if the node is improperly performing DNS resolution or has no hostname set.
 
     describe elasticsearch do
       its('host') { should cmp 'my.hostname.mycompany.biz' }
@@ -134,7 +116,7 @@ Returns a list of enabled modules for each node in the cluster. For more additio
 
 ### modules
 
-Returns detailed information about each enabled module for each node in the cluster. For a succint list of the names of each of the modules enabled, use the `module_list` property. This example uses a bit of additional Ruby to find a specific module and assert a value.
+Returns detailed information about each enabled module for each node in the cluster. For a succint list of the names of each of the modules enabled, use the `module_list` property. This example uses additional Ruby to find a specific module and assert a value.
 
     modules = elasticsearch.modules.first
     lang_groovy_module = modules.find { |mod| mod.name == 'lang-groovy' }
@@ -178,7 +160,7 @@ Returns a list of enabled plugins for each node in the cluster. For more additio
 
 ### plugins
 
-Returns detailed information about each enabled plugin for each node in the cluster. For a succint list of the names of each of the plugins enabled, use the `plugin_list` property. This example uses a bit of additional Ruby to find a specific plugin and assert a value.
+Returns detailed information about each enabled plugin for each node in the cluster. For a succint list of the names of each of the plugins enabled, use the `plugin_list` property. This example uses additional Ruby to find a specific plugin and assert a value.
 
     plugins = elasticsearch.plugins.first
     my_plugin = plugins.find { |plugin| plugin.name == 'my_plugin' }
@@ -243,3 +225,7 @@ Returns the version of Elasticsearch running on each node of the cluster.
     describe elasticsearch do
       its('version') { should cmp '5.5.2' }
     end
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).