Skip to content

Commit

Permalink
add warnings to resources
Browse files Browse the repository at this point in the history
Signed-off-by: Clinton Wolfe <[email protected]>
  • Loading branch information
clintoncwolfe committed Jul 29, 2019
1 parent aab22c6 commit e611bd7
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/resources/habitat_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This resource, like all of the inspec-habitat resource pack, is in the early sta

### Connecting to Habitat

To configure `inspec` to be able to communicate with Chef Habitat, be sure [to follow the instructions](https://github.com/inspec/inspec-habitat#configuring-inspec-to-reach-habitat) regarding configuring the connection options.
To configure `inspec` to be able to communicate with Chef Habitat, be sure [to follow the instructions](https://github.com/inspec/inspec-habitat#configuring-inspec-to-reach-habitat) regarding configuring the connection options. This will prevent 'unsupported platform' errors.

## Examples

Expand Down
11 changes: 11 additions & 0 deletions docs/resources/habitat_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ Use the `habitat_package` (singular) InSpec audit resource to perform in-depth a

Use the `habitat_packages` (plural) InSpec audit resource to list Habitat packages, and perform bulk operations.

## Availability

### Status: EXPERIMENTAL

This resource, like all of the inspec-habitat resource pack, is in the early stages of research and development. Functionality may be defective, incomplete, or be withdrawn in the future. If you are interested in helping this project mature, please join the conversation or contribute code at the [inspec-habitat project](https://github.com/inspec/inspec-habitat).

### Connecting to Habitat

To configure `inspec` to be able to communicate with Chef Habitat, be sure [to follow the instructions](https://github.com/inspec/inspec-habitat#configuring-inspec-to-reach-habitat) regarding configuring the connection options. This will prevent 'unsupported platform' errors.


## Examples

### Ensure httpd and memcached are installed
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/habitat_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ platform: habitat

Use the `habitat_service` InSpec audit resource to test properties of a single Habitat service.

## Availability

### Status: EXPERIMENTAL

This resource, like all of the inspec-habitat resource pack, is in the early stages of research and development. Functionality may be defective, incomplete, or be withdrawn in the future. If you are interested in helping this project mature, please join the conversation or contribute code at the [inspec-habitat project](https://github.com/inspec/inspec-habitat).

### Connecting to Habitat

To configure `inspec` to be able to communicate with Chef Habitat, be sure [to follow the instructions](https://github.com/inspec/inspec-habitat#configuring-inspec-to-reach-habitat) regarding configuring the connection options. This will prevent 'unsupported platform' errors.

## Examples

### Check for core/httpd service
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/habitat_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ Use the `habitat_service` (singular) InSpec audit resource to perform in-depth a

Use the `habitat_services` (plural) InSpec audit resource to list Habitat services, and perform bulk operations.

## Availability

### Status: EXPERIMENTAL

This resource, like all of the inspec-habitat resource pack, is in the early stages of research and development. Functionality may be defective, incomplete, or be withdrawn in the future. If you are interested in helping this project mature, please join the conversation or contribute code at the [inspec-habitat project](https://github.com/inspec/inspec-habitat).

### Connecting to Habitat

To configure `inspec` to be able to communicate with Chef Habitat, be sure [to follow the instructions](https://github.com/inspec/inspec-habitat#configuring-inspec-to-reach-habitat) regarding configuring the connection options. This will prevent 'unsupported platform' errors.

## Examples

### Ensure there are 2 services, with the expected names
Expand Down

0 comments on commit e611bd7

Please sign in to comment.