Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the cookbook description and readme #27

Merged
merged 6 commits into from
Sep 14, 2023
Merged

Improve the cookbook description and readme #27

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b2d0ba
Improve the cookbook description and readme
tas50 Sep 14, 2023
b779b28
Fix typos
tas50 Sep 14, 2023
b6da21e
Update README.md
tas50 Sep 14, 2023
9b89b2c
Update README.md
tas50 Sep 14, 2023
add57cc
Update README.md
tas50 Sep 14, 2023
bc5c53c
Update README.md
tas50 Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
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.
tas50 marked this conversation as resolved.
Show resolved Hide resolved

It does:
The `default` cookbook recipe:

* Installs the signed `mondoo` package
* Login `cnquery` and `cnspec` with Mondoo Platform
tas50 marked this conversation as resolved.
Show resolved Hide resolved
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:
tas50 marked this conversation as resolved.
Show resolved Hide resolved
- 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
View file
Open in desktop
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