Skip to content

Commit

Permalink
fix(libvirt): add missed custom inspec README template
Browse files Browse the repository at this point in the history
* Supposed to be included in #24
* Was used when preparing saltstack-formulas/libvirt-formula#58
  • Loading branch information
myii committed Sep 8, 2019
1 parent 6ef9b0a commit 7378aab
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions ssf/files/tofs_libvirt-formula/inspec/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# InSpec Profile: `{{ suite.name }}`

This shows the implementation of the `{{ suite.name }}` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md).
{%- if suite.name == 'share' %}

It's goal is to share the libraries between all profiles.
{%- endif %}

## Verify a profile

InSpec ships with built-in features to verify a profile structure.

```bash
$ inspec check {{ suite.name }}
Summary
-------
Location: {{ suite.name }}
Profile: profile
Controls: 4
Timestamp: 2019-06-24T23:09:01+00:00
Valid: true

Errors
------

Warnings
--------
```

## Execute a profile

To run all **supported** controls on a local machine use `inspec exec /path/to/profile`.

```bash
$ inspec exec {{ suite.name }}
..

Finished in 0.0025 seconds (files took 0.12449 seconds to load)
8 examples, 0 failures
```
{%- if suite.name != 'share' %}

## Execute a specific control from a profile

To run one control from the profile use `inspec exec /path/to/profile --controls name`.

```bash
$ inspec exec {{ suite.name }} --controls package
.

Finished in 0.0025 seconds (files took 0.12449 seconds to load)
1 examples, 0 failures
```

See an [example control here](https://github.com/inspec/inspec/blob/master/examples/profile/controls/example.rb).
{%- endif %}

0 comments on commit 7378aab

Please sign in to comment.