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.

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

readme updates #223

Merged
merged 1 commit into from May 18, 2017

Conversation

Projects
None yet
3 participants
@jeremymv2
Contributor

jeremymv2 commented May 11, 2017

Signed-off-by: Jeremy J. Miller jm@chef.io

Description

This is an attempt to make it easier for consumers of the cookbook to understand the necessary config options for their desired scenario.

The config_matrix.html can be viewed here

Issues Resolved

Check List

@binamov binamov added the in progress label May 11, 2017

@chris-rock

Great addition @jeremymv2 Should me make this part of the markdown readme?

config_matrix.html Outdated
<th>Fetch From Compliance via Chef Server</th>
<td> <!-- Fetch from Compliance via Chef Server : Report Directly to Compliance -->
<pre>
['audit']['reporter'] = 'chef-compliance'

This comment has been minimized.

@chris-rock

chris-rock May 11, 2017

Collaborator

That should be chef-server-compliance

This comment has been minimized.

@jeremymv2

jeremymv2 May 11, 2017

Contributor
   58   <td> <!-- Fetch from Compliance via Chef Server : Report Directly to Compliance -->
   59     <pre>
   60     ['audit']['reporter'] = 'chef-compliance'
   61     ['audit']['fetcher'] = 'chef-server'
   62     ['audit']['server'] = 'https://compliance-server.test/api'
   63     ['audit']['refresh_token' OR 'token'] = '..'
   64     ['audit']['owner'] = 'Owner/Org'
   65
   66     Compliance Integrated w/ Chef Server
   67     </pre>
   68   </td>

Hey @chris-rock I think it's correct as-is. That section of config is handling: fetching from Compliance via Chef Server (Integration) and report directly to Compliance. The fetcher is therefore chef-server (to fetch via the Integration) and reporter is chef-compliance to report directly to Compliance - not via Chef-Server Integration.

config_matrix.html Outdated
</td>
<td> <!-- Fetch from Compliance via Chef Server : Report Directly to Automate -->
<pre>
['audit']['reporter'] = 'chef-automate'

This comment has been minimized.

@chris-rock

chris-rock May 11, 2017

Collaborator

chef-server-automate

This comment has been minimized.

@jeremymv2

jeremymv2 May 11, 2017

Contributor
69   <td> <!-- Fetch from Compliance via Chef Server : Report Directly to Automate -->
   70     <pre>
   71     ['audit']['reporter'] = 'chef-automate'
   72     ['audit']['fetcher'] = 'chef-server'
   73     ['audit']['server'] = 'https://compliance-server.test/api'
   74     ['audit']['refresh_token' OR 'token'] = '..'
   75     ['audit']['owner'] = 'Owner/Org'
   76
   77     Compliance Integrated w/ Chef Server
   78
   79     client.rb:
   80       data_collector['server_url'] = 'https://automate-server.test/data-collector/v0/'
   81       data_collector['token'] = '..'
   82     </pre>
   83   </td>

Again, I think it's correct as-is. use fetcher=chef-server to fetch via Integration, use report=chef-automate to report Directly to Automate, not via chef-server integration.

@jeremymv2

This comment has been minimized.

Contributor

jeremymv2 commented May 11, 2017

@chris-rock I can see what it looks like with the html table embedded into the README.md markdown. My concern initially was that it may be too wide and look strange. I'll see what happens and paste a screenshot.

@chris-rock

This comment has been minimized.

Collaborator

chris-rock commented May 11, 2017

If we have markdown, we can also create a separate docs dir if required. This would allow us to embed this in our inspec page eventually.

@jeremymv2

This comment has been minimized.

Contributor

jeremymv2 commented May 14, 2017

The new format of the table in the README.md can be seen here: https://github.com/jeremymv2/audit-docs/blob/master/grid3.md

@jeremymv2 jeremymv2 changed the title from config matrix to [WIP] : readme updates May 14, 2017

update README.md with config matrix
Signed-off-by: Jeremy J. Miller <jm@chef.io>

@jeremymv2 jeremymv2 changed the title from [WIP] : readme updates to readme updates May 15, 2017

@jeremymv2

This comment has been minimized.

Contributor

jeremymv2 commented May 15, 2017

@chris-rock I think this is better now because it is all contained in the README. I believe these changes make the documentation more streamlined and easier to consume. Can you review again please?

@chris-rock

Great addition @jeremymv2

@chris-rock chris-rock merged commit e74839d into chef-cookbooks:master May 18, 2017

2 checks passed

DCO This commit has a DCO Signed-off-by
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@chris-rock chris-rock removed the in progress label May 18, 2017

@jeremymv2 jeremymv2 deleted the jeremymv2:jeremymv2/config_matrix branch May 19, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment