Skip to content

Commit d40b8fc

Browse files
authored
Merge pull request #14 from inspec/im/reorganize_resource_docs
Reorganize docs
2 parents 9e16a46 + 21cfe8e commit d40b8fc

File tree

2 files changed

+55
-23
lines changed

2 files changed

+55
-23
lines changed

docs-chef-io/content/_index.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
+++
2+
title = "About the Chef InSpec RabbitMQ resource pack"
3+
draft = false
4+
linkTitle = "RabbitMQ resource pack"
5+
summary = "Chef InSpec resources for auditing RabbitMQ."
6+
7+
[cascade]
8+
[cascade.params]
9+
platform = "rabbitmq"
10+
11+
[menu.rabbitmq]
12+
title = "About RabbitMQ resources"
13+
identifier = "inspec/resources/rabbitmq/about"
14+
parent = "inspec/resources/rabbitmq"
15+
weight = 10
16+
+++
17+
18+
The Chef InSpec RabbitMQ resources allow you to audit a RabbitMQ cluster.
19+
20+
## Support
21+
22+
The InSpec RabbitMQ resources were part of InSpec core through InSpec 6.
23+
Starting in InSpec 7, they're released separately as a Ruby gem.
24+
25+
## Usage
26+
27+
To add this resource pack to an InSpec profile, add the `inspec-rabbitmq-resources` gem as a dependency in your `inspec.yml` file:
28+
29+
```yaml
30+
depends:
31+
- name: inspec-rabbitmq-resources
32+
gem: inspec-rabbitmq-resources
33+
```
34+
35+
## RabbitMQ resources
36+
37+
{{< inspec_resources_filter >}}
38+
39+
The following Chef InSpec RabbitMQ resources are available in this resource pack.
40+
41+
{{< inspec_resources section="rabbitmq" platform="rabbitmq" >}}
Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,24 @@
11
+++
22
title = "rabbitmq_config resource"
33
draft = false
4-
gh_repo = "inspec"
5-
platform = "linux"
64

7-
[menu]
8-
[menu.inspec]
5+
[menu.rabbitmq]
96
title = "rabbitmq_config"
10-
identifier = "inspec/resources/os/rabbitmq_config.md rabbitmq_config resource"
11-
parent = "inspec/resources/os"
7+
identifier = "inspec/resources/rabbitmq/rabbitmq_config.md rabbitmq_config resource"
8+
parent = "inspec/resources/rabbitmq"
129
+++
1310

1411
Use the `rabbitmq_config` Chef InSpec audit resource to test configuration data for the RabbitMQ daemon located at `/etc/rabbitmq/rabbitmq.config` on Linux and Unix platforms.
1512

16-
## Availability
17-
18-
### Install
19-
20-
{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}}
21-
22-
### Version
23-
24-
This resource first became available in v1.20.0 of InSpec.
25-
2613
## Syntax
2714

2815
A `rabbitmq_config` resource block declares the RabbitMQ configuration data to be tested:
2916

30-
describe rabbitmq_config.params('rabbit', 'ssl_listeners') do
31-
it { should cmp 5671 }
32-
end
17+
```ruby
18+
describe rabbitmq_config.params('rabbit', 'ssl_listeners') do
19+
it { should cmp 5671 }
20+
end
21+
```
3322

3423
where
3524

@@ -40,11 +29,13 @@ where
4029

4130
The following examples show how to use this Chef InSpec audit resource.
4231

43-
### Test the list of TCP listeners
32+
Test the list of TCP listeners:
4433

45-
describe rabbitmq_config.params('rabbit', 'tcp_listeners') do
46-
it { should eq [5672] }
47-
end
34+
```ruby
35+
describe rabbitmq_config.params('rabbit', 'tcp_listeners') do
36+
it { should eq [5672] }
37+
end
38+
```
4839

4940
## Matchers
5041

0 commit comments

Comments
 (0)