mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
9cfc86d2ab
Light formatting changes, change order of example and matchers, slight color changes Signed-off-by: hannah-radish <hmaddy@chef.io>
93 lines
2.2 KiB
Text
93 lines
2.2 KiB
Text
---
|
|
title: About the docker_container Resource
|
|
---
|
|
|
|
# docker_container
|
|
|
|
Use the `docker_container` InSpec audit resource to test a docker container.
|
|
|
|
<br>
|
|
|
|
## Syntax
|
|
|
|
A `docker_container` resource block declares the configuration data to be tested:
|
|
|
|
describe docker_container('container') 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
|
|
|
|
The container name can also be passed with the `name` argument:
|
|
|
|
describe docker_container(name: 'an-echo-server') do
|
|
it { should exist }
|
|
it { should be_running }
|
|
end
|
|
|
|
Alternatively, you can pass in the container id:
|
|
|
|
describe docker_container(id: '71b5df59442b') do
|
|
it { should exist }
|
|
it { should be_running }
|
|
end
|
|
|
|
<br>
|
|
|
|
## 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:
|
|
|
|
its('id') { should eq 'sha:71b5df59...442b' }
|
|
|
|
### repo
|
|
|
|
The `repo` matcher tests the value of the image repository:
|
|
|
|
its('repo') { should eq 'busybox' }
|
|
|
|
### tag
|
|
|
|
The `tag` matcher tests the value of the image tag:
|
|
|
|
its('tag') { should eq 'latest' }
|
|
|
|
### ports
|
|
|
|
The `ports` matcher 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:
|
|
|
|
its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
|