inspec 2.3.10 → 2.3.23

data/docs/resources/azure_virtual_machine_data_disk.md.erb

@@ -1,234 +0,0 @@
----
-title:  About the azure_virtual_machine_datadisk Resource
-platform: azure
----
-
-# azure\_virtual\_machine\_datadisk
-
-Use this resource to ensure that a specific data disk attached to a machine has been created properly.
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v2.0.16 of InSpec.
-
-## Syntax
-
-The name of the resource group and machine are required to use this resource.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'MyVM') do
-      its('property') { should eq 'value' }
-    end
-
-where
-
-* `MyVm` is the name of the virtual machine as seen in Azure. (It is **not** the hostname of the machine)
-* `InSpec-Azure` is the name of the resource group that the machine is in.
-* `property` is a resource property
-* `value` is the expected output from the matcher
-
-<br>
-
-## Examples
-
-The following examples show to use this InSpec audit resource.
-
-### Check that the first data disk is of the correct size
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Linux-Internal-VM').where(number: 1) do
-      its('size') { should cmp >= 15 }
-    end
-
-<br>
-
-## Resource Parameters
-
-* `group_name`, `name`, `apiversion`
-
-## Parameter Examples
-
-The options that can be passed to the resource are as follows.
-
-### group_name (required)
-
-Use this parameter to define the Azure Resource Group to be tested.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure') do
-        ...
-    end
-
-### name
-
-Use this parameter to define the name of the Azure resource to test.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM') do
-        ...
-    end
-
-### apiversion
-
-The API Version to use when querying the resource. Defaults to the latest version for the resource.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM', apiversion: '2.0') do
-        ...
-    end
-
-These options can also be set using the environment variables:
-
-* `AZURE_RESOURCE_GROUP_NAME`
-* `AZURE_RESOURCE_NAME`
-* `AZURE_RESOURCE_API_VERSION`
-
-When the options have been set as well as the environment variables, the environment variables take priority.
-
-<br>
-
-## Filter Criteria
-
-* `number`, `disk`
-
-<br>
-
-## Filter Examples
-
-### disk
-
-The zero based index of the disk attached to the machine.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM').where(disk: 0)
-    end
-
-### number
-
-The '1' based index of the disk attached to the machine.
-
-    describe azure_virtual_machine_data_disk(group_name: 'InSpec-Azure', name: 'Windows-Internal-VM').where(number: 1)
-    end
-
-<br>
-
-## Properties
-
-* `count`, `disk`, `number`, `name`, `size`, `lun`, `caching`, `create_option`, `is_managed_disk?`, `vhd_uri`, `storage_account_name`, `storage_account_type`, `id`, `subscription_id`, `resource_group`
-
-<br>
-
-## Property Examples
-
-### count
-
-Returns the number of data disks attached to the machine
-
-    its('count') { should eq 1 }
-
-### name
-
-Returns a string of the name of the disk.
-
-    its('name') { should cmp 'linux-external-datadisk-1' }
-
-### size
-
-Returns an integer of size of this disk in GB.
-
-    its('size') { should cmp >= 15 }
-
-### lun
-
-The disk number as reported by Azure. Has a zero-based index value.
-
-    its('lun') { should cmp 0 }
-
-### caching
-
-String stating the caching that has been set on the disk.
-
-    its('caching') { should cmp 'none' }
-
-### create\_option
-
-How the disk was created. Typically for data disks, this will be the string value 'Empty'.
-
-    its('create_option') { should cmp 'Empty' }
-
-### is\_managed\_disk?
-
-Boolean stating if the disk is a managed disk or not. If it is not a managed disk then it is one that is stored in a Storage Account.
-
-    its('is_managed_disk?') { should cmp 'false' }
-
-### vhd\_uri
-
-If this _not_ a managed disk, then the `vhd_uri` will be the full URI to the disk in the storage account.
-
-    its('vhd_uri') { should cmp '
-https://primary_storage.blob.core.windows.net/container_name/vm_name.vhd' }
-
-### storage\_account\_name
-
-If this is _not_ a managed disk this will be the storage account name in which the disk is stored.
-
-This derived from the `vhd_uri`.
-
-    its('storage_account_name') { should cmp 'primary_storage' }
-
-### storage\_account\_type
-
-If this is a managed disk this is the storage account type, e.g. `Standard_LRS`.
-
-    its('storage_account_type') { should cmp 'Standard_LRS' }
-
-### id
-
-If this is a managed disk then this is the fully qualified id for the disk in Azure.
-
-    its('id') { should cmp '/subscriptions/1234abcd-e567-890f-g123-456h78i9jkl0/resourceGroups/InSpec-Azure' }
-
-### subscription\_id
-
-If this is a managed disk, this returns the subscription id of where the disk is stored.
-
-This is derived from the `id`.
-
-    its('subscription_id') { should cmp '1234abcd-e567-890f-g123-456h78i9jkl0' }
-
-### resource\_group
-
-If this is a managed disk, this returns the resource group in which the disk is stored.
-
-This is derived from the `id`.
-
-    its('resource_group') { should cmp 'InSpec-Azure' }
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-The following properties are applied to the virtual machine itself and not specific disks.
-
-### have\_data\_disks
-
-Returns a boolean denoting if any data disks are attached to the machine.
-
-    it { should have_data_disks }
-
-### have\_managed\_disks
-
-Returns a boolean stating if the machine has Managed Disks for data disks.
-
-    it { should have_managed_disks }
-
-<br>
-
-## References
-
-* [Azure Ruby SDK - Compute](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_compute)
-* [Linux Internal Data Disks](https://github.com/chef/inspec/blob/master/test/azure/verify/controls/virtual_machine_linux_external_vm_datadisk.rb)
-* [Windows Internal Data Disk](https://github.com/chef/inspec/blob/master/test/azure/verify/controls/virtual_machine_windows_internal_vm_datadisk.rb)

data/docs/resources/bash.md.erb

@@ -1,85 +0,0 @@
----
-title: About the bash Resource
-platform: linux
----
-
-# bash
-
-Use the `bash` InSpec audit resource to test an arbitrary command that is run on the system using a Bash script.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `command` resource block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:
-
-    describe bash('command') do
-      it { should exist }
-      its('property') { should eq 'expected value' }
-    end
-
-where
-
-* `'command'` must specify a command to be run
-* `'property'` is one of `exit_status`, `stderr`, or `stdout`
-* `'expected value'` tests the output of the command run on the system versus the expected output stated in the test
-
-For example:
-
-    describe bash('ls -al /') do
-      its('stdout') { should match /bin/ }
-      its('stderr') { should eq '' }
-      its('exit_status') { should eq 0 }
-    end
-
-<br>
-
-## Properties
-
-* `exit_status`, `stderr`, `stdout`
-
-<br>
-
-## Property Examples
-
-### exit_status
-
-The `exit_status` property tests the exit status for the command:
-
-    its('exit_status') { should eq 0 }
-
-### stderr
-
-The `stderr` property tests results of the command as returned in standard error (stderr):
-
-    its('stderr') { should eq '' }
-
-### stdout
-
-The `stdout` property tests results of the command as returned in standard output (stdout).
-
-    its('stdout') { should match /bin/ }
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-If an absolute path is provided, the `exist` matcher tests if the command exists on the filesystem at the specified location. Otherwise, the `exist` matcher tests if the command is found in the PATH.
-
-    it { should exist }
-
-

data/docs/resources/bond.md.erb

@@ -1,100 +0,0 @@
----
-title: About the bond Resource
-platform: linux
----
-
-# bond
-
-Use the `bond` InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the `/proc/net/bonding` directory may be tested.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `bond` resource block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:
-
-    describe bond('name') do
-      it { should exist }
-    end
-
-where
-
-* `'name'` is the name of the bonded network interface
-* `{ should exist }` is a valid matcher for this resource
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### content
-
-The `content` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the `content` matcher are arbitrary.
-
-    its('content') { should match('value') }
-
-### interfaces
-
-The `interfaces` matcher tests if the named secondary interfaces are available.
-
-    its('interfaces') { should eq ['eth0', 'eth1', ...] }
-
-### mode
-
-The `mode` matcher tests the Bonding Mode.
-
-    its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
-
-### params
-
-The `params` matcher tests arbitrary parameters for the bonded network interface.
-
-    its('params') { should eq 'value' }
-
-### Test if eth0 is a secondary interface for bond0
-
-    describe bond('bond0') do
-      it { should exist }
-      it { should have_interface 'eth0' }
-    end
-
-### Test parameters for bond0
-
-    describe bond('bond0') do
-      its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
-      its('Transmit Hash Policy') { should eq 'layer3+4 (1)' }
-      its('MII Status') { should eq 'up' }
-      its('MII Polling Interval (ms)') { should eq '100' }
-      its('Up Delay (ms)') { should eq '0' }
-      its('Down Delay (ms)') { should eq '0' }
-    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 bonded network interface is available:
-
-    it { should exist }
-
-### have_interface
-
-The `have_interface` matcher tests if the bonded network interface has one (or more) secondary interfaces:
-
-    it { should have_interface }
-

data/docs/resources/bridge.md.erb

@@ -1,67 +0,0 @@
----
-title: About the bridge Resource
-platform: linux
----
-
-# bridge
-
-Use the `bridge` InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `bridge` resource block declares the bridge to be tested and what interface it should be associated with:
-
-    describe bridge('br0') do
-      it { should exist }
-      it { should have_interface 'eth0' }
-    end
-
-<br>
-
-## Properties
-
-* On Linux platforms, any value in the `/sys/class/net/{interface}/bridge` directory may be tested
-* On the Windows platform, the `Get-NetAdapter` cmdlet is associated with the `Get-NetAdapterBinding` cmdlet and returns the `ComponentID ms_bridge` value as a JSON object
-
-<br>
-
-## Property Examples
-
-### interfaces
-
-The `interfaces` property tests if the named interface is present:
-
-    its('interfaces') { should eq 'foo' }
-    its('interfaces') { should eq 'bar' }
-    its('interfaces') { should include('foo') }
-
-<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 network bridge is available:
-
-    it { should exist }
-
-### have_interface
-
-The `have_interface` matcher tests if the named interface is defined for the network bridge:
-
-    it { should have_interface 'eth0' }
-