From 5b2d0ba5d15d7113eb0509bc253f5d94d22111dd Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 13:56:59 -0700 Subject: [PATCH 1/6] Improve the cookbook description and readme Minor documentation updates Signed-off-by: Tim Smith --- README.md | 15 +++++++++------ metadata.rb | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f64d3fd..dbec15d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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'. @@ -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 diff --git a/metadata.rb b/metadata.rb index da3bd95..56c2913 100644 --- a/metadata.rb +++ b/metadata.rb @@ -2,7 +2,7 @@ maintainer 'Mondoo, Inc' maintainer_email 'hello@mondoo.com' 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' From b779b281a366270da0736cbc4665f676547f48d3 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 13:58:21 -0700 Subject: [PATCH 2/6] Fix typos Signed-off-by: Tim Smith --- README.md | 2 +- examples/run/recipes/default.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dbec15d..8dc646c 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ MONDOO_TOKEN=ey...Bp KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test You can "enter" the resulting environment used for the test by changing the 'test' kitchen command to 'login'. -You can reduce the number of environments tested (to speed local testing up) by commenting out unneccessary entries from kitchen.dokken.yml. +You can reduce the number of environments tested (to speed local testing up) by commenting out unnecessary entries from kitchen.dokken.yml. ## Release diff --git a/examples/run/recipes/default.rb b/examples/run/recipes/default.rb index 0828ec2..ab50cb9 100644 --- a/examples/run/recipes/default.rb +++ b/examples/run/recipes/default.rb @@ -1,4 +1,4 @@ -# This is really mitigating a bug in Chef. The `package` resoruce fails on a +# This is really mitigating a bug in Chef. The `package` resource fails on a # fresh amazonlinux instance because Chef is not using Utf-8 properly # This ensures all exec's by Chef use utf8 as locale ENV['LANG'] = 'en_US.utf-8' From b6da21eec5e8d658eb25259e51ddd0b777e086c4 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 13:58:42 -0700 Subject: [PATCH 3/6] Update README.md Co-authored-by: Letha --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8dc646c..acd1e6c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This cookbook installs the Mondoo `cnquery` and `cnspec` on Linux servers for in The `default` cookbook recipe: * Installs the signed `mondoo` package -* Login `cnquery` and `cnspec` with Mondoo Platform +* Logs in `cnquery` and `cnspec` with Mondoo Platform * Enables the `cnspec` systemd service ## Requirements From 9b89b2c761bfb3065b375795cb3783f313fbbfe8 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 13:58:51 -0700 Subject: [PATCH 4/6] Update README.md Co-authored-by: Letha --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index acd1e6c..ab4e4b5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![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 for infrastructure security, compliance, and asset intelligence. +This cookbook installs Mondoo `cnquery` and `cnspec` on Linux servers for infrastructure security, compliance, and asset intelligence. The `default` cookbook recipe: From add57cc56d4411800b646d2ceccdfc372d928abb Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 14:00:16 -0700 Subject: [PATCH 5/6] Update README.md Co-authored-by: Letha --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ab4e4b5..117fec4 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ MONDOO_TOKEN=ey...Bp KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test You can "enter" the resulting environment used for the test by changing the 'test' kitchen command to 'login'. -You can reduce the number of environments tested (to speed local testing up) by commenting out unnecessary entries from kitchen.dokken.yml. +You can reduce the number of environments tested (to speed up local testing) by commenting out unnecessary entries from kitchen.dokken.yml. ## Release From bc5c53cac728c12262a85f71f632be1b1f6756cb Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 14 Sep 2023 14:01:22 -0700 Subject: [PATCH 6/6] Update README.md Co-authored-by: Letha --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 117fec4..f082382 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ You can reduce the number of environments tested (to speed up local testing) 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: +This repo includes a GitHub action "Supermarket Release", which you can manually trigger to perform a release. Before running this workflow make sure to: - Update the metadata.rb file with the new version. - Update the CHANGELOG.md file to document the new release.