mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
Normalizes terms accross resources (#2649)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
This commit is contained in:
parent
686b028886
commit
1218949d86
34 changed files with 44 additions and 42 deletions
|
@ -34,7 +34,7 @@ Use the where clause to match a selection_line to one rule or a particular set o
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* `conf_path`, `content`, `rules`, `all_have_rule`
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* 'service', 'conf_dir', 'conf_path', 'user'
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
This matcher will match any property listed in the `auditd.conf` configuration file. Property names and expected values are case-insensitive:
|
||||
|
||||
|
|
|
@ -33,7 +33,7 @@ For example:
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* `exit_status`, `stderr`, `stdout`
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ A `bridge` resource block declares the bridge to be tested and what interface it
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## 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
|
||||
|
|
|
@ -37,7 +37,7 @@ The path to the service manager's control may be specified for situations where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
All properties available to the `service` resource may be used.
|
||||
<br>
|
||||
|
|
|
@ -23,7 +23,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Parameters
|
||||
## Resource Parameters
|
||||
|
||||
This resource uses package names and perl library paths as resource parameters.
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Resource Parameter Examples
|
||||
## Examples
|
||||
|
||||
The following examples show how to use this InSpec audit resource.
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ A `crontab` resource block declares a user (which defaults to the current user,
|
|||
|
||||
<br>
|
||||
|
||||
## Resource Parameter Examples
|
||||
## Examples
|
||||
|
||||
The following examples show how to use this InSpec audit resource.
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Resource Parameter Examples
|
||||
## Examples
|
||||
|
||||
The following examples show how to use this InSpec audit resource.
|
||||
|
||||
|
|
|
@ -36,7 +36,7 @@ Verify whether file contains DH parameters:
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
generator, modulus, prime_length, pem, text
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ A `directory` resource block declares the location of the directory to be tested
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
All of the properties available to `file` may be used with `directory`.
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ A `docker_container` resource block declares the configuration data to be tested
|
|||
|
||||
## Resource Parameter Examples
|
||||
|
||||
### container
|
||||
### name
|
||||
|
||||
The container name can also be passed with the `name` resource parameter:
|
||||
|
||||
|
@ -34,6 +34,8 @@ The container name can also be passed with the `name` resource parameter:
|
|||
it { should be_running }
|
||||
end
|
||||
|
||||
### id
|
||||
|
||||
Alternatively, you can pass in the container id:
|
||||
|
||||
describe docker_container(id: '71b5df59442b') do
|
||||
|
|
|
@ -40,7 +40,7 @@ To simply check if nodes exist that match the criteria, use the `exist` matcher:
|
|||
it { should exist }
|
||||
end
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
The following properties are provided:
|
||||
|
||||
|
|
|
@ -35,7 +35,7 @@ Use the optional constructor parameter to give an alternative path to fstab file
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
* `device_name` is the name associated with the device.
|
||||
* `mount_point` is the directory at which the filesystem is configured to be mounted.
|
||||
|
|
|
@ -32,13 +32,13 @@ where
|
|||
* `name: 'name'`, `group_name: 'group_name'`, `password: 'password'`, `gid: 'gid'`, `group_id: 'gid'`, `users: 'user_name'`, `members: 'member_name'`
|
||||
<br>
|
||||
|
||||
## Supported Resource parameters
|
||||
## Properties
|
||||
|
||||
* `'gids'`, `'groups'`, and `'users'` are valid resource parameters for this resource.
|
||||
|
||||
<br>
|
||||
|
||||
## Resource Parameter Examples
|
||||
## Examples
|
||||
|
||||
The following examples show how to use this InSpec audit resource.
|
||||
|
||||
|
|
|
@ -38,7 +38,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
'ip_address', 'primary_name', 'all_host_names'
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
'daemon', 'client_list', 'options'
|
||||
|
||||
|
|
|
@ -34,13 +34,13 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
'daemon', 'client_list', 'options'
|
||||
|
||||
<br>
|
||||
|
||||
## Parameter Examples and Return Types
|
||||
## Parameter Examples
|
||||
|
||||
### daemon
|
||||
|
||||
|
|
|
@ -24,17 +24,17 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
### General Resource Properties
|
||||
### General Properties
|
||||
|
||||
content, size, basename, path, owner, group, type
|
||||
|
||||
### Unix/Linux Resource Properties
|
||||
### Unix/Linux Properties
|
||||
|
||||
symlink, mode, link_path, mtime, size, selinux\_label, md5sum, sha256sum, path, source, source\_path, uid, gid
|
||||
|
||||
### Windows Resource Properties
|
||||
### Windows Properties
|
||||
|
||||
file\_version, product\_version
|
||||
|
||||
|
|
|
@ -29,7 +29,7 @@ Use the where clause to test open interfaces, sources, and services in active zo
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
### interfaces
|
||||
|
||||
|
|
|
@ -49,7 +49,7 @@ Beginning with InSpec 1.41, you can enable the ability to have the HTTP test exe
|
|||
In InSpec 2.0, the HTTP test will automatically execute remotely whenever InSpec is testing a remote node.
|
||||
|
||||
<br>
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
body, headers, http_method, status,
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ For example:
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
application\_pool, path, physical\_path, protocols, site\_name
|
||||
|
||||
<br>
|
||||
|
|
|
@ -40,7 +40,7 @@ For example:
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
app\_pool, bindings, path, state
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Resource Properties
|
||||
## Properties
|
||||
|
||||
This resource supports any of the properties listed as services in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`.
|
||||
|
||||
|
|
|
@ -43,7 +43,7 @@ In the event a section or setting name has a period in it, the alternate syntax
|
|||
its(['section.with.a.dot.in.it', 'setting.name.with.dots']) { should cmp 'lotsadots' }
|
||||
|
||||
<br>
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
This resource supports any of the settings listed in an INI file as properties.
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ An `interface` resource block declares network interface properties to be tested
|
|||
end
|
||||
|
||||
<br>
|
||||
## Resource Properties
|
||||
## Properties
|
||||
|
||||
`name`, `speed`
|
||||
<br>
|
||||
|
|
|
@ -30,7 +30,7 @@ You can use an optional passphrase with `key_rsa`
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* `public_key`, `private_key`, `key_length`
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* `domain`
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
This resource supports the properties found in the `login.defs` configuration settings.
|
||||
|
||||
|
|
|
@ -29,13 +29,13 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
* 'compiler_info', 'error_log_path', 'http_client_body_temp_path', 'http_fastcgi_temp_path', 'http_log_path', 'http_proxy_temp_path', 'http_scgi_temp_path', 'http_uwsgi_temp_path', 'lock_path', 'modules', 'modules_path', 'openssl_version', 'prefix', 'sbin_path', 'service', 'support_info', 'version'
|
||||
|
||||
<br>
|
||||
|
||||
## Property Examples and Return Types
|
||||
## Property Examples
|
||||
|
||||
### version(String)
|
||||
|
||||
|
|
|
@ -24,13 +24,13 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
'address', 'auth_method', 'auth_params', 'conf_dir' , 'conf_file' , 'database', 'params' ,'type', 'user'
|
||||
|
||||
<br>
|
||||
|
||||
## Property Examples and Return Types
|
||||
## Property Examples
|
||||
|
||||
### address([String])
|
||||
|
||||
|
|
|
@ -24,13 +24,13 @@ where
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
'conf_file', 'map_name', 'params', 'pg_username', 'system_username'
|
||||
|
||||
<br>
|
||||
|
||||
## Property Examples and Return Types
|
||||
## Property Examples
|
||||
|
||||
### map_name([String])
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ An `x509_certificate` resource block declares a certificate `key file` to be tes
|
|||
|
||||
<br>
|
||||
|
||||
## Supported Properties
|
||||
## Properties
|
||||
|
||||
### subject.XX
|
||||
|
||||
|
|
Loading…
Reference in a new issue