mirror of
https://github.com/inspec/inspec
synced 2024-11-23 21:23:29 +00:00
9cfc86d2ab
Light formatting changes, change order of example and matchers, slight color changes Signed-off-by: hannah-radish <hmaddy@chef.io>
56 lines
1.2 KiB
Text
56 lines
1.2 KiB
Text
---
|
|
title: About the virtualization Resource
|
|
---
|
|
|
|
# virtualization
|
|
|
|
Use the `virtualization` InSpec audit resource to test the virtualization platform on which the system is running.
|
|
|
|
<br>
|
|
|
|
## Syntax
|
|
|
|
An `virtualization` resource block declares the virtualization platform that should be tested:
|
|
|
|
describe virtualization do
|
|
its('system') { should MATCHER 'value' }
|
|
end
|
|
|
|
where
|
|
|
|
* `('system')` is the name of the system information of the virtualization platform (e.g. docker, lxc, vbox, kvm, etc)
|
|
* `MATCHER` is a valid matcher for this resource
|
|
* `'value'` is the value to be tested
|
|
|
|
<br>
|
|
|
|
## Examples
|
|
|
|
The following examples show how to use this InSpec audit resource.
|
|
|
|
### Test for Docker
|
|
|
|
describe virtualization do
|
|
its('system') { should eq 'docker' }
|
|
end
|
|
|
|
### Test for VirtualBox
|
|
|
|
describe virtualization do
|
|
its('system') { should eq 'vbox' }
|
|
its('role') { should eq 'guest' }
|
|
end
|
|
|
|
### Detect the virtualization platform
|
|
|
|
if virtualization.system == 'vbox'
|
|
describe package('name') do
|
|
it { should be_installed }
|
|
end
|
|
end
|
|
|
|
<br>
|
|
|
|
## Matchers
|
|
|
|
For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|