Merge branch '18663-add-keepbalance-support'

[arvados-formula.git] / test / integration / keepbalance / README.md

diff --git a/test/integration/keepbalance/README.md b/test/integration/keepbalance/README.md
new file mode 100644 (file)
index 0000000..15b911d
--- /dev/null
+++ b/test/integration/keepbalance/README.md
@@ -0,0 +1,50 @@
+# InSpec Profile: `keepbalance`
+
+This shows the implementation of the `keepbalance` InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md).
+
+## Verify a profile
+
+InSpec ships with built-in features to verify a profile structure.
+
+```bash
+$ inspec check keepbalance
+Summary
+-------
+Location: keepbalance
+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 keepbalance
+..
+
+Finished in 0.0025 seconds (files took 0.12449 seconds to load)
+8 examples, 0 failures
+```
+
+## 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 keepbalance --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).