mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
5a12cddc9c
Adding a dedicated page for the InSpec/Habitat integration which explains what it is, and details the commands a user needs to use the integration. Signed-off-by: Adam Leff <adam@leff.co>
192 lines
No EOL
8.6 KiB
Markdown
192 lines
No EOL
8.6 KiB
Markdown
---
|
|
title: InSpec Integration with Habitat
|
|
---
|
|
|
|
# Habitat Integration
|
|
|
|
InSpec provides an easy method to create an executable Habitat package for an InSpec profile. When run via the Habitat Supervisor, the package will run InSpec with your profile and write out its findings to a JSON file. This provides the ability to ship your compliance controls alongside your Habitat-packaged application and continuously run InSpec, providing you *Continuous Compliance.*
|
|
|
|
## What is Habitat?
|
|
|
|
Habitat by Chef is our new Application Automation tool that aims to make it easy, safe, and fast to build, deploy, and manage applications. From build dependencies, runtime dependencies, dynamic configuration, and service discovery (just to name a few), Habitat packages the automation with the application instead of relying on an underlying platform.
|
|
|
|
To learn more about Habitat and try our demos and tutorials, visit [https://www.habitat.sh](https://www.habitat.sh).
|
|
|
|
## Using the Habitat Integration
|
|
|
|
After creating a Habitat package for an InSpec profile (see CLI commands below) and uploading the package to a Habitat Depot or manually distributing to a host, start the Habitat Supervisor with your package:
|
|
|
|
```bash
|
|
hab start adamleff/inspec-profile-frontend1
|
|
```
|
|
|
|
The Habitat Supervisor will install InSpec and execute your profile in a loop. By default, the loop runs every 300 seconds but can be changed via the `sleep_time` configuration value:
|
|
|
|
```bash
|
|
HAB_INSPEC_PROFILE_FRONTEND1="sleep_time = 60" hab start adamleff/inspec-profile-frontend1
|
|
```
|
|
|
|
The Habitat Supervisor will display output like this:
|
|
|
|
```
|
|
hab start adamleff/inspec-profile-frontend1
|
|
∵ Missing package for core/hab-sup/0.17.0
|
|
» Installing core/hab-sup/0.17.0
|
|
↓ Downloading core/hab-sup/0.17.0/20170214235450
|
|
1.68 MB / 1.68 MB - [=========================================================================] 100.00 % 7.43 MB/s
|
|
|
|
... more Habitat output here ...
|
|
|
|
hab-sup(MN): Starting adamleff/inspec-profile-frontend1/0.1.0/20170328173005
|
|
hab-sup(CS): adamleff/inspec-profile-frontend1/0.1.0/20170328173005 is not installed
|
|
↓ Downloading adamleff-20160617201047 public origin key
|
|
79 B / 79 B | [===============================================================================] 100.00 % 2.64 MB/s
|
|
☑ Cached adamleff-20160617201047 public origin key
|
|
↓ Downloading chef/inspec/1.17.0/20170321214949
|
|
16.93 MB / 16.93 MB / [======================================================================] 100.00 % 10.49 MB/s
|
|
|
|
... more Habitat output here ...
|
|
|
|
★ Install of adamleff/inspec-profile-frontend1/0.1.0/20170328173005 complete with 9 new packages installed.
|
|
hab-sup(MR): Butterfly Member ID d9bd761e18c144469d755b1b97406eb2
|
|
hab-sup(MR): Starting butterfly on 0.0.0.0:9638
|
|
hab-sup(MR): Starting http-gateway on 0.0.0.0:9631
|
|
inspec-profile-frontend1.default(SR): Initializing
|
|
inspec-profile-frontend1.default(SV): Starting process as user=hab, group=hab
|
|
inspec-profile-frontend1.default(O): Executing InSpec for adamleff/inspec-profile-frontend1
|
|
inspec-profile-frontend1.default(O): InSpec run completed successfully.
|
|
inspec-profile-frontend1.default(O): sleeping for 300 seconds
|
|
```
|
|
|
|
The above sample output shows the supervisor starting, downloading the necessary dependencies for the supervisor and the InSpec profile, and then shows the supervisor running InSpec successfully.
|
|
|
|
InSpec will write a JSON file in the `${svc_var_path}/inspec_results` directory containing the results of the last InSpec run. For example, for the `adamleff/inspec-profile-frontend1` package, the InSpec results will be at:
|
|
|
|
```
|
|
/hab/svc/inspec-profile-frontend1/var/inspec_results/inspec-profile-frontend1.json
|
|
```
|
|
|
|
## InSpec Habitat CLI Commands
|
|
|
|
### inspec habitat profile create
|
|
|
|
Create a Habitat package for an InSpec profile. InSpec will validate the profile, fetch and vendor any dependencies (if necessary), and build the Habitat package with a dependency on the latest InSpec. The resulting package will be saved to the current working directory.
|
|
|
|
The package file will be named:
|
|
|
|
```
|
|
HABITAT_ORIGIN-inspec-profile-PROFILE_NAME-PROFILE_VERSION-BUILD_ID-x86_64-linux.hart
|
|
```
|
|
|
|
For example:
|
|
|
|
```
|
|
adamleff-inspec-profile-frontend1-0.1.0-20170328173005-x86_64-linux.hart
|
|
```
|
|
|
|
#### Syntax
|
|
|
|
```bash
|
|
inspec habitat profile create PROFILE_DIRECTORY
|
|
```
|
|
|
|
Example:
|
|
|
|
```bash
|
|
inspec habitat profile create ~/profiles/frontend1
|
|
```
|
|
|
|
### inspec habitat profile create
|
|
|
|
Create a Habitat package for an InSpec profile. InSpec will validate the profile, fetch and vendor any dependencies (if necessary), and build the Habitat package with a dependency on the latest InSpec. The resulting package will be saved to the current working directory.
|
|
|
|
The package can then be manually uploaded to a Habitat Depot or manually distributed to a host and installed via `hab pkg install`.
|
|
|
|
The package file will be named:
|
|
|
|
```
|
|
HABITAT_ORIGIN-inspec-profile-PROFILE_NAME-PROFILE_VERSION-BUILD_ID-x86_64-linux.hart
|
|
```
|
|
|
|
For example:
|
|
|
|
```
|
|
adamleff-inspec-profile-frontend1-0.1.0-20170328173005-x86_64-linux.hart
|
|
```
|
|
|
|
#### Syntax
|
|
|
|
```bash
|
|
inspec habitat profile create PROFILE_DIRECTORY
|
|
```
|
|
|
|
#### Example
|
|
|
|
```bash
|
|
inspec habitat profile create ~/profiles/frontend1
|
|
```
|
|
|
|
#### Example Output
|
|
|
|
```
|
|
$ habitat profile create ~/profiles/frontend1
|
|
[2017-03-28T13:29:32-04:00] INFO: Creating a Habitat artifact for profile: /Users/aleff/profiles/frontend1
|
|
[2017-03-28T13:29:32-04:00] INFO: Checking to see if Habitat is installed...
|
|
[2017-03-28T13:29:32-04:00] INFO: Copying profile contents to the work directory...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating Habitat plan at /var/folders/v5/z54gb76j2rs3wrn65hmtyf1r0000gp/T/inspec-habitat-exporter20170328-4932-kg2ltd/habitat/plan.sh...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating a Habitat run hook at /var/folders/v5/z54gb76j2rs3wrn65hmtyf1r0000gp/T/inspec-habitat-exporter20170328-4932-kg2ltd/habitat/hooks/run...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating Habitat's default.toml configuration...
|
|
[2017-03-28T13:29:32-04:00] INFO: Building our Habitat artifact...
|
|
hab-studio: Destroying Studio at /hab/studios/src (default)
|
|
hab-studio: Creating Studio at /hab/studios/src (default)
|
|
hab-studio: Importing adamleff secret origin key
|
|
» Importing origin key from standard input
|
|
★ Imported secret origin key adamleff-20160617201047.
|
|
» Installing core/hab-backline
|
|
↓ Downloading core/hab-backline/0.19.0/20170311034116
|
|
2.17 KB / 2.17 KB / [=========================================================================] 100.00 % 4.33 MB/s
|
|
|
|
... more Habitat output here...
|
|
|
|
[2017-03-28T13:30:18-04:00] INFO: Copying artifact to /Users/aleff...
|
|
```
|
|
|
|
### inspec habitat profile upload
|
|
|
|
Create and then upload a Habitat package for an InSpec profile. Like the `inspec habitat profile create` command, InSpec will validate the profile, fetch and vendor any dependencies (if necessary), and build the Habitat package with a dependency on the latest InSpec. However, instead of saving the package locally to the workstation, InSpec will upload it to the depot defined in the `HAB_DEPOT` environment variable. If `HAB_DEPOT` is not defined, the package will be uploaded to the public Habitat depot at [https://app.habitat.sh](https://app.habitat.sh).
|
|
|
|
#### Syntax
|
|
|
|
```bash
|
|
inspec habitat profile upload PROFILE_DIRECTORY
|
|
```
|
|
|
|
#### Example
|
|
|
|
```bash
|
|
inspec habitat profile upload ~/profiles/frontend1
|
|
```
|
|
|
|
#### Example Output
|
|
```
|
|
[2017-03-28T13:29:32-04:00] INFO: Creating a Habitat artifact for profile: /Users/aleff/profiles/frontend1
|
|
[2017-03-28T13:29:32-04:00] INFO: Checking to see if Habitat is installed...
|
|
[2017-03-28T13:29:32-04:00] INFO: Copying profile contents to the work directory...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating Habitat plan at /var/folders/v5/z54gb76j2rs3wrn65hmtyf1r0000gp/T/inspec-habitat-exporter20170328-4932-kg2ltd/habitat/plan.sh...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating a Habitat run hook at /var/folders/v5/z54gb76j2rs3wrn65hmtyf1r0000gp/T/inspec-habitat-exporter20170328-4932-kg2ltd/habitat/hooks/run...
|
|
[2017-03-28T13:29:32-04:00] INFO: Generating Habitat's default.toml configuration...
|
|
[2017-03-28T13:29:32-04:00] INFO: Building our Habitat artifact...
|
|
hab-studio: Destroying Studio at /hab/studios/src (default)
|
|
hab-studio: Creating Studio at /hab/studios/src (default)
|
|
hab-studio: Importing adamleff secret origin key
|
|
» Importing origin key from standard input
|
|
★ Imported secret origin key adamleff-20160617201047.
|
|
» Installing core/hab-backline
|
|
↓ Downloading core/hab-backline/0.19.0/20170311034116
|
|
2.17 KB / 2.17 KB / [=========================================================================] 100.00 % 4.33 MB/s
|
|
|
|
... more Habitat output here...
|
|
|
|
[2017-03-28T13:30:18-04:00] INFO: Uploading the Habitat artifact to our Depot...
|
|
[2017-03-28T13:30:23-04:00] INFO: Upload complete!
|
|
``` |