Add docs re: connection details and 'Experimental' warning

[clintoncwolfe]

Description

Adds instructions on how to configure InSpec to talk to Habitat in the README.

Adds warnings that this is an experimental project in one resource (for now during early review); once we all agree on copy edits, I'll copy it to the other three.

Related Issue

Fixes #38
Fixes #37

Indirectly fixes #34

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New content (non-breaking change)
• Breaking change (a content change which would break existing functionality or processes)

Checklist:

• I have read the CONTRIBUTING document.

After this fix is merged, an InSpec microsite website push will be needed.

[ericcalabretta]

should we also add 4.7.3 in the inspec.yml example we provide in the readme? Right now it has inspec_version: '>= 3.8.0'

Can you provide more details on what these settings are:

       "api_url": "http://dev-hab.my-corp.io",
        "cli_ssh_host": "dev-hab.my-corp.io"

It's covered in a little more detail in the train guide. I still don't 100% understand what those settings should be after reading both. The API section makes more sense to me.

Is it possible to run InSpec locally using these resources? I haven't been able to get it to work yet in my environment but I'll spend more time this afternoon trying.

[clintoncwolfe]

Currently, it is not possible* to run the inspec scanner and the hab cli on the same machine - see inspec/train-habitat#12 , which would add this capability.

For now, if you want to run the two on the same physical machine, you'd want to start a supervisor in a VM that supports SSH and has a hab CLI installed in it.

• That is, I suppose you might be able to SSH to localhost, if you are running an SSH server...

[ericcalabretta]

i needed a few more fields for my config.json The user and key files settings were also required.

The cli_ssh_host field was also a little confusing without more description.

{
  "file_version": "1.1",
  "credentials": {
    "habitat": {
      "dev-hab": {
        "api_url": "http://IPorFQDN",
        "cli_ssh_host": "IPorFQDN",
        "cli_ssh_user": "USERNAME",
        "cli_ssh_key_files": "~/.ssh/KEYNAME"
      }
    }
  }
}

[mjingle]

Suggested change

	Here are the most commonly used options for inspec-habitat.
	The most commonly used connection options for inspec-habitat are for either HTTP API or SSH.

[clintoncwolfe]

The latter part of this suggestion is misleading. A user will typically support options for for both SSH and API access. I've added a sentence clarifying that fact.