Skip to content

Commit

Permalink
Improve the cookbook description and readme
Browse files Browse the repository at this point in the history
Minor documentation updates

Signed-off-by: Tim Smith <[email protected]>
  • Loading branch information
tas50 committed Sep 14, 2023
1 parent d3a77cb commit 5b2d0ba
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![Cookbook Version](https://img.shields.io/cookbook/v/mondoo.svg)](https://supermarket.chef.io/cookbooks/mondoo)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

This cookbook installs the Mondoo `cnquery` and `cnspec` on Linux servers.
This cookbook installs the Mondoo `cnquery` and `cnspec` on Linux servers for infrastructure security, compliance, and asset intelligence.

It does:
The `default` cookbook recipe:

* Installs the signed `mondoo` package
* Login `cnquery` and `cnspec` with Mondoo Platform
Expand Down Expand Up @@ -39,14 +39,16 @@ It does:

## Run Mondoo Cookbook with chef-run

See [examples] for how use this cookbook with `chef-run`
See the `examples` directory for examples of using this cookbook with `chef-run`.

## Testing

Ensure docker and vagrant are installed and run:
```

```bash
MONDOO_TOKEN=ey...Bp KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test
```

(or add MONDOO_API_PROXY to the list of variables to test the setting/using of that variable)

You can "enter" the resulting environment used for the test by changing the 'test' kitchen command to 'login'.
Expand All @@ -56,8 +58,9 @@ You can reduce the number of environments tested (to speed local testing up) by
## Release

This repo includes a GitHub action "Supermarket Release", which can be manually triggered to perform a release. Before running this workflow make sure to do the following:
- Update the metadata.rb file with the new version.
- Update the CHANGELOG.md file to document the new release.

- Update the metadata.rb file with the new version.
- Update the CHANGELOG.md file to document the new release.

## Author

Expand Down
2 changes: 1 addition & 1 deletion metadata.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
maintainer 'Mondoo, Inc'
maintainer_email '[email protected]'
license 'Apache-2.0'
description 'Installs and configures Mondoo Client'
description 'Installs and configures Mondoo package for infrastructure security, compliance, and asset intelligence'
version '0.6.0'
chef_version '>= 14'
source_url 'https://github.com/mondoohq/chef-mondoo'
Expand Down

0 comments on commit 5b2d0ba

Please sign in to comment.